Skip to content

Commit bf898ea

Browse files
author
Pelle Wessman
committed
Improve examples in --help
1 parent 9666748 commit bf898ea

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

lib/commands/report/create.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ async function setupCommand (name, description, argv, importMeta) {
7878
$ ${name} .
7979
$ ${name} ../package-lock.json
8080
$ ${name} /path/to/a/package.json /path/to/another/package.json
81+
$ ${name} . --view --json
8182
`, {
8283
argv,
8384
description,

lib/commands/report/view.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ export const view = {
3636
* @returns {void|{ outputJson: boolean, outputMarkdown: boolean, reportId: string }}
3737
*/
3838
function setupCommand (name, description, argv, importMeta) {
39-
// FIXME: Add examples
4039
const cli = meow(`
4140
Usage
4241
$ ${name} <report-identifier>
@@ -46,6 +45,9 @@ function setupCommand (name, description, argv, importMeta) {
4645
'--json': 'Output result as json',
4746
'--markdown': 'Output result as markdown',
4847
}, 6)}
48+
49+
Examples
50+
$ ${name} QXU8PmK7LfH608RAwfIKdbcHgwEd_ZeWJ9QEGv05FJUQ
4951
`, {
5052
argv,
5153
description,

0 commit comments

Comments
 (0)