diff --git a/.changeset/eleven-apples-retire.md b/.changeset/eleven-apples-retire.md deleted file mode 100644 index a442b4ad1..000000000 --- a/.changeset/eleven-apples-retire.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/cli-hooks": patch ---- - -refactor(cli-hooks): use optional chaining check to gather project dependencies diff --git a/.changeset/fiery-sheep-wear.md b/.changeset/fiery-sheep-wear.md deleted file mode 100644 index e552e4f43..000000000 --- a/.changeset/fiery-sheep-wear.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -"@slack/cli-test": major ---- - -refactor(cli-test)!: rename env add/remove to env set/unset - -The Slack CLI v4.0.0 release changes the `env` commands to prefer `set` and `unset` aliases and the test tracers of this package were changed to match: - -```diff -- SLACK_TRACE_ENV_ADD_SUCCESS -- SLACK_TRACE_ENV_REMOVE_SUCCESS -+ SLACK_TRACE_ENV_SET_SUCCESS -+ SLACK_TRACE_ENV_UNSET_SUCCESS -``` diff --git a/.changeset/four-ads-hide.md b/.changeset/four-ads-hide.md deleted file mode 100644 index 88d56c864..000000000 --- a/.changeset/four-ads-hide.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -"@slack/cli-test": major ---- - -refactor(cli-test)!: move 'create' to 'project create' - -Before the Slack CLI v4.0.0 release, the `create` command became a `project` subcommand while remaining aliased the same. This project now prefers: - -```js -const createOutput = await SlackCLI.project.create({ - template: "slack-samples/bolt-js-starter-template", - appPath, - verbose: true, -}); -``` - -But continues to run the `slack create` command for confidence in getting started guides. diff --git a/docs/english/reference/cli-test/index.md b/docs/english/reference/cli-test/index.md index 9c0ef5369..c73c6938f 100644 --- a/docs/english/reference/cli-test/index.md +++ b/docs/english/reference/cli-test/index.md @@ -1,4 +1,4 @@ -# @slack/cli-test v2.2.2 +# @slack/cli-test v3.0.0 ## Classes diff --git a/docs/english/reference/cli-test/variables/SlackCLI.md b/docs/english/reference/cli-test/variables/SlackCLI.md index 3eeed5b77..06e596ef5 100644 --- a/docs/english/reference/cli-test/variables/SlackCLI.md +++ b/docs/english/reference/cli-test/variables/SlackCLI.md @@ -216,26 +216,6 @@ remove: (args) => Promise; command output -### create() - -```ts -create: (args) => Promise; -``` - -`slack create` - -#### Parameters - -##### args - -`ProjectCommandArguments` & `object` - -#### Returns - -`Promise`\<`string`\> - -command output - ### datastore ```ts @@ -328,19 +308,19 @@ command output env: object; ``` -#### env.add() +#### env.list() ```ts -add: (args) => Promise; +list: (args) => Promise; ``` -`slack env add` +`slack env list` ##### Parameters ###### args -`ProjectCommandArguments` & `EnvCommandArguments` +`ProjectCommandArguments` ##### Returns @@ -348,19 +328,19 @@ add: (args) => Promise; command output -#### env.list() +#### env.set() ```ts -list: (args) => Promise; +set: (args) => Promise; ``` -`slack env list` +`slack env set` ##### Parameters ###### args -`ProjectCommandArguments` +`ProjectCommandArguments` & `EnvCommandArguments` ##### Returns @@ -368,13 +348,13 @@ list: (args) => Promise; command output -#### env.remove() +#### env.unset() ```ts -remove: (args) => Promise; +unset: (args) => Promise; ``` -`slack env remove` +`slack env unset` ##### Parameters @@ -672,6 +652,32 @@ stop `slack run` `Promise`\<`void`\> +### project + +```ts +project: object; +``` + +#### project.create() + +```ts +create: (args) => Promise; +``` + +`slack create` + +##### Parameters + +###### args + +`ProjectCommandArguments` & `object` + +##### Returns + +`Promise`\<`string`\> + +command output + ### stopSession() ```ts diff --git a/docs/english/reference/cli-test/variables/SlackTracerId.md b/docs/english/reference/cli-test/variables/SlackTracerId.md index f5eef452d..2e9647f4e 100644 --- a/docs/english/reference/cli-test/variables/SlackTracerId.md +++ b/docs/english/reference/cli-test/variables/SlackTracerId.md @@ -192,12 +192,6 @@ SLACK_TRACE_DATASTORE_COUNT_SUCCESS: string = 'SLACK_TRACE_DATASTORE_COUNT_SUCCE SLACK_TRACE_DATASTORE_COUNT_TOTAL: string = 'SLACK_TRACE_DATASTORE_COUNT_TOTAL'; ``` -### SLACK\_TRACE\_ENV\_ADD\_SUCCESS - -```ts -SLACK_TRACE_ENV_ADD_SUCCESS: string = 'SLACK_TRACE_ENV_ADD_SUCCESS'; -``` - ### SLACK\_TRACE\_ENV\_LIST\_COUNT ```ts @@ -210,10 +204,16 @@ SLACK_TRACE_ENV_LIST_COUNT: string = 'SLACK_TRACE_ENV_LIST_COUNT'; SLACK_TRACE_ENV_LIST_VARIABLES: string = 'SLACK_TRACE_ENV_LIST_VARIABLES'; ``` -### SLACK\_TRACE\_ENV\_REMOVE\_SUCCESS +### SLACK\_TRACE\_ENV\_SET\_SUCCESS + +```ts +SLACK_TRACE_ENV_SET_SUCCESS: string = 'SLACK_TRACE_ENV_SET_SUCCESS'; +``` + +### SLACK\_TRACE\_ENV\_UNSET\_SUCCESS ```ts -SLACK_TRACE_ENV_REMOVE_SUCCESS: string = 'SLACK_TRACE_ENV_REMOVE_SUCCESS'; +SLACK_TRACE_ENV_UNSET_SUCCESS: string = 'SLACK_TRACE_ENV_UNSET_SUCCESS'; ``` ### SLACK\_TRACE\_FEEDBACK\_MESSAGE diff --git a/packages/cli-hooks/CHANGELOG.md b/packages/cli-hooks/CHANGELOG.md index 837dd1baf..9e1dde51a 100644 --- a/packages/cli-hooks/CHANGELOG.md +++ b/packages/cli-hooks/CHANGELOG.md @@ -1,5 +1,11 @@ # @slack/cli-hooks +## 1.3.2 + +### Patch Changes + +- 1a6c510: refactor(cli-hooks): use optional chaining check to gather project dependencies + ## 1.3.1 ### Patch Changes diff --git a/packages/cli-hooks/package.json b/packages/cli-hooks/package.json index 7e8117065..77cdfb43b 100644 --- a/packages/cli-hooks/package.json +++ b/packages/cli-hooks/package.json @@ -1,6 +1,6 @@ { "name": "@slack/cli-hooks", - "version": "1.3.1", + "version": "1.3.2", "description": "Node implementation of the contract between the Slack CLI and Bolt for JavaScript", "author": "Slack Technologies, LLC", "license": "MIT", diff --git a/packages/cli-test/CHANGELOG.md b/packages/cli-test/CHANGELOG.md index 0cea9535b..5a69885ee 100644 --- a/packages/cli-test/CHANGELOG.md +++ b/packages/cli-test/CHANGELOG.md @@ -1,5 +1,34 @@ # @slack/cli-test +## 3.0.0 + +### Major Changes + +- d2b7a89: refactor(cli-test)!: rename env add/remove to env set/unset + + The Slack CLI v4.0.0 release changes the `env` commands to prefer `set` and `unset` aliases and the test tracers of this package were changed to match: + + ```diff + - SLACK_TRACE_ENV_ADD_SUCCESS + - SLACK_TRACE_ENV_REMOVE_SUCCESS + + SLACK_TRACE_ENV_SET_SUCCESS + + SLACK_TRACE_ENV_UNSET_SUCCESS + ``` + +- 5a9bb9a: refactor(cli-test)!: move 'create' to 'project create' + + Before the Slack CLI v4.0.0 release, the `create` command became a `project` subcommand while remaining aliased the same. This project now prefers: + + ```js + const createOutput = await SlackCLI.project.create({ + template: "slack-samples/bolt-js-starter-template", + appPath, + verbose: true, + }); + ``` + + But continues to run the `slack create` command for confidence in getting started guides. + ## 2.2.2 ### Patch Changes diff --git a/packages/cli-test/README.md b/packages/cli-test/README.md index b789f9a85..610eedb3a 100644 --- a/packages/cli-test/README.md +++ b/packages/cli-test/README.md @@ -6,7 +6,7 @@ This library is designed to automate the [Slack Platform Command Line Interface] # Requirements -1. Ensure the [Slack CLI][cli] (version 2.32.2 or higher) is installed on your system. +1. Ensure the [Slack CLI][cli] (version 4.0.0 or higher) is installed on your system. 2. Export the path to the CLI binary as a `SLACK_CLI_PATH` environment variable. # Quickstart @@ -18,8 +18,8 @@ npm install @slack/cli-test ``` 2. Set the path to the CLI executable using the environment variable `SLACK_CLI_PATH` - - supply a link to a binary on the global path, like `slack-cli` - - it will default to using `slack` otherwise + - supply a link to a binary on the global path, like `slack-cli` + - it will default to using `slack` otherwise 3. Import and use `SlackCLI` to automate the CLI! ```ts @@ -33,11 +33,11 @@ const createOutput = await SlackCLI.createAppFromTemplate('slackapi/deno-hello-w This package exports the following: 1. `SlackCLI` - an object containing a variety of methods to interact with the CLI - - methods are named after [Slack CLI commands][commands], e.g. `SlackCLI.deploy()` + - methods are named after [Slack CLI commands][commands], e.g. `SlackCLI.deploy()` 2. `SlackCLIProcess` - a class that can be instantiated that exposes the ability to run arbitrary commands, with optional global flags as well as command-specific flags. 3. `SlackTracerId` - trace IDs to verify CLI command output - - see available exported IDs on `SlackTracerId` object - - to enable the CLI to show this output, any CLI commands executed by this library are invoked with the environment variable set: `SLACK_TEST_TRACE=true` + - see available exported IDs on `SlackTracerId` object + - to enable the CLI to show this output, any CLI commands executed by this library are invoked with the environment variable set: `SLACK_TEST_TRACE=true` ```ts // Import available objects from the package diff --git a/packages/cli-test/package.json b/packages/cli-test/package.json index 1caaa9473..f580c4a3f 100644 --- a/packages/cli-test/package.json +++ b/packages/cli-test/package.json @@ -1,6 +1,6 @@ { "name": "@slack/cli-test", - "version": "2.2.2", + "version": "3.0.0", "description": "Node.js bindings for the Slack CLI for use in automated testing", "author": "Salesforce, Inc.", "license": "MIT",