Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/eleven-apples-retire.md

This file was deleted.

14 changes: 0 additions & 14 deletions .changeset/fiery-sheep-wear.md

This file was deleted.

17 changes: 0 additions & 17 deletions .changeset/four-ads-hide.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/english/reference/cli-test/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/cli-test v2.2.2
# @slack/cli-test v3.0.0

## Classes

Expand Down
68 changes: 37 additions & 31 deletions docs/english/reference/cli-test/variables/SlackCLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,26 +216,6 @@ remove: (args) => Promise<string>;

command output

### create()

```ts
create: (args) => Promise<string>;
```

`slack create`

#### Parameters

##### args

`ProjectCommandArguments` & `object`

#### Returns

`Promise`\<`string`\>

command output

### datastore

```ts
Expand Down Expand Up @@ -328,53 +308,53 @@ command output
env: object;
```

#### env.add()
#### env.list()

```ts
add: (args) => Promise<string>;
list: (args) => Promise<string>;
```

`slack env add`
`slack env list`

##### Parameters

###### args

`ProjectCommandArguments` & `EnvCommandArguments`
`ProjectCommandArguments`

##### Returns

`Promise`\<`string`\>

command output

#### env.list()
#### env.set()

```ts
list: (args) => Promise<string>;
set: (args) => Promise<string>;
```

`slack env list`
`slack env set`

##### Parameters

###### args

`ProjectCommandArguments`
`ProjectCommandArguments` & `EnvCommandArguments`

##### Returns

`Promise`\<`string`\>

command output

#### env.remove()
#### env.unset()

```ts
remove: (args) => Promise<string>;
unset: (args) => Promise<string>;
```

`slack env remove`
`slack env unset`

##### Parameters

Expand Down Expand Up @@ -672,6 +652,32 @@ stop `slack run`

`Promise`\<`void`\>

### project

```ts
project: object;
```

#### project.create()

```ts
create: (args) => Promise<string>;
```

`slack create`

##### Parameters

###### args

`ProjectCommandArguments` & `object`

##### Returns

`Promise`\<`string`\>

command output

### stopSession()

```ts
Expand Down
16 changes: 8 additions & 8 deletions docs/english/reference/cli-test/variables/SlackTracerId.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
6 changes: 6 additions & 0 deletions packages/cli-hooks/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-hooks/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
29 changes: 29 additions & 0 deletions packages/cli-test/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 6 additions & 6 deletions packages/cli-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-test/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down