thinkingmedia/grunt-readme-plus

View on GitHub
src/Plus/Engine/Section.js

Summary

Maintainability
A
3 hrs
Test Coverage

Function Module has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

function Module(Markdown) {

    /**
     * Sections are used to pre-define the structure of the Markdown document. These objects define both the
     * tree hierarchy and creation order for each section.
Severity: Minor
Found in src/Plus/Engine/Section.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

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

function Module(Markdown) {

    /**
     * Sections are used to pre-define the structure of the Markdown document. These objects define both the
     * tree hierarchy and creation order for each section.
Severity: Minor
Found in src/Plus/Engine/Section.js - About 1 hr to fix

Consider simplifying this complex logical expression.
Open

        if (!_.isNumber(order)
            || !_.isNumber(creationOrder)
            || order <= 0
            || order > 100
            || creationOrder <= 0
Severity: Major
Found in src/Plus/Engine/Section.js - About 40 mins to fix

There are no issues that match your filters.

Category
Status