Skip to content

Commit a52ef66

Browse files
pvdzjdalton
andauthored
Polish the usage hints in help in some cases (#425)
Co-authored-by: John-David Dalton <jdalton@users.noreply.github.com>
1 parent 1ff9a26 commit a52ef66

File tree

10 files changed

+12
-25
lines changed

10 files changed

+12
-25
lines changed

src/commands/report/cmd-report-create.ts

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { logger } from '@socketsecurity/registry/lib/logger'
22

3-
import { commonFlags, outputFlags, validationFlags } from '../../flags'
3+
import { commonFlags, outputFlags } from '../../flags'
44
import { meowOrExit } from '../../utils/meow-with-subcommands'
55

66
import type { CliCommandConfig } from '../../utils/meow-with-subcommands'
@@ -11,19 +11,7 @@ const config: CliCommandConfig = {
1111
hidden: false,
1212
flags: {
1313
...commonFlags,
14-
...outputFlags,
15-
...validationFlags,
16-
dryRun: {
17-
type: 'boolean',
18-
default: false,
19-
description: 'Only output what will be done without actually doing it'
20-
},
21-
view: {
22-
type: 'boolean',
23-
shortFlag: 'v',
24-
default: false,
25-
description: 'Will wait for and return the created report'
26-
}
14+
...outputFlags
2715
},
2816
help: () => `
2917
This command is deprecated in favor of \`socket scan view\`.

src/commands/report/cmd-report-view.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { logger } from '@socketsecurity/registry/lib/logger'
22

3-
import { commonFlags, outputFlags, validationFlags } from '../../flags'
3+
import { commonFlags, outputFlags } from '../../flags'
44
import { meowOrExit } from '../../utils/meow-with-subcommands'
55

66
import type { CliCommandConfig } from '../../utils/meow-with-subcommands'
@@ -11,8 +11,7 @@ const config: CliCommandConfig = {
1111
hidden: false,
1212
flags: {
1313
...commonFlags,
14-
...outputFlags,
15-
...validationFlags
14+
...outputFlags
1615
},
1716
help: () => `
1817
This command is deprecated in favor of \`socket scan view\`.

src/commands/repos/cmd-repos-create.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ describe('socket repos create', async () => {
2121
"Create a repository in an organization
2222
2323
Usage
24-
$ socket repos create <org slug>
24+
$ socket repos create <org slug> --repo-name=<name>
2525
2626
API Token Requirements
2727
- Quota: 1 unit

src/commands/repos/cmd-repos-create.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ const config: CliCommandConfig = {
5252
},
5353
help: (command, config) => `
5454
Usage
55-
$ ${command} <org slug>
55+
$ ${command} <org slug> --repo-name=<name>
5656
5757
API Token Requirements
5858
- Quota: 1 unit

src/commands/repos/cmd-repos-update.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ describe('socket repos update', async () => {
2121
"Update a repository in an organization
2222
2323
Usage
24-
$ socket repos update <org slug>
24+
$ socket repos update <org slug> --repo-name=<name>
2525
2626
API Token Requirements
2727
- Quota: 1 unit

src/commands/repos/cmd-repos-update.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ const config: CliCommandConfig = {
5252
},
5353
help: (command, config) => `
5454
Usage
55-
$ ${command} <org slug>
55+
$ ${command} <org slug> --repo-name=<name>
5656
5757
API Token Requirements
5858
- Quota: 1 unit

src/commands/repos/cmd-repos-view.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ describe('socket repos view', async () => {
2121
"View repositories in an organization
2222
2323
Usage
24-
$ socket repos view <org slug>
24+
$ socket repos view <org slug> --repo-name=<name>
2525
2626
API Token Requirements
2727
- Quota: 1 unit

src/commands/repos/cmd-repos-view.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const config: CliCommandConfig = {
2828
},
2929
help: (command, config) => `
3030
Usage
31-
$ ${command} <org slug>
31+
$ ${command} <org slug> --repo-name=<name>
3232
3333
API Token Requirements
3434
- Quota: 1 unit

src/commands/scan/cmd-scan-metadata.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ describe('socket scan metadata', async () => {
2121
"Get a scan's metadata
2222
2323
Usage
24-
$ socket scan metadata <org slug> <scan id>
24+
$ socket scan metadata <org slug> <scan ID>
2525
2626
API Token Requirements
2727
- Quota: 1 unit

src/commands/scan/cmd-scan-metadata.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const config: CliCommandConfig = {
2626
},
2727
help: (command, config) => `
2828
Usage
29-
$ ${command} <org slug> <scan id>
29+
$ ${command} <org slug> <scan ID>
3030
3131
API Token Requirements
3232
- Quota: 1 unit

0 commit comments

Comments
 (0)