storybookjs/storybook

[Bug]: Can not correctly split summary of descriptions

Open

#24,900 opened on Nov 19, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (10,058 forks)batch import
block: descriptionbughelp wantedsev:S3

Repository metrics

Stars
 (89,909 stars)
PR merge metrics
 (Avg merge 7d 22h) (184 merged PRs in 30d)

Description

Describe the bug

Can not correctly split summary of descriptions in table, when summary has special syntax.

To Reproduce

This case will working wrong.

const meta: Meta<typeof MyComp> = {
  title: 'MyComp',
  component: MyComp,
  args: {
  },
  argTypes: {
    offset: {
      description: 'description',
      type: { required: false, name: 'array', value: { name: 'number' } },
      table: {
        type: { summary: 'Array<number> | [number, number]' },
      },
      control: 'object',
    },
  },
};

Got: Array<number> | [number, number]

This case will working well.

const meta: Meta<typeof MyComp> = {
  title: 'MyComp',
  component: MyComp,
  args: {
  },
  argTypes: {
    offset: {
      description: 'description',
      type: { required: false, name: 'array', value: { name: 'number' } },
      table: {
        type: { summary: 'NumberArrary | NumberArrayLike' },
      },
      control: 'object',
    },
  },
};

Got: NumberArrary NumberArrayLike

System

System:
    OS: macOS 13.6.1
    CPU: (8) x64 Intel(R) Core(TM) i5-1038NG7 CPU @ 2.00GHz
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 16.20.2 - ~/.nvm/versions/node/v16.20.2/bin/node
    Yarn: 1.22.4 - /usr/local/bin/yarn
    npm: 8.19.4 - ~/.nvm/versions/node/v16.20.2/bin/npm <----- active
  Browsers:
    Chrome: 119.0.6045.159
    Safari: 16.6
  npmPackages:
    @storybook/addon-actions: ^7.5.3 => 7.5.3 
    @storybook/addon-essentials: ^7.5.3 => 7.5.3 
    @storybook/react: ^7.5.3 => 7.5.3 
    @storybook/react-vite: ^7.5.3 => 7.5.3 
    @storybook/storybook-deployer: ^2.8.16 => 2.8.16 
    eslint-plugin-storybook: ^0.6.15 => 0.6.15 
    storybook: ^7.5.3 => 7.5.3

Additional context

None

Contributor guide