react-docgen-typescript

v2.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) For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Influential project
maintenance
Sustainable
community
Sustainable

Security

No known security issues

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
2.2.2	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.1	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.22.0	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.15	\|	06/2017		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 (4,716,851)

GitHub Stars: 1.19K
Forks: 252
Contributors: 80

Direct Usage Popularity

The npm package react-docgen-typescript receives a total of 4,716,851 downloads a week. As such, we scored react-docgen-typescript popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package react-docgen-typescript, we found that it has been starred 1,191 times.

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

Community

Sustainable

Readme.md: No
Contributing.md: No
Code of Conduct: No
Contributors: 80
Funding: No

With more than 10 contributors for the react-docgen-typescript repository, this is possibly a sign for a growing and inviting community.

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

How about a good first contribution to this project? It seems that react-docgen-typescript is missing a README file.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

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

Further analysis of the maintenance status of react-docgen-typescript 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 react-docgen-typescript 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.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: 9 years
Dependencies: 0 Direct
Versions: 78
Install Size: 242 kB
Dist-tags: 2
# of Files: 51
Maintainers: 1
TS Typings: Yes

react-docgen-typescript 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.

Not sure how to use react-docgen-typescript?

To help you get started, we've collected the most common ways that react-docgen-typescript is being used within popular public projects.

mui-org / material-ui-pickers / docs / scripts / docgen.js View on Github

const fs = require('fs');
const path = require('path');

const removeExternalDeps = propItem =>
  propItem.description && (!propItem.parent || !propItem.parent.fileName.includes('@types'));

const removeWrapperProps = (propItem, Component) => {
  return (
    Component.name === 'ModalWrapper' ||
    (propItem.parent && propItem.parent.name !== 'ModalWrapperProps')
  );
};

const parser = require('react-docgen-typescript').withCustomConfig(
  path.resolve(__dirname, '..', '..', 'lib', 'tsconfig.json'),
  {
    // @ts-ignore
    propFilter: (...args) => removeExternalDeps(...args) && removeWrapperProps(...args),
  }
);

const doc = {};
const srcPath = path.resolve(__dirname, '..', '..', 'lib', 'src');

const components = [
  'wrappers/ModalWrapper.tsx',
  'DatePicker/DatePicker.tsx',
  'DatePicker/KeyboardDatePicker.tsx',
  'TimePicker/TimePicker.tsx',
  'DateTimePicker/DateTimePicker.tsx',

View more ways to use react-docgen-typescript

react-docgen-typescript development dependencies

chai husky mocha react eslint lodash install prettier prop-types typescript @types/chai @types/node lint-staged @types/mocha @types/react @types/lodash @types/prop-types source-map-support @types/source-map-support

FAQs

What is react-docgen-typescript?

[![Build Status](https://github.com/styleguidist/react-docgen-typescript/actions/workflows/nodejs.yml/badge.svg)](https... Visit Snyk Advisor to see a full health score report for react-docgen-typescript, including popularity, security, maintenance & community analysis.

Is react-docgen-typescript popular?

The npm package react-docgen-typescript receives a total of 4,716,851 weekly downloads. As such, react-docgen-typescript popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-docgen-typescript well maintained?

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

Is react-docgen-typescript safe to use?

The npm package react-docgen-typescript was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 19:45 (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