Instruction file imported from xmlui-org/xmlui (
.github/instructions/core.instructions.md). Copyright stays with the author.
XMLUI Core Framework Rules
These rules apply whenever editing files in xmlui/src/components-core/.
Architecture docs by subsystem
Before editing any subsystem, read its corresponding AI doc in .ai/xmlui/:
| Subsystem | Path | AI Doc |
|---|---|---|
| Rendering pipeline | rendering/ |
.ai/xmlui/rendering-pipeline.md |
| State / containers | containers/ |
.ai/xmlui/container-state.md |
| Theming / CSS | theming/ |
.ai/xmlui/theming-styling.md |
| Parts | parts/ |
.ai/xmlui/theming-styling.md |
| Form infrastructure | form*/ |
.ai/xmlui/form-infrastructure.md |
| User-defined components | ud-components/ |
.ai/xmlui/user-defined-components.md |
| Error handling | ErrorBoundary* |
.ai/xmlui/error-handling.md |
| Expression evaluation | parsers/ |
.ai/xmlui/expression-eval.md |
Verified rules: guidelines.md at the repo root.
Refactoring
Use .github/prompts/refactor-core.prompt.md to plan and execute refactors.
Testing
Core changes require unit tests in xmlui/tests/ mirroring the source path:
xmlui/src/components-core/rendering/ComponentAdapter.tsx
xmlui/tests/components-core/rendering/ComponentAdapter.test.tsx
Run from workspace root:
npm run test:unit -w xmluiKey prohibitions
- Do NOT make breaking changes to the public renderer API without explicit instruction.
- Do NOT edit
package.jsonunless explicitly asked. - Never run all E2E tests without user confirmation (~10 minutes).