build: setup monorepo npm workspace for dependent packages (#2478)

Author: zimeg

.github/dependabot.yml

@@ -206,3 +206,11 @@ updates:
       - "github_actions"
     schedule:
       interval: "monthly"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    labels:
+      - "dependencies"
+      - "javascript"
+    schedule:
+      interval: "weekly"

.github/maintainers_guide.md

@@ -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

.github/workflows/ci-build.yml

@@ -7,6 +7,14 @@
       }
     }
   },
+  "files": {
+    "includes": [
+      "packages/**",
+      "!!packages/client",
+      "!!packages/events-api",
+      "!!packages/interactive-messages"
+    ]
+  },
   "formatter": {
     "enabled": true,
     "formatWithErrors": false,
@@ -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"
+          }
+        }
+      }
+    }
+  ]
 }

biome.json

@@ -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"
+  }
+}

package.json

@@ -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": {
@@ -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",

packages/cli-hooks/biome.json

@@ -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",