npmpackage.info

Gathering detailed insights and metrics for react-docgen-typescript-plugin

Other packages similar to react-docgen-typescript-plugin

@storybook/react-docgen-typescript-plugin

1.0.1

A webpack plugin to inject react typescript docgen information.

react-docgen-typescript

2.2.2

[![Build Status](https://github.com/styleguidist/react-docgen-typescript/actions/workflows/nodejs.yml/badge.svg)](https://github.com/styleguidist/react-docgen-typescript/actions/workflows/nodejs.yml)

storybook-addon-react-docgen

1.2.44

A storybook addon to display react docgen info.

babel-plugin-react-docgen

4.2.1

Babel plugin to add react-docgen info into your code

Gathering detailed insights and metrics for react-docgen-typescript-plugin

react-docgen-typescript-plugin

A webpack plugin to inject react typescript docgen information

1.0.8

MIT

TypeScript

124,513,009 2.7

Installations

npm install react-docgen-typescript-plugin

Pull Requests

Open

4

Total

67

Closed

35

Merged

28

Issues

Open

15

Total

29

Closed

14

Releases

v1.0.8

Published on 19 Jun 2024

v1.0.7

Published on 19 Jun 2024

v1.0.6

Published on 26 Mar 2024

v1.0.5

Published on 05 Feb 2023

v1.0.4

Published on 03 Feb 2023

v1.0.3

Published on 03 Feb 2023

View all 25 releases

Developer

hipstersmoothie

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

20.14.0

NPM Version

10.7.0 Statistics

69 Stars

227 Commits

28 Forks

4 Watching

6 Branches

9 Contributors

Updated on 21 Nov 2024

Languages

TypeScript (98%)

JavaScript (2%)

Total Downloads

Cumulative downloads

Total Downloads

124,513,009

Last day

9.4%

76,221

Compared to previous day

Last week

16.5%

387,310

Compared to previous week

Last month

36.7%

1,480,619

Compared to previous month

Last year

-8.7%

15,738,597

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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 allowSyntheticDefaultImports and esModuleInterop will make react-docgen-typescript-plugin a 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 logs
DEBUG=docgen:include - Included modules
DEBUG=docgen:exclude - Excluded modules
DEBUG=docgen:docs - Generated docs

1DEBUG=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} 🚇 ⚠️ 💻 📖	_{Egor Pogadaev} ⚠️ 💻	_{Anton Savoskin} 💻	_{Trevor Burnham} ⚠️ 💻
_{Maxime Meriouma-Caron} 🚇 ⚠️ 💻	_{Adam Skoufis} 💻	_{Nicholas Narsing} 📖 ⚠️ 💻

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

2

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

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

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

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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.

Score

2.7

/10

Last Scanned on 2024-11-18

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-plugin

Other packages similar to react-docgen-typescript-plugin

react-docgen-typescript-plugin

Installations

Pull Requests

4

67

35

28

Issues

15

29

14

Releases

Developer

hipstersmoothie

Developer Guide

CommonJS

Yes

20.14.0

10.7.0

Statistics

Languages

Total Downloads

124,513,009

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

react-docgen-typescript-plugin

Install

Usage

Options

Debugging

Prior Art

Contributors ✨

10

10

10

2

0

0

0

0

0

0

0

0

0

2.7

/10