fbredius/storybook

View on GitHub
lib/core-server/src/core-presets.test.ts

Summary

Maintainability
B
4 hrs
Test Coverage

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

const cleanRoots = (obj): any => {
  if (!obj) return obj;
  if (typeof obj === 'string')
    return obj.replace(ROOT, 'ROOT').replace(NODE_MODULES, 'NODE_MODULES');
  if (Array.isArray(obj)) return obj.map(cleanRoots);
Severity: Minor
Found in lib/core-server/src/core-presets.test.ts - 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

Avoid too many return statements within this function.
Open

    return Object.fromEntries(
      Object.entries(obj).map(([key, val]) => {
        if (key === 'version' && typeof val === 'string') {
          return [key, '*'];
        }
Severity: Major
Found in lib/core-server/src/core-presets.test.ts - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

      return obj;
    Severity: Major
    Found in lib/core-server/src/core-presets.test.ts - About 30 mins to fix

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

          expect(outputStats).toHaveBeenCalledWith(
            '/tmp/dir',
            expect.objectContaining({ toJson: expect.any(Function) }),
            expect.objectContaining({ toJson: expect.any(Function) })
          );
      Severity: Major
      Found in lib/core-server/src/core-presets.test.ts and 1 other location - About 1 hr to fix
      lib/core-server/src/core-presets.test.ts on lines 265..269

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

      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

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

          expect(outputStats).toHaveBeenCalledWith(
            '/tmp/dir',
            expect.objectContaining({ toJson: expect.any(Function) }),
            expect.objectContaining({ toJson: expect.any(Function) })
          );
      Severity: Major
      Found in lib/core-server/src/core-presets.test.ts and 1 other location - About 1 hr to fix
      lib/core-server/src/core-presets.test.ts on lines 207..211

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

      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

      " should be '
      Open

              "Won't copy root directory. Check your staticDirs!"

      Rule: quotemark

      Enforces quote character for string literals.

      Notes
      • Has Fix

      Config

      Five arguments may be optionally provided:

      • "single" enforces single quotes.
      • "double" enforces double quotes.
      • "backtick" enforces backticks.
      • "jsx-single" enforces single quotes for JSX attributes.
      • "jsx-double" enforces double quotes for JSX attributes.
      • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
      • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
      Examples
      "quotemark": true,single,avoid-escape,avoid-template
      "quotemark": true,single,jsx-double
      Schema
      {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "single",
            "double",
            "backtick",
            "jsx-single",
            "jsx-double",
            "avoid-escape",
            "avoid-template"
          ]
        },
        "minLength": 0,
        "maxLength": 5
      }

      For more information see this page.

      " should be '
      Open

          ['root directory /', '/', "Won't remove directory '/'. Check your outputDir!"],

      Rule: quotemark

      Enforces quote character for string literals.

      Notes
      • Has Fix

      Config

      Five arguments may be optionally provided:

      • "single" enforces single quotes.
      • "double" enforces double quotes.
      • "backtick" enforces backticks.
      • "jsx-single" enforces single quotes for JSX attributes.
      • "jsx-double" enforces double quotes for JSX attributes.
      • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
      • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
      Examples
      "quotemark": true,single,avoid-escape,avoid-template
      "quotemark": true,single,jsx-double
      Schema
      {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "single",
            "double",
            "backtick",
            "jsx-single",
            "jsx-double",
            "avoid-escape",
            "avoid-template"
          ]
        },
        "minLength": 0,
        "maxLength": 5
      }

      For more information see this page.

      " should be '
      Open

          ['empty string ""', '', "Won't remove current directory. Check your outputDir!"],

      Rule: quotemark

      Enforces quote character for string literals.

      Notes
      • Has Fix

      Config

      Five arguments may be optionally provided:

      • "single" enforces single quotes.
      • "double" enforces double quotes.
      • "backtick" enforces backticks.
      • "jsx-single" enforces single quotes for JSX attributes.
      • "jsx-double" enforces double quotes for JSX attributes.
      • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
      • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
      Examples
      "quotemark": true,single,avoid-escape,avoid-template
      "quotemark": true,single,jsx-double
      Schema
      {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "single",
            "double",
            "backtick",
            "jsx-single",
            "jsx-double",
            "avoid-escape",
            "avoid-template"
          ]
        },
        "minLength": 0,
        "maxLength": 5
      }

      For more information see this page.

      There are no issues that match your filters.

      Category
      Status