Neutralize Pesky Miscreants

    @storybook/csf
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.1 • Public • Published

    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:

    • 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

    Install

    npm i @storybook/csf

    DownloadsWeekly Downloads

    5,890,679

    Version

    0.0.1

    License

    MIT

    Unpacked Size

    12.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • kylegach
    • tooppaaa
    • ndelangen
    • shilman
    • alexandrebodin
    • hypnosphi
    • danielduan
    • igor-dv
    • pksunkara
    • tmeasday
    • gongreg
    • domyen
    • usulpro
    • kylesuss
    • ghengeveld
    • pago
    • dandean
    • codebyalex
    • mrmckeb
    • dannyhw
    • winkervsbecks
    • rvasikarla
    • amalik2
    • lshadler
    • phated
    • yannbf
    • dylanpiercey
    • monkeyworks
    • darleendenno