Sign upLogin

fbredius/storybook

View on GitHub
Star
lib/store/src/storySort.ts

Summary

Maintainability
D
1 day
Test Coverage

Function storySort has a Cognitive Complexity of 57 (exceeds 5 allowed). Consider refactoring.
Open

  (options: StorySortObjectParameter = {}): StorySortComparatorV7 =>
  (a: StoryIndexEntry, b: StoryIndexEntry): number => {
    // If the two stories have the same story kind, then use the default
    // ordering, which is the order they are defined in the story file.
    // only when includeNames is falsy
Severity: Minor
Found in lib/store/src/storySort.ts - About 1 day 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 storySort has 55 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  (a: StoryIndexEntry, b: StoryIndexEntry): number => {
    // If the two stories have the same story kind, then use the default
    // ordering, which is the order they are defined in the story file.
    // only when includeNames is falsy
    if (a.title === b.title && !options.includeNames) {
Severity: Major
Found in lib/store/src/storySort.ts - About 2 hrs to fix

    Avoid deeply nested control flow statements.
    Open

                if (indexWildcard !== -1) {
              indexB = indexWildcard;
            } else {
              indexB = order.length;
            }
    Severity: Major
    Found in lib/store/src/storySort.ts - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                  if (indexWildcard !== -1) {
              indexA = indexWildcard;
            } else {
              indexA = order.length;
            }
      Severity: Major
      Found in lib/store/src/storySort.ts - About 45 mins to fix

        Avoid too many return statements within this function.
        Open

                  return 0;
        Severity: Major
        Found in lib/store/src/storySort.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return 0;
          Severity: Major
          Found in lib/store/src/storySort.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return nameA.localeCompare(nameB, options.locales ? options.locales : undefined, {
          numeric: true,
          sensitivity: 'accent',
        });
            Severity: Major
            Found in lib/store/src/storySort.ts - About 30 mins to fix

              Use a conditional expression instead of assigning to 'indexA' in multiple places.
              Open

                          if (indexWildcard !== -1) {
              Severity: Minor
              Found in lib/store/src/storySort.ts by tslint

              Rule: prefer-conditional-expression

              Recommends to use a conditional expression instead of assigning to the same thing in each branch of an if statement.

              Rationale

              This reduces duplication and can eliminate an unnecessary variable declaration.

              Config

              If check-else-if is specified, the rule also checks nested if-else-if statements.

              Examples
              "prefer-conditional-expression": true
              "prefer-conditional-expression": true,check-else-if
              Schema
              {
  "type": "string",
  "enum": [
    "check-else-if"
  ]
}

              For more information see this page.

              Use a conditional expression instead of assigning to 'indexB' in multiple places.
              Open

                          if (indexWildcard !== -1) {
              Severity: Minor
              Found in lib/store/src/storySort.ts by tslint

              Rule: prefer-conditional-expression

              Recommends to use a conditional expression instead of assigning to the same thing in each branch of an if statement.

              Rationale

              This reduces duplication and can eliminate an unnecessary variable declaration.

              Config

              If check-else-if is specified, the rule also checks nested if-else-if statements.

              Examples
              "prefer-conditional-expression": true
              "prefer-conditional-expression": true,check-else-if
              Schema
              {
  "type": "string",
  "enum": [
    "check-else-if"
  ]
}

              For more information see this page.

              There are no issues that match your filters.

              Category
              Status