Integrate --help into more things

Author: jdalton

src/commands/analytics.ts

@@ -7,7 +7,7 @@ import chalk from 'chalk'
 import meow from 'meow'
 import ora from 'ora'
 
-import { outputFlags } from '../flags'
+import { commonFlags, outputFlags } from '../flags'
 import {
   handleApiCall,
   handleUnsuccessfulApiResponse
@@ -103,10 +103,10 @@ function setupCommand(
 ): void | CommandContext {
   const flags: { [key: string]: any } = {
     __proto__: null,
+    ...commonFlags,
     ...outputFlags,
     ...analyticsFlags
   }
-
   const cli = meow(
     `
     Usage
@@ -127,31 +127,30 @@ function setupCommand(
       flags
     }
   )
-
-  const { json: outputJson, scope, time, repo, file } = cli.flags
-
+  const { repo, scope, time } = cli.flags
   if (scope !== 'org' && scope !== 'repo') {
     throw new InputError("The scope must either be 'org' or 'repo'")
   }
-
   if (time !== 7 && time !== 30 && time !== 90) {
     throw new InputError('The time filter must either be 7, 30 or 90')
   }
-
+  let showHelp = cli.flags['help']
   if (scope === 'repo' && !repo) {
+    showHelp = true
     console.error(
       `${chalk.bgRed.white('Input error')}: Please provide a repository name when using the repository scope. \n`
     )
+  }
+  if (showHelp) {
     cli.showHelp()
     return
   }
-
   return <CommandContext>{
     scope,
     time,
     repo,
-    outputJson,
-    file
+    outputJson: cli.flags['json'],
+    file: cli.flags['file']
   }
 }
 

src/commands/audit-log.ts

@@ -3,7 +3,7 @@ import chalk from 'chalk'
 import meow from 'meow'
 import ora from 'ora'
 
-import { outputFlags } from '../flags'
+import { commonFlags, outputFlags } from '../flags'
 import {
   handleApiCall,
   handleUnsuccessfulApiResponse
@@ -75,9 +75,9 @@ function setupCommand(
   const flags: { [key: string]: any } = {
     __proto__: null,
     ...auditLogFlags,
+    ...commonFlags,
     ...outputFlags
   }
-
   const cli = meow(
     `
     Usage
@@ -96,25 +96,25 @@ function setupCommand(
       flags
     }
   )
-
-  const {
-    json: outputJson,
-    markdown: outputMarkdown,
-    page,
-    perPage
-  } = cli.flags
-
-  const type = <string>cli.flags['type']
-
+  let showHelp = cli.flags['help']
   if (cli.input.length < 1) {
+    showHelp = true
     console.error(
       `${chalk.white.bgRed('Input error')}: Please provide an organization slug\n`
     )
+  }
+  if (showHelp) {
     cli.showHelp()
     return
   }
+  const {
+    json: outputJson,
+    markdown: outputMarkdown,
+    page,
+    perPage
+  } = cli.flags
+  const type = <string>cli.flags['type']
   const { 0: orgSlug = '' } = cli.input
-
   return <CommandContext>{
     outputJson,
     outputMarkdown,

src/commands/dependencies.ts

@@ -4,7 +4,7 @@ import chalkTable from 'chalk-table'
 import meow from 'meow'
 import ora from 'ora'
 
-import { outputFlags } from '../flags'
+import { commonFlags, outputFlags } from '../flags'
 import {
   handleApiCall,
   handleUnsuccessfulApiResponse
@@ -60,8 +60,9 @@ function setupCommand(
 ): CommandContext | undefined {
   const flags: { [key: string]: any } = {
     __proto__: null,
-    ...outputFlags,
-    ...dependenciesFlags
+    ...commonFlags,
+    ...dependenciesFlags,
+    ...outputFlags
   }
 
   const cli = meow(

src/commands/diff-scan/get.ts

@@ -5,7 +5,7 @@ import chalk from 'chalk'
 import meow from 'meow'
 import ora from 'ora'
 
-import { outputFlags } from '../../flags'
+import { commonFlags, outputFlags } from '../../flags'
 import { handleAPIError, queryAPI } from '../../utils/api-helpers'
 import { AuthError } from '../../utils/errors'
 import { printFlagList } from '../../utils/formatting'
@@ -80,10 +80,10 @@ function setupCommand(
 ): CommandContext | undefined {
   const flags: { [key: string]: any } = {
     __proto__: null,
-    ...outputFlags,
-    ...getDiffScanFlags
+    ...commonFlags,
+    ...getDiffScanFlags,
+    ...outputFlags
   }
-
   const cli = meow(
     `
     Usage
@@ -102,42 +102,32 @@ function setupCommand(
       flags
     }
   )
-
-  const {
-    json: outputJson,
-    markdown: outputMarkdown,
-    before,
-    after,
-    preview,
-    file
-  } = cli.flags
-
+  const { before, after } = cli.flags
+  let showHelp = cli.flags['help']
   if (!before || !after) {
+    showHelp = true
     console.error(
       `${chalk.bgRed.white('Input error')}: Please specify a before and after full scan ID. To get full scans IDs, you can run the command "socket scan list <your org slug>".\n`
     )
-    cli.showHelp()
-    return
-  }
-
-  if (cli.input.length < 1) {
+  } else if (cli.input.length < 1) {
+    showHelp = true
     console.error(
       `${chalk.bgRed.white('Input error')}: Please provide an organization slug\n`
     )
+  }
+  if (showHelp) {
     cli.showHelp()
     return
   }
-
   const [orgSlug = ''] = cli.input
-
   return <CommandContext>{
-    outputJson,
-    outputMarkdown,
+    outputJson: cli.flags['json'],
+    outputMarkdown: cli.flags['markdown'],
     before,
     after,
-    preview,
+    preview: cli.flags['preview'],
     orgSlug,
-    file
+    file: cli.flags['file']
   }
 }
 

src/commands/info.ts

@@ -2,7 +2,7 @@ import chalk from 'chalk'
 import meow from 'meow'
 import ora from 'ora'
 
-import { outputFlags, validationFlags } from '../flags'
+import { commonFlags, outputFlags, validationFlags } from '../flags'
 import {
   handleApiCall,
   handleUnsuccessfulApiResponse
@@ -72,10 +72,10 @@ function setupCommand(
 ): void | CommandContext {
   const flags: { [key: string]: any } = {
     __proto__: null,
+    ...commonFlags,
     ...outputFlags,
     ...validationFlags
   }
-
   const cli = meow(
     `
     Usage
@@ -95,39 +95,30 @@ function setupCommand(
       flags
     }
   )
-
-  const {
-    all: includeAllIssues,
-    json: outputJson,
-    markdown: outputMarkdown,
-    strict
-  } = cli.flags
-
   if (cli.input.length > 1) {
     throw new InputError('Only one package lookup supported at once')
   }
-
   const { 0: rawPkgName = '' } = cli.input
-
+  let showHelp = cli.flags['help']
   if (!rawPkgName) {
+    showHelp = true
+  }
+  if (showHelp) {
     cli.showHelp()
     return
   }
-
   const versionSeparator = rawPkgName.lastIndexOf('@')
-
   const pkgName =
     versionSeparator < 1 ? rawPkgName : rawPkgName.slice(0, versionSeparator)
   const pkgVersion =
     versionSeparator < 1 ? 'latest' : rawPkgName.slice(versionSeparator + 1)
-
   return {
-    includeAllIssues,
-    outputJson,
-    outputMarkdown,
+    includeAllIssues: cli.flags['all'],
+    outputJson: cli.flags['json'],
+    outputMarkdown: cli.flags['markdown'],
     pkgName,
     pkgVersion,
-    strict
+    strict: cli.flags['strict']
   } as CommandContext
 }
 

src/commands/login.ts

@@ -72,17 +72,19 @@ export const login: CliSubcommand = {
         flags
       }
     )
-
+    let showHelp = cli.flags['help']
     if (cli.input.length) {
+      showHelp = true
+    }
+    if (showHelp) {
       cli.showHelp()
+      return
     }
-
     if (!isInteractive()) {
       throw new InputError(
         'Cannot prompt for credentials in a non-interactive shell'
       )
     }
-
     const apiKey =
       (await password({
         message: `Enter your ${terminalLink(

src/commands/logout.ts

@@ -27,11 +27,14 @@ export const logout: CliSubcommand = {
         importMeta
       }
     )
-
+    let showHelp = cli.flags['help']
     if (cli.input.length) {
+      showHelp = true
+    }
+    if (showHelp) {
       cli.showHelp()
+      return
     }
-
     updateSetting('apiKey', null)
     updateSetting('apiBaseUrl', null)
     updateSetting('apiProxy', null)

src/commands/optimize.ts

@@ -9,6 +9,7 @@ import ora from 'ora'
 import pacote from 'pacote'
 import semver from 'semver'
 
+import { commonFlags } from '../flags'
 import { printFlagList } from '../utils/formatting'
 import { hasOwn } from '../utils/objects'
 import { detect } from '../utils/package-manager-detector'
@@ -230,12 +231,12 @@ async function addOverrides(
     await pEach(overridesDataObjects, 3, async ({ overrides, type }) => {
       const overrideExists = hasOwn(overrides, origPkgName)
       if (overrideExists || lockIncludes(lockSrc, origPkgName)) {
-        // With npm you may not set an override for a package that you directly
-        // depend on unless both the dependency and the override itself share
+        // With npm one may not set an override for a package that one directly
+        // depends on unless both the dependency and the override itself share
         // the exact same spec. To make this limitation easier to deal with,
         // overrides may also be defined as a reference to a spec for a direct
-        // dependency by prefixing the name of the package you wish the version
-        // to match with a $.
+        // dependency by prefixing the name of the package to match the version
+        // of with a $.
         // https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides
         const oldSpec = overrides[origPkgName]
         const depAlias = depAliasMap.get(origPkgName)
@@ -305,7 +306,7 @@ export const optimize: CliSubcommand = {
   description: 'Optimize dependencies with @socketregistry overrides',
   async run(argv, importMeta, { parentName }) {
     const commandContext = setupCommand(
-      `${parentName} dependency optimize`,
+      `${parentName} optimize`,
       optimize.description,
       argv,
       importMeta
@@ -441,13 +442,14 @@ function setupCommand(
   importMeta: ImportMeta
 ): CommandContext | undefined {
   const flags: { [key: string]: any } = {
+    __proto__: null,
+    ...commonFlags,
     pin: {
       type: 'boolean',
       default: false,
       description: 'Pin overrides to their latest version'
     }
   }
-
   const cli = meow(
     `
     Usage
@@ -466,9 +468,11 @@ function setupCommand(
       flags
     }
   )
-
-  const { pin } = cli.flags
-
+  const { help, pin } = cli.flags
+  if (help) {
+    cli.showHelp()
+    return
+  }
   return <CommandContext>{
     pin
   }