vgno/roc-config

View on GitHub

Showing 571 of 571 total issues

Avoid too many return statements within this function.
Open

    return undefined;
Severity: Major
Found in src/cli/runCli.js - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

                    return {
                        key: `[${index}]`,
                        value: input[index],
                        message: result,
                    };
    Severity: Major
    Found in src/validation/validators/isArray.js - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return console.log(
                  generateCommandDocumentation(
                      context.extensionConfig.settings,
                      context.meta.settings,
                      commandData.commands,
      Severity: Major
      Found in src/cli/runCli.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return execute(command.command, {
                        context: command.__context,
                        args: input.extraArguments,
                        cwd: dirPath,
                    }).catch((error) => {
        Severity: Major
        Found in src/cli/runCli.js - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                          return commandResult
                              .catch((error) => {
                                  log.small.warn('A problem occurred when running the command', error);
                              });
          Severity: Major
          Found in src/cli/runCli.js - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return (input) => input;
            Severity: Major
            Found in src/converters/automatic.js - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return github(template, version);
              Severity: Major
              Found in src/commands/init/fetchTemplate.js - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                return {
                                    key: `.${key}`,
                                    value: input[key],
                                    message: result,
                                };
                Severity: Major
                Found in src/validation/validators/isObject.js - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return download(template, version, clone);
                  Severity: Major
                  Found in src/commands/init/fetchTemplate.js - About 30 mins to fix

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

                        const tree = projectExtensions.map(({ name, version }) => ({
                            label: `${name}@${version}`,
                            nodes: getParents(name),
                        }));
                    Severity: Minor
                    Found in src/context/initContext.js and 1 other location - About 30 mins to fix
                    src/context/initContext.js on lines 202..208

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

                    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

                            usedExtensions
                                .find(({ name }) => name === extensionName)
                                .parents
                                .map(({ name, version }) => ({
                                    label: `${name}@${version}`,
                    Severity: Minor
                    Found in src/context/initContext.js and 1 other location - About 30 mins to fix
                    src/context/initContext.js on lines 210..213

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

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

                    export function getConfig(customState) {
                        if (customState) {
                            return customState;
                        }
                    
                    
                    Severity: Minor
                    Found in src/configuration/manageConfig.js - 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 fetchTemplate has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    export default function fetchTemplate(template, directory, version, { clone }) {
                        // The provided template is a local folder
                        if (folderExists(template, directory)) {
                            return getAbsolutePath(template, directory);
                        }
                    Severity: Minor
                    Found in src/commands/init/fetchTemplate.js - 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 createInfoObject has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    export default function createInfoObject({
                        validator = () => ({ type: '' }),
                        wrapper,
                        required = false,
                        canBeEmpty,
                    Severity: Minor
                    Found in src/validation/helpers/createInfoObject.js - 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 dependenciesToMarkdown has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    export default function dependenciesToMarkdown(name, extension, dependencies = {}) {
                        const rows = [];
                    
                        rows.push(`# Dependencies for \`${name}\``, '');
                    
                    
                    Severity: Minor
                    Found in src/documentation/markdown/dependenciesToMarkdown.js - 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 extensionsToMarkdown has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    export default function extensionsToMarkdown(name, usedExtensions = [], commandObject, extension) {
                        const rows = [];
                    
                        const packages = usedExtensions.filter((extn) => extn.type === 'package' &&
                            // Do no list the package itself, this is based on the name of the extension and the current name of the
                    Severity: Minor
                    Found in src/documentation/markdown/extensionsToMarkdown.js - 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 buildGroup has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    function buildGroup(cli, command, commandData, allSettingGroups, printGroup, parents, level) {
                        const rows = [];
                        rows.push(`##${'#'.repeat(level)} ${command}`);
                        if (commandData.__meta && commandData.__meta.name) {
                            rows.push(`__${commandData.__meta.name}__`);
                    Severity: Minor
                    Found in src/documentation/markdown/commandsToMarkdown.js - 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 commandsToMarkdown has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    export default function commandsToMarkdown(
                        name,
                        config = {},
                        commands,
                        settingsLink,
                    Severity: Minor
                    Found in src/documentation/markdown/commandsToMarkdown.js - 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 validateRequiredVersion has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                    Open

                    function validateRequiredVersion(templateDir) {
                        // This will eventually be defined by the roc-plugin-create
                        const createVersion = '1.0.0';
                    
                        const checkVersion = (file) => {
                    Severity: Minor
                    Found in src/commands/init/index.js - 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

                    Unexpected trailing comma.
                    Open

                            ...extOptions,
                    Severity: Minor
                    Found in src/cli/processArguments.js by eslint

                    require or disallow trailing commas (comma-dangle)

                    Trailing commas in object literals are valid according to the ECMAScript 5 (and ECMAScript 3!) spec. However, IE8 (when not in IE8 document mode) and below will throw an error when it encounters trailing commas in JavaScript.

                    var foo = {
                        bar: "baz",
                        qux: "quux",
                    };

                    Trailing commas simplify adding and removing items to objects and arrays, since only the lines you are modifying must be touched. Another argument in favor of trailing commas is that it improves the clarity of diffs when an item is added or removed from an object or array:

                    Less clear:

                    var foo = {
                    -    bar: "baz",
                    -    qux: "quux"
                    +    bar: "baz"
                     };

                    More clear:

                    var foo = {
                         bar: "baz",
                    -    qux: "quux",
                     };

                    Rule Details

                    This rule enforces consistent use of trailing commas in object and array literals.

                    Options

                    This rule has a string option or an object option:

                    {
                        "comma-dangle": ["error", "never"],
                        // or
                        "comma-dangle": ["error", {
                            "arrays": "never",
                            "objects": "never",
                            "imports": "never",
                            "exports": "never",
                            "functions": "ignore",
                        }]
                    }
                    • "never" (default) disallows trailing commas
                    • "always" requires trailing commas
                    • "always-multiline" requires trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }
                    • "only-multiline" allows (but does not require) trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }

                    Trailing commas in function declarations and function calls are valid syntax since ECMAScript 2017; however, the string option does not check these situations for backwards compatibility.

                    You can also use an object option to configure this rule for each type of syntax. Each of the following options can be set to "never", "always", "always-multiline", "only-multiline", or "ignore". The default for each option is "never" unless otherwise specified.

                    • arrays is for array literals and array patterns of destructuring. (e.g. let [a,] = [1,];)
                    • objects is for object literals and object patterns of destructuring. (e.g. let {a,} = {a: 1};)
                    • imports is for import declarations of ES Modules. (e.g. import {a,} from "foo";)
                    • exports is for export declarations of ES Modules. (e.g. export {a,};)
                    • functions is for function declarations and function calls. (e.g. (function(a,){ })(b,);)
                      functions is set to "ignore" by default for consistency with the string option.

                    never

                    Examples of incorrect code for this rule with the default "never" option:

                    /*eslint comma-dangle: ["error", "never"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux",
                    };
                    
                    var arr = [1,2,];
                    
                    foo({
                      bar: "baz",
                      qux: "quux",
                    });

                    Examples of correct code for this rule with the default "never" option:

                    /*eslint comma-dangle: ["error", "never"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux"
                    };
                    
                    var arr = [1,2];
                    
                    foo({
                      bar: "baz",
                      qux: "quux"
                    });

                    always

                    Examples of incorrect code for this rule with the "always" option:

                    /*eslint comma-dangle: ["error", "always"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux"
                    };
                    
                    var arr = [1,2];
                    
                    foo({
                      bar: "baz",
                      qux: "quux"
                    });

                    Examples of correct code for this rule with the "always" option:

                    /*eslint comma-dangle: ["error", "always"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux",
                    };
                    
                    var arr = [1,2,];
                    
                    foo({
                      bar: "baz",
                      qux: "quux",
                    });

                    always-multiline

                    Examples of incorrect code for this rule with the "always-multiline" option:

                    /*eslint comma-dangle: ["error", "always-multiline"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux"
                    };
                    
                    var foo = { bar: "baz", qux: "quux", };
                    
                    var arr = [1,2,];
                    
                    var arr = [1,
                        2,];
                    
                    var arr = [
                        1,
                        2
                    ];
                    
                    foo({
                      bar: "baz",
                      qux: "quux"
                    });

                    Examples of correct code for this rule with the "always-multiline" option:

                    /*eslint comma-dangle: ["error", "always-multiline"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux",
                    };
                    
                    var foo = {bar: "baz", qux: "quux"};
                    var arr = [1,2];
                    
                    var arr = [1,
                        2];
                    
                    var arr = [
                        1,
                        2,
                    ];
                    
                    foo({
                      bar: "baz",
                      qux: "quux",
                    });

                    only-multiline

                    Examples of incorrect code for this rule with the "only-multiline" option:

                    /*eslint comma-dangle: ["error", "only-multiline"]*/
                    
                    var foo = { bar: "baz", qux: "quux", };
                    
                    var arr = [1,2,];
                    
                    var arr = [1,
                        2,];

                    Examples of correct code for this rule with the "only-multiline" option:

                    /*eslint comma-dangle: ["error", "only-multiline"]*/
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux",
                    };
                    
                    var foo = {
                        bar: "baz",
                        qux: "quux"
                    };
                    
                    var foo = {bar: "baz", qux: "quux"};
                    var arr = [1,2];
                    
                    var arr = [1,
                        2];
                    
                    var arr = [
                        1,
                        2,
                    ];
                    
                    var arr = [
                        1,
                        2
                    ];
                    
                    foo({
                      bar: "baz",
                      qux: "quux",
                    });
                    
                    foo({
                      bar: "baz",
                      qux: "quux"
                    });

                    functions

                    Examples of incorrect code for this rule with the {"functions": "never"} option:

                    /*eslint comma-dangle: ["error", {"functions": "never"}]*/
                    
                    function foo(a, b,) {
                    }
                    
                    foo(a, b,);
                    new foo(a, b,);

                    Examples of correct code for this rule with the {"functions": "never"} option:

                    /*eslint comma-dangle: ["error", {"functions": "never"}]*/
                    
                    function foo(a, b) {
                    }
                    
                    foo(a, b);
                    new foo(a, b);

                    Examples of incorrect code for this rule with the {"functions": "always"} option:

                    /*eslint comma-dangle: ["error", {"functions": "always"}]*/
                    
                    function foo(a, b) {
                    }
                    
                    foo(a, b);
                    new foo(a, b);

                    Examples of correct code for this rule with the {"functions": "always"} option:

                    /*eslint comma-dangle: ["error", {"functions": "always"}]*/
                    
                    function foo(a, b,) {
                    }
                    
                    foo(a, b,);
                    new foo(a, b,);

                    When Not To Use It

                    You can turn this rule off if you are not concerned with dangling commas. Source: http://eslint.org/docs/rules/

                    Severity
                    Category
                    Status
                    Source
                    Language