Gathering detailed insights and metrics for @storybook/react-docgen-typescript-plugin
A webpack plugin to inject react typescript docgen information
Installations
npm install @storybook/react-docgen-typescript-pluginDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Score
86.9
Supply Chain
68.8
Quality
80.8
Maintenance
100
Vulnerability
97.9
License
Releases
25
Contributors
9
Unable to fetch Contributors
Languages
2
TypeScript
JavaScript
TypeScript (98%)
JavaScript (2%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
hipstersmoothie
Download Statistics
Total Downloads
493,028,305
Last Day
670,421
Last Week
2,913,654
Last Month
14,086,305
Last Year
159,045,535
GitHub Statistics
MIT License
69 Stars
227 Commits
28 Forks
4 Watchers
6 Branches
9 Contributors
Updated on Nov 21, 2024
Maintainers
17
Package Meta Information
Latest Version
1.0.1
Package Id
@storybook/react-docgen-typescript-plugin@1.0.1
Size
16.36 kB
Published on
Jul 30, 2021
Total Downloads
Cumulative downloads
Total Downloads
493,028,305
Last Day
0.1%
670,421
Compared to previous day
Last Week
-16%
2,913,654
Compared to previous week
Last Month
53.7%
14,086,305
Compared to previous month
Last Year
0.3%
159,045,535
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
31
@types/debug@types/find-cache-dir@types/flat-cache@types/jest@types/micromatch@types/node@types/react@typescript-eslint/eslint-plugin@typescript-eslint/parserautoauto-config-hipstersmoothieeslinteslint-config-airbnb-baseeslint-config-prettiereslint-config-xoeslint-plugin-importeslint-plugin-jesteslint-plugin-jsdoceslint-plugin-jsx-a11yeslint-plugin-prettierjestmemfsmemory-fsprettierreactts-jestts-loadertypescriptwebpackwebpack-cliyarn-add-no-save
react-docgen-typescript-plugin
A webpack plugin to inject react typescript docgen information
Install
1npm install --save-dev react-docgen-typescript-plugin 2# or 3yarn add -D react-docgen-typescript-plugin
Usage
NOTE: The TypeScript compiler options
allowSyntheticDefaultImportsandesModuleInteropwill makereact-docgen-typescript-plugina lot harder! Turn them off for faster build times.
1const ts = require('typescript'); 2const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin").default; 3 4module.exports = { 5 plugins: [ 6 // Will default to loading your root tsconfig.json 7 new ReactDocgenTypescriptPlugin(), 8 // or with a specific tsconfig 9 new ReactDocgenTypescriptPlugin({ tsconfigPath: "./tsconfig.dev.json" }), 10 // or with compiler options 11 new ReactDocgenTypescriptPlugin({ compilerOptions: { jsx: ts.JsxEmit.Preserve } }), 12 ], 13};
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 logsDEBUG=docgen:include- Included modulesDEBUG=docgen:exclude- Excluded modulesDEBUG=docgen:docs- Generated docs
1DEBUG=docgen:* npm run storybook
Another great way of debugging your generated docs is to use a
debuggerstatement 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!
No vulnerabilities found.
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
Found 5/21 approved changesets -- score normalized to 2
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/push.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/push.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/hipstersmoothie/react-docgen-typescript-plugin/push.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/hipstersmoothie/react-docgen-typescript-plugin/push.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/hipstersmoothie/react-docgen-typescript-plugin/push.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/hipstersmoothie/react-docgen-typescript-plugin/push.yml/master?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
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
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Reason
22 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-67mm-m3wx-j7fr
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
2.7
/10
Last Scanned on 2025-02-10
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