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
50 changes: 0 additions & 50 deletions .changeset/green-items-write.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changeset/neat-toys-wonder.md

This file was deleted.

58 changes: 58 additions & 0 deletions packages/cli-hooks/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# @slack/cli-hooks

## 1.3.0

### Minor Changes

- 0abdc91: feat(cli-hooks): add default app and manifest watch config

This package now provides default watch configurations for automatic file watching during [`slack run`](https://docs.slack.dev/tools/slack-cli/reference/commands/slack_platform_run). The CLI will restart your app server when source files change and reinstall your app when the manifest changes.

**Requirements:** These features require Slack CLI v3.12.0+ with [file watching support](https://github.com/slackapi/slack-cli/pull/310).

### Default Configuration

The following watch settings are provided automatically when using this package:

```json
{
"config": {
"watch": {
"app": {
"filter-regex": "\\.js$",
"paths": ["."]
},
"manifest": {
"paths": ["manifest.json"]
}
}
}
}
```

- **app**: Watches for JavaScript file changes to restart the app server
- **manifest**: Watches the manifest file for changes to reinstall the app

**Note:** Manifest watching requires a local manifest source in your `.slack/config.json` file. Remote manifests will not be updated on file changes.

```json
{
"manifest": {
"source": "local"
}
}
```

### Custom Configurations

You can override these defaults in your `.slack/hooks.json` file to reduce the paths searched or change the file patterns. Read [Watch Configurations](https://docs.slack.dev/tools/slack-cli/reference/hooks/#watch-configurations) for more options.

### TypeScript Development

TypeScript developers should run `tsc --watch` in a separate terminal during development. This compiles `.ts` files to `.js` on changes, and the default watch configuration will detect changes to the compiled `dist/*.js` files and restart the app server. This approach works best with the default settings.

### Patch Changes

- 8962739: fix(cli-hooks): stop app process if the start hook exits

Fixes a CLI [issue](https://github.com/slackapi/slack-cli/issues/128) where daemon app processes were spawned if the CLI was exited without being interrupted.
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.2.1",
"version": "1.3.0",
"description": "Node implementation of the contract between the Slack CLI and Bolt for JavaScript",
"author": "Slack Technologies, LLC",
"license": "MIT",
Expand Down