npmpackage.info

react-docgen-typescript-webpack-plugin

Webpack loader to generate docgen information from Typescript React components.

1.1.0

361

NOASSERTION

TypeScript

10.86 kB

9,575,794 2.1

Installations

npm install react-docgen-typescript-webpack-plugin

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>= 8.9

Score

86.8

Supply Chain

99.4

Quality

74.9

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

5

Total

31

Closed

11

Merged

15

Issues

Open

50

Total

88

Closed

38

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 14 Contributors

Languages

TypeScript

JavaScript

TypeScript (99.26%)

JavaScript (0.74%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

strothj

Download Statistics

Total Downloads

9,575,794

Last Day

2,516

Last Week

11,466

Last Month

49,456

Last Year

593,351

GitHub Statistics

NOASSERTION License

361 Stars

162 Commits

46 Forks

6 Watchers

4 Branches

14 Contributors

Updated on Oct 30, 2024

Maintainers

Package Meta Information

Latest Version

1.1.0

Package Id

react-docgen-typescript-webpack-plugin@1.1.0

Unpacked Size

10.86 kB

Size

3.70 kB

File Count

Total Downloads

Cumulative downloads

Total Downloads

9,575,794

Last Day

4.5%

2,516

Compared to previous day

Last Week

-4.7%

11,466

Compared to previous week

Last Month

73%

49,456

Compared to previous month

Last Year

-15.2%

593,351

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

react-docgen-typescript-webpack-plugin

Webpack plugin to generate docgen information from Typescript React components.

Installation

Add the package as a development dependency.

1$ npm install --save-dev react-docgen-typescript-webpack-plugin
2
3or
4
5$ yarn add --dev react-docgen-typescript-webpack-plugin

Add the plugin to your Webpack configuration.

1const path = require("path");
2const genDefaultConfig = require("@storybook/react/dist/server/config/defaults/webpack.config.js");
3const TSDocgenPlugin = require("react-docgen-typescript-webpack-plugin");
4
5module.exports = (baseConfig, env) => {
6  const config = genDefaultConfig(baseConfig);
7
8  config.module.rules.push({
9    test: /\.tsx?$/,
10    include: path.resolve(__dirname, "../src"),
11    loader: require.resolve("ts-loader"),
12  });
13
14  config.plugins.push(new TSDocgenPlugin());
15
16  config.resolve.extensions.push(".ts", ".tsx");
17
18  return config;
19};

Usage

Storybook Info Plugin

Include the withInfo decorator as normal.

Special Note:

The Storybook Info addon will only attempt to read Docgen information when the story name matches the name of the component. So if you have a component named ColorButton, then you will have to use something like:

storiesOf("...", module).add("ColorButton", ...)

1import * as React from "react";
2import { storiesOf } from "@storybook/react";
3import { withInfo } from "@storybook/addon-info";
4import ColorButton from "./ColorButton";
5
6storiesOf("Components", module).add(
7  "ColorButton",
8  withInfo({ inline: true })(() => (
9    <ColorButton color="blue">Color Button</ColorButton>
10  )),
11);

Experimental

This plugin is mostly a hack job at the moment. It is a work in progress so it is most likely not suitable for production. Pull requests are most welcome.

Limitations

This plugin makes use of the great project: https://github.com/styleguidist/react-docgen-typescript

It is subject to the same limitations. Component docgen information can not be generated for components who are only exported as default. You can work around the issue by exporting the component using a named export.

CURRENT LIMITATION The current implementation seems to have trouble with the compiler option module being set to esnext.

1import * as React from "react";
2
3interface ColorButtonProps {
4  /** Buttons background color */
5  color: "blue" | "green";
6}
7
8/** A button with a configurable background color. */
9export const ColorButton: React.SFC<ColorButtonProps> = props => (
10  <button
11    style={{
12      padding: 40,
13      color: "#eee",
14      backgroundColor: props.color,
15      fontSize: "2rem",
16    }}
17  >
18    {props.children}
19  </button>
20);
21
22export default ColorButton;

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

130 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-ccrp-c664-8p4j
Warn: Project is vulnerable to: GHSA-4wx3-54gh-9fr9
Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264
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-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-c497-v8pv-ch6x
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-wvhm-4hhf-97x9
Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w
Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
Warn: Project is vulnerable to: GHSA-3949-f494-cm99
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-w5hq-hm5m-4548
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
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-46c4-8wrp-j99v
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

2.1

/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

Other packages similar to react-docgen-typescript-webpack-plugin

@storybook/react-docgen-typescript-plugin

1.0.1

A webpack plugin to inject react typescript docgen information.

react-docgen-typescript-plugin

1.0.8

A webpack plugin to inject react typescript docgen information.

emp-proptypes-docgen-plugin

0.0.35

A webpack plugin to inject react typescript docgen information in cweb.

@channel.io/react-docgen-typescript-plugin

1.0.0

A webpack plugin to inject react typescript docgen information.

react-docgen-typescript-webpack-plugin

Installations

Developer Guide

No

CommonJS

>= 8.9

Score

Pull Requests

5

31

11

15

Issues

50

88

38

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

Languages

Developer

strothj

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

9,575,794

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

react-docgen-typescript-webpack-plugin

Installation

Usage

Storybook Info Plugin

Experimental

Limitations

Contributing

License

10

9

3

0

0

0

0

0

0

0

2.1

/10

Other packages similar to react-docgen-typescript-webpack-plugin