Use more requirements.json

jdalton · jdalton · commit 1a65149e8ea2 · 2025-08-19T17:16:52.000-07:00
diff --git a/requirements.json b/requirements.json
@@ -72,7 +72,7 @@
       "quota": 1,
       "permissions": ["full-scans:create"]
     },
-    "scan:delete": {
+    "scan:del": {
       "quota": 1,
       "permissions": ["full-scans:delete"]
     },
diff --git a/src/commands/audit-log/cmd-audit-log.mts b/src/commands/audit-log/cmd-audit-log.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW, SOCKET_WEBSITE_URL } = constants
 
-const CMD_NAME = 'audit-log'
+export const CMD_NAME = 'audit-log'
 
 const description = 'Look up the audit log for an organization'
 
diff --git a/src/commands/organization/cmd-organization-dependencies.mts b/src/commands/organization/cmd-organization-dependencies.mts
@@ -16,7 +16,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'dependencies'
+export const CMD_NAME = 'dependencies'
 
 const description =
   'Search for any dependency that is being used in your organization'
diff --git a/src/commands/organization/cmd-organization-policy-license.mts b/src/commands/organization/cmd-organization-policy-license.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'license'
+export const CMD_NAME = 'license'
 
 const description = 'Retrieve the license policy of an organization'
 
diff --git a/src/commands/repository/cmd-repository-create.mts b/src/commands/repository/cmd-repository-create.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'create'
+export const CMD_NAME = 'create'
 
 const description = 'Create a repository in an organization'
 
diff --git a/src/commands/repository/cmd-repository-del.mts b/src/commands/repository/cmd-repository-del.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'del'
+export const CMD_NAME = 'del'
 
 const description = 'Delete a repository in an organization'
 
diff --git a/src/commands/repository/cmd-repository-list.mts b/src/commands/repository/cmd-repository-list.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'list'
+export const CMD_NAME = 'list'
 
 const description = 'List repositories in an organization'
 
diff --git a/src/commands/repository/cmd-repository-update.mts b/src/commands/repository/cmd-repository-update.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'update'
+export const CMD_NAME = 'update'
 
 const description = 'Update a repository in an organization'
 
diff --git a/src/commands/repository/cmd-repository-view.mts b/src/commands/repository/cmd-repository-view.mts
@@ -17,7 +17,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const CMD_NAME = 'view'
+export const CMD_NAME = 'view'
 
 const description = 'View repositories in an organization'
 
diff --git a/src/commands/scan/cmd-scan-create.mts b/src/commands/scan/cmd-scan-create.mts
@@ -35,7 +35,7 @@ const {
   SOCKET_DEFAULT_REPOSITORY,
 } = constants
 
-const CMD_NAME = 'create'
+export const CMD_NAME = 'create'
 
 const description = 'Create a new Socket scan and report'
 
diff --git a/src/commands/scan/cmd-scan-del.mts b/src/commands/scan/cmd-scan-del.mts
@@ -7,39 +7,58 @@ import { checkCommandInput } from '../../utils/check-input.mts'
 import { determineOrgSlug } from '../../utils/determine-org-slug.mts'
 import { getOutputKind } from '../../utils/get-output-kind.mts'
 import { meowOrExit } from '../../utils/meow-with-subcommands.mts'
-import { getFlagListOutput } from '../../utils/output-formatting.mts'
+import {
+  getFlagApiRequirementsOutput,
+  getFlagListOutput,
+} from '../../utils/output-formatting.mts'
 import { hasDefaultToken } from '../../utils/sdk.mts'
 
 import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-const config: CliCommandConfig = {
-  commandName: 'del',
-  description: 'Delete a scan',
-  hidden: false,
-  flags: {
-    ...commonFlags,
-    ...outputFlags,
-    interactive: {
-      type: 'boolean',
-      default: true,
-      description:
-        'Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.',
-    },
-    org: {
-      type: 'string',
-      description:
-        'Force override the organization slug, overrides the default org from config',
+export const CMD_NAME = 'del'
+
+const description = 'Delete a scan'
+
+const hidden = false
+
+export const cmdScanDel = {
+  description,
+  hidden,
+  run,
+}
+
+async function run(
+  argv: string[] | readonly string[],
+  importMeta: ImportMeta,
+  { parentName }: { parentName: string },
+): Promise<void> {
+  const config: CliCommandConfig = {
+    commandName: CMD_NAME,
+    description,
+    hidden,
+    flags: {
+      ...commonFlags,
+      ...outputFlags,
+      interactive: {
+        type: 'boolean',
+        default: true,
+        description:
+          'Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.',
+      },
+      org: {
+        type: 'string',
+        description:
+          'Force override the organization slug, overrides the default org from config',
+      },
     },
-  },
-  help: (command, config) => `
+    help: (command, config) => `
     Usage
       $ ${command} [options] <SCAN_ID>
 
     API Token Requirements
-      - Quota: 1 unit
-      - Permissions: full-scans:delete
+      ${getFlagApiRequirementsOutput(`${parentName}:${CMD_NAME}`)}
 
     Options
       ${getFlagListOutput(config.flags)}
@@ -48,19 +67,8 @@ const config: CliCommandConfig = {
       $ ${command} 000aaaa1-0000-0a0a-00a0-00a0000000a0
       $ ${command} 000aaaa1-0000-0a0a-00a0-00a0000000a0 --json
   `,
-}
-
-export const cmdScanDel = {
-  description: config.description,
-  hidden: config.hidden,
-  run,
-}
+  }
 
-async function run(
-  argv: string[] | readonly string[],
-  importMeta: ImportMeta,
-  { parentName }: { parentName: string },
-): Promise<void> {
   const cli = meowOrExit({
     argv,
     config,
diff --git a/src/commands/scan/cmd-scan-diff.mts b/src/commands/scan/cmd-scan-diff.mts
@@ -7,56 +7,75 @@ import { checkCommandInput } from '../../utils/check-input.mts'
 import { determineOrgSlug } from '../../utils/determine-org-slug.mts'
 import { getOutputKind } from '../../utils/get-output-kind.mts'
 import { meowOrExit } from '../../utils/meow-with-subcommands.mts'
-import { getFlagListOutput } from '../../utils/output-formatting.mts'
+import {
+  getFlagApiRequirementsOutput,
+  getFlagListOutput,
+} from '../../utils/output-formatting.mts'
 import { hasDefaultToken } from '../../utils/sdk.mts'
 
 import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW, SOCKET_WEBSITE_URL } = constants
 
+export const CMD_NAME = 'diff'
+
 const SOCKET_SBOM_URL_PREFIX = `${SOCKET_WEBSITE_URL}/dashboard/org/SocketDev/sbom/`
 
 const { length: SOCKET_SBOM_URL_PREFIX_LENGTH } = SOCKET_SBOM_URL_PREFIX
 
-const config: CliCommandConfig = {
-  commandName: 'diff',
-  description: 'See what changed between two Scans',
-  hidden: false,
-  flags: {
-    ...commonFlags,
-    ...outputFlags,
-    depth: {
-      type: 'number',
-      default: 2,
-      description:
-        'Max depth of JSON to display before truncating, use zero for no limit (without --json/--file)',
-    },
-    file: {
-      type: 'string',
-      shortFlag: 'f',
-      default: '',
-      description:
-        'Path to a local file where the output should be saved. Use `-` to force stdout.',
-    },
-    interactive: {
-      type: 'boolean',
-      default: true,
-      description:
-        'Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.',
-    },
-    org: {
-      type: 'string',
-      description:
-        'Force override the organization slug, overrides the default org from config',
+const description = 'See what changed between two Scans'
+
+const hidden = false
+
+export const cmdScanDiff = {
+  description,
+  hidden,
+  run,
+}
+
+async function run(
+  argv: string[] | readonly string[],
+  importMeta: ImportMeta,
+  { parentName }: { parentName: string },
+): Promise<void> {
+  const config: CliCommandConfig = {
+    commandName: CMD_NAME,
+    description,
+    hidden,
+    flags: {
+      ...commonFlags,
+      ...outputFlags,
+      depth: {
+        type: 'number',
+        default: 2,
+        description:
+          'Max depth of JSON to display before truncating, use zero for no limit (without --json/--file)',
+      },
+      file: {
+        type: 'string',
+        shortFlag: 'f',
+        default: '',
+        description:
+          'Path to a local file where the output should be saved. Use `-` to force stdout.',
+      },
+      interactive: {
+        type: 'boolean',
+        default: true,
+        description:
+          'Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.',
+      },
+      org: {
+        type: 'string',
+        description:
+          'Force override the organization slug, overrides the default org from config',
+      },
     },
-  },
-  help: (command, config) => `
+    help: (command, config) => `
     Usage
       $ ${command} [options] <SCAN_ID1> <SCAN_ID2>
 
     API Token Requirements
-      - Quota: 1 unit
-      - Permissions: full-scans:list
+      ${getFlagApiRequirementsOutput(`${parentName}:${CMD_NAME}`)}
 
     This command displays the package changes between two scans. The full output
     can be pretty large depending on the size of your repo and time range. It is
@@ -73,19 +92,8 @@ const config: CliCommandConfig = {
       $ ${command} aaa0aa0a-aaaa-0000-0a0a-0000000a00a0 aaa1aa1a-aaaa-1111-1a1a-1111111a11a1
       $ ${command} aaa0aa0a-aaaa-0000-0a0a-0000000a00a0 aaa1aa1a-aaaa-1111-1a1a-1111111a11a1 --json
   `,
-}
-
-export const cmdScanDiff = {
-  description: config.description,
-  hidden: config.hidden,
-  run,
-}
+  }
 
-async function run(
-  argv: string[] | readonly string[],
-  importMeta: ImportMeta,
-  { parentName }: { parentName: string },
-): Promise<void> {
   const cli = meowOrExit({
     argv,
     config,
diff --git a/src/commands/scan/cmd-scan-github.mts b/src/commands/scan/cmd-scan-github.mts
diff --git a/src/commands/scan/cmd-scan-list.mts b/src/commands/scan/cmd-scan-list.mts
diff --git a/src/commands/scan/cmd-scan-metadata.mts b/src/commands/scan/cmd-scan-metadata.mts
diff --git a/src/commands/scan/cmd-scan-reach.mts b/src/commands/scan/cmd-scan-reach.mts
diff --git a/src/commands/scan/cmd-scan-report.mts b/src/commands/scan/cmd-scan-report.mts
diff --git a/src/commands/scan/cmd-scan-view.mts b/src/commands/scan/cmd-scan-view.mts
