Skip to content

Commit 1fe9d1b

Browse files
jdaltonjdalton
committed
Move package-environment, add cmdPrefixMessage, and wirteup cmdName params
1 parent 2255153 commit 1fe9d1b

16 files changed

+128
-100
lines changed

‎src/cli.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ import constants from './constants'
3636
import { AuthError, InputError, captureException } from './utils/errors'
3737
import { meowWithSubcommands } from './utils/meow-with-subcommands'
3838

39-
const { SOCKET, rootPkgJsonPath } = constants
39+
const { SOCKET_CLI_BIN_NAME, rootPkgJsonPath } = constants
4040

4141
// TODO: Add autocompletion using https://socket.dev/npm/package/omelette
4242
void (async () => {
4343
await updateNotifier({
44-
name: SOCKET,
44+
name: SOCKET_CLI_BIN_NAME,
4545
version: require(rootPkgJsonPath).version,
4646
ttl: 86_400_000 /* 24 hours in milliseconds */
4747
})
@@ -81,7 +81,7 @@ void (async () => {
8181
}
8282
},
8383
argv: process.argv.slice(2),
84-
name: SOCKET,
84+
name: SOCKET_CLI_BIN_NAME,
8585
importMeta: { url: `${pathToFileURL(__filename)}` } as ImportMeta
8686
}
8787
)
@@ -105,7 +105,7 @@ void (async () => {
105105
errorTitle = 'Unexpected error with no details'
106106
}
107107
logger.fail(
108-
`${colors.bgRed(colors.white(errorTitle + ':'))} ${errorMessage}`
108+
`${colors.bgRed(colors.white(`${errorTitle}:`))} ${errorMessage}`
109109
)
110110
if (errorBody) {
111111
logger.error(`\n${errorBody}`)

‎src/commands/fix/npm-fix.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import {
1919
import { getCveInfoByAlertsMap } from '../../utils/socket-package-alert'
2020

2121
import type { SafeNode } from '../../shadow/npm/arborist/lib/node'
22-
import type { EnvDetails } from '../../utils/package-environment-detector'
22+
import type { EnvDetails } from '../../utils/package-environment'
2323
import type { Spinner } from '@socketsecurity/registry/lib/spinner'
2424

2525
const { NPM } = constants

‎src/commands/fix/pnpm-fix.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { getAlertsMapFromPnpmLockfile } from '../../utils/lockfile/pnpm-lock-yam
1919
import { getCveInfoByAlertsMap } from '../../utils/socket-package-alert'
2020
import { runAgentInstall } from '../optimize/run-agent'
2121

22-
import type { EnvDetails } from '../../utils/package-environment-detector'
22+
import type { EnvDetails } from '../../utils/package-environment'
2323
import type { Spinner } from '@socketsecurity/registry/lib/spinner'
2424

2525
const { NPM, OVERRIDES, PNPM } = constants

‎src/commands/fix/run-fix.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ import { logger } from '@socketsecurity/registry/lib/logger'
33
import { npmFix } from './npm-fix'
44
import { pnpmFix } from './pnpm-fix'
55
import constants from '../../constants'
6-
import { detectAndValidatePackageEnvironment } from '../optimize/detect-and-validate-package-environment'
6+
import { detectAndValidatePackageEnvironment } from '../../utils/package-environment'
77

88
const { NPM, PNPM } = constants
99

10+
const CMD_NAME = 'socket fix'
11+
1012
export async function runFix() {
1113
// Lazily access constants.spinner.
1214
const { spinner } = constants
@@ -16,6 +18,7 @@ export async function runFix() {
1618
const cwd = process.cwd()
1719

1820
const pkgEnvDetails = await detectAndValidatePackageEnvironment(cwd, {
21+
cmdName: CMD_NAME,
1922
logger
2023
})
2124
if (!pkgEnvDetails) {

‎src/commands/optimize/apply-optimization.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import { Spinner } from '@socketsecurity/registry/lib/spinner'
1616
import { pluralize } from '@socketsecurity/registry/lib/words'
1717

1818
import { depsIncludesByAgent } from './deps-includes-by-agent'
19-
import { detectAndValidatePackageEnvironment } from './detect-and-validate-package-environment'
2019
import { getDependencyEntries } from './get-dependency-entries'
2120
import { overridesDataByAgent } from './get-overrides-by-agent'
2221
import { getWorkspaceGlobs } from './get-workspace-globs'
@@ -25,13 +24,15 @@ import { lsByAgent } from './ls-by-agent'
2524
import { updateLockfile } from './update-lockfile'
2625
import { updateManifestByAgent } from './update-manifest-by-agent'
2726
import constants from '../../constants'
27+
import { cmdPrefixMessage } from '../../utils/cmd'
28+
import { detectAndValidatePackageEnvironment } from '../../utils/package-environment'
2829

2930
import type { AgentLockIncludesFn } from './lockfile-includes-by-agent'
3031
import type {
3132
Agent,
3233
EnvDetails,
3334
StringKeyValueObject
34-
} from '../../utils/package-environment-detector'
35+
} from '../../utils/package-environment'
3536
import type { Logger } from '@socketsecurity/registry/lib/logger'
3637

3738
type AddOverridesOptions = {
@@ -56,7 +57,7 @@ type Overrides = NpmOverrides | PnpmOrYarnOverrides
5657

5758
const { NPM, PNPM, YARN_CLASSIC } = constants
5859

59-
const COMMAND_TITLE = 'Socket Optimize'
60+
const CMD_NAME = 'socket optimize'
6061

6162
const manifestNpmOverrides = getManifestData(NPM)
6263

@@ -104,7 +105,10 @@ async function addOverrides(
104105
) {
105106
state.warnedPnpmWorkspaceRequiresNpm = true
106107
logger?.warn(
107-
`${COMMAND_TITLE}: pnpm workspace support requires \`npm ls\`, falling back to \`pnpm list\``
108+
cmdPrefixMessage(
109+
CMD_NAME,
110+
'pnpm workspace support requires `npm ls`, falling back to `pnpm list`'
111+
)
108112
)
109113
}
110114
const thingToScan = isLockScanned
@@ -294,6 +298,7 @@ export async function applyOptimization(
294298
prod: boolean
295299
) {
296300
const pkgEnvDetails = await detectAndValidatePackageEnvironment(cwd, {
301+
cmdName: CMD_NAME,
297302
logger,
298303
prod
299304
})
@@ -335,6 +340,6 @@ export async function applyOptimization(
335340
if (pkgEnvDetails.agent === NPM || pkgJsonChanged) {
336341
// Always update package-lock.json until the npm overrides PR lands:
337342
// https://github.com/npm/cli/pull/8089
338-
await updateLockfile(pkgEnvDetails, { logger, spinner })
343+
await updateLockfile(pkgEnvDetails, { cmdName: CMD_NAME, logger, spinner })
339344
}
340345
}

‎src/commands/optimize/deps-includes-by-agent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import constants from '../../constants'
22

3-
import type { Agent } from '../../utils/package-environment-detector'
3+
import type { Agent } from '../../utils/package-environment'
44

55
type AgentDepsIncludesFn = (stdout: string, name: string) => boolean
66

‎src/commands/optimize/detect-and-validate-package-environment.ts

Lines changed: 0 additions & 73 deletions
This file was deleted.

‎src/commands/optimize/get-overrides-by-agent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import constants from '../../constants'
55
import type {
66
Agent,
77
StringKeyValueObject
8-
} from '../../utils/package-environment-detector'
8+
} from '../../utils/package-environment'
99

1010
type PackageJson = Awaited<ReturnType<typeof readPackageJson>>
1111
type NpmOverrides = { [key: string]: string | StringKeyValueObject }

‎src/commands/optimize/get-workspace-globs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { isNonEmptyString } from '@socketsecurity/registry/lib/strings'
88
import constants from '../../constants'
99
import { safeReadFile } from '../../utils/fs'
1010

11-
import type { Agent } from '../../utils/package-environment-detector'
11+
import type { Agent } from '../../utils/package-environment'
1212

1313
type PackageJson = Awaited<ReturnType<typeof readPackageJson>>
1414

‎src/commands/optimize/lockfile-includes-by-agent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { escapeRegExp } from '@socketsecurity/registry/lib/regexps'
22

33
import constants from '../../constants'
44

5-
import type { Agent } from '../../utils/package-environment-detector'
5+
import type { Agent } from '../../utils/package-environment'
66

77
export type AgentLockIncludesFn = (
88
lockSrc: string,

0 commit comments

Comments
 (0)