BRIKEV/express-jsdoc-swagger

View on GitHub
transforms/components/index.js

Summary

Maintainability
A
2 hrs
Test Coverage
A
100%

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

const parseSchema = (schema, options = {}) => {
  const typedef = getTagInfo(schema.tags, 'typedef');
  const propertyValues = getTagsInfo(schema.tags, 'property');
  const requiredProperties = getRequiredProperties(propertyValues);
  const [descriptionValue, enumValues, jsonOptions] = formatDescription(schema.description);
Severity: Minor
Found in transforms/components/index.js - About 1 hr to fix

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

    const formatProperties = (properties, options = {}) => {
      if (!properties || !Array.isArray(properties)) return {};
      return properties.reduce((acum, property) => {
        const name = getPropertyName(property);
        const isRequired = property.name.includes(REQUIRED);
    Severity: Minor
    Found in transforms/components/index.js - About 1 hr to fix

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

      const formatProperties = (properties, options = {}) => {
        if (!properties || !Array.isArray(properties)) return {};
        return properties.reduce((acum, property) => {
          const name = getPropertyName(property);
          const isRequired = property.name.includes(REQUIRED);
      Severity: Minor
      Found in transforms/components/index.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

      There are no issues that match your filters.

      Category
      Status