Sign upLogin

tunnckoCore/koa-better-body

View on GitHub
Star
modules/yaro/src/index.js

Summary

Maintainability
F
3 days
Test Coverage

File index.js has 488 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/* eslint-disable no-continue */
/* eslint-disable class-methods-use-this */
/* eslint-disable no-underscore-dangle */

'use strict';
Severity: Minor
Found in modules/yaro/src/index.js - About 7 hrs to fix

Function buildHelpOutput has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

  buildHelpOutput(commandName) {
    const sections = [];
    const commands = [...this.commands.values()].filter(
      (x) => x.commandName !== '$$root',
    );
Severity: Minor
Found in modules/yaro/src/index.js - About 3 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

Yaro has 25 functions (exceeds 20 allowed). Consider refactoring.
Open

class Yaro {
  constructor(programName, options) {
    if (isObject(programName) && !options) {
      options = programName; // eslint-disable-line no-param-reassign
      programName = null; // eslint-disable-line no-param-reassign
Severity: Minor
Found in modules/yaro/src/index.js - About 2 hrs to fix

Function buildHelpOutput has 59 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  buildHelpOutput(commandName) {
    const sections = [];
    const commands = [...this.commands.values()].filter(
      (x) => x.commandName !== '$$root',
    );
Severity: Major
Found in modules/yaro/src/index.js - About 2 hrs to fix

Function __getResult has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  __getResult(argv) {
    const flagAliases = {};

    [...this.commands.entries()].forEach(([_, cmd]) => {
      [...cmd.flags.entries()].forEach(([flagName, flag]) => {
Severity: Minor
Found in modules/yaro/src/index.js - About 1 hr to fix

Function parse has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  parse(argv = processArgv, options = {}) {
    // NOTE: it's in a single command mode but does not have `.action` defined,
    // so we create noop one o uccessfully continue
    if (!this.currentCommand && this.settings.singleMode === true) {
      this.action(() => {});
Severity: Minor
Found in modules/yaro/src/index.js - About 1 hr to fix

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

  createFlag(rawName, description, config) {
    const flag = {
      rawName,
      description,
    };
Severity: Minor
Found in modules/yaro/src/index.js - About 1 hr to fix

Function checkHelp has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

  checkHelp(cmd) {
    if (this.result.flags.help) {
      const name = cmd && cmd.command && cmd.command.commandName;

      this.showHelp(this.settings.defaultCommand ? '' : name);
Severity: Minor
Found in modules/yaro/src/index.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 constructor has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  constructor(programName, options) {
    if (isObject(programName) && !options) {
      options = programName; // eslint-disable-line no-param-reassign
      programName = null; // eslint-disable-line no-param-reassign
    }
Severity: Minor
Found in modules/yaro/src/index.js - About 1 hr to fix

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

  createFlag(rawName, description, config) {
    const flag = {
      rawName,
      description,
    };
Severity: Minor
Found in modules/yaro/src/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

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

  __getResult(argv) {
    const flagAliases = {};

    [...this.commands.entries()].forEach(([_, cmd]) => {
      [...cmd.flags.entries()].forEach(([flagName, flag]) => {
Severity: Minor
Found in modules/yaro/src/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

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

    if (hasRequired.length > 0 && this.result.args.length === 0) {
      console.log('Missing required arguments');
      exit(1);
    }
Severity: Minor
Found in modules/yaro/src/index.js and 1 other location - About 55 mins to fix
modules/yaro/src/index.js on lines 381..386

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

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 (hasMultiple.length === 0 && this.result.args.length > 1) {
      console.log(
        'Too much arguments passed, you may want add "..." in command declaration?',
      );
      exit(1);
Severity: Minor
Found in modules/yaro/src/index.js and 1 other location - About 55 mins to fix
modules/yaro/src/index.js on lines 377..380

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

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