View react-styleguidist on Snyk Open Source Advisor

Package Health Score

66 / 100

security
Security review needed
popularity
Popular
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
13.1.3	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
13.0.0	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
12.0.1	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.2.0	\|	01/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.1.8	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (49,667)

GitHub Stars: 10.85K
Forks: 1.44K
Contributors: -

Direct Usage Popularity

The npm package react-styleguidist receives a total of 49,667 downloads a week. As such, we scored react-styleguidist popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package react-styleguidist, we found that it has been starred 10,849 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 0
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 100
Open PR: 140
Last Release: 6 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of react-styleguidist based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that react-styleguidist demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14

Age: 9 years
Dependencies: 64 Direct
Versions: 324
Install Size: 420 kB
Dist-tags: 2
# of Files: 475
Maintainers: 2
TS Typings: No

react-styleguidist has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Isolated React component development environment with a living style guide

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component propTypes and shows live, editable usage examples based on Markdown files. Check out the demo style guide.

React Styleguidist in action

Usage

Getting Started: install and run Styleguidist
Documenting components: how to write documentation
Locating components: point Styleguidist to your React components
Configuring webpack: tell Styleguidist how to load your code
Cookbook: how to solve common tasks with Styleguidist

Advanced documentation

Examples

Basic style guide, source
Style guide with sections, source
Style guide with customized styles, source
Style guide with custom express endpoints, source
Create React App integration, source

Showcase

Real projects using React Styleguidist:

Integration with other tools

Create React App — supported out of the box, see the Getting Started guide
Vue, see Vue Styleguidist

Third-party tools

snapguidist: snapshot testing for React Styleguidist
react-styleguidist-visual: automated visual testing for React Styleguidist, using Puppeteer and pixelmatch
styleguidist-scrapper: scrapper script for documentation generated by React Styleguidist

Resources

The Dream of Styleguide Driven Development talk by Sara Vieira
Building React Components Library talk by Robert Haritonov
Say Cheese: Snapshots and Visual Testing
Interview with Artem Sapegin about React Styleguidist.

Change log

The change log can be found on the Releases page.

Contributing

Everyone is welcome to contribute. Please take a moment to read the contributing guidelines and the developer guide.

Sponsoring

Become a sponsor and get your logo on our Readme on GitHub with a link to your site.

Become a backer get your image on our Readme on GitHub with a link to your site.

Authors and license

Artem Sapegin and contributors.

Logo by Sara Vieira and Andrey Okonetchnikov.

MIT License, see the included License.md file.

react-styleguidist dependencies

react-styleguidist development dependencies

@babel/cli @babel/core @babel/plugin-proposal-class-properties @babel/preset-env @babel/preset-flow @babel/preset-react @babel/preset-typescript @testing-library/jest-dom @testing-library/react @types/buble @types/copy-webpack-plugin @types/doctrine @types/escodegen @types/estree @types/hash-sum @types/jest @types/keymirror @types/lodash @types/markdown-to-jsx @types/node @types/prismjs @types/react @types/react-dom @types/terser-webpack-plugin @types/type-detect @types/webpack @types/webpack-dev-server @types/webpack-env @typescript-eslint/eslint-plugin @typescript-eslint/parser babel-core babel-eslint babel-jest babel-loader css-loader danger deabsdeep deepfreeze dog-names eslint eslint-config-tamia eslint-import-resolver-typescript eslint-plugin-compat eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react file-loader fs-extra husky jest keymirror lint-staged memfs prettier raf react react-dom react-test-renderer strip-shebang style-loader typescript url-loader webpack webpack-cli

FAQs

What is react-styleguidist?

React components style guide generator. Visit Snyk Advisor to see a full health score report for react-styleguidist, including popularity, security, maintenance & community analysis.

Is react-styleguidist popular?

The npm package react-styleguidist receives a total of 49,667 weekly downloads. As such, react-styleguidist popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-styleguidist well maintained?

We found indications that react-styleguidist maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is react-styleguidist safe to use?

While scanning the latest version of react-styleguidist, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 10 December-2024, at 11:30 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP