- Update AGENTS.md, CLAUDE.md, and GEMINI.md with Bun workflow rules and bun:test - Update docs/ARCHITECTURE.md with Bun runtime layer and lockfile - Add ADR-010 in docs/DECISIONS.md superseding ADR-001 with Bun adoption - Update README.md with Bun prerequisites, installation, and run instructions
1.1 KiB
1.1 KiB
Claude Instructions for openproject-mcp
Please refer to AGENTS.md for primary project guidelines, coding conventions, architectural standards, and workflow instructions.
Runtime & Tooling (Bun)
Default to using Bun instead of Node.js:
- Use
bun <file>instead ofnode <file>orts-node <file> - Use
bun testinstead ofjestorvitest - Use
bun install/bun addinstead ofnpm installorpnpm install - Use
bun run <script>instead ofnpm run <script> - Use
bunx <package> <command>instead ofnpx <package> <command> - Bun automatically loads
.envand.env.local, so don't usedotenv. - Prefer
Bun.fileovernode:fsfor reading and writing files.
Testing
Use bun test to run tests:
import { test, expect, describe } from "bun:test";
describe("OpenProject Client", () => {
test("authenticates via Basic Auth", () => {
expect(1).toBe(1);
});
});
For full details on project architecture and decisions, see docs/ARCHITECTURE.md and docs/DECISIONS.md.