Skip to content

Commit 36ac63f

Browse files
committed
Use snake-case for CLI arguments
1 parent f2e3146 commit 36ac63f

File tree

3 files changed

+20
-21
lines changed

3 files changed

+20
-21
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -74,24 +74,23 @@ Clean and actionable reports are achieved when non-production code such as tests
7474

7575
```
7676
❯ npx exportman
77-
exportman --config ./config.js[on] [options]
77+
exportman [options]
7878
7979
Options:
80-
--config [file] Path of configuration file (JS or JSON),
81-
requires `entryFiles: []` and `filePatterns: []`
82-
--cwd Working directory (default: current working directory)
83-
--only Report only listed issue group(s): files, exports, types, members, duplicates
84-
--maxIssues Maximum number of unused files until non-zero exit code (default: 1)
85-
--exclude Exclude issue group(s) from report: files, exports, types, members, duplicates
86-
--noProgress Don't show dynamic progress updates
87-
--reporter Select reporter: symbols, compact (default: symbols)
88-
--jsdoc Enable JSDoc parsing, with options: public (default: disabled)
80+
-c/--config [file] Configuration file path (default: ./exportman.json or package.json#exportman)
81+
--cwd Working directory (default: current working directory)
82+
--max-issues Maximum number of unreferenced files until non-zero exit code (default: 1)
83+
--only Report only listed issue group(s): files, exports, types, members, duplicates
84+
--exclude Exclude issue group(s) from report: files, exports, types, members, duplicates
85+
--no-progress Don't show dynamic progress updates
86+
--reporter Select reporter: symbols, compact (default: symbols)
87+
--jsdoc Enable JSDoc parsing, with options: public (default: disabled)
8988
9089
Examples:
9190
92-
$ exportman --config ./exportman.json
93-
$ exportman --config ./exportman.json --cwd packages/client --reporter compact --jsdoc public
94-
$ exportman --config ./exportman.js --only files,duplicates
91+
$ exportman
92+
$ exportman --cwd packages/client --only files
93+
$ exportman -c ./exportman.js --reporter compact --jsdoc public
9594
9695
More info: https://github.com/webpro/exportman
9796
```

src/cli.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ const {
1515
config = 'exportman.json',
1616
only = [],
1717
exclude = [],
18-
noProgress = false,
18+
'no-progress': noProgress = false,
1919
reporter = 'symbols',
2020
jsdoc = [],
21-
maxIssues = '1',
21+
'max-issues': maxIssues = '1',
2222
},
2323
} = parseArgs({
2424
options: {
@@ -27,10 +27,10 @@ const {
2727
config: { type: 'string', short: 'c' },
2828
only: { type: 'string', multiple: true },
2929
exclude: { type: 'string', multiple: true },
30-
noProgress: { type: 'boolean' },
30+
'no-progress': { type: 'boolean' },
3131
reporter: { type: 'string' },
3232
jsdoc: { type: 'string', multiple: true },
33-
maxIssues: { type: 'string' },
33+
'max-issues': { type: 'string' },
3434
},
3535
});
3636

src/help.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ export const printHelp = () => {
44
Options:
55
-c/--config [file] Configuration file path (default: ./exportman.json or package.json#exportman)
66
--cwd Working directory (default: current working directory)
7-
--maxIssues Maximum number of unreferenced files until non-zero exit code (default: 1)
8-
--only Report only listed issue group(s): files, exports, types, members, duplicates
9-
--exclude Exclude issue group(s) from report: files, exports, types, members, duplicates
10-
--noProgress Don't show dynamic progress updates
7+
--max-issues Maximum number of unreferenced files until non-zero exit code (default: 1)
8+
--only Report only listed issue group(s): files, exports, types, nsExports, nsTypes, duplicates
9+
--exclude Exclude issue group(s) from report: files, exports, types, nsExports, nsTypes, duplicates
10+
--no-progress Don't show dynamic progress updates
1111
--reporter Select reporter: symbols, compact (default: symbols)
1212
--jsdoc Enable JSDoc parsing, with options: public (default: disabled)
1313

0 commit comments

Comments
 (0)