wKich / csf

➕ Storybook Component Story Format (CSF)

Storybook Component Story Format (CSF)

A minimal set of utility functions for dealing with Storybook Component Story Format (CSF).

Install

yarn add @storybook/csf

API

See package source for function definitions and types:

• storyNameFromExport(key) - Enhance export name (key) of the story. Currently implemented with startCase.

• isExportStory(key, { includeStories, excludeStories }) - Does a named export match CSF inclusion/exclusion options?

• parseKind(kind, { rootSeparator, groupSeparator }) - Parse out the component/kind name from a path, using the given separator config.

• sanitize(string) - Remove punctuation and illegal characters from a story ID.

• toId(kind, name) - Generate a storybook ID from a component/kind and story name.

Contributing

If you have any suggestions, please open an issue or a PR.

All contributions are welcome!

run tests:

yarn test