1- # react-ts- docgen
1+ # react-docgen-typescript-cli
22
33A tiny CLI wrapper around [ react-docgen-typescript] ( https://github.com/styleguidist/react-docgen-typescript ) .
44
55## Installation
66
77``` bash
8- npm i react-docgen-typescript @types/react react-ts- docgen typescript --save-dev
8+ npm i react-docgen-typescript @types/react react-docgen-typescript-cli typescript --save-dev
99
1010# yarn
11- yarn add react-docgen-typescript @types/react react-ts- docgen typescript --dev
11+ yarn add react-docgen-typescript @types/react react-docgen-typescript-cli typescript --dev
1212```
1313
1414` react-docgen-typescript ` , ` @types/react ` , and ` typescript ` are all ** peer dependencies** of this package.
@@ -19,20 +19,20 @@ The main intended usage of this module is via CLI.
1919
2020``` bash
2121# See the help docs
22- npx react-ts- docgen --help
22+ npx react-docgen-typescript-cli --help
2323
2424# Glob patterns are supported
2525# Write each file out to a directory with -d, or --out-dir
26- npx react-ts- docgen ./src/** /* -d ./out
26+ npx react-docgen-typescript-cli ./src/** /* -d ./out
2727
2828# Filter extensions with -x
29- npx react-ts- docgen ./src/** /* -x tsx -d ./out
29+ npx react-docgen-typescript-cli ./src/** /* -x tsx -d ./out
3030
3131# Full globbing goodness is supported
32- npx react-ts- docgen ./src/** /* .{ts,tsx}
32+ npx react-docgen-typescript-cli ./src/** /* .{ts,tsx}
3333
3434# Concat all doclets into a single file
35- npx react-ts- docgen ./src/** /* -o ./out/doclet/files.json
35+ npx react-docgen-typescript-cli ./src/** /* -o ./out/doclet/files.json
3636```
3737
3838Any custom options that you want to pass to ` react-docgen-typescript ` can be done through options:
0 commit comments