cloudflare/json-schema-docs-generator

View on GitHub

Showing 9 of 15 total issues

Function extract has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

ExampleDataExtractor.prototype.extract = function(component, root, options) {
  options = options || {};
  var reduced = {};

  if (!component) {
Severity: Minor
Found in lib/example-data-extractor.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 build has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

ObjectDefinition.prototype.build = function(object) {
  var required = object.required || [];
  var self = {
    // A map of properties defined by the object, if oneOf/anyOf is not defined
    allProps: {},
Severity: Minor
Found in lib/object-definition.js - About 1 hr to fix

    Function dereferenceSchema has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    Resolver.prototype.dereferenceSchema = function (schema, context, prop, stack) {
      // If the value is not an object, we've reach the end of the line, so just return the value
      if (!_.isPlainObject(schema)) {
        return schema;
      }
    Severity: Minor
    Found in lib/resolver.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 extract has 32 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    ExampleDataExtractor.prototype.extract = function(component, root, options) {
      options = options || {};
      var reduced = {};
    
      if (!component) {
    Severity: Minor
    Found in lib/example-data-extractor.js - About 1 hr to fix

      Function mapPropertiesToExamples has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      ExampleDataExtractor.prototype.mapPropertiesToExamples = function(props, schema, options) {
        options = options || {};
      
        return _.transform(props, function(properties, propConfig, propName) {
          // Allow opt-ing out of generating example data
      Severity: Minor
      Found in lib/example-data-extractor.js - About 1 hr to fix

        Function dereferenceSchema has 26 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        Resolver.prototype.dereferenceSchema = function (schema, context, prop, stack) {
          // If the value is not an object, we've reach the end of the line, so just return the value
          if (!_.isPlainObject(schema)) {
            return schema;
          }
        Severity: Minor
        Found in lib/resolver.js - About 1 hr to fix

          Function getValue has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

          function getValue(context, token) {
            // Reference token evaluation. See Section 4 of spec.
            // First of all we should unescape all special characters in token.
            token = unescapeReferenceToken(token);
            // Further actions depend of context of evaluation.
          Severity: Minor
          Found in lib/pointer.js - About 55 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 build has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

          ObjectDefinition.prototype.build = function(object) {
            var required = object.required || [];
            var self = {
              // A map of properties defined by the object, if oneOf/anyOf is not defined
              allProps: {},
          Severity: Minor
          Found in lib/object-definition.js - About 55 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 defineProperty has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

          ObjectDefinition.prototype.defineProperty = function(property) {
            var definition = {};
            // Determine the appropriate type
            if (property.enum) {
              definition.type = typeof property.enum[0];
          Severity: Minor
          Found in lib/object-definition.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

          Severity
          Category
          Status
          Source
          Language