Gathering detailed insights and metrics for babel-plugin-react-docgen-typescript
Gathering detailed insights and metrics for babel-plugin-react-docgen-typescript
Babel Plugin to generate docgen data from React components written in TypeScript.
Installations
npm install babel-plugin-react-docgen-typescriptDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
11.12.0
NPM Version
6.7.0
Releases
Unable to fetch releases
Languages
2
TypeScript
JavaScript
TypeScript (89.73%)
JavaScript (10.27%)
Developer
strothj
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
12 Stars
39 Commits
4 Forks
1 Watchers
12 Branches
4 Contributors
Updated on Mar 30, 2023
Maintainers
2
Package Meta Information
Latest Version
1.5.1
Package Id
babel-plugin-react-docgen-typescript@1.5.1
Unpacked Size
10.21 kB
Size
2.99 kB
File Count
4
NPM Version
6.7.0
Node Version
11.12.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Dev Dependencies
24
@babel/core@babel/preset-env@babel/preset-react@babel/preset-typescript@types/babel-core@types/jest@types/node@types/reactbabel-corebabel-jestcross-envjestpre-commitprettierreactrolluprollup-plugin-babelrollup-plugin-node-resolvetslinttslint-config-airbnbtslint-config-prettiertslint-language-servicetslint-plugin-prettiertypescript
babel-plugin-react-docgen-typescript
babel-plugin-react-docgen-typescript is a Babel Plugin to generate docgen data from React components written in TypeScript.
Installation
Requirements
- @babel/core
$ npm install --save-dev babel-plugin-react-docgen-typescript
Usage
Via .bablerc
1{ 2 "plugins": [ 3 [ 4 "babel-plugin-react-docgen-typescript", 5 { 6 "docgenCollectionName": "STORYBOOK_REACT_CLASSES", 7 "include": "components.*\\.tsx$", 8 "exclude": "stories\\.tsx$" 9 } 10 ] 11 ] 12}
Performance
This plugin calls out to a parser from react-docgen-typescript for all files ending in .tsx$. This is very inefficient. This plugin is a bit of a hack.
To speed things up a bit, it is recommended to include the plugin settings include and exclude to restrict parsing to your component directories.
Settings
| Setting | Required | Type | Description | Example |
|---|---|---|---|---|
| skipPropsWithName | false | string[] or string | This option is passed along to react-docgen-typescript's parser. It globally ignores props with the specified name(s). | "classname" or ["classname", "color"] |
| skipPropsWithoutDoc | false | boolean | This option is passed along to react-docgen-typescript's parser. It globally ignores props without documentation. | true |
| shouldExtractLiteralValuesFromEnum | false | boolean | This option is passed along to react-docgen-typescript's parser. It convert string enums and unions to docgen enum format. Possible values are still accessible. | true |
| shouldExtractValuesFromUnion | false | boolean | This option is passed along to react-docgen-typescript's parser. It convert multiple types to docgen enum format. Possible values are still accessible. | true |
| docgenCollectionName | false | string | Enables collecting docgen data into a global object. This is used to integrate with tools like Storybook. | "STORYBOOK_REACT_CLASSES" |
| include | false | string | A regular expression of files to pass along to react-docgen-typescript's parser. Defaults to \.tsx$. | "components.*\\.tsx$" |
| exclude | false | string | A regular expression to filter the results from include. For instance, you can add a regular expression to prevent files ending in .stories.tsx from being processed in your component directories. | "stories\\.tsx$" |
License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
Found 3/21 approved changesets -- score normalized to 1
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
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
license file not detected
Details
- Warn: project does not have a license file
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 13 are checked with a SAST tool
Reason
61 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
- Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
- Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
- Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
- Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
- Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
- Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-6394-6h9h-cfjg
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
- Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
- Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
- Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
- Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
- Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.4
/10
Last Scanned on 2025-07-07
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