Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.15 KB

no-title-property-in-meta.md

File metadata and controls

37 lines (24 loc) · 1.15 KB
Raw

Meta should not have a title property (no-title-property-in-meta)

Included in these configurations:

  • csf-strict
  • flat/csf-strict

Rule Details

Starting in CSF 3.0, story titles can be generated automatically. You can still specify a title like in CSF 2.0, but if you don't specify one, it can be inferred from the story's path on disk. This rule aims to enforce not setting a title, making the codebase consistent.

Examples of incorrect code for this rule:

export default {
  title: 'Components/Forms/Input',
  component: Input,
}

Examples of correct code for this rule:

export default {
  component: Input, // no title necessary, it will be inferred from path on disk!
}

When Not To Use It

If you're not strictly enforcing this rule in your codebase (thus allowing custom titles), you should turn this rule off.

Further Reading

You can find more information about CSF3 and story titles here: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#optional-titles