agentleFS
anousss007anousss007/ng-blatui/AGENTS.md

ng-blatui

AGENTS.md17 starsChanged 3 months agoMITView on GitHub

ng-blatui is an Angular UI library: a port of BlatUI's visual system (components, blocks, templates, oklch design tokens, theming) to Angular. Behavior is built on the official Angular headless stack (Angular Aria + CDK); styling is Tailwind CSS v4 + BlatUI tokens. - MCP: the angular-cli MCP server is configured in .mcp.json. Prefer its tools for anything Angular-version-specific: get_best_practices, search_documentation, find_examples, list_projects. Don't answer Angular questions from memory — query it. - Skill: see .claude/skills/angular-best-practices/SKILL.md (the official v22 guide). api.json,…

The file

Files
AGENTS.md

ng-blatui — agent guide

ng-blatui is an Angular UI library: a port of BlatUI's visual system (components, blocks, templates, oklch design tokens, theming) to Angular. Behavior is built on the official Angular headless stack (Angular Aria + CDK); styling is Tailwind CSS v4 + BlatUI tokens.

Use the official Angular tooling

  • MCP: the angular-cli MCP server is configured in .mcp.json. Prefer its tools for anything Angular-version-specific: get_best_practices, search_documentation, find_examples, list_projects. Don't answer Angular questions from memory — query it.
  • Skill: see .claude/skills/angular-best-practices/SKILL.md (the official v22 guide).

Hard rules (this repo)

  • Angular v22, zoneless, standalone (defaults — don't set them explicitly).
  • Do NOT set changeDetection: OnPush explicitly — it's the v22 default.
  • Signals everywhere: input() / output() / model() / computed(). Use inject().
  • Native control flow (@if/@for/@switch); no *ngIf/*ngFor, no ngClass/ngStyle.
  • Accessibility: must pass AXE + WCAG AA. Build behavior on @angular/aria + @angular/cdk.
  • Selectors: library prefix bui, demo app prefix app.
  • Peer support floor: Angular 21.

Commands

TaskCommand
Build librarynpm run build:lib (ng build ng-blatui)
Build demo sitenpm run build
Serve demonpm start (ng serve demo)
Unit tests (Vitest)npm test (CI: npm run test:ci)
Lint (ESLint, type-aware)npm run lint
Format (Prettier)npm run format
Extract the typed APInpm run extract:api → api.json
Check API docs coveragenpm run check:api-docs
Regenerate the catalognpm run build:registry → registry.json + llms.txt

After changing a component's public API

api.json, registry.json and llms.txt are generated, committed artifacts (duplicated into mcp/, projects/demo/public/ and projects/demo/src/app/generated/) — the MCP server and every AI consumer read them. Changing an input()/output()/model() or adding a component means running npm run extract:api && npm run build:registry and committing the regenerated files (conventionally chore: regenerate api/registry for …). Every public API member needs a doc comment; npm run check:api-docs is what enforces it.

Quality gates

  • ESLint flat config (eslint.config.mjs): typescript-eslint strict-type-checked + stylistic, angular-eslint + template accessibility, import-x, unicorn, sonarjs.
  • Prettier (.prettierrc) with Tailwind class sorting.
  • Pre-commit (husky + lint-staged) runs eslint --fix + prettier; commit-msg runs commitlint (Conventional Commits).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.