Skip to content

Commit a7c7bde

Browse files
committed
Move socket wrapper npm/npx env vars closer together
1 parent 72fd0d0 commit a7c7bde

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ use of the `projectIgnorePaths` to excludes files when creating a report.
6161

6262
## Environment variables
6363

64-
- `SOCKET_CLI_ACCEPT_RISKS` - Accept risks of a safe-npm or safe-npx run
6564
- `SOCKET_CLI_API_TOKEN` - Set the Socket API token
6665
- `SOCKET_CLI_CONFIG` - A JSON stringified Socket configuration object
6766
- `SOCKET_CLI_GIT_USER_EMAIL` - The git config `user.email` used by Socket CLI<br>
@@ -72,8 +71,9 @@ use of the `projectIgnorePaths` to excludes files when creating a report.
7271
*Aliases:* `GITHUB_TOKEN`<br>
7372
- `SOCKET_CLI_NO_API_TOKEN` - Make the default API token `undefined`
7473
- `SOCKET_CLI_NPM_PATH` - The absolute location of the npm directory
75-
- `SOCKET_CLI_ORG_SLUG` - Specify the Socket organization slug
76-
- `SOCKET_CLI_VIEW_ALL_RISKS` - View all risks of a safe-npm or safe-npx run
74+
- `SOCKET_CLI_ORG_SLUG` - Specify the Socket organization slug<br><br>
75+
- `SOCKET_CLI_ACCEPT_RISKS` - Accept risks of a Socket wrapped npm/npx run
76+
- `SOCKET_CLI_VIEW_ALL_RISKS` - View all risks of a Socket wrapped npm/npx run
7777

7878
## Contributing
7979

src/commands/cli.test.mts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ describe('socket root command', async () => {
6262
--version Print the app version
6363
6464
Environment variables
65-
SOCKET_CLI_ACCEPT_RISKS Accept risks of a safe-npm or safe-npx run
6665
SOCKET_CLI_API_TOKEN Set the Socket API token
6766
SOCKET_CLI_CONFIG A JSON stringified Socket configuration object
6867
SOCKET_CLI_GIT_USER_EMAIL The git config \`user.email\` used by Socket CLI
@@ -74,7 +73,9 @@ describe('socket root command', async () => {
7473
SOCKET_CLI_NO_API_TOKEN Make the default API token \`undefined\`
7574
SOCKET_CLI_NPM_PATH The absolute location of the npm directory
7675
SOCKET_CLI_ORG_SLUG Specify the Socket organization slug
77-
SOCKET_CLI_VIEW_ALL_RISKS View all risks of a safe-npm or safe-npx run
76+
77+
SOCKET_CLI_ACCEPT_RISKS Accept risks of a Socket wrapped npm/npx run
78+
SOCKET_CLI_VIEW_ALL_RISKS View all risks of a Socket wrapped npm/npx run
7879
7980
Environment variables for development
8081
SOCKET_CLI_API_BASE_URL Change the base URL for all API-calls

src/constants.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ const LAZY_ENV = () => {
340340
// programs are located. When a command is run, the system searches these
341341
// directories to find the executable.
342342
PATH: envAsString(env['PATH']),
343-
// Accept risks of a safe-npm and safe-npx run.
343+
// Accept risks of a Socket wrapped npm/npx run.
344344
SOCKET_CLI_ACCEPT_RISKS: envAsBoolean(env[SOCKET_CLI_ACCEPT_RISKS]),
345345
// Change the base URL for all API-calls.
346346
// https://github.com/SocketDev/socket-cli?tab=readme-ov-file#environment-variables-for-development
@@ -395,7 +395,7 @@ const LAZY_ENV = () => {
395395
envAsString(env['SOCKET_CLI_ORG_SLUG']) ||
396396
// Coana CLI accepts the SOCKET_ORG_SLUG environment variable.
397397
envAsString(env['SOCKET_ORG_SLUG']),
398-
// View all risks of a safe-npm and safe-npx run.
398+
// View all risks of a Socket wrapped npm/npx run.
399399
SOCKET_CLI_VIEW_ALL_RISKS: envAsBoolean(env[SOCKET_CLI_VIEW_ALL_RISKS]),
400400
// Specifies the type of terminal or terminal emulator being used by the process.
401401
TERM: envAsString(env['TERM']),

src/utils/meow-with-subcommands.mts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,6 @@ export async function meowWithSubcommands(
399399
lines.push(
400400
'',
401401
'Environment variables',
402-
' SOCKET_CLI_ACCEPT_RISKS Accept risks of a safe-npm or safe-npx run',
403402
' SOCKET_CLI_API_TOKEN Set the Socket API token',
404403
' SOCKET_CLI_CONFIG A JSON stringified Socket configuration object',
405404
' SOCKET_CLI_GIT_USER_EMAIL The git config `user.email` used by Socket CLI',
@@ -411,7 +410,9 @@ export async function meowWithSubcommands(
411410
' SOCKET_CLI_NO_API_TOKEN Make the default API token `undefined`',
412411
' SOCKET_CLI_NPM_PATH The absolute location of the npm directory',
413412
' SOCKET_CLI_ORG_SLUG Specify the Socket organization slug',
414-
' SOCKET_CLI_VIEW_ALL_RISKS View all risks of a safe-npm or safe-npx run',
413+
'',
414+
' SOCKET_CLI_ACCEPT_RISKS Accept risks of a Socket wrapped npm/npx run',
415+
' SOCKET_CLI_VIEW_ALL_RISKS View all risks of a Socket wrapped npm/npx run',
415416
'',
416417
'Environment variables for development',
417418
' SOCKET_CLI_API_BASE_URL Change the base URL for all API-calls',

0 commit comments

Comments
 (0)