compodoc/ngd

View on GitHub
src/modules/transformer/dist/engines/dot/dot.js

Summary

Maintainability
F
3 days
Test Coverage

Function DotEngine has 208 lines of code (exceeds 25 allowed). Consider refactoring.
Open

var DotEngine = /** @class */ (function () {
    function DotEngine(options) {
        // http://www.graphviz.org/doc/info/shapes.html
        this.template = dot_template_1.DOT_TEMPLATE;
        this.cwd = process.cwd();
Severity: Major
Found in src/modules/transformer/dist/engines/dot/dot.js - About 1 day to fix

    Function DotEngine has a Cognitive Complexity of 40 (exceeds 5 allowed). Consider refactoring.
    Open

    var DotEngine = /** @class */ (function () {
        function DotEngine(options) {
            // http://www.graphviz.org/doc/info/shapes.html
            this.template = dot_template_1.DOT_TEMPLATE;
            this.cwd = process.cwd();
    Severity: Minor
    Found in src/modules/transformer/dist/engines/dot/dot.js - About 6 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 DotEngine has 42 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        function DotEngine(options) {
            // http://www.graphviz.org/doc/info/shapes.html
            this.template = dot_template_1.DOT_TEMPLATE;
            this.cwd = process.cwd();
            this.files = {
    Severity: Minor
    Found in src/modules/transformer/dist/engines/dot/dot.js - About 1 hr to fix

      Function generateGraph has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          DotEngine.prototype.generateGraph = function (deps) {
              var _this = this;
              var template = this.preprocessTemplates(this.options);
              var generators = [];
              // Handle svg dependency with dot, and html with svg
      Severity: Minor
      Found in src/modules/transformer/dist/engines/dot/dot.js - About 1 hr to fix

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

                    fs.outputFile(_this.paths.svg, vizSvg, function (error) {
                        if (error) {
                            reject(error);
                        }
                        if (cleanSvg === false) {
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 1 other location - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 180..188

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

        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

                    }), function (error) {
                        if (error) {
                            reject(error);
                        }
                        if (cleanDot === false) {
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 1 other location - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 196..204

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

        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 (this.options.outputFormats.indexOf('html') > -1 && this.options.outputFormats.indexOf('dot') === -1) {
                        cleanDot = true;
                    }
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 2 other locations - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 80..82
        src/modules/transformer/dist/engines/dot/dot.js on lines 91..93

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

                    if (this.options.outputFormats.indexOf('svg') > -1 && this.options.outputFormats.indexOf('dot') === -1) {
                        cleanDot = true;
                    }
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 2 other locations - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 91..93
        src/modules/transformer/dist/engines/dot/dot.js on lines 94..96

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

                    if (this.options.outputFormats.indexOf('html') > -1 && this.options.outputFormats.indexOf('svg') === -1) {
                        cleanSvg = true;
                    }
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 2 other locations - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 80..82
        src/modules/transformer/dist/engines/dot/dot.js on lines 94..96

        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

                    fs.outputFile(_this.paths.json, JSON.stringify(deps, null, 2), function (error) {
                        if (error) {
                            reject(error);
                        }
                        ngd_core_1.logger.info('creating JSON', _this.paths.json);
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 1 other location - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 213..219

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

        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

                    fs.outputFile(_this.paths.html, htmlContent, function (error) {
                        if (error) {
                            reject(error);
                        }
                        ngd_core_1.logger.info('creating HTML', _this.paths.html);
        Severity: Major
        Found in src/modules/transformer/dist/engines/dot/dot.js and 1 other location - About 1 hr to fix
        src/modules/transformer/dist/engines/dot/dot.js on lines 142..148

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

        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