npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-docgen-typescript-cli

v2.0.0

Published

A CLI tool

Downloads

15

Readme

react-docgen-typescript-cli

A tiny CLI wrapper around react-docgen-typescript.

Installation

npm i react-docgen-typescript @types/react react-docgen-typescript-cli typescript --save-dev

# yarn
yarn add react-docgen-typescript @types/react react-docgen-typescript-cli typescript --dev

react-docgen-typescript, @types/react, and typescript are all peer dependencies of this package.

Usage

The main intended usage of this module is via CLI.

# See the help docs
npx react-docgen-typescript-cli --help

# Glob patterns are supported
# Write each file out to a directory with -d, or --out-dir
npx react-docgen-typescript-cli ./src/**/* -d ./out

# Filter extensions with -x
npx react-docgen-typescript-cli ./src/**/* -x tsx -d ./out

# Full globbing goodness is supported
npx react-docgen-typescript-cli ./src/**/*.{ts,tsx}

# Concat all doclets into a single file
npx react-docgen-typescript-cli ./src/**/* -o ./out/doclet/files.json

Any custom options that you want to pass to react-docgen-typescript can be done through options:

  React Docgen Typescript Options:
  --config                            Path to your tsconfig.json. By default the
                                      script will look in the current working
                                      directory to find the tsconfig    [string]
  --skip-props-without-doc            Skip props without doc
                                                      [boolean] [default: false]
  --skip-props-with-name              Skip the specified list of props without
                                      doc                                [array]
  --skip-components-with-name         Skip the components with the specified
                                      name                               [array]
  --extract-values-from-union         Convert unions to docgen enum format
                                                                       [boolean]
  --remove-undefined-from-optional    If set, types with optional will not
                                      display "| undefined" in the type[boolean]
  --extract-literal-values-from-enum  Convert enums and unions to docgen enum
                                      format          [boolean] [default: false]
  --save-value-as-string              Save default value props as strings
                                      regardless of type
                                                      [boolean] [default: false]