Add more constants

Author: jdalton

src/commands/fix/cmd-fix.mts

@@ -6,7 +6,7 @@ import { arrayUnique, joinOr } from '@socketsecurity/registry/lib/arrays'
 import { logger } from '@socketsecurity/registry/lib/logger'
 
 import { handleFix } from './handle-fix.mts'
-import constants from '../../constants.mts'
+import constants, { ERROR_UNABLE_RESOLVE_ORG } from '../../constants.mts'
 import { commonFlags, outputFlags } from '../../flags.mts'
 import { checkCommandInput } from '../../utils/check-input.mts'
 import { cmdFlagValueToArray } from '../../utils/cmd.mts'
@@ -257,7 +257,7 @@ async function run(
   if (!orgSlugCResult.ok) {
     process.exitCode = orgSlugCResult.code ?? 1
     logger.fail(
-      'Unable to resolve a Socket account organization.\nEnsure a Socket API token is specified for the organization using the SOCKET_CLI_API_TOKEN environment variable.',
+      `${ERROR_UNABLE_RESOLVE_ORG}.\nEnsure a Socket API token is specified for the organization using the SOCKET_CLI_API_TOKEN environment variable.`,
     )
     return
   }

src/commands/login/apply-login.mts

@@ -1,3 +1,9 @@
+import {
+  CONFIG_KEY_API_BASE_URL,
+  CONFIG_KEY_API_PROXY,
+  CONFIG_KEY_API_TOKEN,
+  CONFIG_KEY_ENFORCED_ORGS,
+} from '../../constants.mts'
 import { updateConfigValue } from '../../utils/config.mts'
 
 export function applyLogin(
@@ -6,8 +12,8 @@ export function applyLogin(
   apiBaseUrl: string | undefined,
   apiProxy: string | undefined,
 ) {
-  updateConfigValue('enforcedOrgs', enforcedOrgs)
-  updateConfigValue('apiToken', apiToken)
-  updateConfigValue('apiBaseUrl', apiBaseUrl)
-  updateConfigValue('apiProxy', apiProxy)
+  updateConfigValue(CONFIG_KEY_ENFORCED_ORGS, enforcedOrgs)
+  updateConfigValue(CONFIG_KEY_API_TOKEN, apiToken)
+  updateConfigValue(CONFIG_KEY_API_BASE_URL, apiBaseUrl)
+  updateConfigValue(CONFIG_KEY_API_PROXY, apiProxy)
 }

src/commands/login/attempt-login.mts

@@ -5,7 +5,12 @@ import { logger } from '@socketsecurity/registry/lib/logger'
 import { confirm, password, select } from '@socketsecurity/registry/lib/prompts'
 
 import { applyLogin } from './apply-login.mts'
-import constants from '../../constants.mts'
+import constants, {
+  CONFIG_KEY_API_BASE_URL,
+  CONFIG_KEY_API_PROXY,
+  CONFIG_KEY_API_TOKEN,
+  CONFIG_KEY_DEFAULT_ORG,
+} from '../../constants.mts'
 import {
   getConfigValueOrUndef,
   isReadOnlyConfig,
@@ -26,8 +31,8 @@ export async function attemptLogin(
   apiBaseUrl: string | undefined,
   apiProxy: string | undefined,
 ) {
-  apiBaseUrl ??= getConfigValueOrUndef('apiBaseUrl') ?? undefined
-  apiProxy ??= getConfigValueOrUndef('apiProxy') ?? undefined
+  apiBaseUrl ??= getConfigValueOrUndef(CONFIG_KEY_API_BASE_URL) ?? undefined
+  apiProxy ??= getConfigValueOrUndef(CONFIG_KEY_API_PROXY) ?? undefined
   const apiTokenInput = await password({
     message: `Enter your ${terminalLink(
       'Socket.dev API token',
@@ -148,9 +153,9 @@ export async function attemptLogin(
     }
   }
 
-  updateConfigValue('defaultOrg', orgSlugs[0])
+  updateConfigValue(CONFIG_KEY_DEFAULT_ORG, orgSlugs[0])
 
-  const previousPersistedToken = getConfigValueOrUndef('apiToken')
+  const previousPersistedToken = getConfigValueOrUndef(CONFIG_KEY_API_TOKEN)
   try {
     applyLogin(apiToken, enforcedOrgs, apiBaseUrl, apiProxy)
     logger.success(

src/commands/logout/apply-logout.mts

@@ -1,8 +1,14 @@
+import {
+  CONFIG_KEY_API_BASE_URL,
+  CONFIG_KEY_API_PROXY,
+  CONFIG_KEY_API_TOKEN,
+  CONFIG_KEY_ENFORCED_ORGS,
+} from '../../constants.mts'
 import { updateConfigValue } from '../../utils/config.mts'
 
 export function applyLogout() {
-  updateConfigValue('apiToken', null)
-  updateConfigValue('apiBaseUrl', null)
-  updateConfigValue('apiProxy', null)
-  updateConfigValue('enforcedOrgs', null)
+  updateConfigValue(CONFIG_KEY_API_TOKEN, null)
+  updateConfigValue(CONFIG_KEY_API_BASE_URL, null)
+  updateConfigValue(CONFIG_KEY_API_PROXY, null)
+  updateConfigValue(CONFIG_KEY_ENFORCED_ORGS, null)
 }

src/commands/npm/cmd-npm.mts

@@ -2,7 +2,7 @@ import { createRequire } from 'node:module'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
 
-import constants, { NPM } from '../../constants.mts'
+import constants, { FLAG_JSON, NPM } from '../../constants.mts'
 import { commonFlags, outputFlags } from '../../flags.mts'
 import { filterFlags } from '../../utils/cmd.mts'
 import { meowOrExit } from '../../utils/meow-with-subcommands.mts'
@@ -79,7 +79,7 @@ async function run(
 
   // Filter Socket flags from argv but keep --json for npm.
   const argsToForward = filterFlags(argv, { ...commonFlags, ...outputFlags }, [
-    '--json',
+    FLAG_JSON,
   ])
   const { spawnPromise } = await shadowBin(NPM, argsToForward, {
     stdio: 'inherit',

src/constants.mts

@@ -176,6 +176,13 @@ const ALERT_TYPE_MEDIUM_CVE = 'mediumCVE'
 const ALERT_TYPE_MILD_CVE = 'mildCVE'
 const API_V0_URL = 'https://api.socket.dev/v0/'
 const BUN = 'bun'
+const CONFIG_KEY_API_BASE_URL = 'apiBaseUrl'
+const CONFIG_KEY_API_PROXY = 'apiProxy'
+const CONFIG_KEY_API_TOKEN = 'apiToken'
+const CONFIG_KEY_DEFAULT_ORG = 'defaultOrg'
+const CONFIG_KEY_ENFORCED_ORGS = 'enforcedOrgs'
+const CONFIG_KEY_ORG = 'org'
+const DOT_GIT = '.git'
 const DOT_SOCKET = '.socket'
 const DOT_SOCKET_DOT_FACTS_JSON = `${DOT_SOCKET}.facts.json`
 const DRY_RUN_LABEL = '[DryRun]'
@@ -184,6 +191,25 @@ const DRY_RUN_NOT_SAVING = `${DRY_RUN_LABEL}: Not saving`
 const EMPTY_VALUE = '<empty>'
 const ENVIRONMENT_YAML = 'environment.yaml'
 const ENVIRONMENT_YML = 'environment.yml'
+const ERROR_NO_MANIFEST_FILES = 'No manifest files found'
+const ERROR_NO_PACKAGE_JSON = 'No package.json found'
+const ERROR_NO_REPO_FOUND = 'No repo found'
+const ERROR_NO_SOCKET_DIR = 'No .socket directory found'
+const ERROR_UNABLE_RESOLVE_ORG = 'Unable to resolve a Socket account organization'
+const EXT_YAML = '.yaml'
+const EXT_YML = '.yml'
+const FLAG_CONFIG = '--config'
+const FLAG_DRY_RUN = '--dry-run'
+const FLAG_HELP = '--help'
+const FLAG_JSON = '--json'
+const FLAG_MARKDOWN = '--markdown'
+const FLAG_ORG = '--org'
+const FLAG_PIN = '--pin'
+const FLAG_PROD = '--prod'
+const FLAG_QUIET = '--quiet'
+const FLAG_SILENT = '--silent'
+const FLAG_TEXT = '--text'
+const FLAG_VERBOSE = '--verbose'
 const FOLD_SETTING_FILE = 'file'
 const FOLD_SETTING_NONE = 'none'
 const FOLD_SETTING_PKG = 'pkg'
@@ -239,15 +265,41 @@ export type Constants = Remap<
     readonly ALERT_TYPE_MILD_CVE: typeof ALERT_TYPE_MILD_CVE
     readonly API_V0_URL: typeof API_V0_URL
     readonly BUN: typeof BUN
-    readonly EMPTY_VALUE: typeof EMPTY_VALUE
-    readonly ENV: ENV
+    readonly CONFIG_KEY_API_BASE_URL: typeof CONFIG_KEY_API_BASE_URL
+    readonly CONFIG_KEY_API_PROXY: typeof CONFIG_KEY_API_PROXY
+    readonly CONFIG_KEY_API_TOKEN: typeof CONFIG_KEY_API_TOKEN
+    readonly CONFIG_KEY_DEFAULT_ORG: typeof CONFIG_KEY_DEFAULT_ORG
+    readonly CONFIG_KEY_ENFORCED_ORGS: typeof CONFIG_KEY_ENFORCED_ORGS
+    readonly CONFIG_KEY_ORG: typeof CONFIG_KEY_ORG
+    readonly DOT_GIT: typeof DOT_GIT
     readonly DOT_SOCKET: typeof DOT_SOCKET
     readonly DOT_SOCKET_DOT_FACTS_JSON: typeof DOT_SOCKET_DOT_FACTS_JSON
     readonly DRY_RUN_LABEL: typeof DRY_RUN_LABEL
     readonly DRY_RUN_BAILING_NOW: typeof DRY_RUN_BAILING_NOW
     readonly DRY_RUN_NOT_SAVING: typeof DRY_RUN_NOT_SAVING
+    readonly EMPTY_VALUE: typeof EMPTY_VALUE
+    readonly ENV: ENV
     readonly ENVIRONMENT_YAML: typeof ENVIRONMENT_YAML
     readonly ENVIRONMENT_YML: typeof ENVIRONMENT_YML
+    readonly ERROR_NO_MANIFEST_FILES: typeof ERROR_NO_MANIFEST_FILES
+    readonly ERROR_NO_PACKAGE_JSON: typeof ERROR_NO_PACKAGE_JSON
+    readonly ERROR_NO_REPO_FOUND: typeof ERROR_NO_REPO_FOUND
+    readonly ERROR_NO_SOCKET_DIR: typeof ERROR_NO_SOCKET_DIR
+    readonly ERROR_UNABLE_RESOLVE_ORG: typeof ERROR_UNABLE_RESOLVE_ORG
+    readonly EXT_YAML: typeof EXT_YAML
+    readonly EXT_YML: typeof EXT_YML
+    readonly FLAG_CONFIG: typeof FLAG_CONFIG
+    readonly FLAG_DRY_RUN: typeof FLAG_DRY_RUN
+    readonly FLAG_HELP: typeof FLAG_HELP
+    readonly FLAG_JSON: typeof FLAG_JSON
+    readonly FLAG_MARKDOWN: typeof FLAG_MARKDOWN
+    readonly FLAG_ORG: typeof FLAG_ORG
+    readonly FLAG_PIN: typeof FLAG_PIN
+    readonly FLAG_PROD: typeof FLAG_PROD
+    readonly FLAG_QUIET: typeof FLAG_QUIET
+    readonly FLAG_SILENT: typeof FLAG_SILENT
+    readonly FLAG_TEXT: typeof FLAG_TEXT
+    readonly FLAG_VERBOSE: typeof FLAG_VERBOSE
     readonly FOLD_SETTING_FILE: typeof FOLD_SETTING_FILE
     readonly FOLD_SETTING_NONE: typeof FOLD_SETTING_NONE
     readonly FOLD_SETTING_PKG: typeof FOLD_SETTING_PKG
@@ -766,15 +818,41 @@ const constants: Constants = createConstantsObject(
     ALERT_TYPE_MILD_CVE,
     API_V0_URL,
     BUN,
+    CONFIG_KEY_API_BASE_URL,
+    CONFIG_KEY_API_PROXY,
+    CONFIG_KEY_API_TOKEN,
+    CONFIG_KEY_DEFAULT_ORG,
+    CONFIG_KEY_ENFORCED_ORGS,
+    CONFIG_KEY_ORG,
+    DOT_GIT,
     DOT_SOCKET,
     DOT_SOCKET_DOT_FACTS_JSON,
     DRY_RUN_LABEL,
     DRY_RUN_BAILING_NOW,
     DRY_RUN_NOT_SAVING,
     EMPTY_VALUE,
+    ENV: undefined,
     ENVIRONMENT_YAML,
     ENVIRONMENT_YML,
-    ENV: undefined,
+    ERROR_NO_MANIFEST_FILES,
+    ERROR_NO_PACKAGE_JSON,
+    ERROR_NO_REPO_FOUND,
+    ERROR_NO_SOCKET_DIR,
+    ERROR_UNABLE_RESOLVE_ORG,
+    EXT_YAML,
+    EXT_YML,
+    FLAG_CONFIG,
+    FLAG_DRY_RUN,
+    FLAG_HELP,
+    FLAG_JSON,
+    FLAG_MARKDOWN,
+    FLAG_ORG,
+    FLAG_PIN,
+    FLAG_PROD,
+    FLAG_QUIET,
+    FLAG_SILENT,
+    FLAG_TEXT,
+    FLAG_VERBOSE,
     FOLD_SETTING_FILE,
     FOLD_SETTING_NONE,
     FOLD_SETTING_PKG,
@@ -917,6 +995,13 @@ export {
   BUN,
   CI,
   COLUMN_LIMIT,
+  CONFIG_KEY_API_BASE_URL,
+  CONFIG_KEY_API_PROXY,
+  CONFIG_KEY_API_TOKEN,
+  CONFIG_KEY_DEFAULT_ORG,
+  CONFIG_KEY_ENFORCED_ORGS,
+  CONFIG_KEY_ORG,
+  DOT_GIT,
   DOT_SOCKET,
   DOT_SOCKET_DOT_FACTS_JSON,
   DRY_RUN_BAILING_NOW,
@@ -926,6 +1011,11 @@ export {
   EMPTY_VALUE,
   ENVIRONMENT_YAML,
   ENVIRONMENT_YML,
+  ERROR_NO_MANIFEST_FILES,
+  ERROR_NO_PACKAGE_JSON,
+  ERROR_NO_REPO_FOUND,
+  ERROR_NO_SOCKET_DIR,
+  ERROR_UNABLE_RESOLVE_ORG,
   ESLINT_CONFIG_JS,
   ESNEXT,
   EXTENSIONS,
@@ -942,6 +1032,20 @@ export {
   EXT_MJS,
   EXT_MTS,
   EXT_PS1,
+  EXT_YAML,
+  EXT_YML,
+  FLAG_CONFIG,
+  FLAG_DRY_RUN,
+  FLAG_HELP,
+  FLAG_JSON,
+  FLAG_MARKDOWN,
+  FLAG_ORG,
+  FLAG_PIN,
+  FLAG_PROD,
+  FLAG_QUIET,
+  FLAG_SILENT,
+  FLAG_TEXT,
+  FLAG_VERBOSE,
   FOLD_SETTING_FILE,
   FOLD_SETTING_NONE,
   FOLD_SETTING_PKG,

src/utils/config.mts

@@ -7,7 +7,14 @@ import { safeReadFileSync } from '@socketsecurity/registry/lib/fs'
 import { logger } from '@socketsecurity/registry/lib/logger'
 import { naturalCompare } from '@socketsecurity/registry/lib/sorts'
 
-import constants from '../constants.mts'
+import constants, {
+  CONFIG_KEY_API_BASE_URL,
+  CONFIG_KEY_API_PROXY,
+  CONFIG_KEY_API_TOKEN,
+  CONFIG_KEY_DEFAULT_ORG,
+  CONFIG_KEY_ENFORCED_ORGS,
+  CONFIG_KEY_ORG,
+} from '../constants.mts'
 
 import type { CResult } from '../types.mts'
 import type { SocketYml } from '@socketsecurity/config'
@@ -27,28 +34,28 @@ export interface LocalConfig {
   org?: string | undefined
 }
 
-const sensitiveConfigKeyLookup: Set<keyof LocalConfig> = new Set(['apiToken'])
+const sensitiveConfigKeyLookup: Set<keyof LocalConfig> = new Set([CONFIG_KEY_API_TOKEN])
 
 const supportedConfig: Map<keyof LocalConfig, string> = new Map([
-  ['apiBaseUrl', 'Base URL of the Socket API endpoint'],
-  ['apiProxy', 'A proxy through which to access the Socket API'],
+  [CONFIG_KEY_API_BASE_URL, 'Base URL of the Socket API endpoint'],
+  [CONFIG_KEY_API_PROXY, 'A proxy through which to access the Socket API'],
   [
-    'apiToken',
+    CONFIG_KEY_API_TOKEN,
     'The Socket API token required to access most Socket API endpoints',
   ],
   [
-    'defaultOrg',
+    CONFIG_KEY_DEFAULT_ORG,
     'The default org slug to use; usually the org your Socket API token has access to. When set, all orgSlug arguments are implied to be this value.',
   ],
   [
-    'enforcedOrgs',
+    CONFIG_KEY_ENFORCED_ORGS,
     'Orgs in this list have their security policies enforced on this machine',
   ],
   [
     'skipAskToPersistDefaultOrg',
     'This flag prevents the Socket CLI from asking you to persist the org slug when you selected one interactively',
   ],
-  ['org', 'Alias for defaultOrg'],
+  [CONFIG_KEY_ORG, 'Alias for defaultOrg'],
 ])
 
 const supportedConfigEntries = [...supportedConfig.entries()].sort((a, b) =>
@@ -77,7 +84,7 @@ function getConfigValues(): LocalConfig {
         if (_cachedConfig['apiKey']) {
           const token = _cachedConfig['apiKey']
           delete _cachedConfig['apiKey']
-          updateConfigValue('apiToken', token)
+          updateConfigValue(CONFIG_KEY_API_TOKEN, token)
         }
       } else {
         mkdirSync(path.dirname(socketAppDataPath), { recursive: true })
@@ -94,7 +101,7 @@ function normalizeConfigKey(
   //       property apiKey, we'll copy that to apiToken and delete the old property.
   // We added `org` as a convenience alias for `defaultOrg`
   const normalizedKey =
-    key === 'apiKey' ? 'apiToken' : key === 'org' ? 'defaultOrg' : key
+    key === 'apiKey' ? CONFIG_KEY_API_TOKEN : key === CONFIG_KEY_ORG ? CONFIG_KEY_DEFAULT_ORG : key
   if (!isSupportedConfigKey(normalizedKey)) {
     return {
       ok: false,

src/utils/determine-org-slug.mts

@@ -1,5 +1,6 @@
 import { logger } from '@socketsecurity/registry/lib/logger'
 
+import { CONFIG_KEY_DEFAULT_ORG } from '../constants.mts'
 import { getConfigValueOrUndef } from './config.mts'
 import { suggestOrgSlug } from '../commands/scan/suggest-org-slug.mts'
 import { suggestToPersistOrgSlug } from '../commands/scan/suggest-to-persist-orgslug.mts'
@@ -9,7 +10,7 @@ export async function determineOrgSlug(
   interactive: boolean,
   dryRun: boolean,
 ): Promise<[string, string | undefined]> {
-  const defaultOrgSlug = getConfigValueOrUndef('defaultOrg')
+  const defaultOrgSlug = getConfigValueOrUndef(CONFIG_KEY_DEFAULT_ORG)
   let orgSlug = String(orgFlag || defaultOrgSlug || '')
   if (!orgSlug) {
     if (!interactive) {

src/utils/meow-with-subcommands.mts

@@ -26,6 +26,7 @@ import {
 import { getFlagListOutput, getHelpListOutput } from './output-formatting.mts'
 import constants, {
   API_V0_URL,
+  CONFIG_KEY_DEFAULT_ORG,
   NPM,
   NPX,
   // PNPM,
@@ -134,7 +135,7 @@ function getAsciiHeader(command: string, orgFlag: string | undefined) {
     ? REDACTED
     : constants.ENV.INLINED_SOCKET_CLI_VERSION_HASH
   const nodeVersion = redacting ? REDACTED : process.version
-  const defaultOrg = getConfigValueOrUndef('defaultOrg')
+  const defaultOrg = getConfigValueOrUndef(CONFIG_KEY_DEFAULT_ORG)
   const readOnlyConfig = isReadOnlyConfig() ? '*' : '.'
   const shownToken = redacting
     ? REDACTED