Skip to content

Commit cba59ee

Browse files
committed
feat(:boom:) renaming
1 parent 96b6154 commit cba59ee

File tree

3 files changed

+18
-14
lines changed

3 files changed

+18
-14
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# react-ts-docgen
1+
# react-docgen-typescript-cli
22

33
A 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

3838
Any custom options that you want to pass to `react-docgen-typescript` can be done through options:
File renamed without changes.

package.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
{
2-
"name": "react-ts-docgen",
2+
"name": "react-docgen-typescript-cli",
33
"version": "1.1.0",
44
"description": "A CLI tool",
55
"main": "src/index.js",
66
"scripts": {
77
"test": "jest",
88
"pretest:cli": "shx rm -rf test/actual",
9-
"test:cli": "node ./bin/react-ts-docgen.js --config test/tsconfig.json test/*.tsx -d test/actual && node test/assert.js",
9+
"test:cli": "node ./bin/react-docgen-typescript-cli.js --config test/tsconfig.json test/*.tsx -d test/actual && node test/assert.js",
1010
"lint": "eslint 'src/**/*' 'bin/**/*'",
1111
"version": "npm-run-all -p lint test"
1212
},
13-
"bin": "./bin/react-ts-docgen.js",
14-
"keywords": [],
13+
"bin": "./bin/react-docgen-typescript-cli.js",
14+
"keywords": [
15+
"react-docgen",
16+
"react-docgen-typescript",
17+
"cli"
18+
],
1519
"author": "Dennis Thompson",
1620
"license": "MIT",
1721
"devDependencies": {
@@ -37,15 +41,15 @@
3741
"chalk": "^4.1.0",
3842
"glob": "^7.1.6",
3943
"mkdirp": "^1.0.3",
40-
"yargs": "^15.1.0"
44+
"yargs": "^16.0.0"
4145
},
4246
"husky": {
4347
"hooks": {
4448
"pre-push": "npm test"
4549
}
4650
},
4751
"engines": {
48-
"node": ">=8.2.1"
52+
"node": ">=9.0.0"
4953
},
5054
"eslintConfig": {
5155
"env": {

0 commit comments

Comments
 (0)