timbeadle/cfpathcheck

View on GitHub

Showing 16 of 16 total issues

Function checkFile has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
Open

export const checkFile = (filePath) => {
    const templatePathViolations = [];
    const taglibPathViolations = [];
    const prefixes = [];
    const prefixUsages = [];
Severity: Minor
Found in lib/cfpathcheck.js - About 5 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 comparePrefixArrays has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
Open

export const comparePrefixArrays = (prefixArray1, prefixArray2, message, severity) => {
    const prefixedViolations = {};
    const prefixManifest = {};
    const violations = [];

Severity: Minor
Found in lib/cfpathcheck.js - About 4 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 checkFile has 89 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const checkFile = (filePath) => {
    const templatePathViolations = [];
    const taglibPathViolations = [];
    const prefixes = [];
    const prefixUsages = [];
Severity: Major
Found in lib/cfpathcheck.js - About 3 hrs to fix

    Function comparePrefixArrays has 54 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const comparePrefixArrays = (prefixArray1, prefixArray2, message, severity) => {
        const prefixedViolations = {};
        const prefixManifest = {};
        const violations = [];
    
    
    Severity: Major
    Found in lib/cfpathcheck.js - About 2 hrs to fix

      Function writeOutput has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

      export const writeOutput = (output) => {
          if (Array.isArray(output)) {
              for (const violation of output) {
                  console.log(`File: ${chalk.green(violation.filename)}`);
                  for (const message of violation.messages) {
      Severity: Minor
      Found in lib/cfpathcheck.js - About 1 hr 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

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

                      if (!existsSync(templatePath)) {
                          templatePathViolations.push({
                              line: lineNumber,
                              column: includeMatch.index + 1,
                              message: `cfinclude/include template path ${templatePath} not found`,
      Severity: Major
      Found in lib/cfpathcheck.js and 1 other location - About 1 hr to fix
      lib/cfpathcheck.js on lines 156..163

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

      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 (!existsSync(taglibPath)) {
                      taglibPathViolations.push({
                          line: lineNumber,
                          column: taglibMatch.index + 1,
                          message: `cfimport taglib path ${taglibPath} not found`,
      Severity: Major
      Found in lib/cfpathcheck.js and 1 other location - About 1 hr to fix
      lib/cfpathcheck.js on lines 193..200

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

      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 (importSearch !== null) {
                  prefixes.push({
                      prefix: importSearch.groups.import,
                      line: lineNumber,
                      column: importSearch.index + 1,
      Severity: Minor
      Found in lib/cfpathcheck.js and 1 other location - About 35 mins to fix
      lib/cfpathcheck.js on lines 139..145

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

      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

                  for (const value of namespaceSearch) {
                      prefixUsages.push({
                          prefix: value.groups.namespace,
                          line: lineNumber,
                          column: value.index + 1,
      Severity: Minor
      Found in lib/cfpathcheck.js and 1 other location - About 35 mins to fix
      lib/cfpathcheck.js on lines 127..133

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

      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 getFiles has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      export const getFiles = (filePath) => {
          let fileNames = [];
      
          // Resolve the path, if a relative path was passed in
          if (!path.isAbsolute(filePath)) {
      Severity: Minor
      Found in lib/cfpathcheck.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

      Parsing error: Invalid ecmaVersion.
      Open

      import deepEqual from 'deep-equal';
      Severity: Minor
      Found in lib/utils.js by eslint

      For more information visit Source: http://eslint.org/docs/rules/

      Parsing error: Invalid ecmaVersion.
      Open

      import {
      Severity: Minor
      Found in lib/cfpathcheck.js by eslint

      For more information visit Source: http://eslint.org/docs/rules/

      Parsing error: Invalid ecmaVersion.
      Open

      #!/usr/bin/env node
      Severity: Minor
      Found in bin/cli.js by eslint

      For more information visit Source: http://eslint.org/docs/rules/

      TODO found
      Open

              // @TODO fix vulnerable RegExp
      Severity: Minor
      Found in lib/cfpathcheck.js by fixme

      TODO found
      Open

      TODO.md
      Severity: Minor
      Found in .gitignore by fixme

      TODO found
      Open

      const file = argv._[0] || argv.f || argv.file || 'TODO.md';
      Severity: Minor
      Found in bin/cli.js by fixme
      Severity
      Category
      Status
      Source
      Language