SOFTWARE-CLINIC/featurebook-html

View on GitHub

Showing 3 of 5 total issues

Function html has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

function html(specDir, outputDir) {
  var metadata = featurebook.readMetadataSync(specDir);
  var indexTemplate = path.join(TEMPLATES_DIR, 'index.pug');
  var featureTemplate = path.join(TEMPLATES_DIR, 'feature.pug');
  var compileOptions = {debug: false, pretty: true};
Severity: Minor
Found in lib/featurebook-html.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 html has 54 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function html(specDir, outputDir) {
  var metadata = featurebook.readMetadataSync(specDir);
  var indexTemplate = path.join(TEMPLATES_DIR, 'index.pug');
  var featureTemplate = path.join(TEMPLATES_DIR, 'feature.pug');
  var compileOptions = {debug: false, pretty: true};
Severity: Major
Found in lib/featurebook-html.js - About 2 hrs to fix

    Function print has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      function print(node, pathPrefix) {
        if (node.type === featurebook.NODE_FILE) {
          var featurePath = path.join(specDir, node.path);
          var nextPathPrefix = pathPrefix || './';
          try {
    Severity: Minor
    Found in lib/featurebook-html.js - About 1 hr to fix
      Severity
      Category
      Status
      Source
      Language