Sign upLogin

SOFTWARE-CLINIC/featurebook-html

View on GitHub
Star

Showing 5 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

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

        return function (attrs) {
    var src = attrs.src;
    attrs.src = isAsset(src) ? removeSchemaPrefix(src) : src;
    return attrs;
  };
      Severity: Minor
      Found in lib/featurebook-html.js and 1 other location - About 40 mins to fix
      lib/featurebook-html.js on lines 110..114

      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 48.

      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

        return function (attrs) {
    var href = attrs.href;
    attrs.href = isFeature(href) ? removeSchemaPrefixAndAppendHtmlSuffix(href) : href;
    return attrs;
  };
      Severity: Minor
      Found in lib/featurebook-html.js and 1 other location - About 40 mins to fix
      lib/featurebook-html.js on lines 92..96

      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 48.

      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

      Severity
      Category
      Status
      Source
      Language