Add SOCKET_DEFAULT_BRANCH and SOCKET_DEFAULT_REPOSITORY

Author: jdalton

src/commands/ci/handle-ci.mts

@@ -1,10 +1,13 @@
 import { logger } from '@socketsecurity/registry/lib/logger'
 
 import { getDefaultOrgSlug } from './fetch-default-org-slug.mts'
+import constants from '../../constants.mts'
 import { getRepoName, gitBranch } from '../../utils/git.mts'
 import { serializeResultJson } from '../../utils/serialize-result-json.mts'
 import { handleCreateNewScan } from '../scan/handle-create-new-scan.mts'
 
+const { SOCKET_DEFAULT_BRANCH, SOCKET_DEFAULT_REPOSITORY } = constants
+
 export async function handleCI(autoManifest: boolean): Promise<void> {
   // ci: {
   //   description: 'Alias for "report create --view --strict"',
@@ -23,7 +26,7 @@ export async function handleCI(autoManifest: boolean): Promise<void> {
   // TODO: does it makes sense to use custom branch/repo names here? probably socket.yml, right
   await handleCreateNewScan({
     autoManifest,
-    branchName: (await gitBranch(cwd)) || 'socket-default-branch',
+    branchName: (await gitBranch(cwd)) || SOCKET_DEFAULT_BRANCH,
     commitMessage: '',
     commitHash: '',
     committers: '',
@@ -35,7 +38,7 @@ export async function handleCI(autoManifest: boolean): Promise<void> {
     // When 'pendingHead' is true, it requires 'branchName' set and 'tmp' false.
     pendingHead: true,
     pullRequest: 0,
-    repoName: (await getRepoName(cwd)) || 'socket-default-repository',
+    repoName: (await getRepoName(cwd)) || SOCKET_DEFAULT_REPOSITORY,
     readOnly: false,
     report: true,
     targets: ['.'],

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

@@ -20,7 +20,11 @@ import { detectManifestActions } from '../manifest/detect-manifest-actions.mts'
 
 import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
-const { DRY_RUN_BAILING_NOW } = constants
+const {
+  DRY_RUN_BAILING_NOW,
+  SOCKET_DEFAULT_BRANCH,
+  SOCKET_DEFAULT_REPOSITORY,
+} = constants
 
 const config: CliCommandConfig = {
   commandName: 'create',
@@ -256,15 +260,15 @@ async function run(
       branchName = sockJson.defaults.scan.create.branch
       logger.info('Using default --branch from socket.json:', branchName)
     } else {
-      branchName = (await gitBranch(cwd)) || 'socket-default-branch'
+      branchName = (await gitBranch(cwd)) || SOCKET_DEFAULT_BRANCH
     }
   }
   if (!repoName) {
     if (sockJson.defaults?.scan?.create?.repo) {
       repoName = sockJson.defaults.scan.create.repo
       logger.info('Using default --repo from socket.json:', repoName)
     } else {
-      repoName = (await getRepoName(cwd)) || 'socket-default-repository'
+      repoName = (await getRepoName(cwd)) || SOCKET_DEFAULT_REPOSITORY
     }
   }
   if (typeof report !== 'boolean') {

src/commands/scan/fetch-create-org-full-scan.mts

@@ -1,10 +1,13 @@
+import constants from '../../constants.mts'
 import { handleApiCall } from '../../utils/api.mts'
 import { getRepoName } from '../../utils/git.mts'
 import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SocketSdkReturnType } from '@socketsecurity/sdk'
 
+const { SOCKET_DEFAULT_REPOSITORY } = constants
+
 export async function fetchCreateOrgFullScan(
   packagePaths: string[],
   orgSlug: string,
@@ -33,7 +36,7 @@ export async function fetchCreateOrgFullScan(
     return sockSdkCResult
   }
   const sockSdk = sockSdkCResult.data
-  const repo = repoName || (await getRepoName(cwd)) || 'socket-default-repository'
+  const repo = repoName || (await getRepoName(cwd)) || SOCKET_DEFAULT_REPOSITORY
 
   return await handleApiCall(
     sockSdk.createOrgFullScan(

src/commands/scan/setup-scan-config.mts

@@ -14,6 +14,8 @@ import {
 
 import type { CResult } from '../../types.mts'
 
+const { SOCKET_DEFAULT_BRANCH, SOCKET_DEFAULT_REPOSITORY } = constants
+
 export async function setupScanConfig(
   cwd: string,
   defaultOnReadError = false,
@@ -136,15 +138,15 @@ async function configureScan(
     message:
       '(--repo) What repo name (slug) should be reported to Socket for this dir?',
     default:
-      config.repo || (await getRepoName(cwd)) || 'socket-default-repository',
+      config.repo || (await getRepoName(cwd)) || SOCKET_DEFAULT_REPOSITORY,
     required: false,
     // validate: async string => bool
   })
   if (defaultRepoName === undefined) {
     return canceledByUser()
   }
   if (defaultRepoName) {
-    // Even if it's 'socket-default-repository' store it because if we change
+    // Even if it's SOCKET_DEFAULT_REPOSITORY store it because if we change
     // this default then an existing user probably would not expect the change?
     config.repo = defaultRepoName
   } else {
@@ -154,15 +156,15 @@ async function configureScan(
   const defaultBranchName = await input({
     message:
       '(--branch) What branch name (slug) should be reported to Socket for this dir?',
-    default: config.branch || (await gitBranch(cwd)) || 'socket-default-branch',
+    default: config.branch || (await gitBranch(cwd)) || SOCKET_DEFAULT_BRANCH,
     required: false,
     // validate: async string => bool
   })
   if (defaultBranchName === undefined) {
     return canceledByUser()
   }
   if (defaultBranchName) {
-    // Even if it's 'socket-default-branch' store it because if we change
+    // Even if it's SOCKET_DEFAULT_BRANCH store it because if we change
     // this default then an existing user probably would not expect the change?
     config.branch = defaultBranchName
   } else {

src/constants.mts

@@ -132,6 +132,8 @@ type Constants = Remap<
     readonly SOCKET_CLI_SENTRY_NPX_BIN_NAME: 'socket-npx-with-sentry'
     readonly SOCKET_CLI_SENTRY_PACKAGE_NAME: '@socketsecurity/cli-with-sentry'
     readonly SOCKET_CLI_VIEW_ALL_RISKS: 'SOCKET_CLI_VIEW_ALL_RISKS'
+    readonly SOCKET_DEFAULT_BRANCH: 'socket-default-branch'
+    readonly SOCKET_DEFAULT_REPOSITORY: 'socket-default-repository'
     readonly SOCKET_WEBSITE_URL: 'https://socket.dev'
     readonly VLT: 'vlt'
     readonly WITH_SENTRY: 'with-sentry'
@@ -209,6 +211,8 @@ const SOCKET_CLI_SENTRY_NPM_BIN_NAME = 'socket-npm-with-sentry'
 const SOCKET_CLI_SENTRY_NPX_BIN_NAME = 'socket-npx-with-sentry'
 const SOCKET_CLI_SENTRY_PACKAGE_NAME = '@socketsecurity/cli-with-sentry'
 const SOCKET_CLI_VIEW_ALL_RISKS = 'SOCKET_CLI_VIEW_ALL_RISKS'
+const SOCKET_DEFAULT_BRANCH = 'socket-default-branch'
+const SOCKET_DEFAULT_REPOSITORY = 'socket-default-repository'
 const SOCKET_WEBSITE_URL = 'https://socket.dev'
 const VLT = 'vlt'
 const WITH_SENTRY = 'with-sentry'
@@ -607,6 +611,8 @@ const constants: Constants = createConstantsObject(
     SOCKET_CLI_SENTRY_NPX_BIN_NAME,
     SOCKET_CLI_SENTRY_PACKAGE_NAME,
     SOCKET_CLI_VIEW_ALL_RISKS,
+    SOCKET_DEFAULT_BRANCH,
+    SOCKET_DEFAULT_REPOSITORY,
     SOCKET_WEBSITE_URL,
     VLT,
     WITH_SENTRY,