getlackey/lackey-cms

View on GitHub
lib/server/init/format.js

Summary

Maintainability
F
3 days
Test Coverage

Function format has a Cognitive Complexity of 82 (exceeds 5 allowed). Consider refactoring.
Open

module.exports.format = (req, res, next) => {
    var isYAML = (/(.*).yaml/).test(req.path),
        isJSON = !isYAML && ((/(.*).json$/).test(req.path) || (/^\/api\//).test(req.path)),
        isXLS = !isJSON && !isYAML && (/(.*).xlsx/).test(req.path),
        isHTML = !isJSON && !isYAML && !isXLS;
Severity: Minor
Found in lib/server/init/format.js - About 1 day 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 format has 192 lines of code (exceeds 25 allowed). Consider refactoring.
Open

module.exports.format = (req, res, next) => {
    var isYAML = (/(.*).yaml/).test(req.path),
        isJSON = !isYAML && ((/(.*).json$/).test(req.path) || (/^\/api\//).test(req.path)),
        isXLS = !isJSON && !isYAML && (/(.*).xlsx/).test(req.path),
        isHTML = !isJSON && !isYAML && !isXLS;
Severity: Major
Found in lib/server/init/format.js - About 7 hrs to fix

    Function send has 75 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        res.send = (data, forceFormat) => {
    
            res.send = lSend;
            let output = {};
            output = _.merge(data);
    Severity: Major
    Found in lib/server/init/format.js - About 3 hrs to fix

      Avoid deeply nested control flow statements.
      Open

                                      if (site === 'cms') {
                                          moduleName = parts.shift();
                                          realPath = nPath.resolve(nPath.join(LACKEY_PATH, '/../modules/', moduleName, '/server/views/', parts.join('/')) + '.dust');
                                      } else if (site === 'sites') {
                                          site = parts.shift();
      Severity: Major
      Found in lib/server/init/format.js - About 45 mins to fix

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

            res.js = (listOrOne) => {
                if (typeof listOrOne === 'string') {
                    res.__doc.javascripts.push(listOrOne);
                } else {
                    res.__doc.javascripts = res.__doc.javascripts.concat(listOrOne);
        Severity: Major
        Found in lib/server/init/format.js and 1 other location - About 2 hrs to fix
        lib/server/init/format.js on lines 253..260

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

        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

            res.css = (listOrOne) => {
                if (typeof listOrOne === 'string') {
                    res.__doc.stylesheets.push(listOrOne);
                } else {
                    res.__doc.stylesheets = res.__doc.stylesheets.concat(listOrOne);
        Severity: Major
        Found in lib/server/init/format.js and 1 other location - About 2 hrs to fix
        lib/server/init/format.js on lines 262..268

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

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

            if (isHTML) {
                req.headers.accept = 'text/html,*/*;q=0.1';
                req.headers['content-type'] = 'text/html';
                res.header('Content-Type', 'text/html');
            } else if (isJSON) {
        Severity: Minor
        Found in lib/server/init/format.js and 2 other locations - About 35 mins to fix
        lib/server/init/format.js on lines 61..72
        lib/server/init/format.js on lines 65..72

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

            } else if (isYAML) {
                req.headers.accept = 'text/x-yaml,*/*;q=0.1';
                req.headers['content-type'] = 'text/x-yaml';
                res.header('Content-Type', 'text/x-yaml');
            } else if (isXLS) {
        Severity: Minor
        Found in lib/server/init/format.js and 2 other locations - About 35 mins to fix
        lib/server/init/format.js on lines 57..72
        lib/server/init/format.js on lines 61..72

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

            } else if (isJSON) {
                req.headers.accept = 'application/json,*/*;q=0.1';
                req.headers['content-type'] = 'application/json';
                res.header('Content-Type', 'application/json');
            } else if (isYAML) {
        Severity: Minor
        Found in lib/server/init/format.js and 2 other locations - About 35 mins to fix
        lib/server/init/format.js on lines 57..72
        lib/server/init/format.js on lines 65..72

        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

        There are no issues that match your filters.

        Category
        Status