feat(cli-hooks): add default app and manifest watch config by zimeg · Pull Request #2480 · slackapi/node-slack-sdk

zimeg · 2026-01-27T07:24:36Z

Summary

This PR adds a default app and manifest option to file watching for server restarts and app reinstalls.

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2026-01-27T07:25:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.11%. Comparing base (f34cdba) to head (7c7927d).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2480      +/-   ##
==========================================
+ Coverage   93.10%   93.11%   +0.01%     
==========================================
  Files          40       40              
  Lines       11250    11269      +19     
  Branches      713      713              
==========================================
+ Hits        10474    10493      +19     
  Misses        764      764              
  Partials       12       12

Flag	Coverage Δ
cli-hooks	`95.42% <100.00%> (+0.12%)`	⬆️
cli-test	`94.79% <ø> (ø)`
oauth	`77.39% <ø> (ø)`
socket-mode	`61.87% <ø> (ø)`
web-api	`98.11% <ø> (ø)`
webhook	`96.66% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mwbrooks

Exciting times!

mwbrooks · 2026-01-29T22:28:13Z

packages/cli-hooks/src/get-hooks.js

-        paths: ['.'],
+        app: {
+          paths: ['.'],
+          'filter-regex': '.js$',


suggestion: I think we should also support .ts for TypeScript developers using Bolt JS?

@mwbrooks We might use the built changes from tsc for now, though these changes might be good to document as well!

A note on this is mentioned now in the CHANGELOG and also updates to the sample app:

node-slack-sdk/.changeset/green-items-write.md

Line 41 in cc8e5b7

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.

👾 slack-samples/bolt-ts-starter-template#178

changeset-bot · 2026-01-30T01:36:02Z

🦋 Changeset detected

Latest commit: 7c7927d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@slack/cli-hooks	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

zimeg · 2026-01-30T07:17:43Z

🏷️ Follows: slackapi/slack-cli#310

srtaalej

LGTM and its working for me! ⭐ ⭐ ⭐

srtaalej · 2026-02-02T19:49:29Z

.changeset/green-items-write.md

+
+### 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.


srtaalej · 2026-02-02T19:54:08Z

packages/cli-hooks/src/get-hooks.spec.js

+  it('should return watch config for app files', async () => {
+    const { config } = getHooks();
+    assert(config.watch);
+    assert(config.watch.app);
+    assert.equal(config.watch.app['filter-regex'], '\\.js$');
+    assert.deepEqual(config.watch.app.paths, ['.']);
+  });
+
+  it('should return watch config for manifest files', async () => {
+    const { config } = getHooks();
+    assert(config.watch);
+    assert(config.watch.manifest);
+    assert.deepEqual(config.watch.manifest.paths, ['manifest.json']);


ty for good tests 👾!

mwbrooks

✅ Love this improvement @zimeg! It's so exciting to see this land!

🧪 Local testing works great on my end! 👾

🛠️ I left a few minor, non-blocking suggestions.

✏️ Love the very detailed changeset! This is what I'd like to see in more of our PRs for developers!

packages/cli-hooks/src/get-hooks.js

mwbrooks · 2026-02-04T23:13:16Z

packages/cli-hooks/src/get-hooks.js

-        'filter-regex': '^manifest\\.json$',
-        paths: ['.'],
+        app: {
+          'filter-regex': '\\.js$',


nit: Non-blocker. Not sure if we want to include, this but we could ignore node_modules to avoid restarting the server when the developer runs npm install.

@mwbrooks Our current CLI implementations don't support "not" paths AFAICT. We might want to follow up with this, since changes to the test directories might also be odd to cause restarts! 🤖

Co-authored-by: Michael Brooks <mbrooks@slack-corp.com>

zimeg

@srtaalej @mwbrooks Thanks both so much for the kind reviews and catches 👾 ✨

I'm excited to merge this for an upcoming release, and hope we can continue to support good defaults for most developers!

zimeg · 2026-02-04T23:31:07Z

packages/cli-hooks/src/get-hooks.js

-        'filter-regex': '^manifest\\.json$',
-        paths: ['.'],
+        app: {
+          'filter-regex': '\\.js$',


@mwbrooks Our current CLI implementations don't support "not" paths AFAICT. We might want to follow up with this, since changes to the test directories might also be odd to cause restarts! 🤖

zimeg added 2 commits January 22, 2026 22:40

fix(cli-hooks): stop app process if start hook is exited

f80594a

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

118788e

zimeg self-assigned this Jan 27, 2026

zimeg added semver:minor enhancement M-T: A feature request for new functionality pkg:cli-hooks applies to `@slack/cli-hooks` labels Jan 27, 2026

zimeg mentioned this pull request Jan 27, 2026

feat: restart the app development server on file changes slackapi/slack-cli#310

Merged

2 tasks

mwbrooks reviewed Jan 29, 2026

View reviewed changes

chore: merge w main

f6b85d9

zimeg mentioned this pull request Jan 30, 2026

build: automate release packaging and version bumps with changesets #2483

Merged

2 tasks

zimeg added 5 commits January 29, 2026 18:46

chore: merge w main

e6cbbfb

docs: changeset

bfa23c8

chore: merge w base branch

d69734c

fix: search for explicit .js file extensions

14899a9

docs: changeset

cc8e5b7

zimeg mentioned this pull request Jan 30, 2026

build: add a script to rebuild on typescript file changes slack-samples/bolt-ts-starter-template#178

Open

4 tasks

zimeg marked this pull request as ready for review January 30, 2026 06:43

zimeg requested a review from a team as a code owner January 30, 2026 06:43

zimeg added 2 commits January 29, 2026 22:55

fix: remove manifest.json from filter regexes

2a849b9

docs: note local manifest source requirement for reinstallations

5fcd109

zimeg requested a review from mwbrooks January 30, 2026 07:30

zimeg added this to the cli-hooks@1.3.0 milestone Jan 30, 2026

srtaalej approved these changes Feb 2, 2026

View reviewed changes

Base automatically changed from zimeg-fix-hooks-daemon to main February 4, 2026 05:19

mwbrooks approved these changes Feb 4, 2026

View reviewed changes

zimeg and others added 2 commits February 4, 2026 15:29

Merge branch 'main' into zimeg-feat-hooks-watch

a2f0e82

docs: make optional filter regex for app configuration watch

10b695b

Co-authored-by: Michael Brooks <mbrooks@slack-corp.com>

docs: make optional filter regex for app configuration watch

7c7927d

Co-authored-by: Michael Brooks <mbrooks@slack-corp.com>

zimeg commented Feb 4, 2026

View reviewed changes

zimeg merged commit 0abdc91 into main Feb 4, 2026
58 checks passed

zimeg deleted the zimeg-feat-hooks-watch branch February 4, 2026 23:37


		### 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.

Conversation

zimeg commented Jan 27, 2026

Summary

Requirements

Uh oh!

codecov bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

mwbrooks Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

changeset-bot bot commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

zimeg commented Jan 30, 2026

Uh oh!

srtaalej left a comment

Choose a reason for hiding this comment

Uh oh!

srtaalej Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

srtaalej Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mwbrooks Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 27, 2026 •

edited

Loading

changeset-bot bot commented Jan 30, 2026 •

edited

Loading