stoplightio/markdown

View on GitHub
src/plugins/stringify/code.ts

Summary

Maintainability
C
1 day
Test Coverage
A
100%

Function computeMetaProps has a Cognitive Complexity of 41 (exceeds 5 allowed). Consider refactoring.
Open

function computeMetaProps(annotations: object) {
  const metaProps = [];
  if (Object.keys(annotations).length) {
    for (const key in annotations) {
      const annotationVal = annotations[key];
Severity: Minor
Found in src/plugins/stringify/code.ts - 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 computeMetaProps has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function computeMetaProps(annotations: object) {
  const metaProps = [];
  if (Object.keys(annotations).length) {
    for (const key in annotations) {
      const annotationVal = annotations[key];
Severity: Minor
Found in src/plugins/stringify/code.ts - About 1 hr to fix

    Avoid deeply nested control flow statements.
    Open

            if (annotationVal === 'json_schema') {
              // camelCase to be consistent with rest of annotation props
              metaProps.push('jsonSchema');
            }
    Severity: Major
    Found in src/plugins/stringify/code.ts - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

            } else if (key === 'highlightLines') {
              // handle deprecated way of adding highlightLines via array annotation
              if (Array.isArray(annotationVal)) {
                const rangeVals = [];
                for (const val of annotationVal) {
      Severity: Major
      Found in src/plugins/stringify/code.ts - About 45 mins to fix

        There are no issues that match your filters.

        Category
        Status