Skip to content

Commit 941217f

Browse files
chore: release (#2503)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 0de1e6b commit 941217f

File tree

4 files changed

+59
-58
lines changed

4 files changed

+59
-58
lines changed

.changeset/green-items-write.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

.changeset/neat-toys-wonder.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

packages/cli-hooks/CHANGELOG.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# @slack/cli-hooks
2+
3+
## 1.3.0
4+
5+
### Minor Changes
6+
7+
- 0abdc91: feat(cli-hooks): add default app and manifest watch config
8+
9+
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.
10+
11+
**Requirements:** These features require Slack CLI v3.12.0+ with [file watching support](https://github.com/slackapi/slack-cli/pull/310).
12+
13+
### Default Configuration
14+
15+
The following watch settings are provided automatically when using this package:
16+
17+
```json
18+
{
19+
"config": {
20+
"watch": {
21+
"app": {
22+
"filter-regex": "\\.js$",
23+
"paths": ["."]
24+
},
25+
"manifest": {
26+
"paths": ["manifest.json"]
27+
}
28+
}
29+
}
30+
}
31+
```
32+
33+
- **app**: Watches for JavaScript file changes to restart the app server
34+
- **manifest**: Watches the manifest file for changes to reinstall the app
35+
36+
**Note:** Manifest watching requires a local manifest source in your `.slack/config.json` file. Remote manifests will not be updated on file changes.
37+
38+
```json
39+
{
40+
"manifest": {
41+
"source": "local"
42+
}
43+
}
44+
```
45+
46+
### Custom Configurations
47+
48+
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.
49+
50+
### TypeScript Development
51+
52+
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.
53+
54+
### Patch Changes
55+
56+
- 8962739: fix(cli-hooks): stop app process if the start hook exits
57+
58+
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.

packages/cli-hooks/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@slack/cli-hooks",
3-
"version": "1.2.1",
3+
"version": "1.3.0",
44
"description": "Node implementation of the contract between the Slack CLI and Bolt for JavaScript",
55
"author": "Slack Technologies, LLC",
66
"license": "MIT",

0 commit comments

Comments
 (0)