Sign upLogin

orbital-js/orbital

View on GitHub
Star

Showing 9 of 9 total issues

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

    private createInstanceOfCommand(command: any): CommandInstance {
        const commandInstance = new command();
        const commandMetadata: CommandMetadata = getClassMetadata(command);
        const paramTypes = getParamTypes(commandInstance, 'execute');
Severity: Minor
Found in packages/core/src/command/command-mapper.ts - About 1 hr to fix

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

        private createInstanceOfCommand(command: any): CommandInstance {
        const commandInstance = new command();
        const commandMetadata: CommandMetadata = getClassMetadata(command);
        const paramTypes = getParamTypes(commandInstance, 'execute');
    Severity: Minor
    Found in packages/core/src/command/command-mapper.ts - 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 findCommand has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public findCommand(args: ParsedArgs)
        : { command: CommandInstance, depth: number } {
        let command: CommandInstance | null = null;
        let commands = this.commands;
        let subcommands = this.subcommands;
    Severity: Minor
    Found in packages/core/src/command/command-resolver.ts - 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

    export class MetadataError extends OrbitalError {
    constructor(commandName: string) {
        const message = `There has been an error parsing metadata on command: '${commandName}.`;
        super(message);
    }
    Severity: Minor
    Found in packages/core/src/errors/metadata.error.ts and 1 other location - About 35 mins to fix
    packages/core/src/errors/duplicate-name.error.ts on lines 3..8

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

    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

    export class DuplicateNameError extends OrbitalError {
    constructor(name: string) {
        const message = `CLI modules defines two commands with conflicting names: [${name}]`;
        super(message);
    }
    Severity: Minor
    Found in packages/core/src/errors/duplicate-name.error.ts and 1 other location - About 35 mins to fix
    packages/core/src/errors/metadata.error.ts on lines 3..8

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

    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 getParameters has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        private static getParameters(command: CommandInstance, args: ParsedArgs, depth: number) {
        const parameters = [];
        if (command.params) {
            for (const param of command.params) {
                const argument = args.arguments[param.index + depth];
    Severity: Minor
    Found in packages/core/src/command/command-executor.ts - 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

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

        private static tryRunCommand(input: ParsedArgs, commandInstances: MappedCommands) {
        let hasRun = true;
        try {
            /**
             * FIXME: this behavior is wrong, atleast until we have custom compiler
    Severity: Minor
    Found in packages/core/src/orbital-factory.ts - 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

    Function injectOptions has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        private static injectOptions(command: CommandInstance, args: ParsedArgs): void {
        for (const opt in command.options) {
            const option = command.options[opt];
            const value = this.getOption(option, args);
            if (value) {
    Severity: Minor
    Found in packages/core/src/command/command-executor.ts - About 25 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 generateOptionDocs has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

    export function generateOptionDocs(options: { [prop: string]: ModifiedOptionMetadata }): string {
    let str = '';
    for (const option in options) {
        const opt = options[option];
        str += chalk.blue('--' + opt.name) + s
    Severity: Minor
    Found in packages/core/src/help/util.ts - About 25 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