Sign upLogin

sebinbenjamin/image-res-generator

View on GitHub
Star
src/core/generator.js

Summary

Maintainability
C
1 day
Test Coverage

Function generateForConfig has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function generateForConfig(imageObj, settings, config) {
  const platformPath = path.join(settings.outputDirectory, config.path);
  return fs.ensureDir(platformPath).then(() => {
    // const sectionName = `Generating ${config.type} files for ${config.platform}`;
    const { definitions } = config;
Severity: Minor
Found in src/core/generator.js - About 1 hr to fix

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

    function generate(imageObj, settings, gSelectedPlatforms) {
  display.header('Generating files');
  display.info('=================');
  const configs = [];
  // * TO DO: Refactor if possible
    Severity: Minor
    Found in src/core/generator.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

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

        if (promiseArraySplash.length) {
      Promise.all(promiseArraySplash)
        .then(success => {
          const configType = success[0].config.type;
          const configPlatform = success[0].config.platform;
    Severity: Major
    Found in src/core/generator.js and 1 other location - About 3 hrs to fix
    src/core/generator.js on lines 87..100

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

    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 (promiseArrayIcons.length) {
      Promise.all(promiseArrayIcons)
        .then(success => {
          const configType = success[0].config.type;
          const configPlatform = success[0].config.platform;
    Severity: Major
    Found in src/core/generator.js and 1 other location - About 3 hrs to fix
    src/core/generator.js on lines 101..114

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

    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

    Replace def,·platformPath,·imageObj,·config.type,·config.platform), with ⏎··············def,⏎··············platformPath,⏎··············imageObj,⏎··············config.type,⏎··············config.platform⏎············)
    Open

                transformIcon(def, platformPath, imageObj, config.type, config.platform),
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace def,·platformPath,·imageObj,·config.type,·config.platform), with ⏎··············def,⏎··············platformPath,⏎··············imageObj,⏎··············config.type,⏎··············config.platform⏎············)
    Open

                transformSplash(def, platformPath, imageObj, config.type, config.platform),
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ··
    Open

            platform,
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace }) with ··})⏎····
    Open

        }));
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ⏎·····
    Open

        .then(() => Promise.resolve({
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace config with (config)
    Open

      return filteredConfigs.forEach(config =>
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace ·image.resize(definition.size,·definition.size).toFile(outputFilePath) with ⏎······image.resize(definition.size,·definition.size).toFile(outputFilePath)⏎····
    Open

        .then(() => image.resize(definition.size, definition.size).toFile(outputFilePath))
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace ·image.resize({·width,·height,·position:·'centre'·}).toFile(outputFilePath) with ⏎······image.resize({·width,·height,·position:·'centre'·}).toFile(outputFilePath)⏎····
    Open

        .then(() => image.resize({ width, height, position: 'centre' }).toFile(outputFilePath))
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace success with (success)
    Open

            .then(success => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace platform with (platform)
    Open

      gSelectedPlatforms.forEach(platform => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace ······ with ········
    Open

          },
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ··
    Open

          config: {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ⏎·····
    Open

        .then(() => Promise.resolve({
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace }) with ··})⏎····
    Open

        }));
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace platformDef with (platformDef)
    Open

          platformDef => configs.push(require(platformDef))
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ··
    Open

            type,
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace success with (success)
    Open

            .then(success => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace err with (err)
    Open

            .catch(err => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace ······ with ········
    Open

          },
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace err with (err)
    Open

            .catch(err => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace definition,·platformPath,·imageObj,·type,·platform with ⏎··definition,⏎··platformPath,⏎··imageObj,⏎··type,⏎··platform⏎
    Open

    const transformSplash = (definition, platformPath, imageObj, type, platform) => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ··
    Open

          config: {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace ········ with ··········
    Open

            type,
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Insert ··
    Open

            platform,
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    Replace config with (config)
    Open

      const filteredConfigs = configs.filter(config => {
    Severity: Minor
    Found in src/core/generator.js by eslint

    For more information visit Source: http://eslint.org/docs/rules/

    There are no issues that match your filters.

    Category
    Status