Sign upLogin

fbredius/storybook

View on GitHub
Star
lib/cli/src/initiate.ts

Summary

Maintainability
D
2 days
Test Coverage

Function installStorybook has 166 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const installStorybook = (projectType: ProjectType, options: CommandOptions): Promise<void> => {
  const packageManager = JsPackageManagerFactory.getPackageManager(options.useNpm);

  const npmOptions: NpmOptions = {
    installAsDevDependencies: true,
Severity: Major
Found in lib/cli/src/initiate.ts - About 6 hrs to fix

    Function runGenerator has 138 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      const runGenerator: () => Promise<void> = () => {
    switch (projectType) {
      case ProjectType.ALREADY_HAS_STORYBOOK:
        logger.log();
        paddedLog('There seems to be a Storybook already available in this project.');
    Severity: Major
    Found in lib/cli/src/initiate.ts - About 5 hrs to fix

      File initiate.ts has 282 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      import { UpdateNotifier, Package } from 'update-notifier';
import chalk from 'chalk';
import prompts from 'prompts';
import { detect, isStorybookInstalled, detectLanguage } from './detect';
import { installableProjectTypes, ProjectType, Builder, CoreBuilder } from './project_types';
      Severity: Minor
      Found in lib/cli/src/initiate.ts - About 2 hrs to fix

        Function initiate has 42 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        export async function initiate(options: CommandOptions, pkg: Package): Promise<void> {
  const welcomeMessage = 'sb init - the simplest way to add a Storybook to your project.';
  logger.log(chalk.inverse(`\n ${welcomeMessage} \n`));

  // Update notify code.
        Severity: Minor
        Found in lib/cli/src/initiate.ts - About 1 hr to fix

          Function initiate has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

          export async function initiate(options: CommandOptions, pkg: Package): Promise<void> {
  const welcomeMessage = 'sb init - the simplest way to add a Storybook to your project.';
  logger.log(chalk.inverse(`\n ${welcomeMessage} \n`));

  // Update notify code.
          Severity: Minor
          Found in lib/cli/src/initiate.ts - About 1 hr 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 installStorybook has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

          const installStorybook = (projectType: ProjectType, options: CommandOptions): Promise<void> => {
  const packageManager = JsPackageManagerFactory.getPackageManager(options.useNpm);

  const npmOptions: NpmOptions = {
    installAsDevDependencies: true,
          Severity: Minor
          Found in lib/cli/src/initiate.ts - About 45 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

                      codeLog(["export {default} from './storybook';"]);
          Severity: Minor
          Found in lib/cli/src/initiate.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