From 575a37c3d716197708d000a12fe315d443692206 Mon Sep 17 00:00:00 2001 From: Preston Cabe Date: Wed, 4 Nov 2026 20:38:20 -0500 Subject: [PATCH] Show how to run checks through Devbox in AGENTS.md Project tools are not on PATH outside Devbox, so say how to run the listed commands. Show that the e2e runner takes spec paths and that a Bruno folder run needs -r. Point to the builder-frontend README for form-js work, and drop two conventions agents follow by default. Co-Authored-By: Claude Opus 5.5 --- AGENTS.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 955c8867..fcde89ac 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,7 +6,7 @@ This is a monorepo for building and publishing benefit eligibility screeners. Ke - `library-api/`: Java 21 / Quarkus / Kogito service that turns DMN files into REST endpoints. Read `library-api/AGENTS.md` before changing this subtree. - `builder-api/`: Java 21 / Quarkus administration API backed by Firebase. -- `builder-frontend/`: Solid.js and Vite screener editor. +- `builder-frontend/`: Solid.js and Vite screener editor. Read `builder-frontend/README.md` before changing its form-js extensions or tests that render a form. - `e2e/`: Playwright end-to-end tests. - `docs/` and `website/`: Astro sites. @@ -15,11 +15,14 @@ This is a monorepo for building and publishing benefit eligibility screeners. Ke - Preferred one-time setup: `bin/install-devbox && devbox run setup` - In worktrees, agents may create the ignored root `.env` from `.env.example` when needed to run Devbox commands. The preferred setup command above does this automatically. - Start the development stack: `devbox services up` -- All tests: `devbox run test` (wrapper: `bin/run-all-tests`; accepts `--fail-fast` and suite names `builder-frontend`, `builder-api`, `library-api`, `examples`, `e2e`) +- All tests: `devbox run test` (wrapper: `bin/run-all-tests`; accepts `--fail-fast` and suite names, e.g. `devbox run test -- builder-frontend`; suites are `builder-frontend`, `builder-api`, `library-api`, `examples`, `e2e`) + +Project tools (`mvn`, `npm`, `bru`) come from Devbox and are not on `PATH`. Run the commands below inside `devbox shell`, or wrap one as `devbox run -- bash -c ""`; `devbox run` starts at the repository root. + - Backend tests: `(cd builder-api && mvn test)` -- Library tests: `(cd library-api && mvn test)`; DMN API tests require a running library service, then `(cd library-api/test/bdt && bru run)` +- Library tests: `(cd library-api && mvn test)`; DMN API tests require a running library service, then `(cd library-api/test/bdt && bru run)`. To run one folder, pass `-r` (`bru run checks/age -r`); without it, Bruno skips nested folders and still reports success. - Frontend tests: `(cd builder-frontend && npm test)`; frontend build: `(cd builder-frontend && npm run build)` -- End-to-end tests: `bin/run-e2e-tests` +- End-to-end tests: `bin/run-e2e-tests [spec ...]`, e.g. `bin/run-e2e-tests tests/screener.spec.ts` (paths relative to `e2e/`). It boots the whole local stack and refuses to start while its ports are in use. - Docs/website build: run `npm run build` in the relevant directory. Run the narrowest checks that cover a change. Do not claim a check passed unless it was run; report environmental blockers separately from code failures. @@ -27,8 +30,6 @@ Run the narrowest checks that cover a change. Do not claim a check passed unless ## Working conventions - Java APIs share Maven `groupId` `org.codeforphilly.bdt`, with artifact IDs `bdt-builder-api` and `bdt-library-api`. Use lowercase Java packages under `org.codeforphilly.bdt.builder` and `org.codeforphilly.bdt.library`, respectively; source and test directories must match their package names. -- Preserve unrelated work in the working tree and keep changes scoped to the request. -- Follow existing patterns in the component being edited; consult its README and build configuration rather than guessing versions or commands. - Never edit generated output under `target/`, `dist/`, Playwright reports, emulator exports, logs, or dependency directories unless the user explicitly asks. - Treat `.env` files, credentials, Firebase data, and production deployment commands as sensitive. Use checked-in examples for documentation and do not expose secrets. - Do not deploy, publish, modify production Firebase state, or export emulator state without explicit authorization.