jzaefferer/grunt-html

View on GitHub

Showing 11 of 11 total issues

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

  results.forEach(result => {
    // Register the file
    result.file = path.normalize(result.file);
    if (!files[result.file]) {
      files[result.file] = [];
Severity: Major
Found in lib/reporters/junit.js and 1 other location - About 6 hrs to fix
lib/reporters/checkstyle.js on lines 16..31

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

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

  results.forEach(result => {
    // Register the file
    result.file = path.normalize(result.file);
    if (!files[result.file]) {
      files[result.file] = [];
Severity: Major
Found in lib/reporters/checkstyle.js and 1 other location - About 6 hrs to fix
lib/reporters/junit.js on lines 13..28

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

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

Function htmllint has 104 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function htmllint(config, done) {
  const maxChars = 5000;

  // increase child process buffer to accommodate large amounts of
  // validation output. (default is a paltry 200k.)
Severity: Major
Found in lib/htmllint.js - About 4 hrs to fix

    Function htmllint has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    function htmllint(config, done) {
      const maxChars = 5000;
    
      // increase child process buffer to accommodate large amounts of
      // validation output. (default is a paltry 200k.)
    Severity: Minor
    Found in lib/htmllint.js - About 3 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 exports has 54 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    module.exports = function(grunt) {
      grunt.registerMultiTask('htmllint', 'Validate html files', function() {
        const done = this.async();
        const files = grunt.file.expand(this.filesSrc);
        const options = this.options({
    Severity: Major
    Found in tasks/html.js - About 2 hrs to fix

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

      module.exports = function(grunt) {
        grunt.initConfig({
          htmllint: {
            valid: 'test/valid.html',
            invalid: 'test/*.html',
      Severity: Minor
      Found in Gruntfile.js - About 1 hr to fix

        Function junit has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function junit(results) {
          const files = {};
          const out = [];
        
          results.forEach(result => {
        Severity: Minor
        Found in lib/reporters/junit.js - About 1 hr to fix

          Function checkstyle has 30 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function checkstyle(results) {
            const files = {};
            const out = [];
          
            results.forEach(result => {
          Severity: Minor
          Found in lib/reporters/checkstyle.js - About 1 hr to fix

            Function selectReporter has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

            function selectReporter(options) {
              if (options.reporter === 'checkstyle') {
                // Checkstyle XML reporter
                options.reporter = '../lib/reporters/checkstyle.js';
              } else if (options.reporter === 'json') {
            Severity: Minor
            Found in lib/reporters.js - About 35 mins 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 checkstyle has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            function checkstyle(results) {
              const files = {};
              const out = [];
            
              results.forEach(result => {
            Severity: Minor
            Found in lib/reporters/checkstyle.js - About 25 mins 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 junit has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            function junit(results) {
              const files = {};
              const out = [];
            
              results.forEach(result => {
            Severity: Minor
            Found in lib/reporters/junit.js - About 25 mins 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

            Severity
            Category
            Status
            Source
            Language