Build docs in out directory (#3238)

AndreasArvidsson · web-flow · commit 33fb0550e99b · 2026-03-20T16:49:23.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,6 @@
 # Packages
 /packages/*/out/
 /packages/*/dist/
-/packages/*/build/
 /packages/app-web-docs/.docusaurus/
 /packages/*/tsconfig.tsbuildinfo
 /packages/test-runner/testSubsetGrep.properties
diff --git a/.prettierignore b/.prettierignore
@@ -6,7 +6,6 @@
 # Packages
 /packages/*/out/
 /packages/*/dist/
-/packages/*/build/
 /packages/app-web-docs/.docusaurus/
 /packages/app-vscode/src/keyboard/grammar/generated/
 /packages/lib-engine/src/customCommandGrammar/generated/
diff --git a/eslint.config.mts b/eslint.config.mts
@@ -22,7 +22,6 @@ const ignoresConfig: ConfigWithExtends = {
     // Packages
     "packages/*/out/**",
     "packages/*/dist/**",
-    "packages/*/build/**",
     "packages/app-web-docs/.docusaurus/**",
     "packages/app-vscode/src/keyboard/grammar/generated/**",
     "packages/lib-engine/src/customCommandGrammar/generated/**",
diff --git a/packages/app-neovim/package.json b/packages/app-neovim/package.json
@@ -7,7 +7,7 @@
   "main": "./out/index.cjs",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "dev": "pnpm run compile:dev && pnpm run populate-dist",
     "build": "pnpm run compile:prod && pnpm run populate-dist",
     "compile:prod": "pnpm run compile:base --minify",
diff --git a/packages/app-talonjs/package.json b/packages/app-talonjs/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "dev": "pnpm run compile:watch",
     "build": "pnpm run compile:prod",
     "compile:prod": "pnpm run compile:base --minify src/mainProduction.ts",
diff --git a/packages/app-vscode/package.json b/packages/app-vscode/package.json
@@ -1282,7 +1282,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "test": "pnpm ensure-grammar-up-to-date",
     "dev": "pnpm generate-grammar && pnpm run compile:dev && pnpm run bundle:dev && pnpm run populate-dist",
     "build": "pnpm generate-grammar && pnpm run compile:prod && pnpm run bundle:prod && pnpm run populate-dist",
diff --git a/packages/app-web-docs/README.md b/packages/app-web-docs/README.md
@@ -24,7 +24,7 @@ This command starts a local development server and opens up a browser window. Mo
 pnpm build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the `out` directory and can be served using any static contents hosting service.
 
 ### Deploy
 
diff --git a/packages/app-web-docs/package.json b/packages/app-web-docs/package.json
@@ -18,9 +18,9 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "docusaurus clear && rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "docusaurus clear && rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "dev": "docusaurus start",
-    "build": "docusaurus build"
+    "build": "docusaurus build --out-dir out"
   },
   "dependencies": {
     "@algolia/client-search": "^5.49.2",
diff --git a/packages/app-web/package.json b/packages/app-web/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "dev": "env NODE_OPTIONS=--import=tsx vite serve",
     "build": "env NODE_OPTIONS=--import=tsx vite build"
   },
diff --git a/packages/lib-cheatsheet-local/package.json b/packages/lib-cheatsheet-local/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "test": "jest",
     "dev": "env NODE_OPTIONS=--import=tsx vite serve",
     "bundle:prod": "env NODE_OPTIONS=--import=tsx vite build",
diff --git a/packages/lib-cheatsheet/package.json b/packages/lib-cheatsheet/package.json
@@ -13,7 +13,7 @@
   ],
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "test": "jest"
   },
   "dependencies": {
diff --git a/packages/lib-common/package.json b/packages/lib-common/package.json
@@ -14,7 +14,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "itertools": "^2.6.0",
diff --git a/packages/lib-engine/package.json b/packages/lib-engine/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "test": "pnpm ensure-grammar-up-to-date",
     "generate-grammar:base": "nearleyc src/customCommandGrammar/grammar.ne",
     "ensure-grammar-up-to-date": "pnpm -s generate-grammar:base | diff -u src/customCommandGrammar/generated/grammar.ts -",
diff --git a/packages/lib-neovim-common/package.json b/packages/lib-neovim-common/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/lib-neovim-registry/package.json b/packages/lib-neovim-registry/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "devDependencies": {
     "neovim": "^5.4.0"
diff --git a/packages/lib-node-common/package.json b/packages/lib-node-common/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/lib-sentence-parser/package.json b/packages/lib-sentence-parser/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.10",
diff --git a/packages/lib-talonjs-core/package.json b/packages/lib-talonjs-core/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/lib-test-case-recorder/package.json b/packages/lib-test-case-recorder/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/lib-tutorial/package.json b/packages/lib-tutorial/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/lib-vscode-common/package.json b/packages/lib-vscode-common/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*"
diff --git a/packages/lib-vscode-tutorial-webview/package.json b/packages/lib-vscode-tutorial-webview/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "dev": "env NODE_OPTIONS=--import=tsx vite serve",
     "bundle:prod": "env NODE_OPTIONS=--import=tsx vite build",
     "bundle:dev": "env NODE_OPTIONS=--import=tsx vite build --mode development",
diff --git a/packages/test-neovim-e2e/package.json b/packages/test-neovim-e2e/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/test-runner/package.json b/packages/test-runner/package.json
@@ -8,7 +8,7 @@
   "main": "./out/extensionTestsNeovim.cjs",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "test": "c-tsx ./src/scripts/runUnitTests.ts",
     "test:subset": "c-tsx ./src/scripts/runUnitTests.ts --subset",
     "test:update": "c-tsx ./src/scripts/runUnitTests.ts --update",
diff --git a/packages/test-talon-e2e/package.json b/packages/test-talon-e2e/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build",
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo",
     "test:quickjs": "bash ./scripts/test-quickjs.sh"
   },
   "dependencies": {
diff --git a/packages/test-vscode-e2e/package.json b/packages/test-vscode-e2e/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "dependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/tool-meta-updater/package.json b/packages/tool-meta-updater/package.json
@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "typecheck": "tsc",
-    "clean": "rm -rf ./out ./tsconfig.tsbuildinfo ./dist ./build"
+    "clean": "rm -rf ./out ./dist ./tsconfig.tsbuildinfo"
   },
   "devDependencies": {
     "@cursorless/lib-common": "workspace:*",
diff --git a/packages/tool-meta-updater/src/updatePackageJson.ts b/packages/tool-meta-updater/src/updatePackageJson.ts
@@ -99,7 +99,7 @@ async function getScripts(
 
   scripts.typecheck = "tsc";
 
-  const cleanDirs = ["./out", "./tsconfig.tsbuildinfo", "./dist", "./build"];
+  const cleanDirs = ["./out", "./dist", "./tsconfig.tsbuildinfo"];
   const clean = `rm -rf ${cleanDirs.join(" ")}`;
   const cleanScripts =
     name === "@cursorless/app-web-docs" ? ["docusaurus clear", clean] : [clean];
diff --git a/scripts/build-and-assemble-website.sh b/scripts/build-and-assemble-website.sh
@@ -23,6 +23,6 @@ mkdir -p "$root_dir"
 mkdir -p "$docs_dir"
 
 cp -r packages/app-web/out/* "$root_dir"
-cp -r packages/app-web-docs/build/* "$docs_dir"
+cp -r packages/app-web-docs/out/* "$docs_dir"
 cp packages/app-vscode/out/railroad.html "$root_dir/keyboard-modal-railroad.html"
 cp packages/lib-engine/out/railroad.html "$root_dir/custom-command-railroad.html"
