Sign upLogin

webpack/webpack-cli

View on GitHub
Star
packages/create-webpack-app/src/utils/fileGenerator.ts

Summary

Maintainability
D
1 day
Test Coverage

Function checkAndPrepareContent has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
Open

async function checkAndPrepareContent(config: AddConfig, isTemplate: boolean): Promise<Result> {
  const fileExists = await doesFileExists(config.path);
  let existingFileContent: Content = "";
  let newContent: Content = "";
Severity: Minor
Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 4 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 checkAndPrepareContent has 95 lines of code (exceeds 25 allowed). Consider refactoring.
Open

async function checkAndPrepareContent(config: AddConfig, isTemplate: boolean): Promise<Result> {
  const fileExists = await doesFileExists(config.path);
  let existingFileContent: Content = "";
  let newContent: Content = "";
Severity: Major
Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 3 hrs to fix

    Function getDiff has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function getDiff(filePath: string, tempFilePath: string): Promise<void> {
  return new Promise((resolve, reject) => {
    const platform = process.platform;
    let editor = "";
    Severity: Minor
    Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 1 hr to fix

      Avoid too many return statements within this function.
      Open

                return { status: "overwrite", content: newContent };
      Severity: Major
      Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

              return { status: "identical", content: existingFileContent };
        Severity: Major
        Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return userChoice;
          Severity: Major
          Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return { status: "create", content: newContent };
            Severity: Major
            Found in packages/create-webpack-app/src/utils/fileGenerator.ts - About 30 mins to fix

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

                          const existingRow = `| ${"Existing File".padEnd(15)} | ${existingStats.size
              .toString()
              .padEnd(15)} | ${existingStats.mtime.toISOString().padEnd(25)} |`;
              Severity: Major
              Found in packages/create-webpack-app/src/utils/fileGenerator.ts and 1 other location - About 1 hr to fix
              packages/create-webpack-app/src/utils/fileGenerator.ts on lines 208..210

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

              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

                          const newRow = `| ${"New File".padEnd(15)} | ${newStats.size
              .toString()
              .padEnd(15)} | ${newStats.mtime.toISOString().padEnd(25)} |`;
              Severity: Major
              Found in packages/create-webpack-app/src/utils/fileGenerator.ts and 1 other location - About 1 hr to fix
              packages/create-webpack-app/src/utils/fileGenerator.ts on lines 205..207

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

              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