Skip to content

Commit 34cc9fe

Browse files
committed
Tweak npm/npx command descriptions
1 parent b4a347b commit 34cc9fe

File tree

8 files changed

+36
-50
lines changed

8 files changed

+36
-50
lines changed

src/commands/npm/cmd-npm.mts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,14 @@ async function run(
4444
API Token Requirements
4545
${getFlagApiRequirementsOutput(`${parentName}:${CMD_NAME}`)}
4646
47-
Run npm with packages installs gated through the Socket API.
48-
See docs for more details.
49-
50-
Note: Everything after "npm" is sent straight to the npm command.
51-
Only the \`--dryRun\` and \`--help\` flags are caught here.
47+
Note: Everything after "npm" is passed to the npm command.
48+
Only the \`--dry-run\` and \`--help\` flags are caught here.
5249
5350
Use \`socket wrapper on\` to alias this command as \`npm\`.
5451
5552
Examples
5653
$ ${command}
57-
$ ${command} install -g socket
54+
$ ${command} install -g cowsay
5855
`,
5956
}
6057

src/commands/npm/cmd-npm.test.mts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,14 @@ describe('socket npm', async () => {
2323
- Quota: 100 units
2424
- Permissions: packages:list
2525
26-
Run npm with packages installs gated through the Socket API.
27-
See docs for more details.
28-
29-
Note: Everything after "npm" is sent straight to the npm command.
30-
Only the \`--dryRun\` and \`--help\` flags are caught here.
26+
Note: Everything after "npm" is passed to the npm command.
27+
Only the \`--dry-run\` and \`--help\` flags are caught here.
3128
3229
Use \`socket wrapper on\` to alias this command as \`npm\`.
3330
3431
Examples
3532
$ socket npm
36-
$ socket npm install -g socket"
33+
$ socket npm install -g cowsay"
3734
`,
3835
)
3936
expect(`\n ${stderr}`).toMatchInlineSnapshot(`

src/commands/npx/cmd-npx.mts

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,13 @@ async function run(
4444
API Token Requirements
4545
${getFlagApiRequirementsOutput(`${parentName}:${CMD_NAME}`)}
4646
47-
Run npx with packages installs gated through the Socket API.
48-
See docs for more details.
49-
50-
Note: Everything after "npx" is sent straight to the npx command.
51-
Only the \`--dryRun\` and \`--help\` flags are caught here.
47+
Note: Everything after "npx" is passed to the npx command.
48+
Only the \`--dry-run\` and \`--help\` flags are caught here.
5249
5350
Use \`socket wrapper on\` to alias this command as \`npx\`.
5451
5552
Examples
56-
$ ${command}
57-
$ ${command} prettier
53+
$ ${command} cowsay
5854
`,
5955
}
6056

src/commands/npx/cmd-npx.test.mts

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,13 @@ describe('socket npx', async () => {
2323
- Quota: 100 units
2424
- Permissions: packages:list
2525
26-
Run npx with packages installs gated through the Socket API.
27-
See docs for more details.
28-
29-
Note: Everything after "npx" is sent straight to the npx command.
30-
Only the \`--dryRun\` and \`--help\` flags are caught here.
26+
Note: Everything after "npx" is passed to the npx command.
27+
Only the \`--dry-run\` and \`--help\` flags are caught here.
3128
3229
Use \`socket wrapper on\` to alias this command as \`npx\`.
3330
3431
Examples
35-
$ socket npx
36-
$ socket npx prettier"
32+
$ socket npx cowsay"
3733
`,
3834
)
3935
expect(`\n ${stderr}`).toMatchInlineSnapshot(`

src/commands/raw-npm/cmd-raw-npm.mts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ const config: CliCommandConfig = {
2020
Usage
2121
$ ${command} ...
2222
23-
This does the opposite of \`socket npm\`: it will execute the real \`npm\`
24-
command without Socket. This can be useful when you have the wrapper on
25-
and want to install a certain package anyways. Use at your own risk.
23+
Execute \`npm\` without gating installs through the Socket API.
24+
Useful when \`socket wrapper on\` is enabled and you want to bypass
25+
the Socket wrapper. Use at your own risk.
2626
27-
Note: Everything after "raw-npm" is sent straight to the npm command.
28-
Only the \`--dryRun\` and \`--help\` flags are caught here.
27+
Note: Everything after "raw-npm" is passed to the npm command.
28+
Only the \`--dry-run\` and \`--help\` flags are caught here.
2929
3030
Examples
31-
$ ${command} install -g socket
31+
$ ${command} install -g cowsay
3232
`,
3333
}
3434

src/commands/raw-npm/cmd-raw-npm.test.mts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ describe('socket raw-npm', async () => {
1919
Usage
2020
$ socket raw-npm ...
2121
22-
This does the opposite of \`socket npm\`: it will execute the real \`npm\`
23-
command without Socket. This can be useful when you have the wrapper on
24-
and want to install a certain package anyways. Use at your own risk.
22+
Execute \`npm\` without gating installs through the Socket API.
23+
Useful when \`socket wrapper on\` is enabled and you want to bypass
24+
the Socket wrapper. Use at your own risk.
2525
26-
Note: Everything after "raw-npm" is sent straight to the npm command.
27-
Only the \`--dryRun\` and \`--help\` flags are caught here.
26+
Note: Everything after "raw-npm" is passed to the npm command.
27+
Only the \`--dry-run\` and \`--help\` flags are caught here.
2828
2929
Examples
30-
$ socket raw-npm install -g socket"
30+
$ socket raw-npm install -g cowsay"
3131
`,
3232
)
3333
expect(`\n ${stderr}`).toMatchInlineSnapshot(`

src/commands/raw-npx/cmd-raw-npx.mts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ const config: CliCommandConfig = {
2020
Usage
2121
$ ${command} ...
2222
23-
This does the opposite of \`socket npx\`: it will execute the real \`npx\`
24-
command without Socket. This can be useful when you have the wrapper on
25-
and want to run a certain package anyways. Use at your own risk.
23+
Execute \`npx\` without gating installs through the Socket API.
24+
Useful when \`socket wrapper on\` is enabled and you want to bypass
25+
the Socket wrapper. Use at your own risk.
2626
27-
Note: Everything after "raw-npx" is sent straight to the npx command.
28-
Only the \`--dryRun\` and \`--help\` flags are caught here.
27+
Note: Everything after "raw-npx" is passed to the npx command.
28+
Only the \`--dry-run\` and \`--help\` flags are caught here.
2929
3030
Examples
31-
$ ${command} prettier
31+
$ ${command} cowsay
3232
`,
3333
}
3434

src/commands/raw-npx/cmd-raw-npx.test.mts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ describe('socket raw-npx', async () => {
1919
Usage
2020
$ socket raw-npx ...
2121
22-
This does the opposite of \`socket npx\`: it will execute the real \`npx\`
23-
command without Socket. This can be useful when you have the wrapper on
24-
and want to run a certain package anyways. Use at your own risk.
22+
Execute \`npx\` without gating installs through the Socket API.
23+
Useful when \`socket wrapper on\` is enabled and you want to bypass
24+
the Socket wrapper. Use at your own risk.
2525
26-
Note: Everything after "raw-npx" is sent straight to the npx command.
27-
Only the \`--dryRun\` and \`--help\` flags are caught here.
26+
Note: Everything after "raw-npx" is passed to the npx command.
27+
Only the \`--dry-run\` and \`--help\` flags are caught here.
2828
2929
Examples
30-
$ socket raw-npx prettier"
30+
$ socket raw-npx cowsay"
3131
`,
3232
)
3333
expect(`\n ${stderr}`).toMatchInlineSnapshot(`

0 commit comments

Comments
 (0)