]> Piment Noir Git Repositories - e-mobility-charging-stations-simulator.git/commitdiff
docs: add monorepo structure to copilot instructions, clarify command scopes
authorJérôme Benoit <jerome.benoit@sap.com>
Sun, 19 Apr 2026 16:19:25 +0000 (18:19 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Sun, 19 Apr 2026 16:19:25 +0000 (18:19 +0200)
- Add monorepo structure section to copilot-instructions.md
- Simplify quality gates to reference sub-project READMEs (no duplication)
- Clarify opencode format/test commands scope to root simulator only
- Add pnpm build to ui/common README scripts table
- Fix duplicate bullet points and table alignment

.github/copilot-instructions.md
.opencode/command/format-simulator.md
.opencode/command/test-simulator.md
ui/common/README.md

index 67503c74949d74601b8ba9e2cf28f2703c1eb573..e338c12d3654d6346003ab183b9360d73855cdc3 100644 (file)
@@ -31,6 +31,12 @@ These instructions guide GitHub Copilot to generate changes consistent with this
 - **When documenting**:
   - Follow documentation conventions below.
 
+## Monorepo structure
+
+4 TypeScript packages (pnpm workspace: `/`, `/ui/common`, `/ui/cli`, `/ui/web`) + 1 Python project (`/tests/ocpp-server`). Each has its own quality gates — see sub-project READMEs.
+
+UI Common (`ui-common`) is the shared library for CLI and Web UI. No re-exports between packages.
+
 ## Core principles
 
 - **Design patterns**: prefer established patterns (e.g., factory, singleton, strategy) for code organization and extensibility.
@@ -101,9 +107,8 @@ Documentation serves as an operational specification, not narrative prose.
 
 ## Quality gates
 
-- Documented build/type checks/lint pass (where applicable).
-- Documented tests pass (where applicable).
-- Documentation updated to reflect changes when necessary.
+Each sub-project has its own quality gates (format, typecheck, lint, build, test). See sub-project READMEs for exact commands. Run gates for every sub-project affected by your changes.
+
 - Logs use appropriate levels (error, warn, info, debug).
 - Pull request title and commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format.
 
index c678cf9604c9cdb5fdfb0e4e6136288acc278841..b57eb6316f13c0f81613369900a8114fb4a7c4fe 100644 (file)
@@ -2,7 +2,7 @@
 description: Run simulator code linter and formatter.
 ---
 
-Run simulator code formatter and linter with autofixes.
+Run root simulator code formatter and linter with autofixes (root only, not ui/\* sub-projects).
 Raw output:
 !`pnpm format`
 Summarize code formatter or linter failures and propose targeted fixes.
index 60a15fded5527364da088b6f50b99752d0179aa4..c680d17ca4c3c35eda999f815d4292f88bcf2ab9 100644 (file)
@@ -2,7 +2,7 @@
 description: Run simulator test suite
 ---
 
-Run simulator test suite.
+Run root simulator test suite (root only, not ui/\* sub-projects).
 Raw output:
 !`pnpm test`
 Summarize failing tests and propose targeted fixes.
index 4594a957a5eea5842d758b945a61775682f9da46..5194e650c13805e21481ee578f6ab736e1e58c03 100644 (file)
@@ -74,10 +74,11 @@ const valid = validateUUID(id) // boolean
 
 ## Available Scripts
 
-| Script               | Description                      |
-| -------------------- | -------------------------------- |
-| `pnpm typecheck`     | Type-check                       |
-| `pnpm lint`          | Run ESLint                       |
-| `pnpm format`        | Run Prettier and ESLint auto-fix |
-| `pnpm test`          | Run unit tests                   |
-| `pnpm test:coverage` | Run unit tests with coverage     |
+| Script               | Description                               |
+| -------------------- | ----------------------------------------- |
+| `pnpm build`         | Type-check (same as typecheck, no output) |
+| `pnpm typecheck`     | Type-check                                |
+| `pnpm lint`          | Run ESLint                                |
+| `pnpm format`        | Run Prettier and ESLint auto-fix          |
+| `pnpm test`          | Run unit tests                            |
+| `pnpm test:coverage` | Run unit tests with coverage              |