build: setup monorepo npm workspace for dependent packages #2478

zimeg · 2026-01-29T04:50:33Z

📠 note: Apologies for noise in these changes, but a lot of formatting happened I fear.

zimeg · 2026-01-29T04:46:59Z

🗣️ note: #2482 is an example of changing dependencies between packages being resolved as expected!

In that example, changes to @slack/types are required in @slack/web-api which cause tests on matching commit f2ac218 to fail in an unchanged branch. We might hope to include these changes as part of related PRs for confident CI without updates across prereleases 🫡

This is also so much easier to read and maintain!

mwbrooks · 2026-01-29T19:25:45Z

zimeg · 2026-01-29T05:01:00Z

🪵 note: Linting becomes a global task with impressive speeds of biome - less than 1 second for all packages.

This is a noticed change to the maintenance tasks I think, but --workspace commands are preferred for package scripts overall, which are run from the root:

$ npm run test --workspace=@slack/webhook

🌲 note: I'm so open to adding more scripts here too, but hope to keep this PR scoped to minimal improvements of workspaces to start:

Automatic dependent and deduplicated package resolution in development

Shared linting scripts

Test fixes and simplified linking related to dependencies

Let's keep this PR minimal and scoped, but we can always add more to scripts in future work!

I think a root-level npm test script would be nice to match our npm run lint. Future work!

@mwbrooks Nice callout! A shared test script sounds so amazing for testing changes that span packages 🧪 ✨

zimeg · 2026-01-29T04:57:39Z

🗣️ note: The prepare script is replaced with prepack in all packages!

This helps prevent installation and build errors between packages on an initial install. Otherwise, packages are built when dependencies are installed with the prepare script, and the oauth package requires web-api is built but these are packaged in alphabetical order. Overrides for this aren't obvious to me...

AFAICT this isn't a breaking change since the prepack script is run still when packages are installed from Git. FWIW I cannot figure out how to install packages in a monorepo with that method in both cases either 🤖

-Original file line number
+Diff line change
@@ Expand Up / @@ -206,3 +206,11 @@ updates: @@
           - "github_actions"
         schedule:
           interval: "monthly"
+      - package-ecosystem: "npm"
+        directory: "/"
+        labels:
+          - "dependencies"
+          - "javascript"
+        schedule:
+          interval: "weekly"

-Original file line number
+Diff line change
@@ Expand Up / @@ -41,48 +41,31 @@ jobs: @@
             with:
               node-version: ${{ matrix.node-version }}
           - run: npm --version
-          - run: npm install --verbose
-            working-directory: packages/${{ matrix.package }}
-          - name: Link dependent packages (*nix)
-            if: matrix.os == 'ubuntu-latest'
-            working-directory: packages/${{ matrix.package }}
+          - name: Install dependencies
             run: |
-              # depending on which package we are testing, also npm link up dependent packages within this monorepo
-              case "$PWD" in
-                */webhook) pushd ../types && npm i && popd && npm link ../types;;
-                */web-api) pushd ../types && npm i && popd && npm link ../types && pushd ../logger && npm i && popd && npm link ../logger;;
-                */oauth) pushd ../logger && npm i && popd && npm link ../logger && pushd ../web-api && npm i && popd && npm link ../web-api;;
-                */socket-mode) pushd ../logger && npm i && popd && npm link ../logger && pushd ../web-api && npm i && popd && npm link ../web-api;;
-                *) ;; # default
-              esac
-          - name: Link dependent packages (Windows)
-            if: matrix.os == 'windows-latest'
-            working-directory: packages/${{ matrix.package }}
+              npm install --verbose
+          - name: Build packages
+            run: |
+              # Build packages without internal dependencies
+              npm run build --workspace=@slack/cli-hooks
+              npm run build --workspace=@slack/cli-test
+              # Build base dependencies
+              npm run build --workspace=@slack/logger
+              npm run build --workspace=@slack/types
+              # Build packages requiring base dependencies
+              npm run build --workspace=@slack/web-api
+              npm run build --workspace=@slack/webhook
+              # Build packages that depend on the Web API
+              npm run build --workspace=@slack/oauth
+              npm run build --workspace=@slack/rtm-api
+              npm run build --workspace=@slack/socket-mode
+          - name: Run tests
             run: |
-              # depending on which package we are testing, also npm link up dependent packages within this monorepo
-              # NOTE: the following is PowerShell
-              echo "$pwd"
-              switch -Wildcard ( "$pwd" )
-              {
-                '*\webhook'
-                {
-                  pushd ..\types && npm i && popd && npm link ..\types
-                }
-                '*\web-api'
-                {
-                  pushd ..\types && npm i && popd && npm link ..\types && pushd ..\logger && npm i && popd && npm link ..\logger
-                }
-                '*\oauth'
-                {
-                  pushd ..\logger && npm i && popd && npm link ..\logger && pushd ..\web-api && npm i && popd && npm link ..\web-api
-                }
-                '*\socket-mode'
-                {
-                  pushd ..\logger && npm i && popd && npm link ..\logger && pushd ..\web-api && npm i && popd && npm link ..\web-api
-                }
-              }
-          - run: npm test
-            working-directory: packages/${{ matrix.package }}
+              npm run lint
+              npm test --workspace=@slack/${{ matrix.package }}
           - name: Check for coverage report existence
             id: check_coverage
             uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3.0.0
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,14 @@ @@
           }
         }
       },
+      "files": {
+        "includes": [
+          "packages/**",
+          "!!packages/client",
+          "!!packages/events-api",
+          "!!packages/interactive-messages"
+        ]
+      },
       "formatter": {
         "enabled": true,
         "formatWithErrors": false,
@@ Expand Down Expand Up / @@ -44,5 +52,30 @@ @@
         "enabled": true,
         "clientKind": "git",
         "useIgnoreFile": true
-      }
+      },
+      "overrides": [
+        {
+          "includes": ["packages/web-api/src/types/response/**/*.ts"],
+          "linter": {
+            "rules": {
+              "complexity": {
+                "noBannedTypes": "off"
+              },
+              "suspicious": {
+                "noExplicitAny": "off"
+              }
+            }
+          }
+        },
+        {
+          "includes": ["packages/web-api/src/index.ts"],
+          "assist": {
+            "actions": {
+              "source": {
+                "organizeImports": "off"
+              }
+            }
+          }
+        }
+      ]
     }

-Original file line number
+Diff line change
@@ -0,0 +1,28 @@
+    {
+      "name": "@slack",
+      "version": "0.0.0",
+      "private": true,
+      "type": "module",
+      "repository": {
+        "type": "git",
+        "url": "git+https://github.com/slackapi/node-slack-sdk.git"
+      },
+      "workspaces": [
+        "packages/cli-hooks",
+        "packages/cli-test",
+        "packages/logger",
+        "packages/oauth",
+        "packages/rtm-api",
+        "packages/socket-mode",
+        "packages/types",
+        "packages/web-api",
+        "packages/webhook"
+      ],
+      "scripts": {
+        "lint": "npx @biomejs/biome check packages",
+        "lint:fix": "npx @biomejs/biome check --write packages"
+      },
+      "devDependencies": {
+        "@biomejs/biome": "^2.0.5"
+      }
+    }

-Original file line number
+Diff line change
@@ Expand Up / @@ -35,12 +35,9 @@ @@
         "url": "https://github.com/slackapi/node-slack-sdk/issues"
       },
       "scripts": {
-        "prebuild": "shx rm -rf ./coverage",
         "build": "shx chmod +x src/*.js",
+        "prebuild": "shx rm -rf ./coverage",
         "prelint": "tsc --noemit --module es2022 --maxNodeModuleJsDepth 0 --project ./jsconfig.json",
-        "lint": "npx @biomejs/biome check .",
-        "lint:fix": "npx @biomejs/biome check --write .",
-        "pretest": "npm run lint",
         "test": "c8 --config ./test/.c8rc.json mocha --config ./test/.mocharc.json src/*.spec.js"
       },
       "bin": {
@@ Expand All / @@ -55,7 +52,6 @@ @@
         "semver": "^7.5.4"
       },
       "devDependencies": {
-        "@biomejs/biome": "^2.0.5",
         "@types/minimist": "^1.2.5",
         "@types/mocha": "^10.0.6",
         "@types/node": "^25.0.3",
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: setup monorepo npm workspace for dependent packages #2478

Uh oh!

Diff view

Diff view

There are no files selected for viewing

zimeg Jan 29, 2026

Uh oh!

Uh oh!

zimeg Jan 29, 2026

Uh oh!

mwbrooks Jan 29, 2026

Uh oh!

mwbrooks Jan 29, 2026

Uh oh!

zimeg Jan 29, 2026

Uh oh!

zimeg Jan 29, 2026

Uh oh!

mwbrooks Jan 29, 2026

Uh oh!

zimeg Jan 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zimeg Jan 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,18 +28,15 @@ @@
         "build": "npm run build:clean && tsc",
         "build:clean": "shx rm -rf ./dist ./coverage",
         "docs": "npx typedoc --plugin typedoc-plugin-markdown",
-        "lint": "npx @biomejs/biome check .",
-        "lint:fix": "npx @biomejs/biome check --write .",
-        "prepare": "npm run build",
         "mocha": "cross-env SLACK_CLI_PATH=/doesnt/matter mocha --config ./test/.mocharc.json src/*.spec.ts src/**/*.spec.ts src/**/**/*.spec.ts",
-        "test": "npm run lint && npm run build && c8 --config ./test/.c8rc.json npm run mocha"
+        "prepack": "npm run build",
+        "test": "npm run build && c8 --config ./test/.c8rc.json npm run mocha"
       },
       "dependencies": {
         "tree-kill": "^1.2.2",
         "winston": "^3.8.2"
       },
       "devDependencies": {
-        "@biomejs/biome": "^2.0.5",
         "@tsconfig/recommended": "^1.0.6",
         "@types/chai": "^4.3.16",
         "@types/mocha": "^10.0.6",
@@ Expand Down @@

build: setup monorepo npm workspace for dependent packages #2478

Uh oh!

build: setup monorepo npm workspace for dependent packages #2478

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!