astoilkov/use-local-storage-state

View on GitHub
src/useLocalStorageState.ts

Summary

Maintainability
B
4 hrs
Test Coverage
A
100%

Function useLocalStorage has 86 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function useLocalStorage<T>(
    key: string,
    defaultValue: T | undefined,
    storageSync: boolean = true,
    parse: (value: string) => unknown = parseJSON,
Severity: Major
Found in src/useLocalStorageState.ts - About 3 hrs to fix

    Function useLocalStorage has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        key: string,
        defaultValue: T | undefined,
        storageSync: boolean = true,
        parse: (value: string) => unknown = parseJSON,
        stringify: (value: unknown) => string = JSON.stringify,
    Severity: Minor
    Found in src/useLocalStorageState.ts - About 35 mins to fix

      Function useLocalStorage has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      function useLocalStorage<T>(
          key: string,
          defaultValue: T | undefined,
          storageSync: boolean = true,
          parse: (value: string) => unknown = parseJSON,
      Severity: Minor
      Found in src/useLocalStorageState.ts - About 35 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

      There are no issues that match your filters.

      Category
      Status