fbredius/storybook

View on GitHub
lib/preview-web/src/parseArgsParam.ts

Summary

Maintainability
D
3 days
Test Coverage

Function decoder has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

  decoder(
    str: string,
    defaultDecoder: (str: string, decoder?: any, charset?: string) => string,
    charset: string,
    type: 'key' | 'value'
Severity: Minor
Found in lib/preview-web/src/parseArgsParam.ts - About 3 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 validateArgs has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

const validateArgs = (key = '', value: unknown): boolean => {
  if (key === null) return false;
  if (key === '' || !VALIDATION_REGEXP.test(key)) return false;
  if (value === null || value === undefined) return true; // encoded as `!null` or `!undefined`
  if (value instanceof Date) return true; // encoded as modified ISO string
Severity: Minor
Found in lib/preview-web/src/parseArgsParam.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

  if (typeof value === 'number' || typeof value === 'boolean') return true;
Severity: Major
Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

      if (Array.isArray(value)) return value.every((v) => validateArgs(key, v));
    Severity: Major
    Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

        return false;
      Severity: Major
      Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                  return `${color[1]}(${color[2]}, ${color[3]}, ${color[4]}, ${color[5]})`;
        Severity: Major
        Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              if (type === 'value' && NUMBER_REGEXP.test(str)) return Number(str);
          Severity: Major
          Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

              if (isPlainObject(value)) return Object.entries(value).every(([k, v]) => validateArgs(k, v));
            Severity: Major
            Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                  return defaultDecoder(str, defaultDecoder, charset);
              Severity: Major
              Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                          return `${color[1]}(${color[2]}, ${color[3]}%, ${color[4]}%, ${color[5]})`;
                Severity: Major
                Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                          return str.startsWith('!rgb')
                            ? `${color[1]}(${color[2]}, ${color[3]}, ${color[4]})`
                            : `${color[1]}(${color[2]}, ${color[3]}%, ${color[4]}%)`;
                  Severity: Major
                  Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                        return (
                          VALIDATION_REGEXP.test(value) ||
                          NUMBER_REGEXP.test(value) ||
                          HEX_REGEXP.test(value) ||
                          COLOR_REGEXP.test(value)
                    Severity: Major
                    Found in lib/preview-web/src/parseArgsParam.ts - About 30 mins to fix

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

                      const validateArgs = (key = '', value: unknown): boolean => {
                        if (key === null) return false;
                        if (key === '' || !VALIDATION_REGEXP.test(key)) return false;
                        if (value === null || value === undefined) return true; // encoded as `!null` or `!undefined`
                        if (value instanceof Date) return true; // encoded as modified ISO string
                      Severity: Major
                      Found in lib/preview-web/src/parseArgsParam.ts and 1 other location - About 1 day to fix
                      lib/router/src/utils.ts on lines 70..87

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

                      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

                        return Object.entries(qs.parse(parts.join(';'), QS_OPTIONS)).reduce((acc, [key, value]) => {
                          if (validateArgs(key, value)) return Object.assign(acc, { [key]: value });
                          once.warn(dedent`
                            Omitted potentially unsafe URL args.
                      
                      
                      Severity: Major
                      Found in lib/preview-web/src/parseArgsParam.ts and 1 other location - About 1 hr to fix
                      lib/router/src/utils.ts on lines 118..126

                      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

                              if (str.startsWith('!rgba'))
                                return `${color[1]}(${color[2]}, ${color[3]}, ${color[4]}, ${color[5]})`;
                      Severity: Major
                      Found in lib/preview-web/src/parseArgsParam.ts and 1 other location - About 1 hr to fix
                      lib/preview-web/src/parseArgsParam.ts on lines 52..53

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

                      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 (str.startsWith('!hsla'))
                                return `${color[1]}(${color[2]}, ${color[3]}%, ${color[4]}%, ${color[5]})`;
                      Severity: Major
                      Found in lib/preview-web/src/parseArgsParam.ts and 1 other location - About 1 hr to fix
                      lib/preview-web/src/parseArgsParam.ts on lines 50..51

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

                      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

                      'Object.assign' returns the first argument. Prefer object spread if you want a new object.
                      Open

                          if (validateArgs(key, value)) return Object.assign(acc, { [key]: value });

                      Rule: prefer-object-spread

                      Enforces the use of the ES2018 object spread operator over Object.assign() where appropriate.

                      Rationale

                      Object spread allows for better type checking and inference.

                      Notes
                      • Has Fix

                      Config

                      Not configurable.

                      Examples
                      "prefer-object-spread": true

                      For more information see this page.

                      Type assertion on object literals is forbidden, use a type annotation instead.
                      Open

                        }, {} as Args);

                      Rule: no-object-literal-type-assertion

                      Forbids an object literal to appear in a type assertion expression. Casting to any or to unknown is still allowed.

                      Rationale

                      Always prefer const x: T = { ... }; to const x = { ... } as T;. The type assertion in the latter case is either unnecessary or hides an error. The compiler will warn for excess properties with this syntax, but not missing required fields. For example: const x: { foo: number } = {} will fail to compile, but const x = {} as { foo: number } will succeed. Additionally, the const assertion const x = { foo: 1 } as const, introduced in TypeScript 3.4, is considered beneficial and is ignored by this rule.

                      Notes
                      • TypeScript Only

                      Config

                      One option may be configured:

                      • allow-arguments allows type assertions to be used on object literals inside call expressions.
                      Examples
                      "no-object-literal-type-assertion": true
                      "no-object-literal-type-assertion": true,[object Object]
                      Schema
                      {
                        "type": "object",
                        "properties": {
                          "allow-arguments": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": false
                      }

                      For more information see this page.

                      There are no issues that match your filters.

                      Category
                      Status