Sign upLogin

fbredius/storybook

View on GitHub
Star
lib/core-server/src/utils/release-notes.ts

Summary

Maintainability
A
1 hr
Test Coverage

Function getReleaseNotesData has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const getReleaseNotesData = async (
  currentVersionToParse: string,
  fileSystemCache: any
): Promise<ReleaseNotesData> => {
  let result;
Severity: Minor
Found in lib/core-server/src/utils/release-notes.ts - About 1 hr to fix

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

    export const getReleaseNotesData = async (
  currentVersionToParse: string,
  fileSystemCache: any
): Promise<ReleaseNotesData> => {
  let result;
    Severity: Minor
    Found in lib/core-server/src/utils/release-notes.ts - 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

    block is empty
    Open

        const fromCache = (await fileSystemCache.get('releaseNotesData', []).catch(() => {})) || [];
    Severity: Minor
    Found in lib/core-server/src/utils/release-notes.ts by tslint

    Rule: no-empty

    Disallows empty blocks.

    Blocks with a comment inside are not considered empty.

    Rationale

    Empty blocks are often indicators of missing code.

    Config

    If allow-empty-catch is specified, then catch blocks are allowed to be empty. If allow-empty-functions is specified, then function definitions are allowed to be empty.

    Examples
    "no-empty": true
    "no-empty": true,allow-empty-catch
    "no-empty": true,allow-empty-functions
    "no-empty": true,allow-empty-catch,allow-empty-functions
    Schema
    {
  "type": "array",
  "items": {
    "anyOf": [
      {
        "type": "string",
        "enum": [
          "allow-empty-catch"
        ]
      },
      {
        "type": "string",
        "enum": [
          "allow-empty-functions"
        ]
      }
    ]
  }
}

    For more information see this page.

    There are no issues that match your filters.

    Category
    Status