gkushang/cucumber-html-reporter

View on GitHub
lib/reporter.js

Summary

Maintainability
F
1 wk
Test Coverage

Function generateReport has 418 lines of code (exceeds 25 allowed). Consider refactoring.
Invalid

const generateReport = function (options) {
  let featureOutput = jsonFile.readFileSync(options.jsonFile);
  let packageJsonPath = searchFileUp('package.json');
  let packageJson = {};
  try {
Severity: Major
Found in lib/reporter.js - About 2 days to fix

    Function generateReport has a Cognitive Complexity of 75 (exceeds 5 allowed). Consider refactoring.
    Open

    const generateReport = function (options) {
      let featureOutput = jsonFile.readFileSync(options.jsonFile);
      let packageJsonPath = searchFileUp('package.json');
      let packageJson = {};
      try {
    Severity: Minor
    Found in lib/reporter.js - About 1 day to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function setStats has 221 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      const setStats = function (suite) {
        const featureOutput = suite.features;
        const topLevelFeatures = [];
        const featuresSummary = suite.features.summary;
        let screenshotsDirectory;
    Severity: Major
    Found in lib/reporter.js - About 1 day to fix

      File reporter.js has 518 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      // 'use strict';
      const chalk = require('chalk');
      const jsonFile = require('jsonfile');
      const _ = require('lodash');
      const fs = require('fs-extra');
      Severity: Major
      Found in lib/reporter.js - About 1 day to fix

        Function generate has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
        Open

        function generate(options, callback) {
          function isValidJsonFile() {
            // options.jsonFile = options.jsonFile || options.output + '.json';
            options.jsonFile = options.jsonFile || options.output + '.json' || options.output + '.ndjson';
        
        
        Severity: Minor
        Found in lib/reporter.js - About 2 hrs to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function generate has 49 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function generate(options, callback) {
          function isValidJsonFile() {
            // options.jsonFile = options.jsonFile || options.output + '.json';
            options.jsonFile = options.jsonFile || options.output + '.json' || options.output + '.ndjson';
        
        
        Severity: Minor
        Found in lib/reporter.js - About 1 hr to fix

          Function isValidJsonFile has 34 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            function isValidJsonFile() {
              // options.jsonFile = options.jsonFile || options.output + '.json';
              options.jsonFile = options.jsonFile || options.output + '.json' || options.output + '.ndjson';
          
              function isAFile(filePath) {
          Severity: Minor
          Found in lib/reporter.js - About 1 hr to fix

            Avoid deeply nested control flow statements.
            Open

                              if (!fs.existsSync(screenshotsDirectory)) {
                                fs.mkdirSync(screenshotsDirectory);
                              }
            Severity: Major
            Found in lib/reporter.js - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                if (options.noInlineScreenshots)
                                  step.image = path.relative(path.join(options.output, '..'), filename);
              Severity: Major
              Found in lib/reporter.js - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                                if (options.storeScreenshots && options.storeScreenshots === true) {
                                  let name = sanitize(step.name || step.keyword, /[^a-zA-Z0-9-]+/g); // Only allow URL-friendly file names
                                  if (!fs.existsSync(screenshotsDirectory)) {
                                    fs.mkdirSync(screenshotsDirectory);
                                  }
                Severity: Major
                Found in lib/reporter.js - About 45 mins to fix

                  Avoid too many return statements within this function.
                  Open

                            return suite.scenarios.pending++;
                  Severity: Major
                  Found in lib/reporter.js - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                              return suite.scenarios.skipped++;
                    Severity: Major
                    Found in lib/reporter.js - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                return suite.scenarios.passed++;
                      Severity: Major
                      Found in lib/reporter.js - About 30 mins to fix

                        Similar blocks of code found in 2 locations. Consider refactoring.
                        Open

                                      } else if (embeddingType === 'image/png') {
                                        step.image = 'data:image/png;base64,' + embedding.data;
                        
                                        if (options.storeScreenshots && options.storeScreenshots === true) {
                                          let name = sanitize(step.name || step.keyword, /[^a-zA-Z0-9-]+/g); // Only allow URL-friendly file names
                        Severity: Major
                        Found in lib/reporter.js and 1 other location - About 1 day to fix
                        lib/reporter.js on lines 324..345

                        Duplicated Code

                        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                        Tuning

                        This issue has a mass of 218.

                        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                        Refactorings

                        Further Reading

                        Similar blocks of code found in 2 locations. Consider refactoring.
                        Open

                                      } else if (embeddingType === 'image/gif') {
                                        step.image = 'data:image/gif;base64,' + embedding.data;
                        
                                        if (options.storeScreenshots && options.storeScreenshots === true) {
                                          let name = sanitize(step.name || step.keyword, /[^a-zA-Z0-9-]+/g); // Only allow URL-friendly file names
                        Severity: Major
                        Found in lib/reporter.js and 1 other location - About 1 day to fix
                        lib/reporter.js on lines 310..345

                        Duplicated Code

                        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                        Tuning

                        This issue has a mass of 218.

                        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                        Refactorings

                        Further Reading

                        Similar blocks of code found in 2 locations. Consider refactoring.
                        Open

                                if (element.failed > 0) {
                                  feature.scenarios.failed++;
                                  featuresSummary.isFailed = true;
                                  return suite.scenarios.failed++;
                                }
                        Severity: Minor
                        Found in lib/reporter.js and 1 other location - About 50 mins to fix
                        lib/reporter.js on lines 394..398

                        Duplicated Code

                        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                        Tuning

                        This issue has a mass of 52.

                        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                        Refactorings

                        Further Reading

                        Similar blocks of code found in 2 locations. Consider refactoring.
                        Open

                                if (element.ambiguous > 0) {
                                  feature.scenarios.ambiguous++;
                                  featuresSummary.isAmbiguous = true;
                                  return suite.scenarios.ambiguous++;
                                }
                        Severity: Minor
                        Found in lib/reporter.js and 1 other location - About 50 mins to fix
                        lib/reporter.js on lines 388..392

                        Duplicated Code

                        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                        Tuning

                        This issue has a mass of 52.

                        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                        Refactorings

                        Further Reading

                        There are no issues that match your filters.

                        Category
                        Status