Sign upLogin

jaumard/trailpack-design-first

View on GitHub
Star

Showing 15 of 15 total issues

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

        Object.keys(description.properties).forEach(key => {
          const prop = description.properties[key]
          if (description.required && description.required.length > 0) {
            prop.required = description.required.find(item => key === item)
          }
Severity: Major
Found in lib/util.js and 1 other location - About 4 hrs to fix
lib/util.js on lines 266..272

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

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

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

              Object.keys(description.properties).forEach(key => {
                const prop = description.properties[key]
                if (description.required && description.required.length > 0) {
                  prop.required = description.required.find(item => key === item)
                }
Severity: Major
Found in lib/util.js and 1 other location - About 4 hrs to fix
lib/util.js on lines 169..175

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

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

Function _getJoiValidation has 91 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  _getJoiValidation(description) {
    if (!description) {
      return null
    }
    let type = description.type
Severity: Major
Found in lib/util.js - About 3 hrs to fix

    File util.js has 299 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    const { promisify } = require('util')
const exists = promisify(require('fs').exists)
const Joi = require('joi')
const path = require('path')
const SwaggerParser = require('swagger-parser')
    Severity: Minor
    Found in lib/util.js - About 3 hrs to fix

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

        _mapValidations(definition, methodDefinition) {
    const validation = {}
    const headersValidation = {}
    const queryValidation = {}
    const paramsValidation = {}
      Severity: Major
      Found in lib/util.js - About 2 hrs to fix

        Function setupApiFromDefinition has 61 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          setupApiFromDefinition(definition, app) {
    const operations = definition.paths
    const basePath = definition.basePath
    const baseSecurity = definition.security
    const securityDefinitions = definition.securityDefinitions
        Severity: Major
        Found in lib/util.js - About 2 hrs to fix

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

            _mapValidations(definition, methodDefinition) {
    const validation = {}
    const headersValidation = {}
    const queryValidation = {}
    const paramsValidation = {}
          Severity: Minor
          Found in lib/util.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 _getJoiValidation has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
          Open

            _getJoiValidation(description) {
    if (!description) {
      return null
    }
    let type = description.type
          Severity: Minor
          Found in lib/util.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 setupSwaggerExposition has 39 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            setupSwaggerExposition(app) {
    const definitionFiles = app.config.swagger.swaggerDefinition
    if (Array.isArray(definitionFiles)) {
      const folders = []
      definitionFiles.map(definitionFile => {
          Severity: Minor
          Found in lib/util.js - About 1 hr to fix

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

                if (methodDefinition['consumes'] && methodDefinition['consumes'].length > 0) {
      headersValidation['content-type'] = Joi.string().valid(...methodDefinition['consumes']).required()
    }
            Severity: Major
            Found in lib/util.js and 1 other location - About 1 hr to fix
            lib/util.js on lines 247..249

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

            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

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

                  if (Object.keys(queryValidation).length > 0) {
        validation.query = Joi.object(queryValidation)
      }
      else {
        validation.query = Joi.object({})
            Severity: Major
            Found in lib/util.js and 1 other location - About 1 hr to fix
            lib/util.js on lines 291..296

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

            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

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

                  if (Object.keys(paramsValidation).length > 0) {
        validation.params = Joi.object(paramsValidation)
      }
      else {
        validation.params = Joi.object({})
            Severity: Major
            Found in lib/util.js and 1 other location - About 1 hr to fix
            lib/util.js on lines 297..302

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

            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

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

                if (methodDefinition['produces'] && methodDefinition['produces'].length > 0) {
      headersValidation['accept'] = Joi.string().valid(...methodDefinition['produces']).required()
    }
            Severity: Major
            Found in lib/util.js and 1 other location - About 1 hr to fix
            lib/util.js on lines 244..246

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

            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

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

                if (description.minItems || description.minLength) {
      joi = joi.min(description.minItems || description.minLength)
    }
            Severity: Minor
            Found in lib/util.js and 1 other location - About 35 mins to fix
            lib/util.js on lines 217..219

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

            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

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

                if (description.maxItems || description.maxLength) {
      joi = joi.max(description.maxItems || description.maxLength)
    }
            Severity: Minor
            Found in lib/util.js and 1 other location - About 35 mins to fix
            lib/util.js on lines 220..222

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

            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

            Severity
            Category
            Status
            Source
            Language