yoctore/yocto-doc

View on GitHub

Showing 4 of 4 total issues

Function exports has 263 lines of code (exceeds 25 allowed). Consider refactoring.
Open

module.exports = function (grunt) {
  // Default config path value
  var configPath    = [ __dirname, 'yoctodoc.json' ].join('/');
  var apiDocConfig  = [ process.cwd(), 'docs', 'pivot', 'apidoc.json' ].join('/');
  var appPackage    = JSON.parse(grunt.file.read([ process.cwd(), 'package.json' ].join('/')));
Severity: Major
Found in tasks/yoctodoc.js - About 1 day to fix

    File yoctodoc.js has 273 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    'use strict';
    
    var _         = require('lodash');
    var hooker    = require('hooker');
    var glob      = require('glob');
    Severity: Minor
    Found in tasks/yoctodoc.js - About 2 hrs to fix

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

                        configUsed.opts.footer
                          .replace('%date%', date)
                          .replace('%appname%', grunt.config.data.pkg.name)
                          .replace('%year%', date.getFullYear()), '$3'
      Severity: Major
      Found in tasks/yoctodoc.js and 1 other location - About 1 hr to fix
      tasks/yoctodoc.js on lines 399..402

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

      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

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

                  configUsed.opts.footer
                          .replace('%date%', date)
                          .replace('%appname%', grunt.config.data.pkg.name)
                          .replace('%year%', date.getFullYear()));
      Severity: Major
      Found in tasks/yoctodoc.js and 1 other location - About 1 hr to fix
      tasks/yoctodoc.js on lines 243..246

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

      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