Skip to content

Commit a2a0139

Browse files
jdaltonjdalton
committed
Make descriptions update with command changes
1 parent 7beb847 commit a2a0139

39 files changed

+239
-248
lines changed

‎src/cli.mts

Lines changed: 10 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,7 @@ import updateNotifier from 'tiny-updater'
1111
import { debugDir, debugFn } from '@socketsecurity/registry/lib/debug'
1212
import { logger } from '@socketsecurity/registry/lib/logger'
1313

14-
import { cmdAnalytics } from './commands/analytics/cmd-analytics.mts'
15-
import { cmdAuditLog } from './commands/audit-log/cmd-audit-log.mts'
16-
import { cmdCI } from './commands/ci/cmd-ci.mts'
17-
import { cmdConfig } from './commands/config/cmd-config.mts'
18-
import { cmdFix } from './commands/fix/cmd-fix.mts'
19-
import { cmdInstall } from './commands/install/cmd-install.mts'
20-
import { cmdJson } from './commands/json/cmd-json.mts'
21-
import { cmdLogin } from './commands/login/cmd-login.mts'
22-
import { cmdLogout } from './commands/logout/cmd-logout.mts'
23-
import { cmdManifestCdxgen } from './commands/manifest/cmd-manifest-cdxgen.mts'
24-
import { cmdManifest } from './commands/manifest/cmd-manifest.mts'
25-
import { cmdNpm } from './commands/npm/cmd-npm.mts'
26-
import { cmdNpx } from './commands/npx/cmd-npx.mts'
27-
import { cmdOops } from './commands/oops/cmd-oops.mts'
28-
import { cmdOptimize } from './commands/optimize/cmd-optimize.mts'
29-
import { cmdOrganizationDependencies } from './commands/organization/cmd-organization-dependencies.mts'
30-
import { cmdOrganizationPolicyLicense } from './commands/organization/cmd-organization-policy-license.mts'
31-
import { cmdOrganizationPolicySecurity } from './commands/organization/cmd-organization-policy-security.mts'
32-
import { cmdOrganization } from './commands/organization/cmd-organization.mts'
33-
import { cmdPackage } from './commands/package/cmd-package.mts'
34-
import { cmdRawNpm } from './commands/raw-npm/cmd-raw-npm.mts'
35-
import { cmdRawNpx } from './commands/raw-npx/cmd-raw-npx.mts'
36-
import { cmdRepository } from './commands/repository/cmd-repository.mts'
37-
import { cmdScan } from './commands/scan/cmd-scan.mts'
38-
import { cmdThreatFeed } from './commands/threat-feed/cmd-threat-feed.mts'
39-
import { cmdUninstall } from './commands/uninstall/cmd-uninstall.mts'
40-
import { cmdWrapper } from './commands/wrapper/cmd-wrapper.mts'
14+
import { rootAliases, rootCommands } from './commands.mts'
4115
import constants from './constants.mts'
4216
import { AuthError, InputError, captureException } from './utils/errors.mts'
4317
import { failMsgWithBadge } from './utils/fail-msg-with-badge.mts'
@@ -59,131 +33,13 @@ void (async () => {
5933
})
6034

6135
try {
62-
await meowWithSubcommands(
63-
{
64-
analytics: cmdAnalytics,
65-
'audit-log': cmdAuditLog,
66-
ci: cmdCI,
67-
config: cmdConfig,
68-
fix: cmdFix,
69-
install: cmdInstall,
70-
json: cmdJson,
71-
login: cmdLogin,
72-
logout: cmdLogout,
73-
npm: cmdNpm,
74-
npx: cmdNpx,
75-
oops: cmdOops,
76-
optimize: cmdOptimize,
77-
organization: cmdOrganization,
78-
package: cmdPackage,
79-
manifest: cmdManifest,
80-
scan: cmdScan,
81-
'raw-npm': cmdRawNpm,
82-
'raw-npx': cmdRawNpx,
83-
repos: cmdRepository,
84-
'threat-feed': cmdThreatFeed,
85-
uninstall: cmdUninstall,
86-
wrapper: cmdWrapper,
87-
},
88-
{
89-
aliases: {
90-
audit: {
91-
description: cmdAuditLog.description,
92-
hidden: true,
93-
argv: ['audit-log'],
94-
},
95-
auditLog: {
96-
description: cmdAuditLog.description,
97-
hidden: true,
98-
argv: ['audit-log'],
99-
},
100-
auditLogs: {
101-
description: cmdAuditLog.description,
102-
hidden: true,
103-
argv: ['audit-log'],
104-
},
105-
['audit-logs']: {
106-
description: cmdAuditLog.description,
107-
hidden: true,
108-
argv: ['audit-log'],
109-
},
110-
cdxgen: {
111-
description: cmdManifestCdxgen.description,
112-
hidden: true,
113-
argv: ['manifest', 'cdxgen'],
114-
},
115-
deps: {
116-
description: cmdOrganizationDependencies.description,
117-
hidden: true,
118-
argv: ['dependencies'],
119-
},
120-
feed: {
121-
description: cmdThreatFeed.description,
122-
hidden: true,
123-
argv: ['threat-feed'],
124-
},
125-
license: {
126-
description: cmdOrganizationPolicyLicense.description,
127-
hidden: true,
128-
argv: ['organization', 'policy', 'license'],
129-
},
130-
org: {
131-
description: cmdOrganization.description,
132-
hidden: true,
133-
argv: ['organization'],
134-
},
135-
orgs: {
136-
description: cmdOrganization.description,
137-
hidden: true,
138-
argv: ['organization'],
139-
},
140-
organizations: {
141-
description: cmdOrganization.description,
142-
hidden: true,
143-
argv: ['organization'],
144-
},
145-
organisation: {
146-
description: cmdOrganization.description,
147-
hidden: true,
148-
argv: ['organization'],
149-
},
150-
organisations: {
151-
description: cmdOrganization.description,
152-
hidden: true,
153-
argv: ['organization'],
154-
},
155-
pkg: {
156-
description: cmdPackage.description,
157-
hidden: true,
158-
argv: ['package'],
159-
},
160-
repo: {
161-
description: cmdRepository.description,
162-
hidden: true,
163-
argv: ['repos'],
164-
},
165-
repository: {
166-
description: cmdRepository.description,
167-
hidden: true,
168-
argv: ['repos'],
169-
},
170-
repositories: {
171-
description: cmdRepository.description,
172-
hidden: true,
173-
argv: ['repos'],
174-
},
175-
security: {
176-
description: cmdOrganizationPolicySecurity.description,
177-
hidden: true,
178-
argv: ['organization', 'policy', 'security'],
179-
},
180-
},
181-
argv: process.argv.slice(2),
182-
// Lazily access constants.SOCKET_CLI_BIN_NAME.
183-
name: constants.SOCKET_CLI_BIN_NAME,
184-
importMeta: { url: `${pathToFileURL(__filename)}` } as ImportMeta,
185-
},
186-
)
36+
await meowWithSubcommands(rootCommands, {
37+
aliases: rootAliases,
38+
argv: process.argv.slice(2),
39+
// Lazily access constants.SOCKET_CLI_BIN_NAME.
40+
name: constants.SOCKET_CLI_BIN_NAME,
41+
importMeta: { url: `${pathToFileURL(__filename)}` } as ImportMeta,
42+
})
18743
} catch (e) {
18844
process.exitCode = 1
18945
debugFn('error', 'Uncaught error (BAD!):')
@@ -228,7 +84,8 @@ void (async () => {
22884
}),
22985
)
23086
} else {
231-
logger.error('\n') // Any-spinner-newline
87+
// Bump below any spinner.
88+
logger.error('\n')
23289
logger.fail(failMsgWithBadge(errorTitle, errorMessage))
23390
if (errorBody) {
23491
debugDir('inspect', { errorBody })

‎src/commands.mts

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
#!/usr/bin/env node
2+
3+
import { cmdAnalytics } from './commands/analytics/cmd-analytics.mts'
4+
import { cmdAuditLog } from './commands/audit-log/cmd-audit-log.mts'
5+
import { cmdCI } from './commands/ci/cmd-ci.mts'
6+
import { cmdConfig } from './commands/config/cmd-config.mts'
7+
import { cmdFix } from './commands/fix/cmd-fix.mts'
8+
import { cmdInstall } from './commands/install/cmd-install.mts'
9+
import { cmdJson } from './commands/json/cmd-json.mts'
10+
import { cmdLogin } from './commands/login/cmd-login.mts'
11+
import { cmdLogout } from './commands/logout/cmd-logout.mts'
12+
import { cmdManifestCdxgen } from './commands/manifest/cmd-manifest-cdxgen.mts'
13+
import { cmdManifest } from './commands/manifest/cmd-manifest.mts'
14+
import { cmdNpm } from './commands/npm/cmd-npm.mts'
15+
import { cmdNpx } from './commands/npx/cmd-npx.mts'
16+
import { cmdOops } from './commands/oops/cmd-oops.mts'
17+
import { cmdOptimize } from './commands/optimize/cmd-optimize.mts'
18+
import { cmdOrganizationDependencies } from './commands/organization/cmd-organization-dependencies.mts'
19+
import { cmdOrganizationPolicyLicense } from './commands/organization/cmd-organization-policy-license.mts'
20+
import { cmdOrganizationPolicySecurity } from './commands/organization/cmd-organization-policy-security.mts'
21+
import { cmdOrganization } from './commands/organization/cmd-organization.mts'
22+
import { cmdPackage } from './commands/package/cmd-package.mts'
23+
import { cmdRawNpm } from './commands/raw-npm/cmd-raw-npm.mts'
24+
import { cmdRawNpx } from './commands/raw-npx/cmd-raw-npx.mts'
25+
import { cmdRepository } from './commands/repository/cmd-repository.mts'
26+
import { cmdScan } from './commands/scan/cmd-scan.mts'
27+
import { cmdThreatFeed } from './commands/threat-feed/cmd-threat-feed.mts'
28+
import { cmdUninstall } from './commands/uninstall/cmd-uninstall.mts'
29+
import { cmdWrapper } from './commands/wrapper/cmd-wrapper.mts'
30+
31+
export const rootCommands = {
32+
analytics: cmdAnalytics,
33+
'audit-log': cmdAuditLog,
34+
ci: cmdCI,
35+
cdxgen: cmdManifestCdxgen,
36+
config: cmdConfig,
37+
deps: cmdOrganizationDependencies,
38+
fix: cmdFix,
39+
install: cmdInstall,
40+
json: cmdJson,
41+
license: cmdOrganizationPolicyLicense,
42+
login: cmdLogin,
43+
logout: cmdLogout,
44+
manifest: cmdManifest,
45+
npm: cmdNpm,
46+
npx: cmdNpx,
47+
oops: cmdOops,
48+
optimize: cmdOptimize,
49+
organization: cmdOrganization,
50+
package: cmdPackage,
51+
'raw-npm': cmdRawNpm,
52+
'raw-npx': cmdRawNpx,
53+
repository: cmdRepository,
54+
scan: cmdScan,
55+
security: cmdOrganizationPolicySecurity,
56+
'threat-feed': cmdThreatFeed,
57+
uninstall: cmdUninstall,
58+
wrapper: cmdWrapper,
59+
}
60+
61+
export const rootAliases = {
62+
audit: {
63+
description: cmdAuditLog.description,
64+
hidden: true,
65+
argv: ['audit-log'],
66+
},
67+
auditLog: {
68+
description: cmdAuditLog.description,
69+
hidden: true,
70+
argv: ['audit-log'],
71+
},
72+
auditLogs: {
73+
description: cmdAuditLog.description,
74+
hidden: true,
75+
argv: ['audit-log'],
76+
},
77+
['audit-logs']: {
78+
description: cmdAuditLog.description,
79+
hidden: true,
80+
argv: ['audit-log'],
81+
},
82+
feed: {
83+
description: cmdThreatFeed.description,
84+
hidden: true,
85+
argv: ['threat-feed'],
86+
},
87+
org: {
88+
description: cmdOrganization.description,
89+
hidden: true,
90+
argv: ['organization'],
91+
},
92+
orgs: {
93+
description: cmdOrganization.description,
94+
hidden: true,
95+
argv: ['organization'],
96+
},
97+
organizations: {
98+
description: cmdOrganization.description,
99+
hidden: true,
100+
argv: ['organization'],
101+
},
102+
organisation: {
103+
description: cmdOrganization.description,
104+
hidden: true,
105+
argv: ['organization'],
106+
},
107+
organisations: {
108+
description: cmdOrganization.description,
109+
hidden: true,
110+
argv: ['organization'],
111+
},
112+
pkg: {
113+
description: cmdPackage.description,
114+
hidden: true,
115+
argv: ['package'],
116+
},
117+
repo: {
118+
description: cmdRepository.description,
119+
hidden: true,
120+
argv: ['repos'],
121+
},
122+
repos: {
123+
description: cmdRepository.description,
124+
hidden: true,
125+
argv: ['repos'],
126+
},
127+
repositories: {
128+
description: cmdRepository.description,
129+
hidden: true,
130+
argv: ['repos'],
131+
},
132+
}

‎src/commands/analytics/cmd-analytics.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const { DRY_RUN_BAILING_NOW } = constants
1515

1616
const config: CliCommandConfig = {
1717
commandName: 'analytics',
18-
description: `Look up analytics data`,
18+
description: 'Look up analytics data',
1919
hidden: false,
2020
flags: {
2121
...commonFlags,

‎src/commands/ci/cmd-ci.mts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ const { DRY_RUN_BAILING_NOW } = constants
1212

1313
const config: CliCommandConfig = {
1414
commandName: 'ci',
15-
description:
16-
'Create a new scan and report whether it passes your security policy',
17-
hidden: true,
15+
description: 'Shorthand for `socket scan create --report --no-interactive`',
16+
hidden: false,
1817
flags: {
1918
...commonFlags,
2019
autoManifest: {

‎src/commands/ci/cmd-ci.test.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ describe('socket ci', async () => {
1414
const { code, stderr, stdout } = await invokeNpm(binCliPath, cmd)
1515
expect(stdout).toMatchInlineSnapshot(
1616
`
17-
"Create a new scan and report whether it passes your security policy
17+
"Shorthand for \`socket scan create --report --no-interactive\`
1818
1919
Usage
2020
$ socket ci [options]

0 commit comments

Comments
 (0)