stonecircle/express-autoroute

View on GitHub

Showing 7 of 7 total issues

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

function loadRouteObj(app, prefix, file, options) {
  if (file.indexOf('.js') !== file.length - 3) {
    options.logger.warn("Ignoring file because it doesn't end with .js", {
      prefix,
      file,
Severity: Minor
Found in lib/loader.js - About 1 hr to fix

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

    module.exports.autoroute = {
      get: {
        '/getTest': getTest,
        '/getTest/:id': getTestParameter,
      },
    Severity: Major
    Found in routes/test.js and 2 other locations - About 1 hr to fix
    routes/api/2/test.js on lines 21..33
    routes/api/test.js on lines 21..33

    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 3 locations. Consider refactoring.
    Open

    module.exports.autoroute = {
      get: {
        '/getTest': getTest,
        '/getTest/:id': getTestParameter,
      },
    Severity: Major
    Found in routes/api/test.js and 2 other locations - About 1 hr to fix
    routes/api/2/test.js on lines 21..33
    routes/test.js on lines 21..33

    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 3 locations. Consider refactoring.
    Open

    module.exports.autoroute = {
      get: {
        '/getTest': getTest,
        '/getTest/:id': getTestParameter,
      },
    Severity: Major
    Found in routes/api/2/test.js and 2 other locations - About 1 hr to fix
    routes/api/test.js on lines 21..33
    routes/test.js on lines 21..33

    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

    Function loadFile has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function loadFile(file, prefix, app, options) {
      if (dotFileMatch.test(file)) {
        options.logger.info('Ignoring this file', {
          file,
        });
    Severity: Minor
    Found in lib/loader.js - About 1 hr to fix

      Function expressAutoroute has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      module.exports = function expressAutoroute(app, options) {
        // is a winston instance is passed as the second argument it will be used for autoroute logging
        // otherwise it will use a 'clean' winston instance
        if (!options.logger || (!(options.logger.debug && typeof options.logger.debug === 'function'))) {
          // eslint-disable-next-line global-require,no-param-reassign
      Severity: Minor
      Found in index.js - About 55 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 loadFile has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      function loadFile(file, prefix, app, options) {
        if (dotFileMatch.test(file)) {
          options.logger.info('Ignoring this file', {
            file,
          });
      Severity: Minor
      Found in lib/loader.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

      Severity
      Category
      Status
      Source
      Language