Sign upLogin

Ygilany/paw-apidoc-generator

View on GitHub
Star
ApiDocGenerator.js

Summary

Maintainability
A
3 hrs
Test Coverage

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

const APIDocGenerator = function () {
    this.generate = function (context, requests, options) {

        const request = context.getCurrentRequest();
Severity: Minor
Found in ApiDocGenerator.js - About 1 hr to fix

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

    this.generate = function (context, requests, options) {

        const request = context.getCurrentRequest();

        const headers = [];
Severity: Minor
Found in ApiDocGenerator.js - About 1 hr to fix

Function traverse has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

const traverse = function(o, parent_key = null, result) {
    for (const key in o) {
        const parent = parent_key ? parent_key + "." : "";
        processor(`${parent}${key}`, `${utils.getType(o[key])}`, result)
        if (o[key] !== null && typeof(o[key])=="object") {
Severity: Minor
Found in ApiDocGenerator.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

There are no issues that match your filters.

Category
Status