Simplify command imports to help maintainability

Author: pvdz

src/cli.ts

@@ -7,26 +7,35 @@ import { messageWithCauses, stackWithCauses } from 'pony-cause'
 import updateNotifier from 'tiny-updater'
 import colors from 'yoctocolors-cjs'
 
-import * as cliCommands from './commands'
+import { actionCommand } from './commands/action'
+import { analyticsCommand } from './commands/analytics'
+import { auditLogCommand } from './commands/audit-log'
+import { cdxgenCommand } from './commands/cdxgen'
+import { dependenciesCommand } from './commands/dependencies'
+import { diffScanCommand } from './commands/diff-scan'
+import { fixCommand } from './commands/fix'
+import { infoCommand } from './commands/info'
+import { loginCommand } from './commands/login'
+import { logoutCommand } from './commands/logout'
+import { manifestCommand } from './commands/manifest'
+import { npmCommand } from './commands/npm'
+import { npxCommand } from './commands/npx'
+import { optimizeCommand } from './commands/optimize'
+import { organizationCommand } from './commands/organization'
+import { rawNpmCommand } from './commands/raw-npm'
+import { rawNpxCommand } from './commands/raw-npx'
+import { reportCommand } from './commands/report'
+import { reposCommand } from './commands/repos'
+import { scanCommand } from './commands/scan'
+import { threatFeedCommand } from './commands/threat-feed'
+import { wrapperCommand } from './commands/wrapper'
 import constants from './constants'
 import { AuthError, InputError } from './utils/errors'
 import { logSymbols } from './utils/logging'
 import { meowWithSubcommands } from './utils/meow-with-subcommands'
 
 const { rootPkgJsonPath } = constants
 
-const formattedCliCommands = Object.fromEntries(
-  Object.entries(cliCommands).map(entry => {
-    const key = entry[0]
-    entry[0] = camelToHyphen(key)
-    return entry
-  })
-)
-
-function camelToHyphen(str: string): string {
-  return str.replace(/[A-Z]+/g, '-$&').toLowerCase()
-}
-
 // TODO: Add autocompletion using https://socket.dev/npm/package/omelette
 void (async () => {
   await updateNotifier({
@@ -36,17 +45,43 @@ void (async () => {
   })
 
   try {
-    await meowWithSubcommands(formattedCliCommands, {
-      aliases: {
-        ci: {
-          description: 'Alias for "report create --view --strict"',
-          argv: ['report', 'create', '--view', '--strict']
-        }
+    await meowWithSubcommands(
+      {
+        action: actionCommand,
+        cdxgen: cdxgenCommand,
+        fix: fixCommand,
+        info: infoCommand,
+        login: loginCommand,
+        logout: logoutCommand,
+        npm: npmCommand,
+        npx: npxCommand,
+        optimize: optimizeCommand,
+        organization: organizationCommand,
+        'raw-npm': rawNpmCommand,
+        'raw-npx': rawNpxCommand,
+        report: reportCommand,
+        wrapper: wrapperCommand,
+        scan: scanCommand,
+        'audit-log': auditLogCommand,
+        repos: reposCommand,
+        dependencies: dependenciesCommand,
+        analytics: analyticsCommand,
+        'diff-scan': diffScanCommand,
+        'threat-feed': threatFeedCommand,
+        manifest: manifestCommand
       },
-      argv: process.argv.slice(2),
-      name: 'socket',
-      importMeta: { url: `${pathToFileURL(__filename)}` } as ImportMeta
-    })
+      {
+        aliases: {
+          ci: {
+            description: 'Alias for "report create --view --strict"',
+            argv: ['report', 'create', '--view', '--strict']
+          }
+        },
+        argv: process.argv.slice(2),
+        name: 'socket',
+        importMeta: { url: `${pathToFileURL(__filename)}` } as ImportMeta
+      }
+    )
   } catch (err) {
     let errorBody: string | undefined
     let errorTitle: string

src/commands/action/index.ts

@@ -15,7 +15,7 @@ import { getDefaultToken } from '../../utils/sdk'
 
 const socket = new SocketSdk(getDefaultToken()!)
 
-export const action: CliSubcommand = {
+export const actionCommand: CliSubcommand = {
   description: 'Socket action command',
   hidden: true,
   async run(args: readonly string[]) {

src/commands/analytics.ts

@@ -21,12 +21,14 @@ import { getDefaultToken, setupSdk } from '../utils/sdk'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
-export const analytics: CliSubcommand = {
-  description: `Look up analytics data\n                        Default parameters are set to show the organization-level analytics over the last 7 days.`,
+const description = `Look up analytics data\n                        Default parameters are set to show the organization-level analytics over the last 7 days.`
+
+export const analyticsCommand: CliSubcommand = {
+  description,
   async run(argv, importMeta, { parentName }) {
     const name = parentName + ' analytics'
 
-    const input = setupCommand(name, analytics.description, argv, importMeta)
+    const input = setupCommand(name, description, argv, importMeta)
     if (input) {
       const apiToken = getDefaultToken()
       if (!apiToken) {

src/commands/audit-log.ts

@@ -12,12 +12,14 @@ import { getDefaultToken, setupSdk } from '../utils/sdk'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
-export const auditLog: CliSubcommand = {
-  description: 'Look up the audit log for an organization',
+const description = 'Look up the audit log for an organization'
+
+export const auditLogCommand: CliSubcommand = {
+  description,
   async run(argv, importMeta, { parentName }) {
     const name = parentName + ' audit-log'
 
-    const input = setupCommand(name, auditLog.description, argv, importMeta)
+    const input = setupCommand(name, description, argv, importMeta)
     if (input) {
       const apiToken = getDefaultToken()
       if (!apiToken) {

src/commands/cdxgen.ts

@@ -149,7 +149,7 @@ function argvToArray(argv: {
   return result
 }
 
-export const cdxgen: CliSubcommand = {
+export const cdxgenCommand: CliSubcommand = {
   description: 'Create an SBOM with CycloneDX generator (cdxgen)',
   async run(argv_) {
     const yargv = <any>{

src/commands/dependencies.ts

@@ -13,13 +13,15 @@ import { getDefaultToken, setupSdk } from '../utils/sdk'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
-export const dependencies: CliSubcommand = {
-  description:
-    'Search for any dependency that is being used in your organization',
+const description =
+  'Search for any dependency that is being used in your organization'
+
+export const dependenciesCommand: CliSubcommand = {
+  description,
   async run(argv, importMeta, { parentName }) {
     const name = parentName + ' dependencies'
 
-    const input = setupCommand(name, dependencies.description, argv, importMeta)
+    const input = setupCommand(name, description, argv, importMeta)
     if (input) {
       await searchDeps(input)
     }

src/commands/diff-scan/index.ts

@@ -5,7 +5,7 @@ import type { CliSubcommand } from '../../utils/meow-with-subcommands'
 
 const description = 'Diff scans related commands'
 
-export const diffScan: CliSubcommand = {
+export const diffScanCommand: CliSubcommand = {
   description,
   async run(argv, importMeta, { parentName }) {
     await meowWithSubcommands(

src/commands/fix.ts

@@ -34,7 +34,7 @@ const { SOCKET_CLI_IN_FIX_CMD, SOCKET_IPC_HANDSHAKE } = constants
 // /* eslint-enable no-await-in-loop */
 // return ret!
 
-export const fix: CliSubcommand = {
+export const fixCommand: CliSubcommand = {
   description: 'Fix "fixable" Socket alerts',
   hidden: true,
   async run() {

src/commands/index.ts

@@ -25,17 +25,14 @@ import type { SocketSdkReturnType } from '@socketsecurity/sdk'
 
 const { NPM } = constants
 
-export const info: CliSubcommand = {
-  description: 'Look up info regarding a package',
+const description = 'Look up info regarding a package'
+
+export const infoCommand: CliSubcommand = {
+  description,
   async run(argv, importMeta, { parentName }) {
     const name = parentName + ' info'
 
-    const commandContext = setupCommand(
-      name,
-      info.description,
-      argv,
-      importMeta
-    )
+    const commandContext = setupCommand(name, description, argv, importMeta)
     if (commandContext) {
       const spinnerText =
         commandContext.pkgVersion === 'latest'