@storybook/react-docgen-typescript-plugin

v1.0.1

A webpack plugin to inject react typescript docgen information. For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
Security review needed
popularity
Influential project
maintenance
Sustainable
community
Limited

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
1.0.1	\|	07/2021		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

Influential project

Weekly Downloads (1,425,927)

GitHub Stars: 68
Forks: 28
Contributors: 9

Direct Usage Popularity

The npm package @storybook/react-docgen-typescript-plugin receives a total of 1,425,927 downloads a week. As such, we scored @storybook/react-docgen-typescript-plugin popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package @storybook/react-docgen-typescript-plugin, we found that it has been starred 68 times.

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

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 9
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @storybook/react-docgen-typescript-plugin is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 15
Open PR: 4
Last Release: 3 years ago
Last Commit: 5 months ago

Further analysis of the maintenance status of @storybook/react-docgen-typescript-plugin based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for @storybook/react-docgen-typescript-plugin is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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: not defined

Age: 3 years
Dependencies: 7 Direct
Versions: 22
Install Size: 67.4 kB
Dist-tags: 3
# of Files: 26
Maintainers: 11
TS Typings: No

@storybook/react-docgen-typescript-plugin 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

@storybook/react-docgen-typescript-plugin

A webpack plugin to inject react typescript docgen information

Install

npm install --save-dev @storybook/react-docgen-typescript-plugin
# or
yarn add -D @storybook/react-docgen-typescript-plugin

Usage

> NOTE: The TypeScript compiler options allowSyntheticDefaultImports and esModuleInterop will make > react-docgen-typescript-plugin a lot harder! Turn them off for faster build times.

const ts = require("typescript");
const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin")
  .default;

module.exports = {
  plugins: [
    // Will default to loading your root tsconfig.json
    new ReactDocgenTypescriptPlugin(),
    // or with a specific tsconfig
    new ReactDocgenTypescriptPlugin({ tsconfigPath: "./tsconfig.dev.json" }),
    // or with compiler options
    new ReactDocgenTypescriptPlugin({
      compilerOptions: { jsx: ts.JsxEmit.Preserve },
    }),
  ],
};

Options

This plugins support all parser options from react-docgen-typescript and all of the following options

Option	Type	Description	Default
tsconfigPath	string	Specify the location of the `tsconfig.json` to use.	`null`
compilerOptions	object	Specify compiler options. Cannot be used with `tsconfigPath`	`null`
docgenCollectionName	string or null	Specify the docgen collection name to use. All docgen information will be collected into this global object. Set to `null` to disable.	`STORYBOOK_REACT_CLASSES`
setDisplayName	boolean	Set the components' display name. If you want to set display names yourself or are using another plugin to do this, you should disable this option.	`true`
typePropName	string	Specify the name of the property for docgen info prop type.	`type`
exclude	glob[]	Glob patterns to ignore and not generate docgen information for. (Great for ignoring large icon libraries)	`[]`
include	glob[]	Glob patterns to generate docgen information for	`['/.tsx']`

Debugging

If you want to see how this plugins is including and excluding modules set the DEBUG environment variable.

DEBUG=docgen:* - All logs
DEBUG=docgen:include - Included modules
DEBUG=docgen:exclude - Excluded modules
DEBUG=docgen:docs - Generated docs

DEBUG=docgen:* npm run storybook

> Another great way of debugging your generated docs is to use a debugger statement in your component source file. > If you turn off source maps you will be able to see the code that this package generates.

Prior Art

sn-client - Inspired by this custom webpack plugin
react-docgen-typescript-loader - Webpack loader to generate docgen information from Typescript React components.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Andrew Lisowski}
💻 🎨 📖 🤔 🚧 🚇 ⚠️

_{Michael Shilman}
💻

_{Kyle Herock}
💻

_{Juho Vepsäläinen}
🚇 ⚠️ 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

@storybook/react-docgen-typescript-plugin dependencies

debug endent find-cache-dir flat-cache micromatch react-docgen-typescript tslib

FAQs

What is @storybook/react-docgen-typescript-plugin?

A webpack plugin to inject react typescript docgen information. Visit Snyk Advisor to see a full health score report for @storybook/react-docgen-typescript-plugin, including popularity, security, maintenance & community analysis.

Is @storybook/react-docgen-typescript-plugin popular?

The npm package @storybook/react-docgen-typescript-plugin receives a total of 1,425,927 weekly downloads. As such, @storybook/react-docgen-typescript-plugin popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @storybook/react-docgen-typescript-plugin well maintained?

We found indications that @storybook/react-docgen-typescript-plugin maintenance is sustainable demonstrating some project activity. We saw a total of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @storybook/react-docgen-typescript-plugin safe to use?

While scanning the latest version of @storybook/react-docgen-typescript-plugin, 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 9 November-2024, at 14:12 (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

@storybook/react-docgen-typescript-plugin

A webpack plugin to inject react typescript docgen information. For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (1,425,927)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

@storybook/react-docgen-typescript-plugin

Install

Usage

Options

Debugging

Prior Art

Contributors ✨

@storybook/react-docgen-typescript-plugin dependencies

@storybook/react-docgen-typescript-plugin development dependencies

FAQs

What is @storybook/react-docgen-typescript-plugin?

Is @storybook/react-docgen-typescript-plugin popular?

Is @storybook/react-docgen-typescript-plugin well maintained?

Is @storybook/react-docgen-typescript-plugin safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,425,927)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@storybook/react-docgen-typescript-plugin

Install

Usage

Options

Debugging

Prior Art

Contributors ✨

@storybook/react-docgen-typescript-plugin dependencies

@storybook/react-docgen-typescript-plugin development dependencies

FAQs

What is @storybook/react-docgen-typescript-plugin?

Is @storybook/react-docgen-typescript-plugin popular?

Is @storybook/react-docgen-typescript-plugin well maintained?

Is @storybook/react-docgen-typescript-plugin safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues