Sign upLogin

fbredius/storybook

View on GitHub
Star
lib/addons/src/hooks.ts

Summary

Maintainability
D
1 day
Test Coverage

File hooks.ts has 367 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import global from 'global';
import { logger } from '@storybook/client-logger';
import {
  AnyFramework,
  DecoratorFunction,
Severity: Minor
Found in lib/addons/src/hooks.ts - About 4 hrs to fix

    Function useHook has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

    function useHook(name: string, callback: (hook: Hook) => void, deps?: any[] | undefined): Hook {
  const hooks = getHooksContextOrThrow();
  if (hooks.currentPhase === 'MOUNT') {
    if (deps != null && !Array.isArray(deps)) {
      logger.warn(
    Severity: Minor
    Found in lib/addons/src/hooks.ts - About 2 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 useHook has 41 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function useHook(name: string, callback: (hook: Hook) => void, deps?: any[] | undefined): Hook {
  const hooks = getHooksContextOrThrow();
  if (hooks.currentPhase === 'MOUNT') {
    if (deps != null && !Array.isArray(deps)) {
      logger.warn(
    Severity: Minor
    Found in lib/addons/src/hooks.ts - About 1 hr to fix

      Function hookify has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function hookify<TFramework extends AnyFramework>(fn: AbstractFunction) {
  return (...args: any[]) => {
    const { hooks }: { hooks: HooksContext<TFramework> } =
      typeof args[0] === 'function' ? args[1] : args[0];
      Severity: Minor
      Found in lib/addons/src/hooks.ts - About 1 hr to fix

        Function applyHooks has 26 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          (storyFn: LegacyStoryFn<TFramework>, decorators: DecoratorFunction<TFramework>[]) => {
    const decorated = applyDecorators(
      hookify(storyFn),
      decorators.map((decorator) => hookify(decorator))
    );
        Severity: Minor
        Found in lib/addons/src/hooks.ts - About 1 hr to fix

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

            useEffect(() => {
    Object.entries(eventMap).forEach(([type, listener]) => channel.on(type, listener));
    return () => {
      Object.entries(eventMap).forEach(([type, listener]) =>
        channel.removeListener(type, listener)
          Severity: Major
          Found in lib/addons/src/hooks.ts and 1 other location - About 2 hrs to fix
          lib/api/src/index.tsx on lines 347..352

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

          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

          Unnecessary semicolon
          Open

            };
          Severity: Minor
          Found in lib/addons/src/hooks.ts by tslint

          Rule: semicolon

          Enforces consistent semicolon usage at the end of every statement.

          Notes
          • Has Fix

          Config

          One of the following arguments must be provided:

          • "always" enforces semicolons at the end of every statement.
          • "never" disallows semicolons at the end of every statement except for when they are necessary.

          The following arguments may be optionally provided:

          • "ignore-interfaces" skips checking semicolons at the end of interface members.
          • "ignore-bound-class-methods" skips checking semicolons at the end of bound class methods.
          • "strict-bound-class-methods" disables any special handling of bound class methods and treats them as any other assignment. This option overrides "ignore-bound-class-methods".
          Examples
          "semicolon": true,always
          "semicolon": true,never
          "semicolon": true,always,ignore-interfaces
          "semicolon": true,always,ignore-bound-class-methods
          Schema
          {
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "always",
        "never"
      ]
    },
    {
      "type": "string",
      "enum": [
        "ignore-interfaces"
      ]
    }
  ],
  "additionalItems": false
}

          For more information see this page.

          Interface has only a call signature — use type Listener = (...args: any[]) => void; instead.
          Open

            (...args: any[]): void;
          Severity: Minor
          Found in lib/addons/src/hooks.ts by tslint

          Rule: callable-types

          An interface or literal type with just a call signature can be written as a function type.

          Rationale

          style

          Notes
          • TypeScript Only
          • Has Fix

          Config

          Not configurable.

          For more information see this page.

          There are no issues that match your filters.

          Category
          Status