Sign upLogin

fbredius/storybook

View on GitHub
Star
addons/docs/src/frameworks/angular/compodoc.ts

Summary

Maintainability
B
6 hrs
Test Coverage

Function extractArgTypesFromData has 62 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const extractArgTypesFromData = (componentData: Class | Directive | Injectable | Pipe) => {
  const sectionToItems: Record<string, ArgType[]> = {};
  const compodocClasses = ['component', 'directive'].includes(componentData.type)
    ? ['propertiesClass', 'methodsClass', 'inputsClass', 'outputsClass']
    : ['properties', 'methods'];
Severity: Major
Found in addons/docs/src/frameworks/angular/compodoc.ts - About 2 hrs to fix

    File compodoc.ts has 262 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    /* eslint-disable no-underscore-dangle */
/* global window */

import { ArgType, ArgTypes } from '@storybook/api';
import { logger } from '@storybook/client-logger';
    Severity: Minor
    Found in addons/docs/src/frameworks/angular/compodoc.ts - About 2 hrs to fix

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

      const castDefaultValue = (property: Property, defaultValue: any) => {
  const compodocType = property.type;

  // All these checks are necessary as compodoc does not always set the type ie. @HostBinding have empty types.
  // null and undefined also have 'any' type
      Severity: Minor
      Found in addons/docs/src/frameworks/angular/compodoc.ts - About 1 hr to fix

        Avoid too many return statements within this function.
        Open

          return 'properties';
        Severity: Major
        Found in addons/docs/src/frameworks/angular/compodoc.ts - About 30 mins to fix

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

          const castDefaultValue = (property: Property, defaultValue: any) => {
  const compodocType = property.type;

  // All these checks are necessary as compodoc does not always set the type ie. @HostBinding have empty types.
  // null and undefined also have 'any' type
          Severity: Minor
          Found in addons/docs/src/frameworks/angular/compodoc.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

          " should be '
          Open

                  throw new Error("Cannot be of type Method if key === 'propertiesClass'");
          Severity: Minor
          Found in addons/docs/src/frameworks/angular/compodoc.ts by tslint

          Rule: quotemark

          Enforces quote character for string literals.

          Notes
          • Has Fix

          Config

          Five arguments may be optionally provided:

          • "single" enforces single quotes.
          • "double" enforces double quotes.
          • "backtick" enforces backticks.
          • "jsx-single" enforces single quotes for JSX attributes.
          • "jsx-double" enforces double quotes for JSX attributes.
          • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
          • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
          Examples
          "quotemark": true,single,avoid-escape,avoid-template
          "quotemark": true,single,jsx-double
          Schema
          {
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

          For more information see this page.

          There are no issues that match your filters.

          Category
          Status