@imfusion/web-ui 0.5.1-dev.18.g81350f83 → 0.5.1-dev.2.g0a349a2a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +43 -122
  2. package/bin/install-skill.js +180 -0
  3. package/dist/components/logo/logo.d.ts +1 -1
  4. package/dist/index.js +2 -4
  5. package/dist/style.css +1 -1
  6. package/package.json +24 -34
  7. package/src/docgen/doc.gen.json +1 -1
  8. package/src/llms/skills/imf-web-ui/SKILL.md +11 -15
  9. package/src/llms/skills/imf-web-ui-components/SKILL.md +1 -1
  10. package/src/llms/skills/imf-web-ui-frontend-patterns/SKILL.md +93 -0
  11. package/src/llms/skills/imf-web-ui-frontend-patterns/references/code-conventions.md +133 -0
  12. package/src/llms/skills/{imf-web-ui-frontend-conventions/references/react.md → imf-web-ui-frontend-patterns/references/react-patterns.md} +12 -26
  13. package/src/llms/skills/imf-web-ui-imfusion-frontend-setup/SKILL.md +201 -0
  14. package/src/llms/skills/imf-web-ui-setup/SKILL.md +57 -0
  15. package/src/llms/skills/imf-web-ui-ux/SKILL.md +4 -4
  16. package/src/llms/skills/imf-web-ui-ux/references/forms.md +1 -1
  17. package/bin/install.js +0 -319
  18. package/bin/install.test.ts +0 -139
  19. package/dist/build/vite-css-module-names/index.d.ts +0 -20
  20. package/dist/build/vite-css-module-names.js +0 -17
  21. package/src/llms/skills/imf-web-ui-agent-setup/SKILL.md +0 -71
  22. package/src/llms/skills/imf-web-ui-agent-setup/templates/hooks/baseline-staleness.sh +0 -17
  23. package/src/llms/skills/imf-web-ui-agent-setup/templates/hooks/post-tool-use.sh +0 -21
  24. package/src/llms/skills/imf-web-ui-agent-setup/templates/hooks/session-start.sh +0 -4
  25. package/src/llms/skills/imf-web-ui-agent-setup/templates/hooks/user-prompt-submit.sh +0 -4
  26. package/src/llms/skills/imf-web-ui-agent-setup/templates/settings.json +0 -37
  27. package/src/llms/skills/imf-web-ui-frontend-conventions/SKILL.md +0 -45
  28. package/src/llms/skills/imf-web-ui-frontend-conventions/references/assets.md +0 -23
  29. package/src/llms/skills/imf-web-ui-frontend-conventions/references/class-names.md +0 -42
  30. package/src/llms/skills/imf-web-ui-frontend-conventions/references/components.md +0 -63
  31. package/src/llms/skills/imf-web-ui-frontend-conventions/references/data.md +0 -130
  32. package/src/llms/skills/imf-web-ui-frontend-conventions/references/docs-structure.md +0 -44
  33. package/src/llms/skills/imf-web-ui-frontend-conventions/references/git.md +0 -33
  34. package/src/llms/skills/imf-web-ui-frontend-conventions/references/library-boundary.md +0 -37
  35. package/src/llms/skills/imf-web-ui-frontend-conventions/references/npm-project.md +0 -57
  36. package/src/llms/skills/imf-web-ui-frontend-conventions/references/project-structure.md +0 -21
  37. package/src/llms/skills/imf-web-ui-frontend-conventions/references/stack.md +0 -39
  38. package/src/llms/skills/imf-web-ui-frontend-conventions/references/styling.md +0 -91
  39. package/src/llms/skills/imf-web-ui-frontend-conventions/references/testing.md +0 -16
  40. package/src/llms/skills/imf-web-ui-frontend-conventions/references/tooling.md +0 -76
  41. package/src/llms/skills/imf-web-ui-frontend-conventions/references/typescript.md +0 -45
  42. package/src/llms/skills/imf-web-ui-frontend-setup/SKILL.md +0 -89
  43. package/src/llms/skills/imf-web-ui-frontend-setup/templates/AGENTS.md +0 -34
  44. package/src/llms/skills/imf-web-ui-frontend-setup/templates/README.md +0 -27
  45. package/src/llms/skills/imf-web-ui-library-setup/SKILL.md +0 -36
@@ -1,44 +0,0 @@
1
- # Documentation structure
2
-
3
- What a repo documents, where, and how it's written. `imf-web-ui-frontend-setup` scaffolds this shape from its `templates/`
4
- and audits it.
5
-
6
- ## The shape
7
-
8
- ```
9
- <app>/
10
- README.md # humans: what the app is, setup, scripts
11
- AGENTS.md # agents: stack, pointers into docs/ — restates nothing
12
- docs/
13
- index.md # registers every doc with a one-line "covers" summary
14
- <topic>.md # repo-unique content only
15
- ```
16
-
17
- ## Repo docs hold only what is unique to the repo
18
-
19
- The litmus, applied sentence by sentence: **would this be true in every ImFusion frontend? Then it's baseline — it lives in
20
- the installed skill references, don't restate it.** The baseline is already in the repo, vendored under
21
- `.agents/skills/imf-web-ui-frontend-conventions/`, human-readable and versioned.
22
-
23
- Where the repo deviates from the baseline, the doc says so as a **named deviation** — what the baseline prescribes, what this
24
- repo does instead, and why. A deviation written as freestanding convention gets copied into the next repo as if it were house
25
- style.
26
-
27
- ## How docs are written
28
-
29
- - **Docs explain concepts; code is the source of truth for facts.** A doc captures the why — invariants, rationale,
30
- decisions. It never restates a fact that lives in code (a script definition, a type shape, a config value): point at the
31
- file instead. A copied fact rots the moment the code changes.
32
- - **State what is — no decision residue.** Positive, present-tense statements about the current state. Never narrate the
33
- delta from a past decision or refute alternatives nobody raised ("there is no X mode", "Y was dropped") — that history
34
- belongs in commits and tickets. A negation earns its place only as a guardrail or to preempt a wrong assumption a present
35
- reader would actually arrive at.
36
- - **Boy Scout rule.** Discovered rot — a stale pointer, a doc contradicting the code — is always your responsibility: fix it
37
- in place if trivial, otherwise report it. The two failure modes are equal: stepping over rot, and cramming unrelated
38
- cleanup into an unrelated change.
39
-
40
- ## Staleness at commit time
41
-
42
- Docs are checked when they can go stale: at the commit. A staged change that invalidates a doc — a renamed script, a moved
43
- folder, a changed flow — updates that doc **in the same commit**, not in a follow-up. Pre-commit carries the advisory
44
- staleness checks (vendored baseline, docs) — the mechanics are in [git.md](git.md).
@@ -1,33 +0,0 @@
1
- # Git
2
-
3
- ## git:config
4
-
5
- One script holds the repo's git configuration, run by hand once per clone (the README names it):
6
-
7
- ```
8
- git config core.hooksPath .githooks && git config pull.rebase true && git config merge.ff only
9
- ```
10
-
11
- Hooks live in a tracked directory; history strategy doesn't depend on personal git config. Two silent failure modes to check
12
- for: `git:config` never run (hooks exist only on the machine that configured by hand), and `core.hooksPath` pointing at a
13
- directory that doesn't exist. Config **and** directory.
14
-
15
- ## Verify scopes
16
-
17
- Two blocking, one advisory:
18
-
19
- - **staged** — `verify:staged`, called by the pre-commit hook: lint, format, restage. Fast; a passing commit is not CI green.
20
- - **full** — `verify:full`: the build plus every `verify:*` check. What CI runs.
21
- - **files** — post-edit agent hook. Advisory, never exits non-zero, so a mid-flight refactor can't trap the agent.
22
-
23
- One script owns each scope's step list; npm scripts and hooks only launch them. Name by depth, not by occasion — a
24
- `preflight` needs explaining and invites a near-identical sibling, and two of those drift into "passes locally, fails in CI".
25
-
26
- ## Staleness at commit time
27
-
28
- Pre-commit also runs the advisory staleness checks — warn, never block:
29
-
30
- - **Vendored baseline** — `.agents/hooks/imf-web-ui/baseline-staleness.sh` compares the installed `imf-web-ui-*` skill
31
- markers against the installed package version; the fix it names is `npx web-ui-install`.
32
- - **Docs** — a staged change that invalidates a doc updates that doc in the same commit
33
- ([docs-structure.md](docs-structure.md)). Where the repo has an agent commit workflow, a staged docs audit belongs in it.
@@ -1,37 +0,0 @@
1
- # Library boundary
2
-
3
- The contract between an app and `@imfusion/web-ui`.
4
-
5
- ## Stay behind the library
6
-
7
- Never import Base UI (or any other upstream the library wraps) directly — no upstream stylesheets, no upstream components,
8
- even when upstream docs show it that way. Everything a component needs ships in `@imfusion/web-ui`. If the library is missing
9
- something upstream has, report the gap (see `imf-web-ui-components`); don't reach around it.
10
-
11
- ## Wrap primitives when the app has a reason to
12
-
13
- When the app keeps repeating something around a primitive — default props, a styling override, a composition, an
14
- accessibility refinement, a restriction of the API — wrap it once in an app-level dumb component and use that. The wrapper
15
- derives its props from the primitive (`React.ComponentProps<typeof Button>`, narrowed or extended), lives in `components/`
16
- like any other dumb component ([components.md](components.md)), and styles itself through the sanctioned seams — it never
17
- reaches into the library's internals.
18
-
19
- Two rules keep wrappers honest:
20
-
21
- - Wrap for a reason — any repeated adaptation counts. A wrapper that only renames a primitive is indirection with no payoff.
22
- - Components marked `experimental` in the identity index get wrapped **always**, even with nothing added yet — a breaking
23
- upstream change then lands in one file instead of every call site.
24
-
25
- ## Derive types, don't import them
26
-
27
- Prop types come from the components themselves: `React.ComponentProps<typeof Button>`. The library deliberately exports no
28
- `Props` types — don't look for them, and don't re-declare prop shapes by hand.
29
-
30
- ## Integrations own their peers
31
-
32
- Components under `@imfusion/web-ui/integrations/*` depend on optional peers (e.g. `@tanstack/highlight` for `CodeHighlight`).
33
- Add the peer explicitly to the consumer's `package.json` — never rely on hoisting.
34
-
35
- ## Styling crosses the boundary through seams
36
-
37
- Tokens in, sanctioned selectors at the edge, never the library's internals — the full contract is [styling.md](styling.md).
@@ -1,57 +0,0 @@
1
- # npm project
2
-
3
- How the npm side of an ImFusion frontend is structured: `package.json`, scripts, dependencies. `imf-web-ui-frontend-setup`
4
- audits against this file.
5
-
6
- ## package.json
7
-
8
- The exemplary shape:
9
-
10
- ```jsonc
11
- {
12
- "name": "@imfusion/scan-review",
13
- "type": "module",
14
- "private": true, // only when the package is not meant to be published
15
- "engines": { "node": ">=22" },
16
- "imports": { "#/*": "./src/*" }
17
- }
18
- ```
19
-
20
- - `"type": "module"` always.
21
- - `"private": true` for apps that never publish; a publishable package drops it.
22
- - Node pinned via `engines.node` or `.nvmrc` — not a personal version manager's config.
23
- - The `#/` alias wired through `imports` ([project-structure.md](project-structure.md)).
24
-
25
- ## Scripts
26
-
27
- Same name, same meaning, every repo — "what can I run to check this?" is answered by tab-completing `verify:`.
28
-
29
- | Script | Runs |
30
- | ------------------ | --------------------------------------------------------------------- |
31
- | `dev` | dev server |
32
- | `build` | production build |
33
- | `verify:deps` | exact-pin check over `dependencies` and `devDependencies` |
34
- | `verify:format` | `prettier --check .` |
35
- | `verify:lint` | `eslint . --cache --max-warnings=0` |
36
- | `verify:typecheck` | `tsc --noEmit` (or `tsc -b --noEmit` in a project-references setup) |
37
- | `verify:tests` | `vitest run` |
38
- | `verify:staged` | staged-file subset, called by the pre-commit hook |
39
- | `verify:full` | every `verify:*` check plus the build; what CI runs |
40
- | `format` | `prettier --write .` |
41
- | `lint` | `eslint . --cache --fix` |
42
- | `git:config` | see [git.md](git.md); run by hand once per clone, named in the README |
43
-
44
- Two rules generate the names:
45
-
46
- - **Every check is `verify:*`.** One namespace for everything that reads and reports.
47
- - **Write-mode scripts keep the tool name.** `format` and `lint` change files, which isn't verifying — no prefix, no `:fix`
48
- suffix.
49
-
50
- `verify:staged` is fast and partial; a passing commit is not CI green. `verify:full` is the CI gate.
51
-
52
- ## Dependencies
53
-
54
- - **Pinned exactly.** No `^`, `~`, or `latest`, in `dependencies` and `devDependencies` alike. `verify:deps` catches drift;
55
- `save-exact=true` in `.npmrc` prevents it.
56
- - **`ignore-scripts=true` in `.npmrc`.** Blocks lifecycle scripts on install (the supply-chain vector). Setup that matters is
57
- a command someone runs, not a hook that fires on install.
@@ -1,21 +0,0 @@
1
- # Project structure
2
-
3
- Kebab-case throughout, folders and files alike. Exported symbols stay PascalCase — only the filename is kebab.
4
-
5
- ```
6
- src/
7
- routes/ # TanStack Router file-based routes; routing only — they compose, they don't fetch inline
8
- api/ # one folder per API topic — layout and behaviour in data.md
9
- components/ # grouped by kind — anatomy in components.md
10
- http/ # transport: client, error normalisation — the only transport-aware place (data.md)
11
- lib/ # framework-free helpers
12
- ```
13
-
14
- Each subtree's own rules live with its topic: [data.md](data.md) for `api/` and `http/`, [components.md](components.md) for
15
- `components/`.
16
-
17
- ## Imports
18
-
19
- The `#/` alias for anything outside the current folder, plain `./` for siblings. The alias is always `#/` → `src/` — `#` is
20
- Node's own subpath-import prefix, so it can't collide with an npm scope. Wire it once, through `package.json`'s `imports`
21
- field where the toolchain resolves it natively, with a matching tsconfig `paths` entry.
@@ -1,39 +0,0 @@
1
- # Stack
2
-
3
- The topic→tool map for an ImFusion frontend. Check this before adding a dependency; check the TanStack suite before adding a
4
- non-TanStack one.
5
-
6
- | Topic | Tool |
7
- | --------------------- | ----------------------------------------------------------------------------------------------------- |
8
- | Build | [Vite](https://vite.dev) |
9
- | Routing, URL state | [TanStack Router](https://tanstack.com/router) — file-based, type-safe search params |
10
- | Server state | [TanStack Query](https://tanstack.com/query) — the pattern around it is [data.md](data.md) |
11
- | Forms | [TanStack Form](https://tanstack.com/form) |
12
- | Data grids | [TanStack Table](https://tanstack.com/table) + web-ui's styled `Table` parts |
13
- | App-wide client state | [TanStack Store](https://tanstack.com/store) — last resort in the state ladder ([react.md](react.md)) |
14
- | Schema validation | [Zod](https://zod.dev) — at the network boundary ([data.md](data.md)) |
15
- | Styling | CSS Modules ([styling.md](styling.md)) |
16
- | Test | [Vitest](https://vitest.dev) |
17
- | Format | [Prettier](https://prettier.io) — values in [tooling.md](tooling.md) |
18
- | Lint | [ESLint](https://eslint.org) flat config ([tooling.md](tooling.md)) |
19
- | Types | `tsc --noEmit` — own script, own CI step |
20
- | Staged files | [lint-staged](https://github.com/lint-staged/lint-staged) (or nano-staged, drop-in) |
21
- | Dead code | [knip](https://knipjs.dev) — needs per-repo config |
22
-
23
- ## Devtools come with the library
24
-
25
- Every TanStack library that ships a devtools package gets it as a dev dependency, mounted in development only. Router is a
26
- given, so `@tanstack/react-router-devtools` is a given too; Query's goes in when Query does. Look for a `-devtools` sibling
27
- whenever you add a TanStack dependency — the set grows, and not every library has one yet. Once a project has several,
28
- `@tanstack/devtools` hosts them in one panel.
29
-
30
- ## When a library owns a layer
31
-
32
- A library owns the layer once you find yourself rebuilding what it does: validation timing and cross-field rules (Form),
33
- caching and refetching (Query), URL as the source of truth (Router), sorting and pagination over rows (Table). Adding the
34
- library mid-project is normal and cheap; unpicking a hand-rolled version later is not.
35
-
36
- ## Docs over memory
37
-
38
- `npx @tanstack/cli` for TanStack docs — never work from memory. Where a project has wired up `@tanstack/intent`, use it to
39
- reach the Agent Skills its TanStack dependencies ship, and read those too.
@@ -1,91 +0,0 @@
1
- # Styling
2
-
3
- **CSS Modules with native CSS by default** — nesting and custom properties are the DRY mechanism; no Sass, no CSS-in-JS, no
4
- utility-class framework. Where the stylesheet lives and who owns one is [components.md](components.md).
5
-
6
- - **Nest pseudo-elements, states, and child selectors under the root** so a selector prefix is written once:
7
-
8
- ```css
9
- .root {
10
- transition: clip-path var(--ease);
11
- &:focus-visible {
12
- outline: var(--imf-ui-border-size-2) solid var(--imf-ui-color-fg-support);
13
- }
14
- &[data-disabled] {
15
- opacity: 0.5;
16
- }
17
- }
18
- ```
19
-
20
- - **Lift a repeated literal into a custom property** (an easing, a colour-math result) and reference it. Custom properties
21
- also carry per-state/per-variant values down the tree — the parameterisation a mixin would provide, done natively.
22
- - Don't "merge" rules that only look similar. Structurally different output (three distinct `clip-path` polygons) isn't
23
- repetition a mixin can remove. Keep it explicit.
24
-
25
- ## Build custom UI from tokens
26
-
27
- Anything you build that the library doesn't cover — a stat widget, a custom panel — uses `--imf-ui-*` variables for color,
28
- spacing, radius, and type instead of hardcoded values. That's what makes custom UI look native next to library components,
29
- and what keeps it correct when the theme changes. A hex code or a magic `px` next to a concept the tokens already name is a
30
- defect.
31
-
32
- Geometry that can't be a token (a clip-path percentage, a hairline `1px`) lives in a named custom property at the top of the
33
- stylesheet, with the invariant written next to it. Don't silently approximate to the nearest token.
34
-
35
- ## Override through the sanctioned seams
36
-
37
- All library styles live in the `imf-ui.components` CSS layer, so **any plain selector you write wins** — that's the whole
38
- override contract:
39
-
40
- - Target the stable hooks: `data-imf-ui-component` attributes and your own classes/wrappers.
41
- - Never target the library's internal class names — they are generated and change without notice.
42
- - Never `!important` — if you think you need it, you're targeting the wrong thing.
43
- - **Style against state via data attributes** (`[data-checked]`, `[data-disabled]`, `[data-popup-open]`) — components expose
44
- their state there, so you never maintain your own state classes. `className` is purely a styling surface:
45
-
46
- ```css
47
- [data-imf-ui-component="Switch"][data-checked] {
48
- outline: 2px solid var(--imf-ui-color-bg-positive);
49
- }
50
- ```
51
-
52
- ## The color system
53
-
54
- The color roles you can name: **surfaces** (`main` the canvas, `support` panels, `minor` popovers), **brand** (identity, full
55
- saturation) vs **primary** (contrast-tuned, CTAs — distinct roles on purpose), **status** (`negative`, `warning`, `positive`,
56
- `info`), and three **accent** slots.
57
-
58
- Two layers:
59
-
60
- - **Controls** are the 80/20 customization surface — override one and every derived token shifts:
61
-
62
- ```css
63
- :root {
64
- --imf-ui-color-primary-hue: 30; /* every primary semantic token follows */
65
- }
66
- ```
67
-
68
- - **Semantic tokens** are what you consume in your own CSS: `--imf-ui-color-bg-{name}` per role, a flat
69
- `--imf-ui-color-fg-{main|support|minor|oncolor|…}` ladder for text. Borders and rings draw from the `fg-*` space.
70
-
71
- Rules of thumb: if you push a hue control into a pale corner, you own overriding the matching `fg-*` token; the color scheme
72
- is `<html data-imf-ui-color-scheme="light|dark">` (the provider sets it) — scheme-specific styling selects via that
73
- attribute.
74
-
75
- ## Responsive styling
76
-
77
- - **Tune components per breakpoint by overriding their `--imf-ui-*` variables inside your own media queries** — custom
78
- properties cross the `@media` boundary, props don't. That's why components expose sizing as variables instead of a `width`
79
- prop:
80
-
81
- ```css
82
- @media (min-width: 768px) {
83
- .my-shell {
84
- --imf-ui-appshell-navbar-width: 22rem;
85
- }
86
- }
87
- ```
88
-
89
- - **Write literal breakpoint values.** The library's `@custom-media` aliases are build-internal and don't ship.
90
- - **JS only for behaviour** (render a burger menu on mobile): `useMediaQuery(minWidth("md"))`. Never for styling CSS can do.
91
- - **No responsive props.** `size={{ sm: … }}` objects are deliberately not offered — write the media query.
@@ -1,16 +0,0 @@
1
- # Testing
2
-
3
- Test the **decisions**, not the rendering.
4
-
5
- - **Pure logic gets unit tests** — pricing, permissions, date math, parsing, reducers. These are cheap, fast, and the place
6
- bugs actually hide.
7
- - **Presentational components generally don't.** A component that maps props onto web-ui primitives has no logic of its own;
8
- asserting that it rendered a `<Button>` tests React, not your code.
9
- - **Behaviour a user performs gets an interaction test** — a form that validates, a flow with steps. Test it through the
10
- interface the user has (roles, labels, visible text), not through internals.
11
- - **Extract the decision out of a hook and test that.** A hook whose interesting part is a plain function is easier to test
12
- as a plain function than through a render harness. A hook that only wraps a browser API has no decision to extract.
13
-
14
- The data layer has its own recipe — stub `fetch`, run the real query client — in [data.md](data.md).
15
-
16
- The measure isn't coverage percentage. It's whether a test failing tells you something you didn't already know.
@@ -1,76 +0,0 @@
1
- # Tooling config
2
-
3
- The config baselines for the tools in [stack.md](stack.md). Prefer typed config (`.ts` over `.json`) where the tool supports
4
- it.
5
-
6
- ## Prettier
7
-
8
- Config file shape is free (`.prettierrc`, `prettier.config.ts`); the values are not:
9
-
10
- ```ts
11
- import type { Config } from "prettier";
12
-
13
- const config: Config = {
14
- printWidth: 125,
15
- tabWidth: 2,
16
- useTabs: false,
17
- trailingComma: "none",
18
- arrowParens: "avoid",
19
- semi: true,
20
- singleQuote: false,
21
- proseWrap: "always"
22
- };
23
- ```
24
-
25
- No config file means Prettier runs on defaults — the values silently differ.
26
-
27
- ## ESLint
28
-
29
- Flat config (`eslint.config.ts`):
30
-
31
- - `strictTypeChecked` + `stylisticTypeChecked`, `projectService: true`
32
- - `as` and `!` banned outside tests (`consistent-type-assertions`)
33
- - `.gitignore` as the ignore source (`includeIgnoreFile` from `@eslint/compat`) — ignores aren't maintained twice
34
- - The `#/` alias enforced via `no-restricted-imports` banning the `../*` pattern — parent-relative paths error, siblings
35
- (`./`) stay relative ([project-structure.md](project-structure.md))
36
-
37
- ## tsconfig
38
-
39
- ```jsonc
40
- {
41
- "compilerOptions": {
42
- "strict": true,
43
- "moduleResolution": "bundler",
44
- "verbatimModuleSyntax": true, // import type stays import type
45
- "noUnusedLocals": true,
46
- "noUnusedParameters": true,
47
- "noFallthroughCasesInSwitch": true,
48
- "noUncheckedSideEffectImports": true,
49
- "skipLibCheck": true,
50
- "paths": { "#/*": ["./src/*"] }
51
- }
52
- }
53
- ```
54
-
55
- The `#/` → `src/` alias and its rationale: [project-structure.md](project-structure.md).
56
-
57
- ## Staged files
58
-
59
- Runner config (lint-staged or nano-staged) applying eslint `--fix` and prettier `--write` to staged files only.
60
-
61
- ## CSS class names
62
-
63
- Generated CSS Module class names are readable in the DOM, `{prefix}-{file}-{local}`, never the default hash. A legible DOM is
64
- what makes devtools and browser automation usable. The library ships the plugin that produces them; pass your own short,
65
- app-scoped prefix:
66
-
67
- ```ts
68
- import { readableCssModuleNames } from "@imfusion/web-ui/build/vite-css-module-names";
69
-
70
- export default defineConfig({
71
- plugins: [react(), readableCssModuleNames({ prefix: "acme" })]
72
- });
73
- ```
74
-
75
- One pattern for dev, Storybook, and production. Register the plugin in **every** tool that compiles the CSS — a compiler left
76
- out generates different names for the same source file, and its styles silently don't apply.
@@ -1,45 +0,0 @@
1
- # TypeScript & code style
2
-
3
- Functional by default: pure functions over stateful classes, immutable data over in-place mutation, expressions over
4
- statements, side effects at the edges (network, DOM, store).
5
-
6
- ## Types
7
-
8
- - No `any`. `unknown` at a boundary you can't type, narrowed before use.
9
- - Infer locals; annotate contracts. Exported functions get an explicit return type.
10
- - No temporal coupling — model the states instead of initialising `null` and filling in later.
11
- - Avoid `as`. Fix the type. The honest exception: an untyped third-party boundary, kept at the boundary.
12
- - Derive, don't duplicate:
13
-
14
- ```ts
15
- const sizes = ["sm", "md", "lg"] as const;
16
- type Size = (typeof sizes)[number];
17
-
18
- const labels: Record<Size, string> = { sm: "S", md: "M", lg: "L" }; // compiler breaks if `sizes` changes
19
- ```
20
-
21
- Across boundaries the same rule: library props via `React.ComponentProps<typeof Button>`
22
- ([library-boundary.md](library-boundary.md)), API types via `z.infer` ([data.md](data.md)).
23
-
24
- - Function signatures: 1–2 positional arguments; at 3+, one destructured object.
25
-
26
- ## Immutability & expressions
27
-
28
- - Array methods before loops — `map`, `filter`, `find`, `some`, `flatMap` name what they do:
29
-
30
- ```ts
31
- const activeNames = users.filter(u => u.isActive).map(u => u.name);
32
- ```
33
-
34
- - Produce new values: spreads and `structuredClone` over in-place edits, `toSorted`/`toReversed` over `sort`/`reverse` (which
35
- mutate their receiver).
36
- - Allowed exceptions: a genuine early exit (`for` + `break`), a measured hot loop.
37
- - Keep chains flat: 3–4 steps read well; longer wants named intermediates, and a `reduce` doing four things wants to be a
38
- loop.
39
-
40
- ## Naming
41
-
42
- - Say what it is, not what it's made of: `useUserQuery`, not `useUserHook`; `retryDelay`, not `num`.
43
- - Booleans read as assertions: `isOpen`, `hasAccess`, `canSubmit`.
44
- - Handlers: `onX` as props, `handleX` as implementations.
45
- - Match the vocabulary the product and the API already use — no synonyms for terms the backend named.
@@ -1,89 +0,0 @@
1
- ---
2
- name: imf-web-ui-frontend-setup
3
- description:
4
- "Set up or audit an ImFusion frontend's project tooling: the stack, package.json scripts, formatting, linting, typecheck,
5
- staged-file and pre-commit hooks, verification scopes, dependency pinning, tsconfig, docs structure, agent wiring. House
6
- conventions, not industry standards. Load when starting a new ImFusion frontend, when asked what an existing one's setup is
7
- missing, when asked to align a repo with the baseline, or when asked to check or set up one named topic from it (e.g. CSS
8
- class names, Prettier). Not for a bare 'add this config file' request — that's just the edit. Not for wiring the library
9
- itself (imf-web-ui-library-setup)."
10
- argument-hint: "[new|audit|align|<topic>]"
11
- ---
12
-
13
- # imf-web-ui-frontend-setup
14
-
15
- First-time setup and audit against the ImFusion frontend baseline. The conventions live in `imf-web-ui-frontend-conventions`
16
- — this skill is the process that checks a repo against them and wires up what they assume. In-house conventions, not industry
17
- standards: report findings as "missing against the ImFusion baseline", never "against best practice". Built for ImFusion
18
- frontends; anyone else who likes the baseline can run it too.
19
-
20
- Four modes, same checklist:
21
-
22
- - **New project** — work down the checklist and set each piece up.
23
- - **Audit** — read the repo (don't ask what it has), report present / missing / broken, change nothing until the human picks.
24
- An established repo is where a forgotten piece hides. **The project wins:** where the repo already decided, that stands —
25
- report what's _absent_; a working convention you'd have chosen differently is not a finding.
26
- - **Align** — when the user asks to _align_ the repo with the baseline ("align"/"alignment" is the flag), the project-wins
27
- guard lifts: deviations become migration findings, proposed as a plan, still nothing changed until approved.
28
- - **One topic** — any other argument names a topic instead of a mode (`class names`, `prettier`, `tooling`). Resolve it to
29
- the checklist rows it touches and run the audit process against those only, reading their references as usual. Say which
30
- rows you resolved it to before reporting, and if nothing matches, say so and list the rows rather than guessing or sweeping
31
- everything. Same output as an audit: findings, nothing changed until the human picks.
32
-
33
- **Producer scope.** The web-ui repo itself produces this baseline; it is not a consumer frontend. Consumer-only rows — the
34
- AGENTS.md fence, vendored-skill staleness, the app stack and app `src/` tree — don't apply there. Audit it against the shared
35
- rows only: scripts, tooling, git, docs.
36
-
37
- ## The checklist
38
-
39
- Each row is a reference in `../imf-web-ui-frontend-conventions/references/` — read it, then check the repo against it. A
40
- topic argument narrows this table to the rows it names; every other mode works down all of it.
41
-
42
- | Reference | Set up / audit |
43
- | ---------------------- | ------------------------------------------------------------------------------------------- |
44
- | `stack.md` | the dependencies match the topic→tool map; devtools siblings present |
45
- | `npm-project.md` | script names table, `type`/`private`, exact pins, `.npmrc`, Node pinning |
46
- | `tooling.md` | Prettier values, ESLint flat config, tsconfig, staged-file runner, readable CSS class names |
47
- | `git.md` | `git:config` run and hooks directory present, verify scopes, staleness hooks |
48
- | `project-structure.md` | the `src/` tree, file naming, `#/` alias wiring |
49
- | `components.md` | component folders and colocation |
50
- | `styling.md` | CSS Modules, tokens, no CSS-in-JS or utility framework |
51
- | `docs-structure.md` | docs shape and content rules (see Docs below) |
52
- | — agent tooling | delegated to `imf-web-ui-agent-setup` (see Agent tooling below) |
53
-
54
- ## Docs
55
-
56
- `README.md`, `AGENTS.md`, and `docs/` with a `docs/index.md` that registers every doc. Scaffold from
57
- [`templates/README.md`](templates/README.md) and [`templates/AGENTS.md`](templates/AGENTS.md); missing structure is a
58
- finding.
59
-
60
- Keep `AGENTS.md` lean. The decision test for every line: would the agent make a costly mistake without it? If it would just
61
- need to read a file first, cut it — dev commands, path aliases, and tool config are discoverable from the files themselves.
62
-
63
- `AGENTS.md` contains one installer-owned section: the `<!-- imf-web-ui:begin -->` … `<!-- imf-web-ui:end -->` fence.
64
- `npx web-ui-install` refreshes what's inside on every skills install; everything outside the fence is the repo's own. A
65
- missing fence in an existing `AGENTS.md` is a finding — without it the baseline note can't be kept current.
66
-
67
- Judge existing docs only against `docs-structure.md`: repo-unique content stays, restated baseline becomes a pointer,
68
- deviations get named as deviations. Don't rewrite a repo's docs uninvited — report, and let the human pick.
69
-
70
- ## Agent tooling
71
-
72
- The agent side — vendored skills and their freshness, the lifecycle hooks, the settings registrations — is
73
- `imf-web-ui-agent-setup`. Delegate to it: in a new project after the docs step, in an audit as one checklist row (skills
74
- present and current, hooks wired or consciously adapted). Findings it produces report here like any other.
75
-
76
- ## Optional
77
-
78
- Recommend when the shape calls for it; absence is not a finding.
79
-
80
- - **knip** — once several people delete things independently.
81
- - **`eslint-plugin-jsx-a11y`** — anything user-facing.
82
-
83
- Out of scope, project-specific: CI, env and secrets, error tracking, deploy, dependency updates.
84
-
85
- ## Not this skill
86
-
87
- - Library wiring (styles import, provider) → `imf-web-ui-library-setup`
88
- - The conventions themselves → `imf-web-ui-frontend-conventions` and its references — this skill checks the structure exists,
89
- that skill owns what goes inside it
@@ -1,34 +0,0 @@
1
- # AGENTS.md
2
-
3
- <Keep this file lean — target ~50 lines. Decision test for every line: would the agent make a costly mistake without it? If
4
- it would just need to read a file first, cut it. Dev commands, path aliases, and tool config are discoverable from the files
5
- themselves.>
6
-
7
- <One paragraph: what the app is and the stack in one line.>
8
-
9
- Scripts, deps, and setup: [`README.md`](./README.md) and [`package.json`](./package.json) are the source of truth. Check the
10
- `package.json` scripts before running or suggesting a command — don't infer one exists by pattern-matching a sibling.
11
-
12
- ## Read before you write
13
-
14
- <One bullet per doc in docs/, each with when to read it, e.g.:>
15
-
16
- - [`docs/<topic>.md`](./docs/<topic>.md) — <what it covers>. Read before <the change it governs>.
17
-
18
- [`docs/index.md`](./docs/index.md) registers all of them.
19
-
20
- ## Working here
21
-
22
- <The fenced block below is the only part of this file `npx web-ui-install` touches: its content comes from this template and
23
- is refreshed on every skills install. Everything else in the file is scaffolded once by the setup skill and then owned by the
24
- repo.>
25
-
26
- <!-- imf-web-ui:begin — managed by `npx web-ui-install`; edits inside the fence are overwritten -->
27
-
28
- `.agents/skills/imf-web-ui-*` is vendored from `@imfusion/web-ui` and resynced with `npx web-ui-install`. Don't edit it and
29
- don't put repo conventions there. Load the matching `imf-web-ui-*` skill before writing code, styles, data fetching, or docs;
30
- repo docs hold only what is unique to this repo.
31
-
32
- <!-- imf-web-ui:end -->
33
-
34
- <Repo-specific agent guidance: generated files that are committed, tools to verify APIs against, things never to touch.>
@@ -1,27 +0,0 @@
1
- # <App name>
2
-
3
- <One paragraph: what the app is, the stack in one line — e.g. "Vite + React 19 + TanStack Router (file-based, CSR) + TanStack
4
- Query + @imfusion/web-ui".>
5
-
6
- ## Install
7
-
8
- ```bash
9
- npm install
10
- npm run git:config # once per clone: hooks path, pull.rebase, merge.ff
11
- ```
12
-
13
- <Registry tokens, required services, or other one-time setup. Delete if none.>
14
-
15
- ## Usage
16
-
17
- ```bash
18
- npm run dev
19
- ```
20
-
21
- <Environment specifics: proxies, .env files, ports. Delete if none.>
22
-
23
- `npm run` lists every script; `package.json` is the source of truth. `verify:full` is the CI gate.
24
-
25
- ## Docs
26
-
27
- [`docs/index.md`](./docs/index.md) registers them.