build: write all docs for workspace packages

.changeset/vast-drinks-raise.md

@@ -0,0 +1,5 @@
+---
+"@slack/logger": patch
+---
+
+build: remove @types/node from required dependencies

.claude/settings.json

@@ -1,6 +1,7 @@
 {
   "permissions": {
     "allow": [
+      "Bash(cat:*)",
       "Bash(echo:*)",
       "Bash(gh issue view:*)",
       "Bash(gh label list:*)",
@@ -10,26 +11,35 @@
       "Bash(gh pr status:*)",
       "Bash(gh pr update-branch:*)",
       "Bash(gh pr view:*)",
+      "Bash(gh run view:*)",
       "Bash(gh search code:*)",
       "Bash(git diff:*)",
       "Bash(git grep:*)",
       "Bash(git log:*)",
+      "Bash(git ls-tree:*)",
       "Bash(git show:*)",
       "Bash(git status:*)",
       "Bash(grep:*)",
       "Bash(head:*)",
+      "Bash(jq:*)",
       "Bash(ls:*)",
+      "Bash(node --test:*)",
       "Bash(node --version:*)",
       "Bash(npm --version:*)",
       "Bash(npm config:*)",
       "Bash(npm install)",
       "Bash(npm install:*)",
       "Bash(npm run build:*)",
+      "Bash(npm run docs:*)",
       "Bash(npm run lint:*)",
       "Bash(npm run lint:fix:*)",
+      "Bash(npm show:*)",
       "Bash(npm test:*)",
+      "Bash(npm version:*)",
+      "Bash(nvm use:*)",
       "Bash(tail:*)",
       "Bash(tree:*)",
+      "WebFetch(domain:devblogs.microsoft.com)",
       "WebFetch(domain:docs.slack.dev)",
       "WebFetch(domain:github.com)",
       "WebFetch(domain:npmjs.com)",

.github/maintainers_guide.md

@@ -55,7 +55,13 @@ Remove cached project dependencies with `rm -r node_modules package-lock.json` b
 
 The reference docs for each package is independent of the others. They're generated using the `typedoc` and `typedoc-plugin-markdown` packages with the configurations of the package's `typedoc.json` file.
 
-Each package has a script to these generate reference docs. For example:
+Generate reference docs for all packages:
+
+```sh
+npm run docs
+```
+
+Or generate docs for a specific package. For example:
 
 ```sh
 npm run docs --workspace packages/web-api

.github/workflows/ci-build.yml

@@ -61,6 +61,8 @@ jobs:
           npm run build --workspace=@slack/socket-mode
       - name: Lint
         run: npm run lint
+      - name: Build docs
+        run: npm run docs
       - name: Run tests (Node 18/20)
         if: matrix.node-version != '22.x'
         shell: bash

package.json

@@ -20,12 +20,19 @@
   ],
   "scripts": {
     "changeset": "npx @changesets/cli",
+    "docs": "npm run docs --workspaces --if-present",
     "lint": "npx @biomejs/biome check packages",
     "lint:fix": "npx @biomejs/biome check --write packages",
     "test": "npm test --workspaces --if-present"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.0.5",
-    "@changesets/cli": "^2.29.8"
+    "@changesets/cli": "^2.29.8",
+    "@types/node": "^18.19.130",
+    "shx": "^0.4.0",
+    "tsx": "^4.20.6",
+    "typedoc": "^0.28.7",
+    "typedoc-plugin-markdown": "^4.7.1",
+    "typescript": "5.9.3"
   }
 }

packages/cli-hooks/jsconfig.json

@@ -1,24 +1,9 @@
 {
+  "$schema": "https://json.schemastore.org/jsconfig",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "module": "es2022",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "checkJs": true,
-
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-
-    "baseUrl": ".",
-    "paths": {
-      "*": ["./types/*"]
-    }
+    "checkJs": true
   },
-  "include": ["src/**/*"],
-  "jsdoc": {
-    "out": "support/jsdoc",
-    "access": "public"
-  }
+  "include": ["src/**/*"]
 }

packages/cli-hooks/package.json

@@ -54,11 +54,8 @@
   },
   "devDependencies": {
     "@types/minimist": "^1.2.5",
-    "@types/node": "^25.0.3",
     "@types/semver": "^7.5.6",
     "@types/sinon": "^21.0.0",
-    "shx": "^0.4.0",
-    "sinon": "^21.0.0",
-    "typescript": "5.9.3"
+    "sinon": "^21.0.0"
   }
 }

packages/cli-test/package.json

@@ -41,15 +41,8 @@
     "winston": "^3.8.2"
   },
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.6",
-    "@types/node": "^25.0.3",
     "@types/sinon": "^21.0.0",
     "cross-env": "^10.0.0",
-    "shx": "^0.4.0",
-    "sinon": "^21.0.0",
-    "tsx": "^4.20.6",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1",
-    "typescript": "5.9.3"
+    "sinon": "^21.0.0"
   }
 }

packages/cli-test/tsconfig.json

@@ -1,22 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "compilerOptions": {
-    "declaration": true,
-    "declarationMap": true,
-    "esModuleInterop": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "outDir": "dist",
-    "skipLibCheck": true,
-    "sourceMap": true
-  },
-  "extends": "@tsconfig/recommended/tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "include": ["src/**/*"],
-  "jsdoc": {
-    "out": "support/jsdoc",
-    "access": "public"
-  },
   "exclude": ["src/**/*.test.*"]
 }

packages/logger/package.json

@@ -36,15 +36,5 @@
     "test": "npm run test:unit",
     "test:node18": "npm run build && node --test --test-reporter=spec --import tsx --test src/index.test.ts",
     "test:unit": "npm run build && node --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=lcov.info --test-reporter=junit --test-reporter-destination=test-results.xml --import tsx --test src/index.test.ts"
-  },
-  "dependencies": {
-    "@types/node": ">=18.0.0"
-  },
-  "devDependencies": {
-    "shx": "^0.4.0",
-    "tsx": "^4.20.6",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1",
-    "typescript": "^5.9.3"
   }
 }

packages/logger/tsconfig.json

@@ -1,33 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "compilerOptions": {
-    "target": "es2017",
-    "module": "commonjs",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "dist",
-    "skipLibCheck": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "moduleResolution": "node",
-    "baseUrl": ".",
-    "paths": {
-      "*": ["./types/*"]
-    },
-    "esModuleInterop": true
-    // Not using this setting because it's only used to require the package.json file, and that would change the
-    // structure of the files in the dist directory because package.json is not located inside src. It would be nice
-    // to use import instead of require(), but it's not worth the tradeoff of restructuring the build (for now).
-    // "resolveJsonModule": true,
-  },
+  "extends": "../../tsconfig.base.json",
   "include": ["src/**/*"],
-  "exclude": ["src/**/*.test.*"],
-  "jsdoc": {
-    "out": "support/jsdoc",
-    "access": "public"
-  }
+  "exclude": ["src/**/*.test.*"]
 }

packages/oauth/package.json

@@ -50,11 +50,6 @@
   "devDependencies": {
     "@types/sinon": "^21",
     "rewiremock": "^3",
-    "shx": "^0.4.0",
-    "sinon": "^21",
-    "tsx": "^4.20.6",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.0",
-    "typescript": "5.9.3"
+    "sinon": "^21"
   }
 }

packages/oauth/tsconfig.json

@@ -1,33 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "dist",
-    "skipLibCheck": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "moduleResolution": "node",
-    "baseUrl": ".",
-    "paths": {
-      "*": ["./types/*"]
-    },
-    "esModuleInterop": true
-    // Not using this setting because it's only used to require the package.json file, and that would change the
-    // structure of the files in the dist directory because package.json is not located inside src. It would be nice
-    // to use import instead of require(), but it's not worth the tradeoff of restructuring the build (for now).
-    // "resolveJsonModule": true,
-  },
+  "extends": "../../tsconfig.base.json",
   "include": ["src/**/*"],
-  "exclude": ["src/**/spec-utils.ts", "src/**/*.test.*"],
-  "jsdoc": {
-    "out": "support/jsdoc",
-    "access": "public"
-  }
+  "exclude": ["src/**/spec-utils.ts", "src/**/*.test.*"]
 }

packages/rtm-api/package.json

@@ -57,11 +57,6 @@
   "devDependencies": {
     "@types/sinon": "^17",
     "@types/ws": "^8",
-    "shx": "^0.3.2",
-    "sinon": "^21",
-    "tsx": "^4.20.6",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1",
-    "typescript": "5.9.3"
+    "sinon": "^21"
   }
 }

packages/rtm-api/tsconfig.json

@@ -1,33 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "compilerOptions": {
-    "target": "es2017",
-    "module": "commonjs",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "dist",
-    "skipLibCheck": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "moduleResolution": "node",
-    "baseUrl": ".",
-    "paths": {
-      "*": ["./types/*"]
-    },
-    "esModuleInterop": true
-    // Not using this setting because it's only used to require the package.json file, and that would change the
-    // structure of the files in the dist directory because package.json is not located inside src. It would be nice
-    // to use import instead of require(), but it's not worth the tradeoff of restructuring the build (for now).
-    // "resolveJsonModule": true,
-  },
+  "extends": "../../tsconfig.base.json",
   "include": ["src/**/*"],
-  "exclude": ["src/**/*.spec.*"],
-  "jsdoc": {
-    "out": "support/jsdoc",
-    "access": "public"
-  }
+  "exclude": ["src/**/*.test.*"]
 }

packages/socket-mode/package.json

@@ -58,16 +58,10 @@
     "ws": "^8"
   },
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.7",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^21",
     "nodemon": "^3.1.0",
     "proxyquire": "^2.1.3",
-    "shx": "^0.4.0",
-    "sinon": "^21",
-    "tsx": "^4.20.6",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.0",
-    "typescript": "5.9.3"
+    "sinon": "^21"
   }
 }

packages/socket-mode/tsconfig.json

@@ -1,22 +1,9 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "declaration": true,
-    "declarationMap": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "outDir": "dist",
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true
+    "resolveJsonModule": true
   },
-  "extends": "@tsconfig/recommended/tsconfig.json",
   "include": ["src/**/*"],
-  "exclude": ["src/**/*.test.*"],
-  "jsdoc": {
-    "out": "support/jsdoc",
-    "access": "public"
-  }
+  "exclude": ["src/**/*.test.*"]
 }

packages/types/package.json

@@ -39,11 +39,7 @@
     "test:types": "tsd"
   },
   "devDependencies": {
-    "shx": "^0.4.0",
-    "tsd": "^0.33.0",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1",
-    "typescript": "^5.9.3"
+    "tsd": "^0.33.0"
   },
   "tsd": {
     "directory": "test"