Skip to content

Commit 148802e

Browse files
zimegClaude
andcommitted
refactor(cli-test): rename env add/remove to env set/unset
Aligns with Slack CLI rename of `env add` → `env set` and `env remove` → `env unset` from slackapi/slack-cli#460. - Rename `SLACK_TRACE_ENV_ADD_SUCCESS` → `SLACK_TRACE_ENV_SET_SUCCESS` - Rename `SLACK_TRACE_ENV_REMOVE_SUCCESS` → `SLACK_TRACE_ENV_UNSET_SUCCESS` - Rename exported `add`/`remove` functions to `set`/`unset` - Update tests and regenerate docs Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
1 parent 909b5bd commit 148802e

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

docs/english/reference/cli-test/variables/SlackCLI.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -328,53 +328,53 @@ command output
328328
env: object;
329329
```
330330

331-
#### env.add()
331+
#### env.list()
332332

333333
```ts
334-
add: (args) => Promise<string>;
334+
list: (args) => Promise<string>;
335335
```
336336

337-
`slack env add`
337+
`slack env list`
338338

339339
##### Parameters
340340

341341
###### args
342342

343-
`ProjectCommandArguments` & `EnvCommandArguments`
343+
`ProjectCommandArguments`
344344

345345
##### Returns
346346

347347
`Promise`\<`string`\>
348348

349349
command output
350350

351-
#### env.list()
351+
#### env.set()
352352

353353
```ts
354-
list: (args) => Promise<string>;
354+
set: (args) => Promise<string>;
355355
```
356356

357-
`slack env list`
357+
`slack env set`
358358

359359
##### Parameters
360360

361361
###### args
362362

363-
`ProjectCommandArguments`
363+
`ProjectCommandArguments` & `EnvCommandArguments`
364364

365365
##### Returns
366366

367367
`Promise`\<`string`\>
368368

369369
command output
370370

371-
#### env.remove()
371+
#### env.unset()
372372

373373
```ts
374-
remove: (args) => Promise<string>;
374+
unset: (args) => Promise<string>;
375375
```
376376

377-
`slack env remove`
377+
`slack env unset`
378378

379379
##### Parameters
380380

docs/english/reference/cli-test/variables/SlackTracerId.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,6 @@ SLACK_TRACE_DATASTORE_COUNT_SUCCESS: string = 'SLACK_TRACE_DATASTORE_COUNT_SUCCE
192192
SLACK_TRACE_DATASTORE_COUNT_TOTAL: string = 'SLACK_TRACE_DATASTORE_COUNT_TOTAL';
193193
```
194194

195-
### SLACK\_TRACE\_ENV\_ADD\_SUCCESS
196-
197-
```ts
198-
SLACK_TRACE_ENV_ADD_SUCCESS: string = 'SLACK_TRACE_ENV_ADD_SUCCESS';
199-
```
200-
201195
### SLACK\_TRACE\_ENV\_LIST\_COUNT
202196

203197
```ts
@@ -210,10 +204,16 @@ SLACK_TRACE_ENV_LIST_COUNT: string = 'SLACK_TRACE_ENV_LIST_COUNT';
210204
SLACK_TRACE_ENV_LIST_VARIABLES: string = 'SLACK_TRACE_ENV_LIST_VARIABLES';
211205
```
212206

213-
### SLACK\_TRACE\_ENV\_REMOVE\_SUCCESS
207+
### SLACK\_TRACE\_ENV\_SET\_SUCCESS
208+
209+
```ts
210+
SLACK_TRACE_ENV_SET_SUCCESS: string = 'SLACK_TRACE_ENV_SET_SUCCESS';
211+
```
212+
213+
### SLACK\_TRACE\_ENV\_UNSET\_SUCCESS
214214

215215
```ts
216-
SLACK_TRACE_ENV_REMOVE_SUCCESS: string = 'SLACK_TRACE_ENV_REMOVE_SUCCESS';
216+
SLACK_TRACE_ENV_UNSET_SUCCESS: string = 'SLACK_TRACE_ENV_UNSET_SUCCESS';
217217
```
218218

219219
### SLACK\_TRACE\_FEEDBACK\_MESSAGE

packages/cli-test/src/cli/commands/env.test.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ describe('env commands', () => {
2424
sandbox.restore();
2525
});
2626

27-
describe('add method', () => {
28-
it('should invoke `env add <key> <value>`', async () => {
29-
await env.add({ appPath: '/some/path', secretKey: 'key', secretValue: 'value' });
27+
describe('set method', () => {
28+
it('should invoke `env set <key> <value>`', async () => {
29+
await env.set({ appPath: '/some/path', secretKey: 'key', secretValue: 'value' });
3030
sandbox.assert.calledWith(
3131
spawnSpy,
3232
sinon.match.string,
33-
sinon.match.array.contains(['env', 'add', 'key', 'value']),
33+
sinon.match.array.contains(['env', 'set', 'key', 'value']),
3434
);
3535
});
3636
});
@@ -40,10 +40,10 @@ describe('env commands', () => {
4040
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['env', 'list']));
4141
});
4242
});
43-
describe('remove method', () => {
44-
it('should invoke `env remove <key>`', async () => {
45-
await env.remove({ appPath: '/some/path', secretKey: 'key' });
46-
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['env', 'remove', 'key']));
43+
describe('unset method', () => {
44+
it('should invoke `env unset <key>`', async () => {
45+
await env.unset({ appPath: '/some/path', secretKey: 'key' });
46+
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['env', 'unset', 'key']));
4747
});
4848
});
4949
});

packages/cli-test/src/cli/commands/env.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ export interface EnvCommandArguments {
99
}
1010

1111
/**
12-
* `slack env add`
12+
* `slack env set`
1313
* @returns command output
1414
*/
15-
export const add = async function envAdd(args: ProjectCommandArguments & EnvCommandArguments): Promise<string> {
16-
const cmd = new SlackCLIProcess(['env', 'add', args.secretKey, args.secretValue], args);
15+
export const set = async function envSet(args: ProjectCommandArguments & EnvCommandArguments): Promise<string> {
16+
const cmd = new SlackCLIProcess(['env', 'set', args.secretKey, args.secretValue], args);
1717
const proc = await cmd.execAsync({
1818
cwd: args.appPath,
1919
});
@@ -33,21 +33,21 @@ export const list = async function envList(args: ProjectCommandArguments): Promi
3333
};
3434

3535
/**
36-
* `slack env remove`
36+
* `slack env unset`
3737
* @returns command output
3838
*/
39-
export const remove = async function envRemove(
39+
export const unset = async function envUnset(
4040
args: ProjectCommandArguments & Pick<EnvCommandArguments, 'secretKey'>,
4141
): Promise<string> {
42-
const cmd = new SlackCLIProcess(['env', 'remove', args.secretKey], args);
42+
const cmd = new SlackCLIProcess(['env', 'unset', args.secretKey], args);
4343
const proc = await cmd.execAsync({
4444
cwd: args.appPath,
4545
});
4646
return proc.output;
4747
};
4848

4949
export default {
50-
add,
50+
set,
5151
list,
52-
remove,
52+
unset,
5353
};

packages/cli-test/src/utils/constants.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ export const SlackTracerId = {
3333
SLACK_TRACE_DATASTORE_COUNT_DATASTORE: 'SLACK_TRACE_DATASTORE_COUNT_DATASTORE',
3434
SLACK_TRACE_DATASTORE_COUNT_SUCCESS: 'SLACK_TRACE_DATASTORE_COUNT_SUCCESS',
3535
SLACK_TRACE_DATASTORE_COUNT_TOTAL: 'SLACK_TRACE_DATASTORE_COUNT_TOTAL',
36-
SLACK_TRACE_ENV_ADD_SUCCESS: 'SLACK_TRACE_ENV_ADD_SUCCESS',
36+
SLACK_TRACE_ENV_SET_SUCCESS: 'SLACK_TRACE_ENV_SET_SUCCESS',
3737
SLACK_TRACE_ENV_LIST_COUNT: 'SLACK_TRACE_ENV_LIST_COUNT',
3838
SLACK_TRACE_ENV_LIST_VARIABLES: 'SLACK_TRACE_ENV_LIST_VARIABLES',
39-
SLACK_TRACE_ENV_REMOVE_SUCCESS: 'SLACK_TRACE_ENV_REMOVE_SUCCESS',
39+
SLACK_TRACE_ENV_UNSET_SUCCESS: 'SLACK_TRACE_ENV_UNSET_SUCCESS',
4040
SLACK_TRACE_FEEDBACK_MESSAGE: 'SLACK_TRACE_FEEDBACK_MESSAGE',
4141
SLACK_TRACE_MANIFEST_VALIDATE_SUCCESS: 'SLACK_TRACE_MANIFEST_VALIDATE_SUCCESS',
4242
SLACK_TRACE_PLATFORM_DEPLOY_SUCCESS: 'SLACK_TRACE_PLATFORM_DEPLOY_SUCCESS',

0 commit comments

Comments
 (0)