Sign upLogin

joyent/node

View on GitHub
Star
tools/doc/json.js

Summary

Maintainability
D
3 days
Test Coverage

File json.js has 382 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
Severity: Minor
Found in tools/doc/json.js - About 5 hrs to fix

    Function doJSON has 86 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function doJSON(input, filename, cb) {
  var root = {source: filename};
  var stack = [root];
  var depth = 0;
  var current = root;
    Severity: Major
    Found in tools/doc/json.js - About 3 hrs to fix

      Function finishSection has 79 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function finishSection(section, parent) {
  if (!section || !parent) {
    throw new Error('Invalid finishSection call\n'+
                    JSON.stringify(section) + '\n' +
                    JSON.stringify(parent));
      Severity: Major
      Found in tools/doc/json.js - About 3 hrs to fix

        Function processList has 71 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function processList(section) {
  var list = section.list;
  var values = [];
  var current;
  var stack = [];
        Severity: Major
        Found in tools/doc/json.js - About 2 hrs to fix

          Function finishSection has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
          Open

          function finishSection(section, parent) {
  if (!section || !parent) {
    throw new Error('Invalid finishSection call\n'+
                    JSON.stringify(section) + '\n' +
                    JSON.stringify(parent));
          Severity: Minor
          Found in tools/doc/json.js - About 2 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 parseListItem has 38 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function parseListItem(item) {
  if (item.options) item.options.forEach(parseListItem);
  if (!item.textRaw) return;

  // the goal here is to find the name, type, default, and optional.
          Severity: Minor
          Found in tools/doc/json.js - About 1 hr to fix

            Function parseSignature has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            function parseSignature(text, sig) {
  var params = text.match(paramExpr);
  if (!params) return;
  params = params[1];
  // the [ is irrelevant. ] indicates optionalness.
            Severity: Minor
            Found in tools/doc/json.js - About 1 hr to fix

              Function parseListItem has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

              function parseListItem(item) {
  if (item.options) item.options.forEach(parseListItem);
  if (!item.textRaw) return;

  // the goal here is to find the name, type, default, and optional.
              Severity: Minor
              Found in tools/doc/json.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 newSection has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              function newSection(tok) {
  var section = {};
  // infer the type from the text.
  var text = section.textRaw = tok.text;
  if (text.match(eventExpr)) {
              Severity: Minor
              Found in tools/doc/json.js - About 1 hr to fix

                Function newSection has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                function newSection(tok) {
  var section = {};
  // infer the type from the text.
  var text = section.textRaw = tok.text;
  if (text.match(eventExpr)) {
                Severity: Minor
                Found in tools/doc/json.js - About 45 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

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

                function processList(section) {
  var list = section.list;
  var values = [];
  var current;
  var stack = [];
                Severity: Minor
                Found in tools/doc/json.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

                Avoid too many return statements within this function.
                Open

                      return;
                Severity: Major
                Found in tools/doc/json.js - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                        return;
                  Severity: Major
                  Found in tools/doc/json.js - About 30 mins to fix

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

                        if (eq !== -1) {
      def = p.substr(eq + 1);
      p = p.substr(0, eq);
    }
                    Severity: Minor
                    Found in tools/doc/json.js and 1 other location - About 40 mins to fix
                    deps/v8/tools/tickprocessor.js on lines 903..906

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

                    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