Gathering detailed insights and metrics for chromatic
Gathering detailed insights and metrics for chromatic
Installations
npm install chromaticDeveloper
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
Yes
Node Version
18.20.5
NPM Version
10.8.2
Statistics
289 Stars
3,800 Commits
70 Forks
15 Watching
76 Branches
68 Contributors
Updated on 25 Nov 2024
Languages
TypeScript (95.05%)
JavaScript (2.96%)
HTML (1.99%)
Total Downloads
Cumulative downloads
Total Downloads
151,059,758
Last day
1.8%
446,059
Compared to previous day
Last week
2.7%
2,278,608
Compared to previous week
Last month
15.3%
9,618,117
Compared to previous month
Last year
77.5%
72,863,872
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
111
cpyesmzodautomeowtsupuuidviteboxenchalkdebugexecahuskyjson5listrreactslashdotenvenv-cieslintpkg-upsemvervitestfind-upglobalsmock-fsp-limitpromptsarchiverfake-tagfilesizefs-extrajsonfileno-proxynode-askprettier@antfu/niansi-htmlcross-envpicomatchpluralizereact-domstorybookts-dedentts-loadernode-fetchobservableprop-typesstrip-ansitypescript@sentry/cli@types/nodeasync-retrycross-spawnnpm-run-allstring-argvtmp-promisexxhash-wasmyarn-or-npm@sentry/node@types/listr@actions/core@types/semverclean-packageformdata-nodeos-browserify@auto-it/slack@types/promptsany-observableutil-deprecatezen-observable@actions/github@types/archiver@types/fs-extra@types/jsonfileprogress-streamread-package-up@storybook/react@tsconfig/node16@types/picomatchhttps-proxy-agentsort-package-jsontypescript-eslint@types/async-retry@types/cross-spawn@types/webpack-enveslint-plugin-json@vitest/coverage-v8eslint-plugin-jsdoceslint-plugin-reactwhy-is-node-running@storybook/csf-toolseslint-plugin-importjunit-report-builder@discoveryjs/json-exteslint-plugin-unicornlistr-update-renderer@types/progress-streameslint-config-prettiereslint-plugin-security@storybook/linter-configeslint-plugin-no-secrets@storybook/react-webpack5@typescript-eslint/parser@storybook/addon-essentialssnyk-nodejs-lockfile-parser@typescript-eslint/eslint-plugineslint-plugin-simple-import-sorteslint-plugin-sort-class-members@storybook/addon-webpack5-compiler-swc@eslint-community/eslint-plugin-eslint-comments
Versions
Chromatic CLI
Publishes your Storybook to Chromatic and kicks off tests if they're enabled.
Documentation
👉 Read the Chromatic CLI docs
📝 View the Changelog
System requirements
The Chromatic CLI (and GitHub Action) is built to run in a variety of environments. We provide support for the following platforms:
- Latest (LTS) versions of Ubuntu, Windows (Server), macOS
- Node.js Current, Active or Maintenance (LTS) versions, according to their release schedule
- Storybook 6.5+
Other platforms/versions may work, but are not officially supported. Certain features may not be available on certain platforms/versions, even if otherwise supported.
Contributing
Contributions of any kind are welcome! If you're a maintainer, refer to the following instructions to set up your development environment with Chromatic.
Compatibility & versioning
Compatibility is guaranteed between this package and Chromatic like so:
- Production Chromatic ensures it’s compatible with what’s on npm
- What's on the Git tag is equal to what's published on npm for that version
- This package ensures it’s compatible with production Chromatic
To facilitate upgrading in the future, removing and adding features, this is the process:
- Any new features will have to be on Chromatic production before they could be used in this package
- We can add feature flags to be able to test new functionality
- Chromatic production can not remove any features this package depends on until after the usage has been removed from this package in addition to a grace period to allow users to upgrade
No vulnerabilities found.
Reason
30 commit(s) and 15 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: SECURITY.md:1
Reason
Found 7/20 approved changesets -- score normalized to 3
Reason
8 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-7q7g-4xm8-89cq
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-4wx3-54gh-9fr9
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/pull-request-workflow.yml:21
- Info: found token with 'none' permissions: .github/workflows/check-labels.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/chromatic-main-and-prs.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/chromatic-prod.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/lint-and-test.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/package-size-main.yml:8
- Info: topLevel 'contents' permission set to 'read': .github/workflows/package-size.yml:12
- Info: topLevel 'contents' permission set to 'read': .github/workflows/pull-request-workflow.yml:14
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:25
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-action-next.yml:5
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-action.yml:9
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-node-api.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-node18.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-node20.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-npx.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-windows.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-yarn-berry.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-yarn-canary.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-yarn-classic.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke-test-yarn.yml:10
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-labels.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/check-labels.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/check-labels.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/check-labels.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic-main-and-prs.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-main-and-prs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic-main-and-prs.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-main-and-prs.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/chromatic-main-and-prs.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-main-and-prs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic-main-and-prs.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-main-and-prs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic-prod.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-prod.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic-prod.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-prod.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/chromatic-prod.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-prod.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic-prod.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/chromatic-prod.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-and-test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/lint-and-test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-and-test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/lint-and-test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package-size-main.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/package-size-main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package-size-main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/package-size-main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package-size.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/package-size.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package-size.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/package-size.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package-size.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/package-size.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-action-next.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-action-next.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-action-next.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-action-next.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/smoke-test-action-next.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-action-next.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-action.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-action.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-action.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-action.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-node-api.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-node-api.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-node-api.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-node-api.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-node18.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-node18.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-node18.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-node18.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-node20.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-node20.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-node20.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-node20.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-npx.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-npx.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-npx.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-npx.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-windows.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-windows.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-windows.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-windows.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn-berry.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn-berry.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn-berry.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn-berry.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn-canary.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn-canary.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn-canary.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn-canary.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn-classic.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn-classic.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn-classic.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn-classic.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/smoke-test-yarn.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/chromaui/chromatic-cli/smoke-test-yarn.yml/main?enable=pin
- Warn: downloadThenRun not pinned by hash: .github/workflows/lint-and-test.yml:38
- Info: 0 out of 37 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 downloadThenRun dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 18 are checked with a SAST tool
Score
4.9
/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