Reaching for the stars (#627)

* Reaching for the stars

* update copy pasta

* dep management

* oh sure we probably dont need this for this command

---------

Co-authored-by: John-David Dalton <jdalton@users.noreply.github.com>

Author: pvdz

src/commands/scan/cmd-scan-reach.mts

@@ -0,0 +1,84 @@
+import path from 'node:path'
+
+import { logger } from '@socketsecurity/registry/lib/logger'
+
+import { handleScanReach } from './handle-reach-scan.mts'
+import constants from '../../constants.mts'
+import { commonFlags, outputFlags } from '../../flags.mts'
+import { checkCommandInput } from '../../utils/check-input.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 type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
+
+const { DRY_RUN_BAILING_NOW } = constants
+
+const config: CliCommandConfig = {
+  commandName: 'reach',
+  description: 'Compute tier 1 reachability',
+  hidden: true, // b-e-tah
+  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.',
+    },
+  },
+  help: (command, config) => `
+    Usage
+      $ ${command} [CWD=.]
+
+    Options
+      ${getFlagListOutput(config.flags, 6)}
+
+    Examples
+      $ ${command}
+      $ ${command} ./proj
+  `,
+}
+
+export const cmdScanReach = {
+  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,
+    importMeta,
+    parentName,
+  })
+
+  const { dryRun, interactive, json, markdown } = cli.flags
+  const outputKind = getOutputKind(json, markdown)
+  let [cwd = '.'] = cli.input
+  // Note: path.resolve vs .join:
+  // If given path is absolute then cwd should not affect it.
+  cwd = path.resolve(process.cwd(), cwd)
+  logger.info(
+    'If you dont have any interactive bits then drop the flag',
+    interactive,
+  )
+
+  const wasValidInput = checkCommandInput(outputKind)
+  if (!wasValidInput) {
+    return
+  }
+
+  if (dryRun) {
+    logger.log(DRY_RUN_BAILING_NOW)
+    return
+  }
+
+  await handleScanReach(cwd, outputKind)
+}

src/commands/scan/cmd-scan.mts

@@ -4,6 +4,7 @@ import { cmdScanDiff } from './cmd-scan-diff.mts'
 import { cmdScanGithub } from './cmd-scan-github.mts'
 import { cmdScanList } from './cmd-scan-list.mts'
 import { cmdScanMetadata } from './cmd-scan-metadata.mts'
+import { cmdScanReach } from './cmd-scan-reach.mts'
 import { cmdScanReport } from './cmd-scan-report.mts'
 import { cmdScanSetup } from './cmd-scan-setup.mts'
 import { cmdScanView } from './cmd-scan-view.mts'
@@ -24,6 +25,7 @@ export const cmdScan: CliSubcommand = {
         github: cmdScanGithub,
         list: cmdScanList,
         metadata: cmdScanMetadata,
+        reach: cmdScanReach,
         report: cmdScanReport,
         setup: cmdScanSetup,
         view: cmdScanView,

src/commands/scan/handle-reach-scan.mts

@@ -0,0 +1,10 @@
+import { outputScanReach } from './output-scan-reach.mts'
+import { scanReachability } from './scan-reachability.mts'
+
+import type { OutputKind } from '../../types.mts'
+
+export async function handleScanReach(cwd: string, outputKind: OutputKind) {
+  const result = await scanReachability(cwd)
+
+  await outputScanReach(result, cwd, outputKind)
+}

src/commands/scan/output-scan-reach.mts

@@ -0,0 +1,27 @@
+import { logger } from '@socketsecurity/registry/lib/logger'
+
+import { failMsgWithBadge } from '../../utils/fail-msg-with-badge.mts'
+import { serializeResultJson } from '../../utils/serialize-result-json.mts'
+
+import type { CResult, OutputKind } from '../../types.mts'
+
+export async function outputScanReach(
+  result: CResult<unknown>,
+  cwd: string,
+  outputKind: OutputKind,
+): Promise<void> {
+  if (!result.ok) {
+    process.exitCode = result.code ?? 1
+  }
+
+  if (outputKind === 'json') {
+    logger.log(serializeResultJson(result))
+    return
+  }
+  if (!result.ok) {
+    logger.fail(failMsgWithBadge(result.message, result.cause))
+    return
+  }
+
+  logger.success('finished on', cwd)
+}

src/commands/scan/scan-reachability.mts

@@ -0,0 +1,7 @@
+import type { CResult } from '../../types.mts'
+
+export async function scanReachability(cwd: string): Promise<CResult<unknown>> {
+  console.log('Scanning now... as soon as you implement me! From', cwd)
+
+  return { ok: true, data: undefined }
+}

src/utils/api.mts

@@ -176,6 +176,7 @@ export async function queryApi(path: string, apiToken: string) {
       'API endpoint is not set and default was empty. Request is likely to fail.',
     )
   }
+
   return await fetch(`${baseUrl}${baseUrl.endsWith('/') ? '' : '/'}${path}`, {
     method: 'GET',
     headers: {