Gathering detailed insights and metrics for @storybook/csf
Gathering detailed insights and metrics for @storybook/csf
Component Story Format is an open standard for UI component examples based on JavaScript ES6 modules.
Installations
npm install @storybook/csfScore
99.4
Supply Chain
90.9
Quality
99.6
Maintenance
100
Vulnerability
100
License
Developer
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
Yes
Node Version
14.21.3
NPM Version
6.14.18
Statistics
843 Stars
227 Commits
47 Forks
16 Watching
10 Branches
16 Contributors
Updated on 26 Nov 2024
Languages
TypeScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
1,473,197,382
Last day
-7.8%
2,003,408
Compared to previous day
Last week
1.3%
10,980,956
Compared to previous week
Last month
4%
47,043,469
Compared to previous month
Last year
8.8%
531,280,558
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
21
autojesttsupeslintlodashts-jestprettiertypescript@types/jest@types/nodecommon-tagsexpect-type@types/lodash@auto-it/releasedeslint-plugin-jest@ngard/tiny-isequaleslint-plugin-import@typescript-eslint/parser@typescript-eslint/eslint-plugineslint-import-resolver-typescript@storybook/eslint-config-storybook
Versions
Component Story Format (CSF)
Why a standard format?
Components have risen to dominate the UI landscape. There are new component-oriented tools for development, testing, design, and prototyping. These tools engage in the creation and consumption of components and component examples (a.k.a. stories). But each tool has its own proprietary format because a simple, platform-agnostic way to express component examples doesn't yet exist.
The "Story" is the source of truth for a component.
A story is a code snippet that renders an example of a component in a specific state. Think about it like a "user story".
It uses the production code shipped to users, making it the most accurate representation of a component example. What's more, stories are expressed in the view layer you use to build your app.
Component Story Format
The Component Story Format is an open standard for component examples based on JavaScript ES6 modules. This enables interoperation between development, testing, and design tools.
1export default { title: 'atoms/Button' }; 2export const text = () => <Button>Hello</Button>; 3export const emoji = () => <Button>😀😎👍💯</Button>;
💎 Simple. Writing component "stories" is as easy as exporting ES6 functions using a clean, widely-used format.
🚚 Non-proprietary. CSF doesn't require any vendor-specific libraries. Component stories are easily consumed anywhere ES6 modules live, including your favourite testing tools like Jest and Cypress.
☝️ Declarative. The declarative syntax is isomorphic to higher-level formats like MDX, enabling clean, verifiable transformations.
🔥 Optimized. Component stories don't need any libraries other than your components. And because they're ES6 modules, they're even tree-shakeable!
Who uses CSF?
Tools: Storybook, WebComponents.dev, Components.studio, RedwoodJS, UXPin
Compatible with: Jest, Enzyme, Testing Library, Cypress, Playwright, Mocha, etc.
CSF utilities
A minimal set of utility functions for dealing with Component Story Format (CSF).
Install
1yarn add @storybook/csf
API
See package source for function definitions and types:
-
storyNameFromExport(key)- Enhance export name (key) of the story. Implemented to have parity 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:
1yarn test
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 9/12 approved changesets -- score normalized to 7
Reason
7 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/ComponentDriven/csf/release.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ComponentDriven/csf/release.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/ComponentDriven/csf/release.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/ComponentDriven/csf/test.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/ComponentDriven/csf/test.yml/next?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
3.8
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More