Skip to content

Commit 4c3ebdc

Browse files
committed
Relax package manager guidance in AGENTS.md
Clarify package manager guidance: remove strict Yarn-only requirement and note that multiple managers (npm/pnpm/yarn/bun) work with the project. Document that yarn.lock is committed and package.json pins yarn@4.12.0, but Netlify builds use bun and Docker builds use yarn; examples continue to use yarn. Update production note to reflect Netlify builds with Bun.
1 parent 565dd7a commit 4c3ebdc

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ am32-configurator/
5252

5353
- **Indent**: 4 spaces (ESLint enforced)
5454
- **Semicolons**: always required
55-
- **Package manager**: Yarn 4.12 — do NOT use npm
55+
- **Package manager**: No strict convention. `yarn.lock` is committed and `package.json` declares `yarn@4.12.0`, but Netlify deploys with `bun run build`, Docker uses `yarn run build`. npm/pnpm/yarn/bun all work per Nuxt defaults.
5656
- **SSR disabled**: pure SPA (`ssr: false`), no server-side rendering for pages
5757
- **Auto-imports**: Nuxt auto-imports Vue APIs, composables, utils, stores
5858
- **Singletons**: `Serial`, `Msp`, `FourWay`, `Direct``export default new X()`
@@ -73,12 +73,16 @@ am32-configurator/
7373
## COMMANDS
7474

7575
```bash
76+
# Any package manager works (npm/pnpm/yarn/bun)
77+
# Examples below use yarn (yarn.lock is committed), substitute as needed
7678
yarn dev # Start dev server
7779
yarn build # Production build
7880
yarn generate # Static site generation
7981
yarn preview # Preview production build
8082
yarn lint # ESLint check
8183
yarn upload:files # Upload firmware files to MinIO
84+
# Netlify deploys with: bun run build
85+
# Docker builds with: yarn run build
8286
```
8387

8488
## NOTES
@@ -89,5 +93,5 @@ yarn upload:files # Upload firmware files to MinIO
8993
- MCU variants identified by 2-byte signature (e.g. `1F06` = STM32F051)
9094
- `Mcu.LAYOUT_SIZE = 0xB8` (184 bytes) — total EEPROM read size
9195
- `Mcu.RESET_DELAY_MS = 5000` — wait 5s for MCU reset after flash
92-
- Production: Netlify + Netlify Blobs. Alt: Docker + Redis + Traefik
96+
- Production: Netlify (builds with Bun) + Netlify Blobs. Alt: Docker + Redis + Traefik
9397
- PWA auto-update with 1h periodic sync

0 commit comments

Comments
 (0)