From 65fc9618b6c0b282894e7332b6353cab0abec5a1 Mon Sep 17 00:00:00 2001 From: J8k3 Date: Tue, 9 Jun 2026 23:16:36 -0400 Subject: [PATCH] docs(agents): clarify lint runs locally on W: share, not Docker --- AGENTS.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 0b3188f9..c47906b4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -8,11 +8,13 @@ - Node 24 - `npm ci` - `npm test` -- **Before committing any JS/MJS change, run the full lint suite in Docker:** +- **Before committing any JS/MJS change, run the full lint suite:** ``` npx grunt eslint ``` This runs all five targets: `eslint:configs`, `eslint:core`, `eslint:web`, `eslint:node`, `eslint:tests`. Running only `eslint:core` misses errors in test files and other targets. Do not push without a clean lint run. +- ESLint is pure JS and runs fine via local Node on Windows — Docker is not required for lint. (`W:\` is an SMB share to `\\nas.marks.local\Files\Jacob\workspace`, and Docker Desktop's WSL2 bind mount cannot see `node_modules` through it. Don't waste time trying.) +- Docker/Linux remains required for builds and tests (webpack output, native deps, postinstall behavior). - Dev server with auto-rebuild: `npm start` (port 8080). Production build: `npm run build` (output in `build/prod/`). If the production build OOMs, set `NODE_OPTIONS=--max_old_space_size=2048`. - **Do not run `npm run build` or `npm start` on Windows.** The local Node version is not guaranteed to match CI and webpack builds will silently fail or produce wrong output. Build verification belongs in Docker/Linux CI only. - Do not spend time fixing Windows-only runtime or dependency issues unless explicitly requested.