diff --git a/.agents/skills/add-catalogue-project/SKILL.md b/.agents/skills/add-catalogue-project/SKILL.md deleted file mode 100644 index 963fe0b2..00000000 --- a/.agents/skills/add-catalogue-project/SKILL.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -name: add-catalogue-project -description: Use when adding a repository to the Purview-Dev website catalogue — recon the repo, author the catalogue record (docs, packages, tags, use cases), integrate it across the catalogue/docs/releases surfaces, and prove it with the validation pipeline. -category: purview-dev-website -roles: - - catalogue - - docs - - integration -tags: - - projects-yml - - astro - - starlight - - documentation ---- - -# add-catalogue-project Skill - -Use this skill when a repository must be added to (or promoted within) the Purview-Dev website. - -Related: `add-project-intake`, `project-manifest-reference`, `docs-aggregation-rules`, -`use-case-authoring`, `github-repo-metadata`, `site-validation-loop`. - -## Step 0 — decide the target collection - -| Situation | Where it goes | -| --- | --- | -| Repository is owned by the `purview-dev` organisation | `projects:` | -| Project the organisation contributes to but does not own (for example `likec4/likec4`) | `externalProjects:` | - -Only `projects:` entries get a `/projects//` page, documentation aggregation, LLM bundles and -release data. `externalProjects:` entries are link-out cards on `/projects/` and must never point at -a `purview-dev` repository. - -## Step 1 — recon the repository (never guess) - -```shell -# Metadata: description, topics, archived, default branch, discussions, homepage -gh api repos// --jq '{description, topics, archived, default_branch, has_discussions, homepage}' - -# Docs layout: does docs/ exist, is it a mirror of the wiki, is there a _Sidebar.md? -gh api "repos///git/trees/main?recursive=1" --jq '.tree[].path' -gh api "repos///contents/README.md" -H 'Accept: application/vnd.github.raw' - -# Project conventions: build type, agent guidance, licensing -gh api "repos///contents/purview-build.json" -H 'Accept: application/vnd.github.raw' - -# Release channel and tag shape -gh api "repos///releases?per_page=10" --jq '.[] | {tag_name, prerelease, published_at}' - -# Packages: confirm each id exists and see its channel (replace the id) -curl.exe -s "https://api.nuget.org/v3-flatcontainer//index.json" -# npm packages (skip the NuGet index): the registry document carries versions + dist-tags -curl.exe -s "https://registry.npmjs.org/%2F" -``` - -Record, as evidence for the record you are about to write: where the docs live, the exact markdown -file that should be the landing page, the NuGet package ids, the release channel, and the repository -description/topics. - -## Step 2 — classify - -- `category`: exactly one of `application-framework`, `validation`, `observability`, - `source-generation`, `aspire`, `build-tooling`, `developer-tooling`. -- `status`: - - `archived` when the repository is archived (GitHub `archived: true`). - - `preview` when there is no stable release on the registry the project publishes to. - - `stable` only when a stable (non-prerelease) release exists and is recommended for use. -- `experimental: true` (a flag, not a status value) when the tooling is explicitly an experiment: - no compatibility promise, no production support guarantee. Keep `status` as the honest release - channel alongside it (`preview` for prerelease-only tooling). See ADR 0004; the project page and - every aggregated documentation page then carry an Experimental warning. -- `id`: lowercase `[a-z0-9-]` slug, normally the repository name. -- `name`: display name. **It must slugify to `id` when the project has `docs`** (so the display name - and the `/projects//` and `/docs//` URLs agree). -- `order`: pick an unused value (10–80 in tens is the existing convention). - -## Step 3 — author the record - -Add the entry as `src/src/data/projects/.yml` (see `project-manifest-reference` for every field): - -```yaml - - id: - name: - shortDescription: - description: >- - - origin: >- - - useWhen: >- - - avoidWhen: >- - - repository: purview-dev/ - category: - status: - order: - docs: - source: github-path | wiki | readme - path: docs # github-path only - rootPage: Home.md # optional; see docs-aggregation-rules - exclude: [ _Sidebar.md ] # only files the repository actually ships - targetFrameworks: [ net8.0, net9.0 ] - install: nuget | msbuild-sdk | dotnet-tool # NuGet packages only; omit for npm - packages: - - id: - registry: nuget | npm # optional; defaults to nuget (ADR 0012) - description: - primary: true - related: [ ] - acknowledgments: - - name: - url: https://github.com// - description: - useCases: - - audience: developer - title: - scenario: >- - - code: | - - language: csharp - outcome: >- - - evidence: >- - - docsPage: -``` - -Every non-archived project needs at least **one** use case with `code` + `language` and an -`evidence` fact (ADR 0002). See `use-case-authoring`. - -## Step 4 — fix the upstream metadata (this is where tags come from) - -- Set GitHub **topics** on the repository (they become the site's tag chips). See - `github-repo-metadata` for the exact command and the taxonomy guidance. -- The repository description must be genuinely descriptive: it backs the `shortDescription` - fallback and social/`og:` metadata. -- Leave `discussions` unset: the loader detects it from the repository (`hasDiscussions`). Set - `discussions: false` only to opt a repository out, or `true` to force the link. - -## Step 5 — integrate and verify - -```shell -just data-sync # aggregate docs + refresh release data (cache-first) -just check-projects # deterministic catalogue guard (part of `just validate`) -bun run typecheck && bun run test -just check-generated -just validate # full chain: format, lint, build, link crawl, dist tests -``` - -Confirm each surface actually lights up: - -1. `/projects/` shows the card with the right category/status/tags (tags come from topics). -2. `/projects//` renders description, use cases, install panel, packages, and related links. -3. `/docs//` exists with the expected page count and a sidebar topic named after the project. -4. `/projects//llms.txt` and `/projects//llms-full.txt` are emitted and linked from - `/llms.txt`. -5. `/use-cases/` lists the new use cases under the right audiences. -6. `/releases/` shows GitHub and registry versions (NuGet or npm) for the declared packages. -7. If a live example page exists at `src/src/pages/examples/.mdx`, `/projects//` links it as - **Live example** (the page is discovered, not declared). - -## Step 6 — report - -State: the record added, the recon evidence, the package ids and channels, the docs source and page -count, the checks run with their result, and any `upstream` follow-ups (for example: topics missing, -docs not yet in a `docs/` folder, no stable release yet). - -## Pitfalls - -- `docs.path` must be a **repository path** (`docs`, `docs/wiki`), never a URL. -- A repository whose wiki is mirrored into `docs/wiki` is plain Markdown: `Home.md` is the hub and - `_Sidebar.md` (the navigation) is the only file that has to be excluded. A wiki that keeps a - different first page keeps `rootPage`; only a page the repository does **not** ship needs excluding, - and a stale pattern (an `index.md` the upstream deleted) is a silent no-op rather than an error. - See `docs-aggregation-rules`. -- Aggregation reads branch `main`. If the repository's default branch is `master`/`develop`, docs - aggregation silently yields nothing — rename or report it. -- The `README.md`-as-index mode (`readme:`) publishes exactly one page and cannot be combined with - `rootPage`. -- Adding a project does not require editing tests: the manifest tests assert `>=` counts, not exact - membership. But keep their expectations true (for example the `>= 8` use-case coverage). diff --git a/.agents/skills/audit-catalogue-projects/SKILL.md b/.agents/skills/audit-catalogue-projects/SKILL.md deleted file mode 100644 index 90328d7f..00000000 --- a/.agents/skills/audit-catalogue-projects/SKILL.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -name: audit-catalogue-projects -description: Use when auditing or repairing the catalogue records under src/src/data/ — the invariant checklist for documentation, stability, metadata, tags, packages, relationships, use cases and ordering, plus the findings report format. -category: purview-dev-website -roles: - - catalogue - - audit -tags: - - projects-yml - - validation - - metadata ---- - -# audit-catalogue-projects Skill - -Use this skill to answer "is every project in the catalogue correct?" with evidence, and to repair -the unambiguous problems. - -Related: `project-manifest-reference` (fields and vocabularies), `docs-aggregation-rules`, -`use-case-authoring`, `github-repo-metadata`, `site-validation-loop`. - -## Method - -1. **Deterministic first.** Run `just check-projects` and `bun run test`. These already enforce the - structural invariants; start from their output rather than re-deriving it. -2. **Then the judgement checks** that no script can make: is the description truthful, is the - category right, is the stability honest, is the use-case evidence real. -3. **Gather live evidence per project** with `gh` and NuGet (commands in `github-repo-metadata`). -4. **Report before repairing.** Produce the findings table, then apply `blocker`/`drift` fixes and - re-run the guards. - -## Invariant checklist - -### Structure (enforced by `loadProjects()` / `just check-projects`) - -- `id` is a lowercase `[a-z0-9-]` slug; `repository` is `purview-dev/` for `projects:`. -- `related`, `supersedes`, `supersededBy` reference known ids; a superseded project names its - successor and vice versa where the pairing exists. -- Every NuGet package id appears exactly once across the catalogue. -- `order` values are unique integers and the sorted order is the intended presentation order. -- For every project with `docs`, `name` slugifies to exactly `id`. -- Every non-archived project has ≥1 use case; every use case with `code` has `language`. -- Every `docsPage` resolves to a page in `src/.cache/docs/index.json` for that project. -- `externalProjects` never point at a `purview-dev` repository and always have a working `url`. - -### Documentation - -- `docs.source` matches reality: `github-path` when the repository has a docs folder, - `wiki` when the content lives in the wiki, `readme` only for single-page projects. -- `docs.path` exists **on branch `main`** and contains `.md` files. -- `rootPage` names a page that exists under `docs.path`; when it names a non-index page and a - conventional root page (`index.md`/`Home.md`/`readme.md`) also exists, that conventional page must be - listed in `exclude`. -- `exclude` keeps the navigation files out of the page list: `_Sidebar.md` (and `_Footer.md` for a - `wiki` source). It is a filter over the files the repository ships, so a pattern naming a file that - no longer exists is a no-op, not a warning or a failure. -- The aggregated page count is non-zero and the landing page is the page a reader should land on. -- Archived projects that still declare `docs` are intentional (they are excluded from the portal). -- Documentation is not duplicated here: this repository only holds the mirror. -- Pages moved in the repository's history have a redirect — in its `_redirects.yml` or the entry's - `docs.redirects` (ADR 0013). Diagrams are LikeC4/Mermaid pairs, not ASCII art or Mermaid in a - `text` fence. The consumer assessment script reports both against a clone (below); file the - repository-side fixes as `upstream` items, since they belong in the product repository. - -### Stability - -- `archived` repository ⇒ `status: archived`. -- No stable NuGet release ⇒ not `stable` (`preview`). -- `experimental: true` is orthogonal to `status`: report `experimental` with `status: stable` as - `drift` (the flag says "no support promise" while the channel says "recommended for use"), and - `experimental` on an archived project as a `blocker` (the schema rejects it outright). -- `stable` ⇒ a stable, listed NuGet release exists and the repository is not archived. -- Deprecated NuGet packages are reported, not silently accepted. -- A project with `packages: []` is intentional: build tooling consumed as a tool/SDK still declares - its package id when one exists. - -### Metadata and tags - -- Repository description is present, factual, and consistent with `shortDescription`/`description`. -- **Topics are non-empty** — they are the only source of site tags — and follow the lowercase, - hyphenated taxonomy. -- `discussions: true` only when the repository has discussions enabled. -- `homepage`/`url` targets resolve. -- `featured` is used deliberately (a handful of headline projects, not most of the catalogue). - -### Packages, frameworks and install - -- Each declared package id exists on NuGet and has published versions (the guard checks the release - cache). -- Exactly one `primary` when a project has multiple packages. -- `targetFrameworks` match the package's actual TFMs (`netstandard2.0` for generators/analyzers is - normal). `just check-projects` reports a mismatch as an advisory observation: project-level - frameworks against the union of the runtime packages' published TFMs, package-level frameworks - against that package's own. `netstandard*` is treated as an analyzer/generator target, not a - consumer framework. -- `install` is set only when the package is not a plain NuGet reference: `msbuild-sdk` for - `Purview.BuildSdk`, `dotnet-tool` for `Purview.Build`. - -### Use cases - -- Coverage across audiences is meaningful for the project's shape (adopter, approver, extender). -- `scenario` describes a situation; `outcome` describes the result; `evidence` is a fact. -- Snippets are short, compile-plausible, and use the right `language`. -- `docsPage` points at the page that actually carries the depth. - -## Evidence commands - -```shell -# Deterministic guards -just check-projects -bun run test - -# Per-project live evidence -gh api repos/purview-dev/ --jq '{description, topics, archived, default_branch, has_discussions, homepage}' -gh api "repos/purview-dev//git/trees/main?recursive=1" --jq '[.tree[].path | select(endswith(".md"))]' -gh api "repos/purview-dev//releases?per_page=10" --jq '.[] | {tag_name, prerelease}' -curl.exe -s "https://api.nuget.org/v3-flatcontainer//index.json" - -# Repository-side integration (docs layout, diagrams, redirects, skills) against a fresh clone -git clone --depth 300 https://github.com/purview-dev/.git / -node skills/purview-site-assessment/scripts/assess.mjs / --catalogue src/src/data/projects/.yml - -# Aggregated result -node -e "const m=require('./src/.cache/docs/index.json');for(const p of m.projects)console.log(p.projectId,p.pages.length)" -``` - -If `.cache/docs/index.json` or the release cache is stale, run `just data-sync` (live) first so the -evidence and the guards agree. - -## Report format - -```markdown -| Project | Field | Observed | Expected | Severity | Evidence | Fix | -| --- | --- | --- | --- | --- | --- | --- | -| example-tool | status | stable | preview | drift | no stable NuGet version (flat container: only 1.2.0-prerelease.3) | set status: preview | -| example-tool | — | topics: [] | 6–15 topics | drift | `gh api repos/...` shows an empty topics array | set repository topics | -``` - -- Severity: `blocker` (schema/build failure or a broken page), `drift` (data contradicts reality), - `polish` (quality), `upstream` (must be fixed in the product repository: missing docs, missing - topics you cannot set, no stable release). -- Close the report with: number of projects audited, checks run, fixes applied, and the items left - for a human. -- Apply only `blocker` and `drift` fixes; never restructure a record or change a category to make a - check pass. - -## Guardrails - -- Do not add use cases or evidence you cannot trace to the repository or the aggregated docs; report - the gap instead. -- Do not change the schema vocabulary; adding a `status`/`category` value needs an ADR. -- Do not hand-edit the docs mirror or caches to make the audit pass. -- If an audit fix changes a catalogue record, re-run `just check-projects`, `bun run test`, and - `just validate` before reporting completion. diff --git a/.agents/skills/docs-aggregation-rules/SKILL.md b/.agents/skills/docs-aggregation-rules/SKILL.md deleted file mode 100644 index b5e646c8..00000000 --- a/.agents/skills/docs-aggregation-rules/SKILL.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -name: docs-aggregation-rules -description: How the website aggregates documentation from product repositories into /docs// — sources, root-page and exclusion rules, ordering, injected front matter, tags from repository topics, staleness, and the failure modes with their remediations. -category: purview-dev-website -roles: - - docs - - reference -tags: - - starlight - - documentation - - aggregation ---- - -# docs-aggregation-rules Skill - -`just data-sync` runs `src/scripts/sync-docs.ts` → `aggregateDocs()` in -`src/src/lib/docs/aggregate.ts`. It reads each catalogue project's `docs` configuration, fetches -the markdown from the product repository, writes the mirror to `src/src/content/docs/docs//` -and records the page list in `src/.cache/docs/index.json`. - -**Never edit the mirror by hand** — it is gitignored and regenerated. - -## Where content comes from - -| `docs.source` | Fetch mechanism | Notes | -| --- | --- | --- | -| `github-path` | Repository tree (`git/trees/?recursive=1`) filtered to `/**/*.md` | Each file fetched from `raw.githubusercontent.com` at the channel's ref (the repository's default branch when no `channels` are declared) | -| `wiki` | `git clone --depth 1 https://github.com/.wiki.git` | `_Sidebar.md` and `_Footer.md` are never rendered. A wiki has one HEAD, so it supports a single channel | -| `readme` | Raw `README.md` | Exactly one page (`index`), single channel | - -The ref is the repository's **default branch** (from the release cache, falling -back to `main`) unless the manifest declares `docs.channels` (ADR 0009). -`lastReviewed` is the last commit date for the file (Atom feed for -`github-path`/`readme`, wiki HEAD commit for `wiki`); a channel pinned to a -release tag uses that release's date instead, because the content cannot move. - -## Channels (`live` and `prerelease`) - -A project may publish two views of its documentation: - -```yaml - docs: - source: github-path - path: docs/wiki - rootPage: Getting-Started.md - channels: - live: - ref: latest-stable - prerelease: - ref: default -``` - -- The **default** channel (`live`, or the only declared channel) is written to - `src/src/content/docs/docs//.md` and served at `/docs///`. -- Any other channel is written to - `src/src/content/docs/docs///.md` and served at - `/docs////`. -- `docs//` is reserved: a source page whose slug equals a channel id - raises `DocsValidationError`. -- `src/.cache/docs/index.json` is schema 2 and stores - `projects[].channels[] = { id, ref, refKind, version, label, default, pages[] }`. - A cache from an older schema reads as absent, so `just data-sync` regenerates it. -- The Starlight sidebar groups a two-channel project per channel (`Live 2.4.2`, - `Prerelease main`); a one-channel project keeps a flat list. The page title - component renders the switcher and a prerelease notice. -- **Promotion is automatic.** The prerelease channel is only aggregated while a - prerelease version outranks the newest stable release, computed from GitHub - release tags and NuGet versions. A stable release that catches up retires the - channel on the next sync (a `docs : prerelease documentation is not - published: …` line, not an error) and the next prerelease restores it. Never - remove the declaration just to stop publishing it. -- **Retired URLs redirect to live.** For each withheld channel URL the build - writes a `noindex` meta-refresh page (canonical + `data-pagefind-ignore`) - pointing at the live page with the same slug — GitHub Pages serves files only, - so `_redirects` is not an option. These files are written at - `astro:build:done` (`config/docs-redirects-integration.ts`), outside Astro's - route list, so they stay out of the sitemap, `discover.json` and the llms - bundles. -- Per-project `llms-full.txt` publishes the default channel only; `llms.txt` - also links the prerelease channel when one exists. - - -## Root page selection (the most common onboarding failure) - -1. A conventional index file wins by default: `index.md`, `Home.md`, or `readme.md` (case-insensitive - basename). -2. `docs.rootPage` may override it **only** when that conventional file is removed with - `docs.exclude`. Otherwise aggregation raises `DocsValidationError`: - *"selects a non-index page while a conventional root page already exists"*. -3. If no index file and no `rootPage` exist, aggregation raises - *"docs: no root page exists"* — add `index.md`/`Home.md`/`readme.md` or set `rootPage`. -4. If `rootPage` names a file that does not exist, aggregation raises - *"docs.rootPage: ... does not exist"*. - -The product wikis are mirrored into `docs/wiki` and are **plain Markdown**: `Home.md` is the hub, -`_Sidebar.md` is the whole navigation, and the repository carries no site configuration at all — the -engineering playbook deleted its `mkdocs.yml` and its TechDocs `index.md`, and no repository needs to -add them back. A repository that still ships a site file (`mkdocs.yml`) or a generated `index.md` is a -**deviation this portal ignores**: aggregation reads `docs.path` and this entry's `exclude`, never the -site configuration. So the pattern for a wiki is: - -```yaml - docs: - source: github-path - path: docs/wiki - rootPage: Home.md - exclude: [ _Sidebar.md ] -``` - -`Home.md` is itself a conventional root page, so `rootPage` restates the default rather than -overriding it, and nothing has to be excluded for it to win. Exclude only the files the repository -actually ships. - -While a repository still carries a site file, `just data-sync` reports it once and **never fails**: - - docs containers: mkdocs.yml is a repository site configuration and the portal ignores it — the - catalogue entry alone decides what is published, so the repository can drop the file. - -That is an advisory (`findLegacySiteConfig` in `src/lib/docs/aggregate.ts`), not a gate, and it is -printed on stdout so it survives into the build log; on GitHub Actions the same text is repeated as a -`::warning` annotation on the run. The aggregation keeps stripping the Material markup such a file -stands for (`./mkdocs`), so the file can be deleted upstream in its own time and on its own pull -request; when it is gone the advisory simply stops appearing. - -## Exclusions and ordering - -- `exclude` matches the **base file name** (`index.md`, `_Sidebar.md`) with `*` wildcards; it is - applied **before** the root page is selected (that is what makes rule 2 work). -- A pattern that matches nothing is a **no-op**: excluding `index.md` from a wiki that has since - replaced it with `Home.md` neither warns nor fails, so a stale pattern cannot block the build while - the upstream repository is mid-reorganisation. Remove it when you notice, but it is not drift the - guard reports. -- Page order comes from, in priority: `docs.order` (explicit slug list) → a `_Sidebar.md` link order - (both for `wiki` and for a mirrored wiki under `github-path`) → `1000`. -- The landing page is always `order: -1`, so it heads the sidebar as "Overview". -- A page's slug is its path from the docs root (ADR 0011): a flat corpus keeps the single-segment - slug (`Getting-Started.md` → `getting-started`, served at `/docs//getting-started/`), and a - topic folder stays a path segment (`schemas/Custom-Rules.md` → - `/docs//schemas/custom-rules/`). A nested `README.md` is the folder's index, so - `guide/README.md` publishes at `/docs//guide/` (the root `README.md` stays the landing page). - A `docsPage` in a use case must use a slug that still resolves in the **default** channel, which - is why it stays a single segment. - -## Injected front matter (per page) - -`title` (first `# H1`, else the slug), `description` (first prose paragraph, ≤160 chars), -`owners: [purview-dev]`, `status` (the project's status), `experimental: true` (written only when -the catalogue flags the project, ADR 0004), `lastReviewed`, `sourceProject`, -`sourceRepo`, `projectName`, `sourcePath`, `editUrl`, `tags` (the repository's GitHub **topics**, -absent when there are none), and `sidebar.label`/`sidebar.order`. - -Additional transformations: GitHub alert blockquotes become Starlight asides; relative links between -documents are rewritten to portal URLs; **relative** images are rewritten to GitHub raw URLs while -**absolute** image URLs pass through untouched — a registry badge such as -`![Purview.BuildSdk](https://img.shields.io/nuget/v/Purview.BuildSdk)` keeps its own URL, so a page can -show a live version without stating a number that rots; the first top-level H1 is removed from the body -(it becomes the front-matter `title`, which the page header renders) and any later H1 is demoted to `##`, -so each page shows its title once. - -## What the site does with it - -- Each documented project becomes a `starlight-sidebar-topics` topic whose items come from - `src/.cache/docs/index.json` (so the mirror and the manifest must come from the same sync). -- The sidebar mirrors the published tree (ADR 0011): every folder in a slug becomes a nested - `starlight` group labelled with the folder's name spelled out (`schemas` → `Schemas`), placed where - its first page appears and holding all of that folder's pages in channel order. Nesting is - recursive, a folder's `index.md` or nested `README.md` links the folder's own address, and a flat - corpus renders exactly the flat list it always did (`buildChannelItems` in - `src/lib/docs/sidebar.ts`). -- Each aggregated page also names the folders above it, above the title, in the same spelling as the - sidebar (`PageTitle.astro` + `docSectionTrail`). -- Archived projects are excluded from the docs portal, the sidebar topics, and per-project LLM - bundles, even if they declare `docs`. -- Every documented project gets `/projects//llms.txt` and `/projects//llms-full.txt`, linked - from `/llms.txt` and from the project page. -- Staleness: a page is flagged when `lastReviewed` is older than 365 days - (`src/src/lib/docs/staleness.ts`). -- A ```` ```likec4 ```` fence in a mirrored page is rendered when it compiles, and - stays **source** when it does not: the whole `docs` collection is relaxed through - astroc4's `validation: { collections: ['docs'] }` (`astro.config.ts`). Such a page - was written for another renderer, so its fence is often a partial snippet; astroc4 - logs a warning and leaves it as a highlighted code block instead of failing the - build. Pages the site authors (`src/pages/**`) are not in the collection, so they - keep strict validation. - -## Diagram pairs (ADR 0013) - -A product page pairs a GitHub rendering with a LikeC4 view: - -````markdown - -```mermaid -flowchart LR - resume --> next -``` -[LikeC4 model](./diagrams/the-loop.c4) - -```` - -`buildPage` runs `applyDiagramBlocks` (`src/lib/docs/diagrams.ts`) on the raw source before anything -else: the `.c4` file is read from the repository at the channel's ref (resolved relative to the page, -or `/`-rooted at the repository root), and the whole block becomes a ```` ```likec4 ```` fence holding -the model, with `view`, `project`, `title`, `description`, `height`, `collapsible` and `defaultOpen` -passed through. A missing model, an undeclared view or a malformed marker keeps the Mermaid and logs -`docs : line : …`. Markers inside code fences are ignored. - -## Repository redirects (`_redirects.yml`, ADR 0013) - -`/_redirects.yml` (the wiki root for `source: wiki`) holds `previous: current` pairs, either -under `redirects:` or as a bare map; each side is a slug or a Markdown path, reduced with `docSlug`. -It is read per channel and stored as `channels[].redirects` in `src/.cache/docs/index.json`; -`docsPageRedirects(projects, manifest)` writes each channel's pairs from that channel's base, after the -catalogue's `docs.redirects` (which wins on a conflict). An invalid file is a `DocsValidationError`; a -destination that is not a page, or a source that still is, is an advisory line in the sync log. - -## Consumer skills - -`skills/` at the repository root is what product repositories install -(`npx skills add purview-dev/purview-dev`): `purview-site-integration`, `purview-site-docs` and -`purview-site-assessment` (with `scripts/assess.mjs`). They restate these rules for authors, so a change -to slugs, diagram pairs or redirects here changes them in the same pull request. - -## Verifying - -```shell -just data-sync # expect "docs : pages" per project -node -e "console.log(require('./src/.cache/docs/index.json').projects)" -just build && just check-generated # asserts the mirror matches the manifest -``` - -A reorganised tree is verified in the built output: the old flat slug must be a meta-refresh page -pointing at the new address, on every channel that publishes the tree (`/docs///` and -`/docs//prerelease//`), and the sidebar of a nested channel must contain a `group-label`. - -A page that shows a registry badge instead of a version is verified the same way: the badge URL must -appear verbatim in the built page (`dist/docs///index.html`), not rewritten to a -`raw.githubusercontent.com` address. `docs.test.ts` covers an absolute badge URL beside a relative one. diff --git a/.agents/skills/github-repo-metadata/SKILL.md b/.agents/skills/github-repo-metadata/SKILL.md deleted file mode 100644 index c346bc19..00000000 --- a/.agents/skills/github-repo-metadata/SKILL.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -name: github-repo-metadata -description: How GitHub repository metadata feeds the website (topics become tags, description backs shortDescription, archived/description/discussions drive status and links) and how to inspect and correct it with gh. -category: purview-dev-website -roles: - - catalogue - - metadata -tags: - - github - - topics - - tags - - nuget ---- - -# github-repo-metadata Skill - -The manifest is curated, but several site surfaces read **live repository metadata** that is fetched -at build time into `src/.cache/releases/releases.json` (`fetchGitHubRepo`, `fetchNuGetIndex`, -`fetchNuGetSearch` in `src/src/lib/releases/github.ts`). NuGet **version numbers** are the one -exception: the browser re-checks them against the flat-container index and stores the result -(ADR 0008, `src/src/lib/releases/live.ts`), so a published version appears without a redeploy. -Everything else in the table below is build-time. - -## What comes from where - -| Site surface | Source | Notes | -| --- | --- | --- | -| Tag chips (cards, docs portal, docs-page front matter `tags`) | GitHub **topics** | `projectRepoEnrichment()` in `src/src/lib/releases/repo.ts` | -| `shortDescription` fallback | GitHub **description** | Used only when the manifest value is empty | -| "supplemental" description on the project page | GitHub description | Shown when it differs from the manifest description | -| Successor/archived messaging | GitHub **archived** flag + `status`/`supersededBy` | | -| Version numbers, release dates, badges | GitHub releases + NuGet flat-container index | | -| Downloads / deprecated / listed | NuGet search entry | Rendered on the release tables | -| Discussions link | repository discussion settings (detected) | `hasDiscussions` from the cache; a record's `discussions` is only an override | - -`search` corpora on `/projects/` deliberately include the topics, so missing topics make a project -undiscoverable by its domain keywords. - -## Inspecting - -```shell -gh api repos/purview-dev/ --jq '{description, topics, archived, default_branch, has_discussions, homepage, visibility}' -gh api "repos/purview-dev//releases?per_page=10" --jq '.[] | {tag_name, prerelease, draft}' -curl.exe -s "https://api.nuget.org/v3-flatcontainer//index.json" -curl.exe -s "https://azuresearch-usnc.nuget.org/query?q=packageid:&take=1" -``` - -## Correcting - -Topics are replaced wholesale (PUT), so send the complete set: - -```shell -echo '{"names":["csharp","dotnet","roslyn","source-generators","telemetry"]}' > topics.json -gh api repos/purview-dev//topics --method PUT --input topics.json -rm topics.json -``` - -`gh` also accepts repeated array fields: `gh api repos///topics --method PUT -f 'names[]=csharp' -f 'names[]=dotnet'`. - -Other metadata (`description`, `homepage`, `has_discussions`) is set in the repository settings or -with `gh api repos// --method PATCH -f description='...' -f homepage='...'`. Enabling -Discussions on an organisation repository requires organisation permission; report it as an -`upstream` item when you cannot do it. - -## Tag taxonomy guidance - -- Lowercase, hyphenated, and specific: `event-sourcing`, `source-generators`, `zero-allocation`, - `msbuild-sdk`, `dotnet-aspire`, `csharp`, `roslyn`. -- 6–15 topics is the useful range: enough to describe the domain, few enough that the card's first - four chips are meaningful (cards render `tags.slice(0, 4)`). -- Prefer ecosystem-standard names (`dotnet`, `csharp`, `nuget`, `opentelemetry`) so cross-repo - searches behave predictably. -- Topics are the **only** way tags reach the site. There is no `tags` field in a catalogue record — do - not add one. - -## Stability signals to check against `status` - -| Signal | Implication | -| --- | --- | -| `archived: true` | `status` must be `archived` (and `supersededBy` when a successor exists) | -| No stable release, only `-prerelease.N` tags | `preview` at most | -| Latest NuGet version is stable and listed | `stable` is allowed | -| The README/repository presents the project as an experiment | Set `experimental: true` (it does not replace `status`, which stays the release channel) | -| NuGet `deprecated: true` | Report as `drift`/`upstream`; a deprecated package should not front a `stable` project without explanation | -| `default_branch` is not `main` | Docs aggregation produces nothing — a blocker for any project with `docs` | - -Note that the organisation's Changesets automation publishes `vX.Y.Z-prerelease.N` tags **without** -setting GitHub's `prerelease` flag, so version selection is semver-based; do not judge the channel -from the GitHub `prerelease` boolean alone. diff --git a/.agents/skills/project-manifest-reference/SKILL.md b/.agents/skills/project-manifest-reference/SKILL.md deleted file mode 100644 index d02ca06c..00000000 --- a/.agents/skills/project-manifest-reference/SKILL.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -name: project-manifest-reference -description: Field-by-field reference for the catalogue records under src/src/data/projects/ (schema vocabulary, defaults, loader-enforced rules, and the invariants the site build depends on). Use whenever authoring or reviewing a catalogue record. -category: purview-dev-website -roles: - - catalogue - - reference -tags: - - projects-yml - - zod - - schema ---- - -# project-manifest-reference Skill - -The catalogue is one file per project under `src/src/data/projects/` (plus -`src/src/data/external-projects.yml` for collaborations), typed by `src/src/lib/manifest/schema.ts` and validated -by `src/src/lib/manifest/load.ts`. `$schema: ../lib/manifest/schema.ts` is the first line of the file. - -## Vocabularies (do not invent values) - -| Field | Allowed values | -| --- | --- | -| `category` | `application-framework`, `validation`, `observability`, `source-generation`, `aspire`, `build-tooling`, `developer-tooling` | -| `status` | `stable`, `preview`, `archived` | -| `experimental` | boolean flag, default `false` — orthogonal to `status` (ADR 0004); invalid with `status: archived` | -| `install` | `nuget` (default), `msbuild-sdk`, `dotnet-tool` — NuGet packages only | -| `packages[].registry` | `nuget` (default), `npm` (ADR 0012) | -| `useCases[].audience` | `developer`, `team-lead`, `architect`, `contributor` (labels: Developer, Team lead, Architect, Contributor) | - -Adding a value to any of these lists is a schema change and requires an ADR. `experimental` is a -**flag, not a status value**: it never replaces `status`, which stays the project's release channel. - -## `projects[]` fields - -| Field | Required | Notes | -| --- | --- | --- | -| `id` | yes | Lowercase `[a-z0-9-]` slug; also the URL segment and the LLM bundle name | -| `name` | yes | Display name; **must slugify to `id` when `docs` is set**; must not start with `Purview ` | -| `shortDescription` | yes | One sentence; falls back to the GitHub description if empty, then to `name` | -| `description` | yes | Long description (2–4 sentences) | -| `origin` | yes | Why the project became reusable tooling | -| `useWhen` | yes | When it is the right choice | -| `avoidWhen` | yes | When it is the wrong choice | -| `repository` | yes | `owner/repository`; **`owner` must be `purview-dev`** for `projects[]` | -| `category` | yes | See vocabulary | -| `status` | yes | See vocabulary | -| `experimental` | no | Default `false`; marks an exploratory project (unstable API, no support promise). Orthogonal to `status`; invalid with `status: archived`. Displayed as its own status via `displayStatus()` | -| `featured` | no | Default `false`; shown prominently on the home page | -| `order` | no | Default `1000`; projects are sorted ascending; keep values unique | -| `docs` | no | See below | -| `install` | no | Default `nuget`; how a **NuGet** package is consumed, so it has no meaning for an npm package | -| `targetFrameworks` | no | e.g. `net8.0`, `net9.0`, `net10.0`, `netstandard2.0`; `just check-projects` reports (advisory) when it does not match the union of the runtime packages' published NuGet TFMs | -| `packages` | no | `{ id, registry?, description?, primary?, targetFrameworks? }[]`; defaults to `[]`. `registry` is `nuget` (default) or `npm`; versions come from that registry and the install panel follows it | -| `skills` | no | `{ name, path?, description? }[]` — Agent Skills the project publishes from `skills//SKILL.md` (ADR 0010); mirrored to `/skills///` and rendered with the shared install block; defaults to `[]` | -| `assets` | no | `{ path, output, description? }[]`; repository files mirrored into `public/` at build time (`path` is repo-relative, `output` is site-relative); defaults to `[]` | -| `related` | no | Known project ids; rendered in the project page aside | -| `useCases` | no | Default `[]`; at least one required for non-archived projects | -| `acknowledgments` | no | `{ name, url, description? }[]`; upstream work the project credits | -| `supersedes` / `supersededBy` | no | Known project ids; used for archived/successor messaging | -| `discussions` | no | **Detected, not authored**: the page links repository Discussions when the repository has them enabled (`hasDiscussions` in the release cache). Set it only to override — `false` opts a repository out | - -## `docs` (a discriminated union on `source`) - -| `source` | Fields | Behaviour | -| --- | --- | --- | -| `github-path` | `path` (required), plus `rootPage`, `readmeAsIndex`, `order`, `exclude`, `channels`, `redirects` | Walks `/**/*.md` at each channel's ref (default branch when no `channels`) | -| `wiki` | `rootPage`, `readmeAsIndex`, `order`, `exclude` | Shallow-clones `.wiki.git`; `_Sidebar.md` orders pages, `_Footer.md` is skipped. Single channel only | -| `readme` | none | Publishes `README.md` alone as `/docs//`. Single channel only | - -- `rootPage` names the markdown file that becomes the landing page (`index`). It may only select a - non-index page when the conventional root page is removed via `exclude` (the aggregation otherwise - raises `DocsValidationError`). A product wiki mirrored from `docs/wiki` uses `rootPage: Home.md`: the - wiki is plain Markdown with `Home.md` as its hub and `_Sidebar.md` as the whole navigation, and it - carries no site configuration — a repository that still ships one is a deviation the portal ignores, - not a requirement. -- `exclude` matches the **base file name** (not the repository path) and supports `*` wildcards. It is a - filter over the files the repository ships, so a pattern naming a file that has since been deleted is a - no-op, never a warning or a failure. -- `readmeAsIndex` uses the repository `README.md` as the landing page and cannot be combined with - `rootPage`; it aliases `readme` to `index`. -- `order` is an explicit list of page slugs, applied before the `_Sidebar.md` order. -- `redirects` maps moved slugs (`previous: current`) to keep old URLs alive on every channel that - publishes the tree. Prefer the repository's own `_redirects.yml` in its docs root (ADR 0013), which - lands with the move and is read per channel; the catalogue's pairs win when both name a slug. -- If `docs` is set but the aggregation yields no pages, `just data-sync` fails loudly. - -## `docs.channels` — live and prerelease documentation (ADR 0009) - -A project whose default branch is ahead of its latest release can publish two -views of its documentation. Channels are optional; omitting them keeps one -`live` channel on the default branch. - -```yaml -docs: - source: github-path - path: docs/wiki - rootPage: Getting-Started.md - channels: - live: - ref: latest-stable # newest non-prerelease release tag - prerelease: - ref: default # the repository's default branch -``` - -| Field | Meaning | -| --- | --- | -| `channels.live` / `channels.prerelease` | At most these two; unknown keys are rejected | -| `ref` | `default` (default branch), `latest-stable`, `latest-prerelease`, or any branch/tag/commit used verbatim. Defaults: `live` → `latest-stable`, `prerelease` → `default` | -| `path`, `rootPage`, `readmeAsIndex`, `order`, `exclude` | Optional per-channel overrides of the shared block (a tag's docs tree can differ from `main`) | - -- **`live` is the default channel** and owns `/docs//…`; `prerelease` is - served at `/docs//prerelease/…`. A prerelease-only project is the default - channel and serves its docs at the canonical URLs. -- `latest-stable` with no stable release → live follows the default branch - (warning). `latest-prerelease` with no tag → the channel is skipped. Two - channels on the same ref → the non-default one is dropped. -- **Promotion is automatic.** The prerelease channel is published only while a - prerelease version outranks the newest stable release, comparing GitHub - release tags with NuGet versions. Publishing `3.0.0` retires - `3.0.0-prerelease.N` docs on the next build; the channel returns with the next - prerelease. No manifest edit or PR is needed to stop publishing it. -- `wiki` and `readme` sources reject `channels`: they have a single version. -- Use-case `docsPage` deep links resolve against the **default** channel. - -## Loader-enforced rules (`loadProjects()`) - -1. Schema validation with remediation text (unknown keys are rejected). -2. `projects[].repository.split('/')[0]` must equal `purview-dev`. -3. `related`, `supersedes`, and `supersededBy` must all reference existing project ids. -4. A package id may be declared by **exactly one** project for its registry (the key is - `registry:id`; an absent `registry` means `nuget`). -5. `experimental: true` is rejected when `status` is `archived` (schema refinement). -6. An asset `output` path may be declared by **exactly one** project, must be relative, and must - not contain a `..` segment. -7. The returned list is sorted by `order` ascending. - -## Defaults applied by the loader - -`featured: false`, `order: 1000`, `packages: []`, `related: []`, `useCases: []`, -`acknowledgments: []`, `install: 'nuget'`, `experimental: false`. Derived values (`repoOwner`, -`repoName`, `sourceUrl`, `issuesUrl`, `discussions`, `discussionsUrl`, `changelogUrl`, `releasesUrl`) are computed, -never authored. - -## `externalProjects[]` fields - -Required: `id` (slug), `name`, `shortDescription`, `description`, `url` (valid URL), `category`. -Optional: `repository` (`owner/repo`, link target), `status`, `featured`, `order`. -Loader-enforced: a collaboration entry must **not** use the `purview-dev` owner (the manifest test -asserts that no `externalProjects` id starts with `purview-`). diff --git a/.agents/skills/purview-architecture-testing/SKILL.md b/.agents/skills/purview-architecture-testing/SKILL.md deleted file mode 100644 index 55d0ca8b..00000000 --- a/.agents/skills/purview-architecture-testing/SKILL.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -name: purview-architecture-testing -description: >- - Use when adding, changing or debugging architecture tests in a .NET solution - dependency-direction - rules, forbidden framework references, project naming checks, cycle detection - or when a boundary - keeps being broken in review and should fail the build instead. Adopts Purview.Architecture.Testing - and a single policy file rather than hand-maintained lists. -license: MIT -metadata: - author: Purview-Dev - version: "2.0" - repository: purview-dev/engineering-playbook ---- - -# Purview architecture testing - -A boundary that only review enforces is a boundary that erodes. The job of this skill is to turn a -rule a reviewer keeps repeating into a test that fails the build, **without** producing a wall of -brittle assertions that everyone disables six months later. - -Prerequisite: know what the projects are *for*. See `purview-architecture`. - -## 1. Only test a rule that is real - -Before writing anything, answer: **has this rule been broken, or is it certain to be?** - -A test for a dependency nobody would plausibly add is cost with no benefit. Good candidates: - -- A direction that has already been violated once. -- A boundary that is load-bearing - Core staying free of EF Core, Composition being referenced by - nothing. -- A rule a newcomer cannot infer from the code. - -Bad candidates: anything the compiler already enforces, and style preferences dressed up as -architecture. - -## 2. Adopt the package; define the policy once - -The failure mode of architecture tests is a dependency matrix written twice - once in a wiki table and -once in assertions - which then disagree. The prose is the copy that drifts, because nothing fails -when it is wrong. - -So do not write the rule engine. `Purview.Architecture.Testing` ships it, so the matrix, naming, -sibling-independence, composition, forbidden-package, cycle, test-reference and waiver rules are -defined once and shared. Adoption is two files. - -**A policy** at `.config/architecture-policy.json`, pointing at the published schema so an editor -validates it as you type: - -```json -{ - "$schema": "https://raw.githubusercontent.com/purview-dev/architests/main/architecture-policy.schema.json", - "version": 2, - "sourceRoots": ["src"], - "responsibilities": [ - { - "name": "Core", - "aliases": ["Domain"], - "category": "domain", - "purpose": "The domain model, its invariants and its rules.", - "mayDependOn": ["Shared"], - "mustNotDependOn": ["Application", "Persistence", "Composition"], - "forbiddenPackagePrefixes": ["Microsoft.EntityFrameworkCore", "Microsoft.AspNetCore"] - } - ], - "waivers": [] -} -``` - -**One derived test class:** - -```csharp -[InheritsTests] -public sealed class ArchitectureTests : PurviewArchitectureTests; -``` - -That is the whole of the adoption. Each rule is a separate test, so a failure names the rule rather -than collapsing the set into one assertion, and the package validates the policy against its schema -first - a policy that does not match the schema may be silently missing a rule. - -The build-sdk ships a skill for the package itself, `purview-buildsdk-architecture-tests`, which is -authoritative on its API and rule ids. Read it rather than this page when you are extending or -debugging the package. - -Then add a test that the documentation matches the policy, so the table in the wiki is falsifiable -too. Full worked example: -[Project Responsibilities](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/foundations/Project-Responsibilities.md). - -## 3. Read project files, and assemblies - -Two sources, because they catch different things: - -| Source | Catches | Misses | -| -- | -- | -- | -| `.csproj` `ProjectReference` | The reference a reviewer actually added | A dependency arriving transitively | -| Compiled assembly references | A dependency that arrived indirectly | Intent — it cannot tell direct from transitive | - -The package's rules read the **project files**, because a declared `ProjectReference` is what a -reviewer adds and what the policy governs. Add a small hand-written test that reads the **compiled -assemblies** for the leak a project file cannot show - a namespace from the wrong layer reaching a -public type. - -Classify a project by the **first segment** of its name, so `Persistence.SqlServer` and `Persistence` -are both Persistence - qualification is a naming choice, never a different rule. The package does -this for you; a hand-written assembly test must do it too. - -## 4. The rules worth having - -| Rule | What it catches | -| -- | -- | -| Dependency matrix | Core referencing Persistence; Application referencing a concrete provider | -| Nothing references Composition | A circular implementation choice | -| Sibling independence | `Providers.GitHub` reaching into `Providers.AzureDevOps` | -| Forbidden package prefixes | EF Core in Core; ASP.NET hosting in a domain project | -| Cycle detection | A graph that MSBuild rejects with an unreadable message | -| Catch-all names | `Infrastructure`, `Services`, `Helpers` appearing as project names | -| No production → test reference | A test helper leaking into shipped code | - -The package provides all of these. Do not re-implement one; change the policy instead. - -## 5. Write failures someone can act on - -This is what decides whether the suite survives. A failure must name: - -1. The offending project. -2. The rule violated. -3. The specific reference that broke it. -4. The direction the dependency *should* run. -5. The likely fix. - -```text -'Application' (Application) references 'Persistence.SqlServer' (Persistence), but Application -must not depend on Persistence. Invert it: Persistence may depend on Application, or introduce -an abstraction that Application owns and Persistence implements. -``` - -Not `Expected collection to be empty`. Collect every violation and report them as a numbered list - -one test run should show all of them, not the first. The package already reports this way; keep the -same standard in any rule you add. - -## 6. Waivers, not suppressions - -A repository that predates the policy will violate it. Deleting the test or adding a blanket -`#pragma` makes the policy a lie. Record the departure in the policy instead: - -```json -{ - "project": "Infrastructure", - "mapsTo": "Adapters", - "rules": ["naming"], - "reason": "Holds one adapter, predates the catalogue; renaming churns the wiki and docs for no gain.", - "reviewedOn": "2026-10-15" -} -``` - -The package tests the waivers themselves: each must name a project that still exists, a rule, and a -substantive reason. A waiver for a deleted project is dead weight that hides the next one. - -Critically, a waiver excuses **the narrowest thing possible** - usually the name. `mapsTo` keeps the -project classified so every dependency rule still applies to it. Prefer a waiver to -`SkipRule`, which removes a rule for the whole repository with no record. - -## 7. Conventions - -- TUnit, matching the repository's other tests, adopted through `PurviewArchitectureTests` with - `[InheritsTests]`. -- Arrange/Act/Assert, one behaviour per test. -- Let the package find the repository root - it probes upward for the policy and stops at the `.git` - boundary. Override `RepositoryRoot` only when the policy does not sit above the test binary. -- Keep the policy file free of anything a rule cannot read; a field no rule consults is a rule that - looks enforced and is not. - -## Checks before you answer - -- Is every rule you added one that has been, or will be, broken? -- Is the matrix defined once, in the policy, with the documentation checked against it? -- Does each failure name the fix, not just the fact? -- Did you record a waiver rather than weaken a rule for existing code? - -## See also - -- `purview-architecture` — what the projects are for, and how they are named -- `purview-buildsdk-architecture-tests` — the package's own skill, authoritative on its API -- [Architecture as Tests](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/foundations/Architecture-As-Tests.md) diff --git a/.agents/skills/purview-architecture/SKILL.md b/.agents/skills/purview-architecture/SKILL.md deleted file mode 100644 index 0c435966..00000000 --- a/.agents/skills/purview-architecture/SKILL.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -name: purview-architecture -description: >- - Use when deciding the shape of a .NET solution that uses Purview libraries — how many projects, - whether to add a repository or CQRS layer, where validation lives, how an API and its clients share - a contract (Contracts, OpenAPI or Hybrid) and when a BFF is earned — or before generating - substantial implementation code. Establishes project context first, then applies DRY, KISS and - architecture proportional to the actual requirements rather than to an enterprise reference diagram. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview architecture - -The job of this skill is to stop two failures that cost far more than they look: - -- **Architecture bought in advance.** Four projects, a repository interface and a mapping layer for an - application that has one table and one caller. -- **A recommendation made without context.** Advice about database-side GUID generation given to a - stateless CLI, or a Clean Architecture split proposed for a 300-line utility. - -So: establish context, then choose proportionally. Both steps are mandatory, and the first one is the -one that gets skipped. - -## 1. Establish context before deciding - -Before recommending a structure, adding a project, or generating substantial code, you must know four -things. **Read them out of the repository first** — asking a user a question the code already answers -is the most common way this skill is applied badly. - -| Dimension | Read it from | Ask only if | -| -- | -- | -- | -| Complexity (small / medium / large) | Number of functional areas, integrations and external consumers — not file count | The requirements are genuinely not written down anywhere | -| Project type | SDK attribute, `OutputType`, `Microsoft.NET.Sdk.Web`, an AppHost project, a `Main` | The repository is empty | -| Persistence | `PackageReference` to an EF Core provider, `DbContext`, a connection string, a `Purview.Containers` resource | Persistence is being introduced now | -| Telemetry | `Purview.Telemetry.SourceGenerator`, `ILogger` injection, `ActivitySource`, an OTLP exporter | Nothing is configured and you are about to add it | - -Identifier generation is a **conditional** dimension: resolve it only when persistence exists *and* -GUID keys are in play. See `purview-persistence`. - -Judge complexity on requirements, not size. A 2,000-line CLI with one output format is small. A -900-line service that reconciles three upstream systems and owns money movement is not. - -**Do not re-ask.** A dimension answered by repository configuration, existing source, a project file, -an earlier turn in the conversation, or a recorded architectural decision is answered. Ask concise, -targeted questions only for the unknowns that change your recommendation — and if nothing changes, -ask nothing. - -Full decision procedure: `references/project-context-discovery.md`. - -## 2. Choose proportionally - -| Scale | Shape | What you still do not add | -| -- | -- | -- | -| Small | One project, or two when a test project needs a non-trivial subject. Direct implementations. | Repository over `DbContext`, CQRS, a mapping layer, speculative interfaces | -| Medium | Explicit boundaries where complexity already hurts — usually a domain project and a host | Event sourcing, a generic infrastructure framework, a second infrastructure implementation nobody asked for | -| Large | Modularity, independent infrastructure implementations, enforceable boundaries (see the playbook's Architecture-As-Tests page) | Patterns adopted for symmetry rather than for a named problem | - -Architecture is allowed to arrive late. A boundary added when the second caller appears is cheap; a -boundary added in anticipation of a second caller that never appears is permanent. - -**Never add a project for symmetry.** "Domain, Application, Infrastructure, API" is a response to a -problem, not a starting position. If you cannot name the failure a layer prevents in this codebase, -do not add the layer. - -Full guidance and the per-pattern justification tests: `references/proportional-architecture.md`. - -## 3. Name what you do create - -A project name states a **responsibility**, optionally qualified by an implementation: - -```text -[.] -``` - -The responsibility decides the rules; the qualifier never changes them. Three rules people usually -get wrong: - -- **Do not qualify a single implementation.** `Persistence` is correct even when it uses SQL Server. - Rename when a second provider arrives, not in anticipation. -- **Do not create an empty parent.** `Persistence.SqlServer` + `Persistence.PostgreSql` with nothing - shared need no `Persistence` project. -- **Multiple implementations do not require multiple assemblies.** Two small adapters with the same - dependencies belong in one project. - -Never use a *category* as a project name — `Infrastructure`, `Services`, `Managers`, `Models`, -`Helpers`, `Common`. Nothing can be excluded from a category, so it grows without limit. And never -rename an established project just to match canonical terminology; `Domain`, `UseCases` and -`Integrations` are recognised aliases. - -Responsibility catalogue, dependency matrix and the naming decision tree: -`references/project-responsibilities.md`. - -## 4. Check the direction - -`A → B` means **A depends on B at compile time** — not a runtime call, a DI registration, an HTTP -request or an Aspire orchestration edge. Confusing those is the most common source of a wrong answer -about whether a dependency is allowed. - -The rules that matter most: - -- Core depends on nothing but `Shared`. -- Application never references a concrete `Persistence`, `Providers` or `Adapters` project. -- Composition references implementations; **nothing references Composition** except a host. -- Sibling implementations (`Providers.GitHub`, `Providers.AzureDevOps`) stay independent. -- Persistence owns migration *definitions*; `Migrator` owns their *execution*. Production API startup - does not apply schema migrations. - -When a boundary is worth having, make it fail the build rather than the review — see -`purview-architecture-testing`. - -## 5. Choose how an API and its clients share a contract - -When there is an HTTP API and at least one client, choose **Contracts**, **OpenAPI** or **Hybrid** -from the clients that **exist today**. A planned client is noted; it does not count. - -| Clients today | Strategy | Failure it prevents | -| -- | -- | -- | -| All .NET, same solution, shipped in lockstep | **Contracts** — a library of request/response types on the domain's value objects, referenced by the server and every .NET client | Rules drifting, and a weaker second copy of them in the UI | -| At least one non-.NET client, or one that ships independently | **Hybrid** — Contracts is the source; the OpenAPI document and its schemas are generated from it | Non-.NET clients hand-writing shapes, and .NET clients losing their value objects to a generated client | -| No .NET client — partners or the public only | **OpenAPI**, generated from the server's types; no Contracts project | A project with no consumer but the server | - -The rules that do not bend: - -- **OpenAPI is an output, never an input**, while Contracts exists. Never regenerate a C# client from - your own API's document when that client is in the same solution. -- **Never hand-maintain a parallel set of models**, and **the server always validates** — a shared - validator is for user experience, not trust. -- **Contracts is browser-safe** when a WebAssembly client references it: architecture-policy bans, - the trim and AOT analyzers and the browser platform analyzer check it, not a reviewer. -- **A BFF is earned by keeping tokens out of the browser.** It holds the tokens, gives the browser an - `HttpOnly` cookie, forwards with the user's token, and requires an anti-forgery header on every - forwarded call. In Blazor it is the host that serves the WebAssembly client, and a BFF that only - forwards does not reference Contracts. The policy does not define a BFF yet, so these are review - obligations until a future Build SDK release adds Blazor and BFF support. - -Full procedure, version-skew rules, BFF guidance and worked examples: `references/contract-strategy.md`. - -## 6. DRY, applied where it pays - -Reuse the Purview libraries when they remove a real source of truth, not for coverage: - -| Concern | Library | Use it when | -| -- | -- | -- | -| Operation outcomes without exceptions for control flow | `Purview.Results` | Failures are expected and the caller must handle them | -| Primitive obsession, validated identity types | `Purview.ValueObjects` | A value has rules that would otherwise be re-checked at each boundary | -| Schema shared with a TypeScript client | `Purview.ZodSharp` | A contract is duplicated between C# and TypeScript today | -| Local dependencies for dev and integration tests | `Purview.Containers` | Tests need a real database, queue or emulator | -| Logging, tracing and metrics from one declaration | `Purview.Telemetry.SourceGenerator` | Always — see `purview-telemetry` | - -Duplication that matters: validation repeated per entry point, a domain rule restated in the UI, -configuration bound in two places, two types that both claim to be the truth. Duplication that does -not: two similar-looking methods that answer to different owners. - -## 7. Telemetry is not an advanced topic - -Recommend instrumentation from the first commit, at every project size. A small application gets -small telemetry — it does not get none. See `purview-telemetry`. - -## Checks before you answer - -- Did you read the four context dimensions rather than ask for them? -- Can you name, for each project and each abstraction you are proposing, the failure it prevents here? -- Is anything in your proposal there only because a reference architecture has it? -- If there is an API with clients, did you choose its contract strategy from the clients that exist - today? -- Did you include telemetry? - -## See also - -- `purview-telemetry` — instrumentation at every scale -- `purview-persistence` — storage and GUID-key guidance, only when persistence is real -- [Engineering Principles](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/Engineering-Principles.md) -- [Adopting This At Your Scale](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/governance/Adopting-This-At-Your-Scale.md) diff --git a/.agents/skills/purview-architecture/references/contract-strategy.md b/.agents/skills/purview-architecture/references/contract-strategy.md deleted file mode 100644 index 62b5a17f..00000000 --- a/.agents/skills/purview-architecture/references/contract-strategy.md +++ /dev/null @@ -1,236 +0,0 @@ -# Contract strategy: Contracts, OpenAPI or Hybrid - -When a solution has an HTTP API and one or more clients, something has to define the shapes that cross -between them. There are three ways to do it, and the wrong one fails in one of two directions: - -- **Rules drift.** The client holds a second, weaker copy of the domain rules, and a request the UI - accepted is rejected by the server — or a break only surfaces at runtime. -- **Decoupling bought in advance.** A .NET client in the same solution regenerates its models from - the API's own OpenAPI document, and throws away every value object and rule to buy an independence - the solution does not have. - -The strategy is chosen from the clients that **exist today**. A planned client is noted; it does not -count. "Later" and "in case" do not justify a strategy any more than they justify a project — see -`proportional-architecture.md`. - -## The three strategies - -### Contracts - -A .NET class library holding the request and response types, built on the domain's value objects and -carrying `[ZodSchema]`. The server references it, and so does every .NET client — including a Blazor -WebAssembly client. - -There is one copy of every rule, error code and normalisation, and both sides run the same generated -validators. - -### OpenAPI - -The server publishes an OpenAPI document, and clients generate their models and calls from it. It is -language-neutral and versions independently. - -Generated models are primitives. Value objects, custom ZodSharp rules, error codes, and trimming and -casing are lost; only what JSON Schema can express survives. - -### Hybrid - -Contracts is the **single source of truth**. The OpenAPI document is **generated from it**, with its -component schemas taken from ZodSharp's export — the generated `{T}Schema.BuildJsonSchema()` is built -from the same metadata as the validator, so the document and the validators cannot drift. - -.NET clients reference Contracts. Non-.NET clients generate from the document and take their -validation rules from the exported JSON Schema — for TypeScript, `z.fromJSONSchema` (Zod 4) reads it -back as Zod schemas. The `purview-zodsharp-json` and `purview-zodsharp-source-generator` skills are -authoritative on the export. - -Three facts about the export that a Hybrid design has to plan for: - -- **ZodSharp ships no OpenAPI integration.** It produces JSON Schema; putting that into the OpenAPI - document — for example with a schema transformer in `Microsoft.AspNetCore.OpenApi` — is the API - host's job. Without it, ASP.NET Core describes a value object from its CLR shape, not from its rules, - and the document and the validators drift after all. -- **A non-.NET client still gets only what JSON Schema can express.** A value object exports as its - underlying value, and a rule the exporter cannot represent is listed under `x-zodsharp-unsupported` - rather than dropped. The contract test should fail when that list grows. -- **Exported objects set `additionalProperties: false`.** A client that validates a *response* against - that schema rejects a field the server has added — so "additive changes only" is not safe until - clients tolerate unknown response fields. Validate requests strictly and responses leniently, or the - versioning rule below protects nobody. (The reverse also holds: System.Text.Json ignores unknown - members, so the server accepts a request with an extra key that the schema rejects.) - -## Decision procedure - -1. **List the clients that exist today.** For each, record: - - its language and runtime; - - who owns it; - - whether it lives in the same repository and solution; - - whether it ships **in lockstep** with the server or on its own cadence. - - A planned client is noted, but it does not count yet. -2. **Every client is .NET, in the same solution, and ships in lockstep → Contracts.** This prevents: - - rules drifting between client and server; - - a second, weaker copy of the domain rules in the UI; - - contract breaks that only surface at runtime. - - Publish OpenAPI anyway if documentation or tooling wants it, but generate it from Contracts. It is - an output, never an input. -3. **At least one client is not .NET, or ships independently → Hybrid.** This prevents: - - non-.NET clients hand-writing shapes and rules; - - the .NET clients losing their value objects and rules to a generated client. - - It requires the independent-versioning rules under [Version skew](#version-skew). -4. **No .NET client exists, or the API is a surface whose clients the team does not own (public or - partner) → OpenAPI**, still generated from the server's types. A separate Contracts project is not - earned when the server is its only consumer. -5. **A .NET client in another repository with its own release cadence** prefers Contracts shipped as - a package, if that team accepts the dependency. Otherwise treat it as step 3. - -```text -flowchart TD - A["List the clients that exist today"] --> C{"Every client .NET,
same solution, lockstep?"} - C -- yes --> K["Contracts
OpenAPI only as an output"] - C -- no --> B{"Any .NET client
at all?"} - B -- no --> O["OpenAPI
generated from the server's types"] - B -- yes --> D{"The only other clients are .NET
in another repository,
and they accept a package?"} - D -- yes --> P["Contracts, shipped as a package"] - D -- no --> H["Hybrid
Contracts is the source, OpenAPI generated from it"] -``` - -Steps 3 and 4 do not overlap: a .NET client in the solution alongside a partner or non-.NET client is -step 3, because the .NET client still has value objects and rules to lose. - -## Rules that follow - -- **Never regenerate a C# client from your own API's OpenAPI document when that client is in the same - solution.** It throws away value objects and rules to buy decoupling the solution does not have. -- **Never hand-maintain a parallel set of models** on either side. Two definitions of one wire shape - disagree eventually, and nothing fails when they start to. -- **The server always validates.** Sharing validators with a client is for user experience and - consistency. It is never a substitute for validating on the server, because the client is untrusted. -- **Moving from Contracts to Hybrid must be additive.** Because Contracts is already the source, adding - a non-.NET client means turning on generation of the OpenAPI document and a contract test. Nothing in - Contracts changes. Design for that, but do not build it until the client exists. - -## Contracts project constraints - -- **References only the domain library (value objects) and the runtime Purview packages** — - `Purview.ValueObjects`, `Purview.ZodSharp`, `Purview.Results`. Never the server, persistence, HTTP - clients or hosting, and never an ASP.NET Core bridge such as `Purview.ZodSharp.AspNetCore`; those - belong to the API host. A Contracts project that references the server is a server that every client - now ships. -- **Browser-safe when a WebAssembly client references it.** No file, network or process I/O, safe to - trim, and no reflection-dependent behaviour. The same applies transitively to the domain library, - because the client downloads it too. Make the build enforce it, not a reviewer — three mechanisms, - each catching what the others cannot: - - **Your repository's architecture policy** forbids `Microsoft.AspNetCore` packages - (`forbiddenPackagePrefixes`) and the `Microsoft.AspNetCore.App` framework reference - (`forbiddenFrameworkReferences`) in `Contracts` and `Core`. The playbook's own policy forbids the - packages in `Core` only; the rest arrives with the Build SDK's planned Blazor support, so add it - yourself until then. See `purview-architecture-testing`. - - **`true`** on both projects turns on the trim and AOT analyzers, - so reflection a trimmed client would break on is a warning at build time. `Purview.ValueObjects` - and `Purview.ZodSharp` already set it. - - **``** makes the platform-compatibility analyzer (`CA1416`) - flag an API that is unsupported in the browser, such as starting a process. - - The policy rules fail a test run. The two analyzers produce warnings, and the SDK does not turn on - `TreatWarningsAsErrors` for an ordinary project — set it on `Contracts` and `Core`, or the "clean - build has no warnings" rule is the only thing standing behind them. No analyzer proves the absence of - every kind of I/O; what they miss is a review obligation, and the client's own tests running in the - browser are the last check. -- **Deserialisation mode is a deliberate choice per direction.** The server reads requests through - `Create` (strict), because the client is untrusted. Record what the client uses for responses, and - why — strict catches a server that has drifted, and `Hydrate` trusts a server the client cannot - verify. - -## Version skew - -| Shipping | Strategy | Failure it prevents | What to do | -| -- | -- | -- | -- | -| Lockstep | Contracts, internal apps | A silent failure that looks like a bug, when an old cached client talks to a new server | The server stamps its build on responses; the client prompts the user to reload when the stamps differ | -| Independent | Hybrid, OpenAPI | A deployed client breaking without warning | Additive changes only; a breaking change gets a new route version; a contract test compares the generated document against the last published one and fails on a breaking difference | - -## Backend-for-Frontend - -A BFF is a host, not a layer, and it is held to the same justification test as anything else. -Microsoft's [Blazor Web App with OIDC and the BFF pattern](https://learn.microsoft.com/aspnet/core/blazor/security/blazor-web-app-with-oidc?pivots=with-bff-pattern) -is the authority on the mechanics; what follows is the rules and the failures behind them. - -### What earns it - -- **Keeping tokens out of the browser.** The BFF signs the user in (OpenID Connect), holds the access - and refresh tokens, and gives the browser only an authentication cookie. Script in the page — a - compromised dependency, an XSS hole — cannot read a token that never reached it. This prevents tokens - being stolen from browser storage. -- **It forwards with the user's access token, never its own identity.** The API validates that token - exactly as it would any other, so authorisation and the audit trail stay per-user. A BFF calling with - a client-credentials token turns every action into the BFF's and moves authorisation into the BFF. - -### In a Blazor solution, the BFF is the host - -The project that serves the WebAssembly client is the natural BFF: it already runs on the server, at -the client's origin. Do not add a separate BFF in front of it. - -- **It references the client project** (`Bff → WebApp`) because it serves the client's assets. The - client never references it; they talk over HTTP with the cookie. -- **Same origin is the point.** The client calls the BFF's own routes, the BFF forwards them to the API - (with YARP's `MapForwarder`, for example), and there is no CORS configuration and no third-party - cookie. -- **The client shares Contracts with the API directly.** The WebAssembly client references Contracts, - sends Contracts types, and runs the generated validators. The BFF in the middle passes the bytes - through untouched. - -### Rules that come with a cookie - -Moving the credential into a cookie trades token theft for a different attack, and the BFF has to -close it: - -- **Every forwarded call requires an anti-forgery signal.** The browser attaches the cookie to any - request to the BFF's origin, including one a hostile page triggers. Require a custom header the - client always sends, which a cross-site form cannot set, and reject calls without it — Duende.BFF's - `X-CSRF: 1` is the established form. `SameSite` narrows the attack; it does not replace the check. - This prevents cross-site request forgery. -- **The cookie is `HttpOnly`, `Secure` and `SameSite=Strict` or `Lax`.** `HttpOnly` is what keeps - script from reading it; without it the BFF protects nothing. -- **Data Protection keys are persisted and shared** when the BFF runs on more than one instance or - survives a restart. The cookie is encrypted with them, so per-instance keys sign users out at random. -- **Refresh happens on the server.** The BFF refreshes the access token before it expires and signs - the user out when refresh fails. The client never sees either token. -- **A large session moves to a server-side store.** Tokens kept inside the cookie make it large enough - to be split across several cookies, and the session cannot be revoked server-side. Use a ticket store - when either matters. - -### What it may reference - -- **A BFF that only forwards does not reference Contracts** and never reads payloads. Reading a payload - it does not own makes it a second consumer that has to change in lockstep for no benefit. -- **Prerendering is the common exception.** If the BFF prerenders client components that load data, - it must run those data calls on the server, and it references Contracts to do so. That is a real - reason; turning prerendering off for those components is the alternative, and the choice should be - written down. -- **A BFF that combines several API calls into one response owns its own contract** for those - responses, chosen with this same procedure. That is a separate justification. The forwarding-only - test — "a service layer that forwards" is not earned — still applies to everything else it does. -- **One BFF per client kind, not one per screen.** Web and mobile may each get one when their sign-in - or response needs differ. - -**None of this is enforced yet.** The architecture policy has no BFF responsibility; Blazor and BFF -support is planned for a future Build SDK release. Until then every rule in this section is a review -obligation, and a repository that adds a BFF project records it in its own policy — see -`project-responsibilities.md`. Even once it is in the policy, "Contracts only when it prerenders or -combines" stays a review obligation, because a dependency matrix cannot express a condition. - -## Worked examples - -| Clients today | Strategy | -| -- | -- | -| Blazor WebAssembly app, same solution, lockstep, signed in through a BFF | Contracts, referenced by the API and the WebAssembly client. The BFF is the host that serves the client, holds the tokens and forwards with the user's token; it references Contracts only if it prerenders data. OpenAPI generated for documentation. | -| Blazor WebAssembly app plus a React Native mobile app on its own release cadence | Hybrid. Mobile generates from the document and takes Zod rules from the exported schema. Additive-only versioning. A mobile BFF if sign-in differs. | -| Partner integrations only | OpenAPI, generated from the server's types. No Contracts project. | - -## See also - -- [Contracts and Data Exchange](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/data/Contracts-And-Data-Exchange.md) - — `Create` and `Hydrate`, and the schema as the source of truth for a wire shape -- [zodsharp](https://github.com/purview-dev/zodsharp) — authoritative on `[ZodSchema]` and JSON Schema - export diff --git a/.agents/skills/purview-architecture/references/project-context-discovery.md b/.agents/skills/purview-architecture/references/project-context-discovery.md deleted file mode 100644 index d40569a3..00000000 --- a/.agents/skills/purview-architecture/references/project-context-discovery.md +++ /dev/null @@ -1,115 +0,0 @@ -# Project context discovery - -The procedure for establishing enough context to make an architectural recommendation, and — just as -importantly — for knowing when to stop asking. - -## The principle - -Every question you ask a user is a question they have usually already answered in the repository. -Reading is free and silent; asking is slow and, when the answer was already in a project file, it -reads as not having looked. So the order is fixed: - -1. Read the repository. -2. Read the conversation so far. -3. Ask only about what remains *and* changes your answer. - -A dimension whose answer would not change your recommendation is not worth a question. If a project -is a stateless CLI, the database GUID strategy is not an unknown — it is irrelevant, and raising it -is noise. - -## Dimension 1 — complexity - -Assess from requirements, never from line or project count. - -| Signal | Suggests | -| -- | -- | -| One functional area, one consumer, no integrations | Small | -| A handful of features, one or two integrations, a single team | Medium | -| Several bounded areas, multiple services or teams, operational obligations (SLOs, auditability, money) | Large | - -Where to look: `README.md`, the wiki, issue or ticket references, the solution file's project list, -`PackageReference` entries naming external systems, the number of distinct hosts. - -Traps: - -- **A big repository is not a complex one.** A monorepo of ten tiny tools is ten small projects. -- **A small repository can be complex.** Few files, hard invariants. -- **Generated code inflates everything.** Discount it. - -## Dimension 2 — project type - -Read it; do not ask it. - -| Evidence | Type | -| -- | -- | -| `Microsoft.NET.Sdk.Web` | Web application or HTTP API — distinguish by whether views/pages or endpoints dominate | -| `OutputType` of `Exe` plus an argument parser | CLI | -| `IsPackable`, no entry point | Reusable library | -| `IHostedService` / `BackgroundService`, `Worker` SDK | Background worker | -| An AppHost project, `Aspire.Hosting` | Distributed application | -| WPF/WinForms/Avalonia/MAUI SDK or `UseWPF` | Desktop application | - -A reusable library carries the strongest constraint on the rest of your advice: it must not configure -global telemetry providers, must not read configuration from the ambient environment, and must not -decide a persistence technology for its consumer. - -## Dimension 3 — persistence - -| Question | Read it from | -| -- | -- | -| Is persistence required at all? | Any data-access `PackageReference`, a `DbContext`, a connection string, a repository type, an Aspire resource | -| Which technology? | The EF Core provider package (`Microsoft.EntityFrameworkCore.SqlServer`, `Npgsql.EntityFrameworkCore.PostgreSQL`), the client package, or the `Purview.Containers` resource in the AppHost | -| Is more than one implementation required? | Two providers referenced, a provider abstraction already present, or an explicitly stated requirement | -| EF Core or something else? | Presence of `Microsoft.EntityFrameworkCore` versus Dapper, a raw client, or a document store SDK | - -"No persistence" is a complete and common answer. When it is the answer, every storage-shaped -recommendation — repositories, migrations, GUID strategies, connection resilience — is out of scope. - -## Dimension 4 — telemetry - -| Question | Read it from | -| -- | -- | -| Is telemetry configured? | `ILogger` injection, `ActivitySource`/`Meter` construction, `AddOpenTelemetry`, a `ServiceDefaults` project | -| Is Purview Telemetry available? | A `Purview.Telemetry.SourceGenerator` `PackageReference`, or interfaces attributed `[Logger]`, `[ActivitySource]`, `[Meter]` | -| Which signals are relevant? | Logs always; traces once a call crosses a process or a dependency; metrics once someone would alert on a rate or a duration | -| Is there an exporter? | An OTLP endpoint in configuration, a console exporter, an Aspire dashboard, an APM package | - -Existing instrumentation is a constraint, not a starting point to replace. Preserve it, extend it, -and never register the same source twice. - -## Conditional dimension — identifier generation - -Resolve **only** when persistence exists and GUIDs are, or are about to be, primary keys. - -- Are GUIDs primary keys, or just surface identifiers? -- Is the value generated in the application or by the database? -- Which provider and version? (This changes the answer — see `purview-persistence`.) -- Does index locality matter at the expected write volume? -- Must the identifier exist before the entity is persisted (outbox, correlation, client-side graph)? - -The last question usually decides it: if the application needs the value before `SaveChanges`, the -database cannot be the generator. - -## Asking well - -When you must ask, ask few and ask concretely. Batch the unknowns into one short set, offer the -likely answers, and state what you will do if the user does not care. - -Good: - -> Two things I can't tell from the repository: is this service expected to own its own database, or -> read from the existing one? And should failures be returned to the caller or thrown? I'll assume -> its own database and `Purview.Results` for expected failures unless you say otherwise. - -Bad: - -> What is the project complexity? What is the project type? Is persistence required? Which database? -> Is telemetry configured? Do you use GUID primary keys? - -The second asks six questions, five of which the repository answers, and one of which is irrelevant. - -## Recording the answer - -When a dimension is resolved by conversation rather than by the repository, that is a decision the -next agent will not be able to read. Write it down — in `AGENTS.md`, a wiki page, or an ADR — so the -question is asked once and never again. diff --git a/.agents/skills/purview-architecture/references/project-responsibilities.md b/.agents/skills/purview-architecture/references/project-responsibilities.md deleted file mode 100644 index dc4e67cc..00000000 --- a/.agents/skills/purview-architecture/references/project-responsibilities.md +++ /dev/null @@ -1,119 +0,0 @@ -# Project responsibilities, naming and dependency direction - -The catalogue in brief. The authoritative definition is -[`.config/architecture-policy.json`](https://github.com/purview-dev/engineering-playbook/blob/main/.config/architecture-policy.json), -and the full page — with diagrams — is -[Project Responsibilities](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/foundations/Project-Responsibilities.md). -Do not restate either here or in another skill; link to them. - -## The catalogue - -`A → B` means A depends on B **at compile time**. - -| Responsibility | Also known as | Owns | May depend on | -| -- | -- | -- | -- | -| `Core` | `Domain` | Entities, value objects, invariants, domain events and errors | Shared | -| `Abstractions` | — | Cross-boundary capability contracts | Core, Shared | -| `Application` | `UseCases` | Use cases, workflows, orchestration | Core, Abstractions, Contracts, Shared | -| `Contracts` | — | Externally exposed request/response types; browser-safe when a WebAssembly client references it | Core, Shared | -| `Persistence` | — | DbContext, mappings, migration *definitions* | Core, Abstractions, Application, Shared | -| `Providers` | `Integrations` | Integration with a *named external platform* | Core, Abstractions, Application, Shared | -| `Adapters` | — | An *application-defined capability* via one technology | Core, Abstractions, Application, Shared | -| `Composition` | — | DI registration and implementation selection | Everything above | -| `API` | — | HTTP host | Composition, Contracts, ServiceDefaults, … | -| `Worker` | — | Background-processing host | Composition, ServiceDefaults, … | -| `Migrator` | — | *Executes* migrations and controlled seeding | Persistence, Composition, ServiceDefaults | -| `AppHost` | — | Aspire orchestration | The hosts it orchestrates | -| `ServiceDefaults` | — | Telemetry, health, resilience, discovery defaults | Shared | -| `WebApp` | — | Frontend, including a Blazor WebAssembly client that references Contracts | Contracts, ServiceDefaults, Shared | -| `Shared` | — | Small domain-independent primitives | *nothing* | - -**None of these is mandatory.** A small application with `Core` and one host has a complete and -correct architecture. The catalogue names responsibilities so you can tell when splitting one out -buys something — it is not a list of projects to create. - -### Backend-for-Frontend: guidance, not yet policy - -A BFF is a host responsibility that the policy does **not** define yet; Blazor and BFF support is -planned for a future Build SDK release. Until then it is guidance, and every rule below is a review -obligation: - -| Owns | May depend on | Split it out when | Leave it combined when | -| -- | -- | -- | -- | -| Sign-in and token custody for a browser or mobile client; forwards with the user's token. In Blazor, the host that serves the WebAssembly client | The WebAssembly client project, ServiceDefaults, Shared — and Contracts only when it prerenders data or combines responses | Tokens must be kept out of the browser, or several API calls must become one response | It would only forward calls that the client could make with a token it already holds safely | - -A repository that adds a BFF project today needs its own responsibility entry or a waiver in its -policy, or the architecture tests reject the project as unclassified. See `contract-strategy.md`. - -## When to split - -| Responsibility | Split it out when | Leave it combined when | -| -- | -- | -- | -| `Core` | A domain model exists | The app is a thin utility | -| `Abstractions` | Two implementations, or the consumer must not see the implementation | One implementation — keep the interface beside it | -| `Application` | Workflows are reused by more than one host | It would only forward CRUD | -| `Contracts` | The contract strategy is Contracts or Hybrid — see `contract-strategy.md` | The API host is the only consumer, which is the OpenAPI strategy || `Persistence` | Persistence exists at all | A single-project utility writing a file | -| `Providers` | Two platforms with different SDKs or lifecycles | One platform | -| `Adapters` | One capability, several technologies | One capability, one technology | -| `Composition` | Two hosts compose the same implementations | One host — compose in the host | -| `Migrator` | Schema changes are a deliberate deployment step | Development-only startup migration | -| `Shared` | A primitive is used by two or more responsibilities | Almost always | - -## Naming - -```text -[.] -``` - -| Situation | Name | -| -- | -- | -| One implementation | `Persistence` — do **not** qualify it just because it is SQL Server | -| Several, same dependencies and lifecycle | `Persistence` — one project, several classes | -| Several, genuinely different | `Persistence.SqlServer`, `Persistence.PostgreSql` | -| Several, with shared code | Add `Persistence` alongside the qualified projects | -| Several, nothing shared | Qualified projects only — no empty parent | - -Discouraged as project names, because each names a category rather than a responsibility: -`Infrastructure`, `Services`, `Managers`, `Models`, `Helpers`, `Common`, `Utils`, `Utilities`. - -`Infrastructure` is the common case. It is a useful *category* — covering Persistence, Providers and -Adapters — and a poor *project*, because every technical class qualifies for it. - -**Do not rename an established project** merely to match canonical terminology. A rename costs more -than the consistency is worth, and `Domain`/`UseCases`/`Integrations` are recognised aliases. - -## Providers versus Adapters - -Not a vendor distinction: - -- **Provider** — the requirement names the platform: "sync issues from GitHub". Swapping it changes - the product. -- **Adapter** — the requirement names the capability: "send an email". Swapping the technology - changes nothing the user sees. - -Azure Blob behind `IFileStore` is an Adapter. The Azure DevOps work-item API in a product that -integrates Azure DevOps is a Provider. - -## Dependency rules that catch people out - -1. **Composition is referenced by nothing** except a host. It selects implementations, so it depends - on them; the reverse would make the choice circular. -2. **Application never references a concrete infrastructure project.** It depends on an abstraction - and receives an implementation it cannot name. -3. **Sibling implementations stay independent.** If `Providers.GitHub` needs something from - `Providers.AzureDevOps`, that shared thing belongs in the unqualified project or an abstraction. -4. **Persistence owns migration definitions; Migrator executes them.** Production API startup does - not mutate a schema. -5. **Runtime is not compile time.** DI registration, an HTTP call and Aspire orchestration are not - assembly references. A Worker and an API can share Application without referencing each other. - -## Recommending this to a repository that predates it - -Do not propose a mass rename. Suggest, in order: - -1. Fix dependency *directions* that are actually wrong — those are bugs. -2. Split a project only where a named problem justifies it. -3. Record a waiver for an established name rather than renaming it, so the rule stays enforceable - without churn. - -A waiver excuses the name only; the project still classifies, so every dependency rule still applies. diff --git a/.agents/skills/purview-architecture/references/proportional-architecture.md b/.agents/skills/purview-architecture/references/proportional-architecture.md deleted file mode 100644 index 3ed7f553..00000000 --- a/.agents/skills/purview-architecture/references/proportional-architecture.md +++ /dev/null @@ -1,92 +0,0 @@ -# Proportional architecture - -Structure is a cost paid now against a failure expected later. Proportional architecture is the -practice of only paying when the failure is named, present, and more expensive than the structure. - -## The justification test - -Before adding a project, an interface, a layer or a pattern, answer in one sentence: - -> **What failure does this prevent in *this* codebase, and has it happened or is it certain to?** - -If the sentence needs the words "in case", "later", "when we scale", or "it's good practice", the -structure is not yet justified. Write the simpler thing. The simpler thing is also the thing that is -cheapest to change when the failure finally does arrive. - -This is not an argument against structure. It is an argument against *unfalsifiable* structure. - -## By scale - -### Small — a utility, CLI, prototype, simple API, limited-scope application - -- One project. A second only when there is a test project, or when a genuinely reusable library - falls out. -- Call the database, the API or the file system directly from the code that needs it. -- Validate at the edge, once. -- Logging from the first commit; traces and metrics when there is something to correlate. - -Do not add: a repository interface over `DbContext`, a service layer that forwards, a mapping layer -between two near-identical shapes, an interface with one implementation and no test double need -(`Purview.Containers` and TUnit.Mocks remove most of that need), a `Domain`/`Application`/ -`Infrastructure` split. - -### Medium — several functional areas, some integrations, moderate domain complexity - -- Introduce a boundary where you can name what it separates. Usually that is domain rules from the - host, so a domain project and an application host. -- An abstraction over an external dependency earns its place when the dependency is genuinely - swappable, or when testing against it is otherwise painful. "Swappable in principle" is not - swappable. -- Dependency instrumentation, trace propagation across the integrations, metrics on the operations - someone would be paged about. - -Do not add: CQRS unless reads and writes have actually diverged in shape, lifetime or scaling; -event sourcing unless the history *is* the product; a second infrastructure implementation that has -no second consumer. - -### Large — complex domain, multiple services or teams, substantial operational requirements - -- Modularity along ownership lines, because the real constraint is people, not code. -- Independent infrastructure implementations where they are genuinely independent. -- Boundaries made enforceable rather than documented — a dependency-direction rule that a wrong - `ProjectReference` fails the build. See the playbook's Architecture-As-Tests page. -- End-to-end tracing, standardised resource attributes, SLIs, retention and sampling policy. - -Even here, the justification test holds per decision. "Large" licenses the *option* to add -structure, not the obligation to add all of it on day one. - -## Patterns and the conditions that earn them - -| Pattern | Earned when | Not earned by | -| -- | -- | -- | -| Repository over EF Core | You must swap the store, or the `DbContext` API genuinely leaks into domain decisions | Testability — EF Core's in-memory and container-backed testing already covers it | -| CQRS | Read and write models have diverged in shape or scaling needs | A desire for symmetry with a reference architecture | -| Event sourcing | The sequence of changes is the product, or audit is a hard requirement | "We might want history" | -| Mediator / in-process bus | Many handlers, genuinely decoupled registration | Three call sites that could be method calls | -| Mapping layer | Two shapes that must diverge and are owned separately | Two shapes that are identical today | -| Extra DI indirection | A real second implementation, or a composition root that must vary | Inversion for its own sake | -| Generic infrastructure framework | Three or more concrete uses exist now | One use and an expectation of more | - -## Evolving incrementally - -The honest sequence is: write the direct implementation; let the second caller arrive; extract the -boundary the second caller revealed. Each step is small, reversible and informed. - -The dishonest sequence is: predict the second caller; build the boundary; never get the second -caller; maintain the boundary forever. The cost is invisible because it is spread across every -future change. - -When you do extract, extract along the seam the code showed you — not the seam the diagram -predicted. - -## What this does not license - -Proportional is not an excuse for: - -- Skipping tests, or skipping telemetry. -- Leaving validation duplicated across entry points. -- Letting domain rules live in the UI or in the database. -- Two sources of truth for the same fact. - -Those are not structure bought in advance; they are defects. Simplicity means fewer moving parts, -not fewer guarantees. diff --git a/.agents/skills/purview-buildsdk-adoption/SKILL.md b/.agents/skills/purview-buildsdk-adoption/SKILL.md deleted file mode 100644 index 07be90ab..00000000 --- a/.agents/skills/purview-buildsdk-adoption/SKILL.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -name: purview-buildsdk-adoption -description: Adopt Purview.BuildSdk in a repository, or troubleshoot an adoption that is not behaving. Use when wiring the SDK into Directory.Build.props for the first time, when a property seems to have no effect, when the resolved version, target framework or namespace is wrong, or when a consuming repository builds but the SDK's automatic behaviour is not appearing. Covers the import chain, pre-import property ordering, required settings and versions, target frameworks, and version detection from package.json. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Adopting Purview.BuildSdk - -The goal is a working adoption that does not break existing build behaviour. Prefer minimal, -targeted property changes over rewriting a repository's `Directory.Build.props`. - -For the full property list use `purview-buildsdk-configuration`; for auditing an existing -repository's shape, `purview-buildsdk-repository-review`. - -## 1. The import chain - -```xml - - - - - Acme.Sales - - - - -``` - -```xml - - - - -``` - -Both halves are required. A repository with only `Sdk.props` imported gets the evaluation-time -defaults — naming, identity, framework selection — but none of the targets, so validation, -packaging behaviour and the generated files never run. That combination usually presents as "the -properties look right but nothing happens". - -### Required settings and versions - -Four values decide whether the SDK behaves as documented. Set the first three **before** the import -where noted: - -| What | Where | Notes | -| -- | -- | -- | -| `NamespacePrefix` | `Directory.Build.props`, above the import | Required — the build fails without it unless `DisableNamespacePrefixCheck=true`. | -| SDK version | `global.json` → `msbuild-sdks.Purview.BuildSdk` | The pinned `Purview.BuildSdk` version, e.g. `2.0.1`. The SDK bootstraps `global.json` when it is missing and writes `PurviewBuildSdkVersionForGlobalJson` — the restored package version, else the version it was packed as. | -| Product version | repo-root `package.json` → `version` | Drives `Version` and `PackageVersion`. `UsePackageJsonVersion` / `RootPackageJson` are pre-import. | -| Package versions | `Directory.Packages.props` | CPM is on; a `PackageVersion` is a minimum, not an exact pin. | - -```json -// global.json -{ - "test": { "runner": "Microsoft.Testing.Platform" }, - "msbuild-sdks": { "Purview.BuildSdk": "2.0.1" } -} -``` - -## 2. Pre-import ordering is the first thing to check - -**A property that must affect `Sdk.props` evaluation has to be set before the import.** Setting it -in a `.csproj`, or below the import, is too late and silently does nothing — no error, no warning. -This is the single most common adoption failure. - -Set before the import: - -- `NamespacePrefix` -- `UsePackageJsonVersion`, `RootPackageJson`, `RepoRoot` -- `EnableAssemblyNameGeneration` -- `TestingFramework`, `SubstituteFramework`, `TestDataFramework` — even for a single project; a - value in the `.csproj` is too late and the defaults (`TUnit`, `TUnitMocks`, `Bogus`) stay -- `PurviewTestContextNoWarn`, `DisablePurviewTestContextRuleSet` -- `DisablePurviewBlazorWebAssemblyDefaults` -- `PurviewTargetFrameworks`, when redefining a framework set - -Most other properties are read in `Sdk.targets`, or only after the project body, and can be set in a -project file — `PurviewSharedTestingOutputType` and `AutoIncludeUsings` among them. `purview-buildsdk-configuration` lists -which is which. - -When a property appears to have no effect, confirm what MSBuild actually resolved before changing -anything else: - -```bash -dotnet msbuild -getProperty:NamespacePrefix -getProperty:RootNamespace -``` - -## 3. Version detection - -Versions come from `package.json`. Resolution order: - -1. An explicit `RootPackageJson`. -2. An explicit `RepoRoot`, else CI workspace variables (`GITHUB_WORKSPACE`, - `BUILD_SOURCESDIRECTORY`, `BUILD_REPOSITORY_LOCALPATH`, `CI_PROJECT_DIR`). -3. The nearest `.git` above the project. -4. The nearest `package.json` above the project. - -The `package.json` at that root is read, and on success both `Version` and `PackageVersion` are set -from its `version` field. A root that is found but has no `package.json`, or a `package.json` with no -`version`, already fails the build. - -If the version looks wrong, do not guess at the discovery — make it fail loudly instead: - -```xml -Strict -``` - -`Strict` also fails the build when no repository root can be discovered at all, rather than silently -skipping detection and leaving the default `0.0.1`. Set `VersionDetectionLogEnabled=true` to see what it found. - -## 4. Naming and placement - -Most of the SDK's value is inferred from project names and locations, so an adoption that keeps a -bespoke structure gets correspondingly little. Confirm the repository follows the conventions rather -than introducing new structure to work around them — see `purview-buildsdk-project-layout`, and -`purview-buildsdk-repository-review` for auditing an existing layout. - -The highest-value single check: every test project is named `.Tests`. **The dot is -required.** A project named plainly `UnitTests` is not detected as a test project at all, and -silently gets no runner, no coverage, no `InternalsVisibleTo` and no category. - -## 5. Agent skills are a separate, explicit step - -Nothing the SDK does during a restore or a build touches agent skills. Installing, updating and -cleaning them up are separate targets a person runs by name — `InstallPurviewSkills`, -`UpdatePurviewSkills`, `CheckPurviewSkills`, `FixPurviewSkills` — and the ones that change the -repository refuse to run inside a build (`PRSKL0009`). Do not hook them into one. The skills CLI does -the installing, through `bun x` by default; with `PurviewSkillsAgents` unset it auto-detects agents. - -If the repository uses `just`, add recipes for them — see `purview-buildsdk-justfile`. For what each -target does and the `PRSKL*` diagnostics, see `purview-buildsdk-skill-installation`. - -## 6. Target frameworks - -A project that declares neither `TargetFramework` nor `TargetFrameworks` gets `net10.0;net11.0`. -Confirm what a project resolves before changing it: - -```bash -dotnet msbuild -getProperty:TargetFramework -getProperty:TargetFrameworks -``` - -To set it: - -- **Declare it explicitly** — `TargetFramework` (one) or `TargetFrameworks` (many). An explicit value - always wins over every set, wherever it is set (the project, with or without a `Condition`, a file it - imports, or `Directory.Build.props`) — but not in `Directory.Build.targets`, which is too late. -- **Select a curated set** — `Supported` in - `Directory.Build.props` or the `.csproj` (`Current`, `Latest`, `Supported`, `Broad`, `All`), so a - lifecycle change is one SDK bump rather than an edit in every project. -- **Redefine a set** — set `PurviewTargetFrameworks` before the import to pin the repository's - meaning of a set. - -A Roslyn component targets `netstandard2.0` and ignores the sets. Full detail in -`purview-buildsdk-configuration` and [Configuration Reference](https://github.com/purview-dev/build-sdk/blob/main/docs/wiki/Configuration-Reference.md#target-framework-sets). - -## 7. SourceLink provider - -The SDK adds a SourceLink provider package (`SourceLinkPackageName`, default -`Microsoft.SourceLink.GitHub`) to every non-test project, and `PublishRepositoryUrl=true` writes the -repository URL and commit into the packed `.nuspec`. Match the repository host in -`Directory.Build.props`, so every project gets the same provider: - -| Host | Package | -| -- | -- | -| GitHub / GitHub Enterprise | `Microsoft.SourceLink.GitHub` *(default)* | -| Azure DevOps Services / Azure Repos | `Microsoft.SourceLink.AzureRepos.Git` | -| Azure DevOps Server / TFS (on-premises) | `Microsoft.SourceLink.AzureDevOpsServer.Git`, plus a `SourceLinkAzureDevOpsServerGitHost` item | -| GitLab | `Microsoft.SourceLink.GitLab` | -| Bitbucket | `Microsoft.SourceLink.Bitbucket.Git` | - -CPM is on, so add a `PackageVersion` for the chosen provider to `Directory.Packages.props` — the shipped -template already declares GitHub, Azure Repos and GitLab. `DisableSourceLink=true` opts out entirely. -Detail, including the on-premises host item, is in `purview-buildsdk-configuration`. - -## Constraints - -- Prefer minimal, targeted property changes over broad `Directory.Build.props` rewrites. -- Do not disable `PurviewAutoSdkPack` unless the consumer explicitly asks to opt out. -- Do not restate an SDK default in a project file. Hand-configuration that merely repeats a default - is pure maintenance cost, and it hides the fact that the default later changed. -- Re-run the build — or the repository's canonical build command — after each change, and confirm - the fix before moving to the next one. diff --git a/.agents/skills/purview-buildsdk-configuration/SKILL.md b/.agents/skills/purview-buildsdk-configuration/SKILL.md deleted file mode 100644 index 767a81ae..00000000 --- a/.agents/skills/purview-buildsdk-configuration/SKILL.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -name: purview-buildsdk-configuration -description: Configure Purview.BuildSdk from Directory.Build.props or a .csproj. Use when setting NamespacePrefix, setting the target framework(s) or selecting a curated framework set, choosing a SourceLink provider for the repository host (GitHub, Azure DevOps, GitLab, Bitbucket), choosing a testing or mocking framework, turning telemetry or SourceLink off, controlling version detection from package.json, pinning the SDK version in global.json, tuning the repository bootstrap, making a library browser-safe for a Blazor WebAssembly client, configuring a BFF host, or working out whether a property must be set before the SDK import. Also use when the SDK "did something automatically" and you need the property that controls it. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Purview.BuildSdk configuration - -Use this skill when the question is "what property controls this, and where do I set it?" - -For *why* the SDK classified a project a particular way, use `purview-buildsdk-project-detection` -instead. For where projects and tests should live, use `purview-buildsdk-project-layout`. - -## First rule: know where a property must be set - -A property that changes `Sdk.props` evaluation must be set **before** the SDK import — in -`Directory.Build.props`, above the import. Setting it in a `.csproj` is too late and silently has no -effect. - -Pre-import properties include: - -- `NamespacePrefix` -- `UsePackageJsonVersion`, `RootPackageJson` -- `EnableAssemblyNameGeneration` -- `PurviewTestContextNoWarn`, `DisablePurviewTestContextRuleSet` -- `DisablePurviewBlazorWebAssemblyDefaults` -- `TestingFramework`, `SubstituteFramework`, `TestDataFramework` — even for a single project - -A target framework is a special case. An explicit `TargetFramework`/`TargetFrameworks` always wins, -wherever it is set except `Directory.Build.targets`. `PurviewTargetFrameworkSet` is read from the -**project XML**, so it can live in the project or in `Directory.Build.props` but must be declared -**unconditionally** — see [Setting the target framework(s)](#setting-the-target-frameworks). - -Everything else is read in `Sdk.targets`, or only after the project body, and can be set in a project -file — `PurviewSharedTestingOutputType` and `AutoIncludeUsings` among them. Prefer repo-wide defaults -in `Directory.Build.props` unless the setting is deliberately project-specific. - -## Required settings and versions - -Four things must be right, and three of them are read during `Sdk.props` evaluation — set those in -`Directory.Build.props` **above** the ``: - -| Setting | Where | Notes | -| -- | -- | -- | -| `NamespacePrefix` | `Directory.Build.props`, pre-import | Required. The build fails without it (`ValidateRootNamespacePrefixTarget`) unless `DisableNamespacePrefixCheck=true`. | -| SDK version | `global.json` → `msbuild-sdks.Purview.BuildSdk` | The pinned `Purview.BuildSdk` version. The SDK bootstraps `global.json` (with this value) when it is missing; `PurviewBuildSdkVersionForGlobalJson` decides what is written. | -| Product version | repo-root `package.json` → `version` | Drives both `Version` and `PackageVersion`. `UsePackageJsonVersion` (`true`/`false`/`Strict`) and `RootPackageJson` are pre-import; `Strict` fails the build when discovery cannot succeed instead of silently staying on `0.0.1`. | -| Package versions | `Directory.Packages.props` | CPM is on (`ManagePackageVersionsCentrally=true`). Each `PackageVersion` is a minimum, not an exact pin. | - -## Setting the target framework(s) - -A project that declares neither `TargetFramework` nor `TargetFrameworks` gets the SDK's default set, -`net10.0;net11.0` (`Current`). Pick one of three routes, narrowest first: - -1. **Explicit declaration** — `net10.0` for one target, - `net10.0;net11.0` for many. An explicit value **always wins** - over every set, wherever it is set — the project (with or without a `Condition`), a file it - imports, or `Directory.Build.props` before or after the import. Only `Directory.Build.targets` is - too late, because the .NET SDK has already decided whether to multi-target. A project declaring - `TargetFrameworks` keeps `TargetFramework` empty. -2. **A curated set** — `Supported` in - `Directory.Build.props` (repository-wide) or the `.csproj`. Sets: `Current` (default), - `Latest` (`net11.0`), `Supported` (`net10.0;net11.0`), `Broad` (`net8.0;net9.0;net10.0`), `All` - (`net8.0;net9.0;net10.0;net11.0`). An unknown name fails with `PurviewInvalidTargetFrameworkSet` - rather than silently falling back. -3. **Redefine a set** — set `PurviewTargetFrameworks` (for example `PurviewTargetFrameworksSupported`) - **before the import** to pin the repository's meaning of a set across an SDK bump. - -A Roslyn component (`IsRoslynComponent=true`) targets `netstandard2.0` and ignores the sets; selecting -one is reported as `PurviewTargetFrameworkSetIgnored`. The full table is in -[references/properties.md](references/properties.md#target-framework-and-language). - -## The properties you will reach for most - -| Property | Default | What it does | -| -- | -- | -- | -| `NamespacePrefix` | *(required)* | The root identity. Required unless `DisableNamespacePrefixCheck=true` | -| `TestingFramework` | `TUnit` | `TUnit`, `Xunit` or `None` | -| `SubstituteFramework` | `TUnitMocks` | `TUnitMocks`, `NSubstitute` or `None` | -| `TestDataFramework` | `Bogus` | `Bogus` or `None` | -| `TargetFramework` | `net10.0;net11.0` | `netstandard2.0` when `IsRoslynComponent=true` | -| `IsPackable` | `false` | Opts a project into the packable defaults | -| `UsePackageJsonVersion` | `true` | `true`, `false` or `Strict` — version from `package.json` | -| `ExcludePurviewTelemetry` | `false` | Drops the telemetry source generator | -| `DisableSourceLink` | `false` | Stops the SDK adding the SourceLink provider package to any project | -| `EnableAssemblyNameGeneration` | `true` | `AssemblyName`/`PackageId` follow the resolved `RootNamespace` | -| `PurviewBrowserSafe` | *(unset)* | On a class library a WebAssembly client downloads: trim, AOT and browser-unsupported APIs fail the build | -| `IsBffProject` | name ends `Bff` | Classifies a BFF host; `false` opts out | -| `PurviewBrowserSafeReferenceCheckAsError` | `false` | Makes `PRBLZ0001` (a client reference that is not browser-safe) an error | -| `MemorySafetyRules` | `0` | C# 15 memory-safety tier on `net11.0`+: `0` off (default), `1` preview syntax, `2` updated rules (`updated-memory-safety-rules`, opt-in — an experimental compiler feature) | -| `PurviewRuntimeAsync` | *(unset, treated as false)* | Opts a `net11.0`+ target into `runtime-async=on`; `UseRuntimeAsync=true` also opts in | -| `IsClientSideProject` | *(computed)* | Whether the project's assemblies can reach a browser; overrides the `ServerShared` classification | -| `PurviewAutoServerSharedReference` | `true` | Adds a sibling `ServerShared` reference to a non-client-side project | -| `PurviewMultiThreadedBuild` | `true` | Bootstraps a `Directory.Build.rsp` enabling MSBuild `-mt`; unset, a Blazor WebAssembly client writes `-mt:false` (`PRBLZ0002`) | - -The full set, grouped by area and with the behaviour each one changes, is in -[references/properties.md](references/properties.md). Read it rather than guessing a property name — -several of these have near-miss names that do nothing. - -## Derived properties to inspect, not re-derive - -When explaining what the SDK did, read the value it computed rather than reasoning from the folder -name: - -`PurviewLogicalProjectName`, `PurviewNamespacePrefix`, `PurviewProjectShortName`, `PurviewTestType`, -`RootNamespace`, `AssemblyName`, `PackageVersion`, `TestingType`, `TargetProjectName`, `RepoRoot`, -`RootPackageJson`, `IsBlazorHostProject`, `IsBffProject`, `PurviewBffExposesApi`, `IsAotCompatible`, -`WarningsAsErrors`. - -Ask MSBuild for one directly: - -```bash -dotnet msbuild -getProperty:RootNamespace -dotnet msbuild -getProperty:TestingType -getProperty:TargetProjectName -``` - -## Compiler-visible properties - -The SDK exports a large set of properties to Roslyn analyzers and source generators through -`CompilerVisibleProperty`, readable as `build_property.`: - -```csharp -context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.IsBffProject", out var isBff); -``` - -- **Consuming them** — read the exported property instead of re-deriving SDK behaviour; the export is - the SDK's answer and stays correct when the rules change. The SDK's own analyzers use this - (`build_property.IsBffProject` gates `PDS0008`/`PDS0009`). -- **Exposing a new one** — an analyzer can only see a property the SDK lists as a - `CompilerVisibleProperty` item (with a ``) in `Sdk.props`. Add it there; there is no - other mechanism, and an MSBuild property is invisible to the compiler until it is listed. - -The exported set is listed in -[references/properties.md](references/properties.md#compiler-visible-properties). - -## Version detection - -1. If `RootPackageJson` is set, that file is used. -2. Otherwise the repo root is discovered from CI variables, `.git`, or a nearby `package.json`. -3. On success, both `Version` and `PackageVersion` come from the `version` field. -4. `UsePackageJsonVersion=Strict` turns a failed discovery into a build failure instead of a silent - fallback. - -## Repository bootstrap - -The SDK bootstraps three repository-wide files from the package: `.editorconfig`, `global.json` and -`Directory.Build.rsp`. - -- `PurviewRepoBootstrapMode` — `IfMissing` (default), `Always`, `WarnOnDrift`, `Never` -- `DisableAutoCopySdkFiles` — the master off switch -- `PurviewRepoBootstrapCopyRetries` / `...RetryDelayMilliseconds` / `...FailureAsError` -- `BootstrapMultiThreadedBuildRspToRepoRoot` / `PurviewMultiThreadedBuild` — the response file that - enables MSBuild `-mt` (and `-nr:false`, which avoids a `RoslynCodeTaskFactory` cache left by a - non-`-mt` build). A repository with a Blazor WebAssembly client gets `-mt:false` instead, because a - `net11.0` client cannot build under `-mt`; a client built under `-mt` anyway fails with `PRBLZ0002`. - The WebAssembly SDK's own error for this is `MSB4060` on `ReadWasmProps`, and it does not mention the - response file - -Every project in a solution writes those same destinations, so the write is race-tolerant by -design: an existing file is never overwritten unless asked, each write is staged into a temporary -file and renamed into place, retries are quiet, and only a failure that survives every retry is -reported. - -**The SDK writes nothing into an agent directory.** It used to mirror a package's `.agents/**` into -the repository; that is gone, along with `EnableAgentFolderInPackage`, `AgentPackDestinationFolder` -and the `PurviewAgentFolder*` properties. Skills have exactly one installer, the skills CLI — see -`purview-buildsdk-skill-installation`. - -The skill targets read their settings when they run, so these can go in `Directory.Build.props` or -on the command line, and a repository-wide choice belongs in `Directory.Build.props`: - -| Property | Default | Controls | -| -- | -- | -- | -| `PurviewSkillsRunner` | `bun` (`bun x skills`) | Which package runner launches the skills CLI | -| `PurviewSkillsAgents` | empty — the CLI auto-detects | Agents to install to; when set, the only agent directories `CheckPurviewSkills` allows | -| `PurviewSkillsDryRun` | `false` | Install and update print commands instead of running them | - -On a command line, `dotnet msbuild -p:` splits values on `,` and `;` — write -`-p:PurviewSkillsAgents=claude-code%2Ccodex`. For `just` recipes, see `purview-buildsdk-justfile`. - -## SourceLink - -Every non-test project gets a SourceLink provider package — `SourceLinkPackageName`, default -`Microsoft.SourceLink.GitHub`, added with `PrivateAssets="all"` so a debugger can step into a consumed -package's source and the `.nuspec` records the repository URL and commit. A repository on another host -selects the matching package in `Directory.Build.props`, so every project agrees: - -| Host | Provider package | -| -- | -- | -| GitHub / GitHub Enterprise | `Microsoft.SourceLink.GitHub` *(default)* | -| Azure DevOps Services / Azure Repos | `Microsoft.SourceLink.AzureRepos.Git` | -| Azure DevOps Server / TFS (on-premises) | `Microsoft.SourceLink.AzureDevOpsServer.Git` (+ `SourceLinkAzureDevOpsServerGitHost`) | -| GitLab | `Microsoft.SourceLink.GitLab` | -| Bitbucket | `Microsoft.SourceLink.Bitbucket.Git` | - -Because CPM is on, the chosen provider also needs a `PackageVersion` in `Directory.Packages.props`. Use -`DisableSourceLink=true` (in `Directory.Build.props`, or one project) to opt out. The host matrix, the on-premises Azure DevOps Server -host item, the CPM requirement and the self-hosted case are in -[references/sourcelink.md](references/sourcelink.md). - -## Guidance when changing configuration - -1. Preserve existing defaults unless the task explicitly changes behaviour, and do not restate an SDK - default in a project file. -2. Confirm a change with `dotnet msbuild -getProperty:` rather than reasoning about it. -3. For a package that ships its **own** MSBuild properties — adding one, renaming it, documenting it in - a `.buildschema.json` sidecar, or exporting it to analyzers — use `purview-buildsdk-msbuild-properties`. diff --git a/.agents/skills/purview-buildsdk-configuration/references/properties.md b/.agents/skills/purview-buildsdk-configuration/references/properties.md deleted file mode 100644 index 8efd3db9..00000000 --- a/.agents/skills/purview-buildsdk-configuration/references/properties.md +++ /dev/null @@ -1,219 +0,0 @@ -# Purview.BuildSdk property reference - -Every user-facing property, grouped by what it changes. Defaults are what the SDK applies when the -consuming project supplies nothing. - -## Identity and naming - -| Property | Default | Behaviour | -| -- | -- | -- | -| `NamespacePrefix` | *(required)* | The root identity source. Required unless the check is disabled. Set before the SDK import | -| `DisableNamespacePrefixCheck` | `false` | Stops the build failing when `NamespacePrefix` is unset | -| `EnableAssemblyNameGeneration` | `true` | `AssemblyName` and the default `PackageId` follow the fully evaluated `RootNamespace`, or the full logical project name when suffix-stripping removed a segment (`Shared`, `ServiceDefaults`). Set `false` before the SDK import for standard project-name behaviour | -| `AssemblyIdentifierClassName` | *(derived)* | Renames the generated marker class | -| `DisableGenerateAssemblyIdentifierClass` | `false` (forced `true` for test and shared-testing projects) | Drops the empty marker class (`Assembly`, global namespace) that architecture tests use to pin an assembly by `typeof` rather than by name | -| `DisableGenerateAssemblyInfoClass` | `false` (forced `true` for test and shared-testing projects) | Drops the generated `AssemblyInfo` | -| `DisableAutoInternalsVisibleTo` | `false` | Drops automatic friend-assembly generation | -| `DisableProjectFileNamingConventionCheck` | `false` | Stops validating that the `.csproj` filename matches its directory | -| `AutoIncludeUsings` | `true` | Controls the SDK-added global usings. Can be set in a project file | - -## Target framework and language - -| Property | Default | Behaviour | -| -- | -- | -- | -| `TargetFramework` | `net10.0;net11.0` | Applied when neither `TargetFramework` nor `TargetFrameworks` is set. An explicit value (or `TargetFrameworks`) always wins over every set, wherever it is set — with or without a `Condition` — except `Directory.Build.targets`, which is too late. A project that explicitly declares `IsRoslynComponent=true` defaults to `netstandard2.0` | -| `PurviewTargetFrameworkSet` | `Current` | Named set resolved when the project declares no TFM: `Current`, `Latest`, `Supported`, `Broad` or `All`. An unknown name fails with `PurviewInvalidTargetFrameworkSet`. A single-entry set resolves to `TargetFramework` rather than paying for an outer build. Declare unconditionally | -| `PurviewTargetFrameworksCurrent` | `net10.0;net11.0` | Redefines the `Current` set (the default). Set before the SDK import | -| `PurviewTargetFrameworksLatest` | `net11.0` | Redefines the `Latest` set | -| `PurviewTargetFrameworksSupported` | `net10.0;net11.0` | Redefines the `Supported` set | -| `PurviewTargetFrameworksBroad` | `net8.0;net9.0;net10.0` | Redefines the `Broad` set | -| `PurviewTargetFrameworksAll` | `net8.0;net9.0;net10.0;net11.0` | Redefines the `All` set | -| `TreatWarningsAsErrors` | `true` | Every project: compiler, analyzer and NuGet warnings fail the build (MSBuild `` tasks do not). `false` in a project or `Directory.Build.props` opts out. A packable Roslyn component still fails its pack without it (`PRSGD0003`) | -| `IsRoslynComponent` | *(unset)* | When explicitly `true`: a single `netstandard2.0` target, `LangVersion=latest`, `Nullable=enable`, `TreatWarningsAsErrors=true`, `Deterministic=true`, extended analyzer rules, SourceLink with `EmbedUntrackedSources=true`, no dependency file, telemetry exclusion, and `PrivateAssets=all` on `Microsoft.CodeAnalysis.*` references | -| `IsRoslynComponentOnly` | `true` for Roslyn components | Analyzer-only package: `IncludeBuildOutput=false`, `IncludeSymbols=false`, portable PDB packed beside the analyzer under `analyzers/dotnet/cs/`. Set `false` for a dual-role component using normal library symbol packaging | -| `DisableRoslynCompilerDefaultsValidation` | `false` | Opts out of `ValidateRoslynComponentCompilerSettings`, which fails the pack of a packable Roslyn component missing `LangVersion`, `Nullable`, `TreatWarningsAsErrors` or `EnforceExtendedAnalyzerRules` | -| `PackProjectReferencedSourceGenerators` | `true` | Packable projects include analyzer `ProjectReference` outputs under `analyzers/dotnet/cs/`. Use `Pack="false"` on one reference to opt that one out | - -Overrides are layered, narrowest first: an explicit `TargetFramework`/`TargetFrameworks` in the project -always wins, then a `PurviewTargetFrameworkSet` in the project, then a set the repository selected, then -a `PurviewTargetFrameworks` redefinition, then the SDK default. Roslyn components are not covered — -they target `netstandard2.0`; selecting a set on one is reported as `PurviewTargetFrameworkSetIgnored`. - -## Style policy - -| Property | Default | Behaviour | -| -- | -- | -- | -| `DisablePurviewStylePolicyValidation` | `false` | Stops the build failing (`PRSGD0006`–`PRSGD0009`) when the repository `.editorconfig` overrides the modifier policy — `dotnet_style_require_accessibility_modifiers` other than `omit_if_default`, hiding `IDE0040`/`IDE1006`, disabling the Style category in bulk, weakening the `_camelCase` private-instance-field rule, or adding the accessibility rules to `NoWarn`. Entries the SDK injects itself are ignored | -| `PurviewTestContextNoWarn` | `CA1002;CA1012;CA1034;CA1047;CA1050;CA1051;CA1062;CA1064;CA1515;CA1707` | The production API-surface rules exempted in test and shared-testing projects. Test projects keep the strict style contract (`IDE0040`, field naming, formatting, `IDE1006`) but are context aware: public test classes, `Method_Scenario_Expectation` names, exposed fields and unvalidated helper parameters are allowed. Set before the SDK import | -| `DisablePurviewTestContextRuleSet` | `false` | Makes test and shared-testing projects enforce the production API-surface rules too | -| `PurviewPolicyExemptNoWarn` | *(derived)* | The SDK-injected `NoWarn` entries `ValidatePurviewStylePolicy` accepts | - -## .NET 11 features and ServerShared - -| Property | Default | Behaviour | -| -- | -- | -- | -| `MemorySafetyRules` | `0` | C# 15 memory-safety tier on `net11.0`+ targets: `0` off (default), `1` preview pointer syntax (sets `LangVersion=preview` when none was chosen), `2` `updated-memory-safety-rules`. Tier `2` is opt-in — the updated rules are an experimental compiler feature. Unknown values fail with `PRCFG0001`. Never touches `AllowUnsafeBlocks` | -| `PurviewRuntimeAsync` | *(unset, treated as false)* | Set to `true` for `runtime-async=on` on `net11.0`+ targets. `UseRuntimeAsync=true` also opts in; an explicit `false` under either name keeps it off | -| `PurviewMultiThreadedBuild` | `true` | Bootstraps a managed `Directory.Build.rsp` with `-mt`/`-nr:false`; `false` writes `-mt:false`. Unset, a Blazor WebAssembly client writes `-mt:false` for the repository, and a client built under `-mt` anyway fails with `PRBLZ0002`; an explicit value always wins | -| `BootstrapMultiThreadedBuildRspToRepoRoot` | `true` | Whether that bootstrapped response file is written at all | -| `IsClientSideProject` | *(computed)* | `true` for a WebAssembly client, `PurviewBrowserSafe` library, Razor class library, or `*.Client`/`*.ClientShared`/`*.Browser`/`*.Wasm`/`*.WebAssembly`/`*.Components` (or `ClientShared`/`Components`) name. Explicit value wins | -| `PurviewAutoServerSharedReference` | `true` | Adds `../ServerShared*/ServerShared*.csproj` to a non-client-side project | -| `PurviewServerSharedReferenceCheckAsError` | `false` | Makes `PRSHR0001`/`PRSHR0002` errors | -| `DisablePurviewServerSharedReferenceCheck` | `false` | Turns `PRSHR0001`/`PRSHR0002` off | - -## Testing - -| Property | Default | Behaviour | -| -- | -- | -- | -| `TestingFramework` | `TUnit` | `TUnit`, `Xunit`, `None` | -| `SubstituteFramework` | `TUnitMocks` | `TUnitMocks`, `NSubstitute`, `None` | -| `TestDataFramework` | `Bogus` | `Bogus`, `None` | -| `CollectCoverage` | `true` for detected test projects | | -| `EnableStaticNativeInstrumentation` | `false` for test projects | | -| `EnableDynamicNativeInstrumentation` | `false` for test projects | | -| `TestingPlatformDotnetTestSupport`, `UseMicrosoftTestingPlatformRunner`, `EnableMicrosoftTestingPlatform` | enabled for TUnit test projects | Microsoft.Testing.Platform wiring | -| `PurviewSharedTestingOutputType` | `Library` | Forced onto `IsSharedTestingProject` projects, with `IsTestProject`/`IsTestingPlatformApplication` cleared, because the test packages otherwise flip them into an executable test host. Set `Exe` (in the project or `Directory.Build.props`) to keep the package-driven shape | - -## Packaging - -| Property | Default | Behaviour | -| -- | -- | -- | -| `IsPackable` | `false` | | -| `PurviewAutoSdkPack` | `true` | Packs `Sdk/**/*` into the package at the right root-level paths | -| `PurviewSkillsSourceFolder` | `/skills` | Where authored skills live | - -Packable-project defaults, applied only when the project supplied nothing: -`GenerateDocumentationFile=true`, `IncludeSymbols=true`, `SymbolPackageFormat=snupkg`, -`PublishRepositoryUrl=true`, `EmbedUntrackedSources=true`, `DebugType=portable`. Portable PDBs ship -in the `.snupkg`; the `.nupkg` gets none unless the project opts in. Roslyn-component-only packages -instead default `IncludeSymbols=false` and ship their PDB inside `analyzers/dotnet/cs/`. - -Unless `PackageReadmeFile` is configured, a README is packed and registered automatically: the project's -own `README.md` (beside its `.csproj`) wins, else the repository-root one. A README-named file already -being packed, such as an `Sdk/README.md`, is used instead. - -Non-packable projects, including web apps, default `WarnOnPackingNonPackableProject=false` so a -solution-wide pack skips them silently. - -`ContinuousIntegrationBuild` is set only by real CI environment variables. Packability alone never -forces SourceLink's CI-mode dirty-repository checks. - -## Telemetry and SourceLink - -| Property | Default | Behaviour | -| -- | -- | -- | -| `ExcludePurviewTelemetry` | `false` | Removes `Purview.Telemetry.SourceGenerator` | -| `ExcludeMSTelemetryExtension` | `false` | Removes `Microsoft.Extensions.Telemetry.Abstractions`. Only relevant when `ExcludePurviewTelemetry` is also `false` — the whole group is skipped otherwise | -| `SourceLinkPackageName` | `Microsoft.SourceLink.GitHub` | The provider package, added with `PrivateAssets=all` to every non-test project. Set it in `Directory.Build.props` to match the host — `Microsoft.SourceLink.AzureRepos.Git` (Azure DevOps Services), `Microsoft.SourceLink.AzureDevOpsServer.Git` (on-premises ADO Server / TFS), `Microsoft.SourceLink.GitLab`, `Microsoft.SourceLink.Bitbucket.Git` | -| `DisableSourceLink` | `false` | `true` stops the SDK adding the package at all. An empty `SourceLinkPackageName` does **not** opt out — the GitHub default fills it | -| `EnableSourceLink` | `true` (set by the provider) | The provider package's own switch; `false` keeps the package but skips the source mapping | - -Both are read only on the package reference the SDK adds, which MSBuild evaluates after the project body, -so a `.csproj` value works too; `Directory.Build.props` keeps every project on one provider. See -[sourcelink.md](sourcelink.md) for the host matrix, Azure DevOps specifics, the CPM `PackageVersion` -requirement and self-hosted hosts. - -## Blazor WebAssembly, browser-safe libraries and BFF hosts - -| Property | Default | Behaviour | -| -- | -- | -- | -| `IsBffProject` | `true` for a web SDK project named `*Bff`, else `false` | Classifies a BFF host. `false` opts a `*Bff` project out; `true` opts another web project in | -| `IsBlazorHostProject` | *(computed)* | `true` for a web SDK project that references a WebAssembly client. Set `false` to opt out. Never implies `IsBffProject` | -| `PurviewAutoBlazorClientReference` | `true` | A host named `` references its `.Client` WebAssembly client automatically. Skipped when the reference is already declared | -| `DisablePurviewBlazorWebAssemblyDefaults` | `false` | Keeps the generic defaults on a WebAssembly client: packable when asked, Dockerfile container detection, the automatic `Shared` reference. Set before the SDK import | -| `PurviewBrowserSafe` | *(unset)* | `true` on a class library applies `IsAotCompatible`, `SupportedPlatform browser` and the browser-safe `WarningsAsErrors`, each only where the project set nothing | -| `PurviewBrowserSafeWarningsAsErrors` | `true` on a `PurviewBrowserSafe` library, otherwise unset | `false` hands the trim and AOT diagnostics back to `TreatWarningsAsErrors` (`true` by default); `CA1416` then falls back to the repository's severity (`suggestion` in the shipped `.editorconfig`) | -| `PurviewBrowserSafeWarningCodes` | `CA1416`, `IL2001`-`IL2128`, `IL3000`-`IL3005`, `IL3050`-`IL3059` | The ids a browser-safe library adds to `WarningsAsErrors` | -| `DisablePurviewBrowserSafeReferenceCheck` | `false` | Turns off `PRBLZ0001`, the check that every project a client (or browser-safe library) references sets `PurviewBrowserSafe` | -| `PurviewBrowserSafeReferenceCheckAsError` | `false` | Reports `PRBLZ0001` as an error | -| `PurviewBffExposesApi` | `true` when the BFF references `Microsoft.AspNetCore.OpenApi`, otherwise unset | Whether a BFF keeps the `Microsoft.AspNetCore.OpenApi.Generated` interceptor namespace | - -`PurviewBrowserSafe="true"` is also accepted as `ProjectReference` metadata, recording that a -reference was judged browser-safe when it cannot say so itself. - -## Version detection - -| Property | Default | Behaviour | -| -- | -- | -- | -| `UsePackageJsonVersion` | `true` | `true`, `false`, `Strict` | -| `RootPackageJson` | *(discovered)* | Explicit path to the `package.json` to read. A relative path resolves from the project directory; in `Directory.Build.props` use `$(MSBuildThisFileDirectory)package.json` | -| `EnableVersionDetectionCache` | `true` | | -| `VersionDetectionCacheFile` | *(derived)* | | -| `VersionDetectionLogEnabled` | `false` | Logs the detected version | - -## Repository bootstrap - -| Property | Default | Behaviour | -| -- | -- | -- | -| `DisableAutoCopySdkFiles` | `false` | Master switch for SDK-managed repository file writes | -| `PurviewRepoBootstrapMode` | `IfMissing` | Also `Always`, `WarnOnDrift`, `Never` | -| `BootstrapEditorConfigToRepoRoot` | `true` | | -| `RepositoryEditorConfigFilePath` | *(derived)* | Overrides the destination `.editorconfig` | -| `BootstrapGlobalJsonToRepoRoot` | `true` | | -| `RepositoryGlobalJsonFilePath` | *(derived)* | Overrides the destination `global.json` | -| `BootstrapMultiThreadedBuildRspToRepoRoot` | `true` | Creates a managed `Directory.Build.rsp` enabling `-mt` | -| `RepositoryDirectoryBuildRspFilePath` | *(derived)* | Overrides the destination `Directory.Build.rsp` | -| `PurviewMultiThreadedBuild` | `true` | `false` rewrites a managed rsp to `-mt:false`; unset, a WebAssembly client writes `-mt:false` | -| `PurviewBuildSdkVersionForGlobalJson` | restored package version, else the version it was packed as | | -| `PurviewRepoBootstrapCopyRetries` | `3` | | -| `PurviewRepoBootstrapCopyRetryDelayMilliseconds` | `500` | | -| `PurviewRepoBootstrapCopyFailureAsError` | `true` | `false` downgrades a persistent write failure to a warning | -| `PurviewSuppressCopyRetryWarnings` | `true` | Demotes the built-in copy task's `MSB3026` retry notice to a message | -| `PurviewRepositoryRootMarkers` | `.git/;.github/;.gitattributes;LICENSE.md;AGENTS.md;.agents/;CLAUDE.md;.claude/;package.json` | Ordered markers identifying a repository root, most authoritative first | - -There is no agent-folder mirror. `EnableAgentFolderInPackage`, `AgentPackDestinationFolder`, -`PurviewAgentFolderSourcePath`, `PurviewAgentFolderCopy*`, `PurviewAgentSyncManifestPath` and -`DisableMirroredFileTrackingCheck` were removed: skills are installed by the skills CLI, and -nothing else was left for the mirror to deliver. - -## Skills - -Covered in full by `purview-buildsdk-skill-installation`: `PurviewSkillsRunner`, -`PurviewSkillsRunnerCandidates`, `PurviewSkillsCommand`, `PurviewSkillsPackage`, -`PurviewSkillsAgents`, `PurviewSkillsSource`, `PurviewSkillsInstallRoot`, `PurviewSkillsRepoRoot`, -`PurviewSkillsDryRun`, and the `PurviewSkillsAgentDirectory` item group. - -## Compiler-visible properties - -The SDK lists these as `CompilerVisibleProperty` items, so Roslyn analyzers and source generators read -them as `build_property.`: - -```csharp -context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.IsBffProject", out var isBff); -``` - -Read the exported property rather than re-deriving SDK behaviour — it is the SDK's own answer and stays -correct when the rules change. To make a new property visible, add a `CompilerVisibleProperty` item -(with a ``) in `Sdk.props`; nothing else exposes an MSBuild property to the compiler. - -Among the exported properties (the full list, with descriptions, is the *Compiler-visible SDK properties* -table in the [Configuration Reference](https://github.com/purview-dev/build-sdk/blob/main/docs/wiki/Configuration-Reference.md#compiler-visible-sdk-properties)): - -- `UsePackageJsonVersion`, `RootPackageJson`, `RepoRoot`, `Version`, `PackageVersion` -- `NamespacePrefix`, `DisableNamespacePrefixCheck` -- `TestingFramework`, `SubstituteFramework`, `TestDataFramework` -- `ExcludePurviewTelemetry`, `ExcludeMSTelemetryExtension` -- `EnableAssemblyNameGeneration`, `DisableAutoInternalsVisibleTo`, `DisableGenerateAssemblyInfoClass`, - `DisableGenerateAssemblyIdentifierClass`, `AssemblyIdentifierClassName` -- `IsCSharpProject`, `IsTestProject`, `IsSharedTestingProject`, `IsSharedProject`, - `IsServerSharedProject`, `IsClientSideProject` -- `PurviewAutoServerSharedReference`, `DisablePurviewServerSharedReferenceCheck`, - `PurviewServerSharedReferenceCheckAsError` -- `MemorySafetyRules`, `PurviewRuntimeAsync`, `PurviewMultiThreadedBuild` -- `TestingType`, `TargetProjectName` -- `IsContainerProject`, `IsSdkProject`, `SdkProjectName`, `IsWebProject`, `IsWebSdkProject`, - `IsWorkerSdkProject`, `IsAspireHostProject`, `IsCLIProject` -- `IsBlazorWebAssemblyProject`, `IsRazorClassLibraryProject`, `IsBlazorHostProject`, `IsBffProject` -- `PurviewBrowserSafe`, `PurviewBrowserSafeWarningsAsErrors`, `DisablePurviewBrowserSafeReferenceCheck`, - `PurviewBrowserSafeReferenceCheckAsError`, `DisablePurviewBlazorWebAssemblyDefaults`, - `PurviewAutoBlazorClientReference`, `PurviewBffExposesApi` -- `EditorConfigFilePath`, `RepositoryEditorConfigFilePath`, `BootstrapEditorConfigToRepoRoot` -- `RepositoryGlobalJsonFilePath`, `BootstrapGlobalJsonToRepoRoot`, `DisableAutoCopySdkFiles` -- `PurviewRepoBootstrapMode`, `PurviewRepoBootstrapCopyRetries`, - `PurviewRepoBootstrapCopyRetryDelayMilliseconds`, `PurviewRepoBootstrapCopyFailureAsError` -- `PurviewSuppressCopyRetryWarnings` -- `PurviewSkillsSourceFolder`, - `PurviewSkillsAgents`, `PurviewSkillsInstallRoot`, `PurviewRepositoryRootMarkers`, - `PurviewSkillsRunner`, `PurviewSkillsDryRun` -- `PurviewBuildSdkVersionForGlobalJson`, `CurrentYear`, `AutoGeneratedAssemblyInfoFile`, - `AutoGeneratedAssemblyIdentifierFile` diff --git a/.agents/skills/purview-buildsdk-configuration/references/sourcelink.md b/.agents/skills/purview-buildsdk-configuration/references/sourcelink.md deleted file mode 100644 index aafa6231..00000000 --- a/.agents/skills/purview-buildsdk-configuration/references/sourcelink.md +++ /dev/null @@ -1,80 +0,0 @@ -# SourceLink - -Every non-test project gets a SourceLink **provider** package, added with `PrivateAssets="all"`, so a -debugger can step into a consumed package's source and the packed `.nuspec` records the repository URL -and the exact commit (`PublishRepositoryUrl=true`). Test and shared-testing projects are excluded, -because their symbols are never published. - -## Property reference - -| Property | Default | Behaviour | -| -- | -- | -- | -| `SourceLinkPackageName` | `Microsoft.SourceLink.GitHub` | The provider package | -| `DisableSourceLink` | `false` | `true` stops the package being added at all | -| `EnableSourceLink` | `true` (set by the provider) | The provider package's own switch; `false` keeps the package but skips the source mapping | - -Set `SourceLinkPackageName` and `DisableSourceLink` in `Directory.Build.props`, so every project agrees. -A `.csproj` value also works: the SDK reads both only on the package reference it adds, and MSBuild -evaluates that after the project body. `EnableSourceLink` belongs to the provider package. An **empty** -`SourceLinkPackageName` does not disable SourceLink: the SDK fills it with the GitHub default. - -## Choosing a provider for the host - -| Host | `SourceLinkPackageName` | Extra configuration | -| -- | -- | -- | -| GitHub / GitHub Enterprise | `Microsoft.SourceLink.GitHub` *(default)* | none | -| Azure DevOps Services / Azure Repos (`dev.azure.com`, `*.visualstudio.com`) | `Microsoft.SourceLink.AzureRepos.Git` | none | -| Azure DevOps Server / TFS (on-premises) | `Microsoft.SourceLink.AzureDevOpsServer.Git` | a `SourceLinkAzureDevOpsServerGitHost` item | -| GitLab (12.0+) | `Microsoft.SourceLink.GitLab` | older GitLab: `SourceLinkGitLabHost` + `Version` | -| Bitbucket Cloud | `Microsoft.SourceLink.Bitbucket.Git` | Bitbucket Server / DC < 4.7: `SourceLinkBitbucketGitHost` + `Version` | -| anything else / self-hosted | *(none built in)* | a third-party or hand-rolled provider, or opt out | - -```xml - - - Microsoft.SourceLink.AzureRepos.Git - -``` - -### Azure DevOps - -- **Azure DevOps Services** — `Microsoft.SourceLink.AzureRepos.Git`, and nothing else. The provider - reads the `origin` remote and derives the content URLs itself. -- **Azure DevOps Server / TFS (on-premises)** — `Microsoft.SourceLink.AzureDevOpsServer.Git` plus the - host, because the virtual directory cannot be inferred from the repository URL: - - ```xml - - - - ``` - - `Include` is the domain, optionally with a port (`tfs.example.com:8080`). A path - (`tfs.example.com/tfs`) fails the provider's own validation ("not a valid domain name"), so the - virtual directory is a separate attribute. -- Azure Pipelines sets `TF_BUILD`, so `ContinuousIntegrationBuild` is on there with no configuration. - -## Central Package Management - -CPM is on, so the chosen provider needs a `PackageVersion` in `Directory.Packages.props`. The shipped -`templates/Directory.Packages.props` declares `Microsoft.SourceLink.GitHub`, -`Microsoft.SourceLink.AzureRepos.Git` and `Microsoft.SourceLink.GitLab` at `$(SourceLinkVersion)`. A -provider that is selected but not declared fails the restore with `NU1010`. - -## Continuous integration - -`ContinuousIntegrationBuild` is set to `true` only when `CI`, `GITHUB_ACTIONS` or `TF_BUILD` is `true` -(`TF_BUILD` is Azure Pipelines). A local build is deliberately **not** treated as CI, because -SourceLink's CI-mode dirty-repository checks would otherwise fail a local `TreatWarningsAsErrors` build. - -## Opting out, and self-hosted hosts - -`DisableSourceLink=true` stops the SDK adding the package. For a host with no -official provider, bring a source-control package (`Microsoft.Build.Tasks.Git`) and a provider package -in yourself and set `DisableSourceLink=true`, so the GitHub default is not added alongside them. - -## Why it matters beyond debugging - -`PublishRepositoryUrl=true` writes `` into the `.nuspec`, so anyone -holding the package can find the exact commit it was built from — the commit to pin, for example, when -installing that repository's skills with `bun x skills add owner/repo#`. diff --git a/.agents/skills/purview-buildsdk-docs-sync/SKILL.md b/.agents/skills/purview-buildsdk-docs-sync/SKILL.md deleted file mode 100644 index 9661abc6..00000000 --- a/.agents/skills/purview-buildsdk-docs-sync/SKILL.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -name: purview-buildsdk-docs-sync -description: Bring a Purview.BuildSdk repository's written surfaces back in line with its code - the authored skills (skills/*/SKILL.md and references/), the agent instructions (AGENTS.md, CLAUDE.md, .github/copilot-instructions.md), the READMEs (repository root, each project's README.md, a project's Sdk/README.md, which is what its package ships) and the docs/wiki/ pages - and keep the wiki hierarchical, one topic folder per area, with _Sidebar.md and Home.md in step. Use after a feature, property, recipe, diagnostic or project is added, renamed or removed; when docs or skills may have drifted from the code; when reorganising or adding wiki pages; or when asked to audit or "sync the docs". Every statement is checked against the code, never against another document. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Keeping skills, agent instructions, READMEs and the wiki true - -A repository describes itself in four places, read by different people: - -| Surface | Read by | Lives in | -| -- | -- | -- | -| Authored skills | agents in *other* repositories, after `npx skills add` | `skills//SKILL.md`, `skills//references/*.md` | -| Agent instructions | agents working *in* this repository | `AGENTS.md`; `CLAUDE.md` and `.github/copilot-instructions.md` are thin wrappers that point at it | -| READMEs | GitHub visitors, and NuGet users of each package | the repository root, each project folder, a project's `Sdk/` folder | -| Wiki | readers of the documentation site | `docs/wiki/` | - -They drift independently, and nothing fails when they do: the reader simply follows a document that -describes last release's code. **The code is the only source of truth.** Never correct one document -from another — two documents agreeing proves nothing if both are stale. - -## The one rule - -**Every claim is checked against the code before it is kept, written or changed.** A claim is -anything a reader could act on: a property name and its default, a recipe, a command, a diagnostic -id, a file path, a package id, a target framework, a default behaviour, a version. Look each one up: -read the `.props`/`.targets`, the `Justfile` and its modules, the analyzer's descriptor, the -`.csproj`, the test that pins the behaviour. A claim you cannot find in the code is **removed or -marked as a question for the user** — never kept on trust, never guessed. - -How to check each kind of claim: [references/truth-audit.md](references/truth-audit.md). - -## Which README is which - -What a package ships as its README decides which file a NuGet user reads, so work it out from the -build, not from the file names. With Purview.BuildSdk, for a packable project with no explicit -`PackageReadmeFile`: - -1. the project's own `README.md`, beside its `.csproj`, wins; -2. otherwise the repository-root `README.md` is packed; -3. a file under the project's `Sdk/` folder named `*.md` is packed to the package root by - `PurviewAutoSdkPack`, so `Sdk/README.md` *is* the package README when the project packs `Sdk/`. - -So in a repository with several packages, each package's README is the per-project one, and the root -`README.md` describes the repository as a whole. A project README covers only what that package -does, how to install it and its own settings; it links to the wiki for the rest rather than copying -it. Check which file each project actually packs (`dotnet pack`, then list the `.nupkg`) before -editing one, and say in the root README which per-project READMEs exist. - -## The wiki is hierarchical - -`docs/wiki/` is one folder per topic area, plus a few root pages. Two index files tie it together: - -- `_Sidebar.md` — every page exactly once, grouped into sections (`- **Section**`), in reading order. - The documentation site reads its links in document order for page order, and does not publish it. -- `Home.md` — the browsing index: a short intro, a "How this wiki is organised" table, then one - `## Section` heading per sidebar section, each with a `| Page | What it answers |` table. - -The rules, the published-URL consequences, and the test that enforces them: -[references/wiki-structure.md](references/wiki-structure.md). The short form: - -- a page lives at the wiki root **only** when the site depends on its URL: the landing page - (`docs.rootPage`) and any page the site's project catalogue deep-links (`docsPage`). Everything else - is in exactly one topic folder, never deeper; -- folder and page names are letters, digits and single dashes (`configuration/Property-Schema.md`); -- each page opens with exactly one `# ` title, then a one-paragraph description of what it answers; -- links are relative to the file they are written in (`../packaging/SourceLink.md` from a folder page); -- moving a page changes its published URL — record the old and new slugs so the site can redirect. - -## The sweep - -Run it as a sweep, not an edit: a change that lands in one surface and stops there is exactly the -drift this skill exists to prevent. - -1. **Inventory the change.** From the diff (or, for an audit, the code): what was added, renamed, - re-defaulted or removed — properties, targets, recipes, diagnostics, projects, packages, skills, - files. Each item is a row in the sweep. -2. **Find every mention.** For each item, search all four surfaces, including old names: - `git grep -n -e OldName -e NewName -- '*.md'`. Also search `CHANGELOG.md`, but never rewrite - released entries — they are history. -3. **Correct each mention against the code** (the one rule). Prefer deleting a duplicated explanation - and linking to its one home over keeping two copies in step. -4. **Skills** - - Update the `description` so the skill *fires* on the new question, and keep it under 1024 - characters. - - Keep `SKILL.md` under 500 lines, with detail in `references/`. - - A skill describes what a **consumer** does. Guidance about working in this repository belongs in - `AGENTS.md`, or in a repository-local skill under `.agents/skills/`, which is not published. - - A new skill is named `--`, and its folder name matches its `name`. -5. **Agent instructions.** - - `AGENTS.md` carries the skill table (one row per authored skill, linking its authored path - `./skills//SKILL.md`, never `.agents/skills/`), the repository map, the canonical commands - and the invariants a contributor must not break. - - The wrappers stay one-line pointers to it. -6. **READMEs.** - - The root README covers what the repository ships, the quick start, the feature summary and where - the docs are. - - Each per-project README covers its own package. - - Long reference tables belong in the wiki. Keep only those the tests hold the README to. -7. **Wiki.** - - Update the page that owns the topic. - - A new page goes in its topic's folder and gets added to `_Sidebar.md` (once, in reading order) - and to that section's table in `Home.md`. - - A new topic area gets a folder, a sidebar section and a `Home.md` heading, all with the same - name. -8. **Changelog.** Add one entry per user-visible change: `### Documentation` for a docs-only fix, - naming what was wrong. It goes under the heading for the version in `package.json` - (`## [x.y.z] - `, created when a bump moves the version), **not** under `[Unreleased]`. A - merge to `main` publishes that version, so an entry parked under `[Unreleased]` reads as unreleased - until it is already live, and the changelog is out of date the moment it ships. `[Unreleased]` is - only for a pre-release version (`x.y.z-alpha.1`, `-beta`, `-rc`), whose changes genuinely have not - shipped as a release yet. -9. **Verify** (below), and state the commands you ran. - -## Verify - -Each check proves something different, so run all that the repository has: - -```bash -git grep -n -e '' -- '*.md' # nothing stale left -just skills-validate # PRSKL0005: every skill well formed, every references/ link resolves -just test # the repository's doc tests: wiki structure, skill rules, property tables -``` - -- **The wiki test:** if the repository has none, add one (see - [references/wiki-structure.md](references/wiki-structure.md#the-test)). Without it, every rule - above is a convention nobody checks. -- **Links outside the wiki:** for every link a README or skill makes into `docs/wiki/`, open the - target and confirm the page and the `#anchor` exist. -- **Skill references:** follow each relative link once. - -## Guardrails - -- **Do not change behaviour to match a document.** When the code and the docs disagree, the docs are - wrong — unless the user says the code is. Report a disagreement that looks like a code bug rather - than documenting the bug as intended. -- **Do not invent.** No undocumented defaults, no example output you did not run, no version numbers - from memory. -- **Do not move a root page** the site deep-links without telling the user. It breaks inbound links - outside this repository. -- **Do not rewrite released changelog entries,** and do not touch generated files. -- Keep the sweep to documentation: a refactor found along the way is a separate change. diff --git a/.agents/skills/purview-buildsdk-docs-sync/references/truth-audit.md b/.agents/skills/purview-buildsdk-docs-sync/references/truth-audit.md deleted file mode 100644 index 3da13b74..00000000 --- a/.agents/skills/purview-buildsdk-docs-sync/references/truth-audit.md +++ /dev/null @@ -1,41 +0,0 @@ -# Checking a claim against the code - -For each kind of statement a document makes, where the truth lives and how to look it up. Search with -`git grep -n`, which only reads tracked files, and read the definition itself rather than a comment -that describes it. - -| Claim | The truth | How to check | -| -- | -- | -- | -| An MSBuild property exists, and its default | the `.props`/`.targets` that define it (`Sdk/Props/*.props`, `Sdk/Sdk.props`, `Sdk/Sdk.targets`, `Sdk/Targets/*.targets`), and the `.buildschema.json` sidecar | `git grep -n ' -getProperty:Name` | -| A property must be set before the import | whether `Sdk.props`, or a file it imports, *reads* it | a read in a value or `Condition` in `Sdk.props`'s import graph, other than its own `== ''` guard, makes it pre-import | -| An analyzer reads `build_property.X` | a `CompilerVisibleProperty Include="X"` item, and the analyzer source | `git grep -n 'CompilerVisibleProperty' -- '*.props'` and `git grep -n 'build_property.X'` | -| A diagnostic id, its severity and its meaning | the `DiagnosticDescriptor` (analyzers) or the `Code="..."` on an MSBuild `Error`/`Warning`/`Message` (targets) | `git grep -n 'PRSKL0012'`. The severity is the descriptor's default or the task's `Importance`, not the docs table | -| A target exists and what it runs | the ``, its `DependsOnTargets`, `BeforeTargets`/`AfterTargets` | read the target; "never runs during a build" means it has no hook *and* nothing hooks it | -| A `just` recipe and what it does | the `Justfile` and every file it imports | `just --list` for names, `just --dry-run ` for the exact command — never read a recipe name off another document | -| A command line works | running it | run it, or `--dry-run`/`-p:...DryRun=true` when it changes things; do not quote output you did not see | -| A file or folder path | the file system | `git ls-files `, which also proves it is tracked rather than generated | -| A package id, and what it contains | the `.csproj` (`PackageId`, `IsPackable`) and the packed `.nupkg` | `dotnet pack`, then list the archive; pack validation config (for example `.config/purview-build.json` `RequiredContent`) lists the expected files | -| A target framework or framework set | the `.props` defining the sets, and the project's evaluated value | `dotnet msbuild -getProperty:TargetFrameworks` | -| A version | `package.json` `version`, `global.json` `msbuild-sdks`, `Directory.Packages.props` | read the file. A quick-start snippet's pin is checked by the repository's version-sync check, if there is one | -| A skill exists, and what it answers | `skills//SKILL.md` frontmatter | `name` and `description`; a skill listed in `AGENTS.md` must exist, and every authored skill must be listed | -| "Tested by X" | the test | `git grep -n 'X'` under the test folder, and read the test: does it assert what the document says it does? | -| Behaviour ("the SDK does Y when Z") | the code path, and ideally the test that pins it | find both. If no test pins it, say so in your report rather than strengthening the claim | - -## Reading a document for claims - -Go through a page section by section and list every checkable statement before changing anything. -For each, record **kept** (found, matches), **fixed** (found, differs — the code wins), **removed** -(not found anywhere) or **question** (found but ambiguous, or the code looks wrong). Report the -removed and question rows to the user: a removed claim may describe something that should exist. - -## Things that look true and are not - -- **A comment in a `.props` file** describing a default the next line no longer sets. -- **The same table in two places,** both stale. Fix both from the code, then delete one and link to - the other where the tests allow it. -- **A recipe name in a doc** from before the `Justfile` was split into modules: check - `just --list`, not memory. -- **An example `global.json` or package version** — usually a pin the version-sync check owns; leave - the number to it. -- **"Removed" features** still described in a page nobody re-read when they went. Search for the - feature's property names as well as its title. diff --git a/.agents/skills/purview-buildsdk-docs-sync/references/wiki-structure.md b/.agents/skills/purview-buildsdk-docs-sync/references/wiki-structure.md deleted file mode 100644 index a4b7c534..00000000 --- a/.agents/skills/purview-buildsdk-docs-sync/references/wiki-structure.md +++ /dev/null @@ -1,109 +0,0 @@ -# The wiki structure - -`docs/wiki/` is the source for the project's pages on the documentation site. The site's sync reads -the folder, publishes each page at a URL derived from its path, and rewrites relative `.md` links into -site routes. That makes the folder tree part of the published interface, not just filing. - -## Layout - -```text -docs/wiki/ - _Sidebar.md page order and sections (not published) - Home.md the browsing index (not published) - Getting-Started.md the landing page (docs.rootPage) - .md any page the site catalogue deep-links (docsPage) - / - .md - / - ... -``` - -- **Root pages need a site contract.** Only the landing page and the pages the site's project - catalogue deep-links through `docsPage` stay at the root. A deep link is a single path segment, so - such a page cannot live in a folder unless the catalogue entry moves with it. Find the contract in - the site's catalogue entry for the project (`docs.rootPage`, every `useCases[].docsPage`). -- **One level of folders.** A page is at the root or in exactly one topic folder. A topic folder is - named for the area (`configuration/`, `packaging/`), lower case, and holds at least two pages unless - the area is clearly going to grow. Do not name a folder `build/` — the standard .NET `.gitignore` - ignores `[Bb]uild/`. -- **URL-safe names.** Folder and page names are letters, digits and single dashes. The path becomes - the slug, lower-cased: `packaging/SourceLink.md` → `/docs//packaging/sourcelink/`. -- **One title.** Each page opens with exactly one `# ` heading — the title the site shows — and a - one-paragraph description of what the page answers. Section headings are `##` and below. -- **Relative links, from the file they are in.** From `configuration/Property-Schema.md`, the reference - page is `../Configuration-Reference.md` and a sibling is `Version-Detection.md`. A link that climbs - out of `docs/wiki/` (`../../README.md`) is a repository path; the site rewrites it to a GitHub URL. - -## `_Sidebar.md` - -```markdown - - -- [Home](Home.md) -- **Get started** - - [Getting Started](Getting-Started.md) - - [Engineering Principles](concepts/Engineering-Principles.md) -- **Configuration** - - [Configuration Reference](Configuration-Reference.md) - - [Property Schema](configuration/Property-Schema.md) -``` - -Every page appears exactly once, with its path from `docs/wiki/`. A page missing here is published -with no place in the sidebar. A page listed twice has two competing positions. - -## `Home.md` - -```markdown -# Wiki - - - -## How this wiki is organised - -| Section | Where it lives | -| -- | -- | -| Get started | the wiki root and `concepts/` | -| Configuration | `Configuration-Reference.md` and `configuration/` | - -## Get started - -| Page | What it answers | -| -- | -- | -| [Getting Started](Getting-Started.md) | Installing the SDK and building a first project. | -``` - -The `## ` headings are the sidebar's section labels, word for word, in the same order. Every page is -linked from at least one section table. Feature highlights and requirements may follow the sections. - -## Moving or renaming a page - -The published URL changes, and inbound links — from other repositories, from search results, -from bookmarks — break. So: - -1. Move it with `git mv`, so history follows the file. -2. Fix every inbound link: other wiki pages (relative to *their* folder), `_Sidebar.md`, `Home.md`, the - READMEs, `AGENTS.md`, the skills, and any test that names the path. -3. Record `old-slug: new/slug` pairs (lower-cased, no `.md`) and ask the user to add them to the site - catalogue's `docs.redirects`, which keeps the old URL working. Editing the site's repository is - outside this repository — do not do it unasked. - -## The test - -A repository with a wiki should hold it to these rules in its test suite, reading files only, with -no network: - -| Assertion | Catches | -| -- | -- | -| the wiki folder resolves to this repository (`_Sidebar.md`, `Home.md` and the landing page exist) | every other assertion passing vacuously | -| every page is at the root or one folder deep, and the folders are exactly the expected set | accidental nesting, a stray new topic | -| root pages are exactly the site-contract pages | a page left at the root, or a deep-linked page moved | -| every folder and page name is URL-safe | a slug the sync would rewrite | -| `_Sidebar.md` lists every page exactly once | an unpublished or doubly-ordered page | -| `Home.md` links every page | a page no reader can browse to | -| every sidebar section has a matching `## ` in `Home.md` | the two indexes disagreeing | -| every relative `.md` link in the wiki resolves | a page moved without its inbound links | -| every page opens with exactly one `# ` title (code fences and inline code ignored) | untitled or doubly-titled pages | - -Strip fenced code blocks and inline code before reading headings or links. A quoted `# comment` in a -shell example is not a title. diff --git a/.agents/skills/purview-buildsdk-justfile/SKILL.md b/.agents/skills/purview-buildsdk-justfile/SKILL.md deleted file mode 100644 index 0ac76c2a..00000000 --- a/.agents/skills/purview-buildsdk-justfile/SKILL.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -name: purview-buildsdk-justfile -description: Set up or update the Justfile of a repository that uses Purview.BuildSdk - a root Justfile that imports one barrel, .build/just/index.just, over shared modules for .NET (restore, build, test, pack, ensure-tools), version display and `just bump major|minor|patch`, local Purview.Build pipeline runs (pipeline-pr, pipeline-local-release), the agent-skill targets (skills-add, skills-install, skills-update, skills-check, skills-fix), lint-check/lint-fix, vs, scrub, an optional pm-docs-site Docs group, and exported telemetry opt-outs and .NET CLI speed-ups. Use when adding a Justfile, splitting or de-duplicating one, adding a just recipe, bumping the version from just, replacing hand-written skill scripts (update-agent-skills.ts, package.json skills:* scripts) with the SDK targets, or when a recipe runs the wrong project, runner or agents. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# The Justfile - -A repository's recipes are mostly the same everywhere: restore, build, test, pack, lint, the -pipeline, the skill targets. Written into each `Justfile` by hand they drift, and every repository -fixes the same quoting bug separately. So the shared recipes are **modules**, copied verbatim from -this skill's [`assets/just/`](assets/just/index.just) into the repository, and the root `Justfile` -holds only what is specific to that repository. - -```text -Justfile settings, one import, the repository's variables and own recipes -.build/just/ - index.just the barrel: imports every module, optional ones with import? - env.just exported telemetry opt-outs and .NET CLI speed-ups - version.just version, bump - bump-version.ts what `just bump` runs (Bun) - dotnet.just ensure-tools, restore, build, clean, test, pack - utilities.just lint-check, lint-fix, vs, scrub - purview-build.just pipeline-pr, pipeline-build, pipeline-tests - skills.just skills-add, -install, -update, -check, -fix - purview-build-nuget.just optional: pipeline-pack-validate, pipeline-local-release, pipeline-release - docs.just optional: docs, docs-install, docs-check -``` - -`.build/` is not matched by the stock `.gitignore` templates — `[Bb]uild/` does not match a leading -dot — but confirm it with `git check-ignore -v .build/just/index.just` (no output, exit 1, means -tracked). If a rule matches, add `!/.build/` after it. - -## The root Justfile - -```just -# Recipes for . Run `just` for the list. -# -# The shared recipes come from .build/just/, copied verbatim from the purview-buildsdk-justfile -# skill. Change them there, not here; this file holds what belongs to this repository. - -set quiet - -# Let a definition here override a module's default variable or no-op hook. -set allow-duplicate-variables -set allow-duplicate-recipes - -import ".build/just/index.just" - -solution_file := "src/Acme.slnx" - -[private] -default: - just --list -``` - -**Import the barrel and nothing else.** Adding or removing a module never touches the root file. - -Both `allow-duplicate-*` settings are required. Every module gives its variables a default, and a -definition in the root `Justfile` replaces it — regardless of where it sits relative to the import. -Without the settings, a duplicate is an error. - -## Variables the modules read - -Override only what differs from the default. `solution_file` is the one nearly every repository sets. - -| Variable | Module | Default | Notes | -| -- | -- | -- | -- | -| `solution_file` | `dotnet.just` | `.` | the `.slnx`/`.sln` every recipe builds; `.` lets dotnet find the only one in the root | -| `build_configuration` | `dotnet.just` | `Debug` | | -| `artifacts_folder` | `dotnet.just` | `./artifacts` | `pack` output; `scrub` deletes it | -| `test_filter` | `dotnet.just` | `/*/*/*/*/` | MTP tree-node filter, `just test` with no argument | -| `version_file` | `version.just` | `package.json` | read by just itself, no Bun needed | -| `current_version` | `version.just` | from `version_file` | shown by `build`, `pack`, `version` | -| `csharpier` | `utilities.just` | `dotnet csharpier` | | -| `pipeline_tool` | `purview-build.just` | `dotnet purview-build` | | -| `skills_project` | `skills.just` | `solution_file` | always the solution — see [the skill recipes](references/skills-recipes.md) | -| `docs_site` | `docs.just` | `src/docs-site` | pm-docs-site's `SITE_ROOT` | - -To find `solution_file`: an existing `Justfile` variable or the path its `build`/`test` recipes use; -otherwise the only `*.slnx`/`*.sln` outside `bin/`, `obj/`, `node_modules/` and `artifacts/`; with -several, the one CI builds. Ask only if that still leaves more than one. - -## Hooks - -`_after-bump` runs after a successful `just bump` and does nothing by default. A repository that -pins its version anywhere else — docs, templates — overrides it in the root `Justfile`: - -```just -_after-bump: version-sync -``` - -## Optional modules - -The barrel imports these with `import?`, so **the file's presence is the switch**: copy it into -`.build/just/` to turn it on, delete it to turn it off. Never edit `index.just` for this. - -- **`purview-build-nuget.just`** — copy it when the repository packs NuGet packages: any project is - packable, or `.config/purview-build.json` has a `PackValidation` section. Pack validation reads - `PackValidation.RequiredContent`, which lists every file each package must contain. A packed file - that it does not list fails the run (`contains undeclared content ... not defined in - RequiredContent`), so a new file under a package's `Sdk/`, `build/` or `buildTransitive/` needs an - entry there as well. -- **`docs.just`** — copy it when the repository has a pm-docs-site project site: a `pm-docs-site.json` - somewhere, usually `src/docs-site/`. Set `docs_site` to that folder when it is not `src/docs-site`. - This module **is** the `Docs` group pm-docs-site's spec asks for, so do not add a second one to the - root `Justfile`. - -## The environment - -`env.just` exports, to every process a recipe starts: - -- **Telemetry opt-outs**: the .NET CLI, MSBuild, Aspire, the Azure SDKs and Azure MCP, PowerShell, - Git Credential Manager, Next.js, Astro, Yarn, Claude Code, plus `DO_NOT_TRACK`. -- **.NET CLI speed and noise**: `DOTNET_CLI_ENABLEAOT` (the .NET 11 NativeAOT CLI host) and - `DOTNET_NOLOGO`. - -The MSBuild server (`DOTNET_CLI_USE_MSBUILD_SERVER`) is deliberately **not** forced on. One shared, -long-lived MSBuild process keeps the NuGet SDK resolver's settings from the first build. A later build -under a different `nuget.config` then resolves with the wrong sources and fallback folders, and fails -with `MSB4242`. Purview.BuildSdk's own package-consumption tests do exactly that, and fail. Leave it to -the SDK default unless every build on the machine shares one NuGet configuration. - -Each is `env(NAME, default)`, so a value already in the environment — a developer who opted back in, a -CI job — wins. Multithreaded MSBuild (`-mt`) is not set here: Purview.BuildSdk bootstraps it into -`Directory.Build.rsp`, which a plain `dotnet build` and an IDE also read. - -## Version - -`just version` prints the version from `package.json`. `just bump major|minor|patch` increments that -part and resets the parts after it — `2.0.1` → `3.0.0` / `2.1.0` / `2.0.2` — dropping any -pre-release suffix. It rewrites only the `"version"` value, so the file keeps its formatting. -`just bump patch --dry-run` prints the result and writes nothing. Any other part is rejected before -anything runs. It needs Bun. - -## Adopting it, or migrating an existing Justfile - -1. **Read the whole existing `Justfile`**, any `*.just` it imports, CI workflows, and hook config - (`.config/lefthook.yml`, `lefthook.yml`, `.husky/`). Write down every recipe name something outside - the `Justfile` calls. -2. **Copy the modules** from [`assets/just/`](assets/just/index.just) into `.build/just/`, byte for - byte, plus the optional ones that apply. Do not edit them in place. -3. **Write the root `Justfile`** as above, with the variables the repository needs. -4. **Delete every recipe a module now provides.** A copy in the root silently *replaces* the module's - recipe (that is what `allow-duplicate-recipes` does), so a leftover duplicate is not harmless: it - keeps the old behaviour and hides the fix. Keep a root recipe only when it does something - different on purpose, and comment why. -5. **Keep what is the repository's own**: recipes that run its own scripts, apps or migrations. Put - them in the root `Justfile` under their own `[group(...)]`. -6. **Map renamed recipes** and update every caller found in step 1: - - | Old | Now | - | -- | -- | - | `ensure-pipeline-tool`, `restore-tools` | `ensure-tools` | - | `current_version` (recipe) | `version` | - | `import "Justfile.skills.just"` | `skills.just`, through the barrel — delete the old file | - | a hand-written `Docs` group | `docs.just` | - -7. **Do not add `set shell` or `set windows-shell`.** The modules are written for just's default `sh` - — Git Bash on Windows — so they run unchanged on every OS. - -## Changing a module - -Change it here, in the skill's `assets/just/`, then copy the file into each repository. A repository -that edits its copy drifts from every other, and the next copy overwrites the edit. If one repository -needs different behaviour, override the recipe or variable in its root `Justfile`. - -Recipe comments: just shows a recipe's **last** comment line in `just --list`. A recipe with a -multi-line comment carries `[doc('...')]` with its one-line summary. - -## Verify - -```bash -git check-ignore -v .build/just/index.just # no output: tracked -just --list # every group, one-line descriptions -just --dry-run build # the solution path is the right one -just bump patch --dry-run # prints the next version, writes nothing -just skills-update -p:PurviewSkillsDryRun=true -``` - -For the skill recipes in detail, replacing hand-written skill scripts, and the runner and agent -settings, see [references/skills-recipes.md](references/skills-recipes.md). diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/bump-version.ts b/.agents/skills/purview-buildsdk-justfile/assets/just/bump-version.ts deleted file mode 100644 index 8cb38ffb..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/bump-version.ts +++ /dev/null @@ -1,62 +0,0 @@ -// Bumps one part of the semantic version in package.json, for `just bump `. -// -// The parts after the one bumped are reset to 0, and a pre-release or build suffix is dropped: -// -// 2.0.1 major -> 3.0.0 minor -> 2.1.0 patch -> 2.0.2 -// 2.1.0-rc.1 patch -> 2.1.1 -// -// Only the "version" value is rewritten, in place, so the file keeps its own indentation, key order -// and line endings - re-serialising the JSON would reformat it. -// -// bun bump-version.ts [package.json] [--dry-run] - -import { readFileSync, writeFileSync } from "node:fs"; - -const parts = ["major", "minor", "patch"] as const; -type Part = (typeof parts)[number]; - -const args = process.argv.slice(2); -const dryRun = args.includes("--dry-run"); -const [part, file = "package.json"] = args.filter((arg) => arg !== "--dry-run"); - -if (!parts.includes(part as Part)) { - console.error(`Expected one of ${parts.join(", ")}, not '${part ?? ""}'.`); - process.exit(1); -} - -const text = readFileSync(file, "utf8"); -const versionPattern = /("version"\s*:\s*")([^"]*)(")/; -const match = versionPattern.exec(text); -if (!match) { - console.error(`No "version" field in ${file}.`); - process.exit(1); -} - -const current = match[2]; -const semver = /^(\d+)\.(\d+)\.(\d+)(?:[-+].*)?$/.exec(current); -if (!semver) { - console.error(`'${current}' in ${file} is not a major.minor.patch version.`); - process.exit(1); -} - -let [major, minor, patch] = semver.slice(1, 4).map(Number); -switch (part as Part) { - case "major": - [major, minor, patch] = [major + 1, 0, 0]; - break; - case "minor": - [minor, patch] = [minor + 1, 0]; - break; - case "patch": - patch += 1; - break; -} - -const next = `${major}.${minor}.${patch}`; -if (dryRun) { - console.log(` ${file}: ${current} -> ${next} (dry run, nothing written)`); - process.exit(0); -} - -writeFileSync(file, text.replace(versionPattern, `$1${next}$3`)); -console.log(` ${file}: ${current} -> ${next}`); diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/docs.just b/.agents/skills/purview-buildsdk-justfile/assets/just/docs.just deleted file mode 100644 index 646d444a..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/docs.just +++ /dev/null @@ -1,26 +0,0 @@ -# Optional: the project site a pm-docs-site skill (purview-dev/pm-skills) scaffolds. Copy this file -# into the module folder only when the repository has one; the barrel imports it if present. Each -# recipe runs inside the site, so none of them needs `cd`. Requires Bun. - -# The site folder, relative to the repository root - pm-docs-site's SITE_ROOT. -docs_site := "src/docs-site" - -# Serve the project site at http://localhost:4321 -[group('Docs')] -[working-directory(docs_site)] -docs: docs-install - bun run dev - -# Install the project site's dependencies from its lockfile -[group('Docs')] -[working-directory(docs_site)] -docs-install: - bun install --frozen-lockfile - -# Test, type-check and build the project site - its build check -[group('Docs')] -[working-directory(docs_site)] -docs-check: docs-install - bun run test - bun run check - bun run build diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/dotnet.just b/.agents/skills/purview-buildsdk-justfile/assets/just/dotnet.just deleted file mode 100644 index 9507263f..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/dotnet.just +++ /dev/null @@ -1,53 +0,0 @@ -# .NET recipes: tools, restore, build, clean, test and pack, all against one solution. -# -# Override these in the root Justfile. `solution_file` is the one nearly every repository sets; "." -# lets dotnet find the single solution or project in the repository root. - -solution_file := "." -build_configuration := "Debug" -artifacts_folder := "./artifacts" - -# Every test. A TUnit/MTP tree-node filter: /assembly/namespace/class/test. -test_filter := "/*/*/*/*/" - -# Restore the repository's .NET local tools (.config/dotnet-tools.json) -[group('Build and Test')] -ensure-tools: - dotnet tool restore - -# Restore NuGet packages for the solution -[group('Build and Test')] -restore *args: - echo "==> Restoring {{ BLUE }}{{ solution_file }}{{ NORMAL }}" - dotnet restore "{{ solution_file }}" {{ args }} - -# Build the solution with build_configuration (default: Debug) -[group('Build and Test')] -build *args: - echo "==> Building {{ BLUE }}{{ solution_file }}{{ NORMAL }} ({{ GREEN }}{{ current_version }}{{ NORMAL }}) with configuration {{ YELLOW }}{{ build_configuration }}{{ NORMAL }}" - dotnet build "{{ solution_file }}" --configuration "{{ build_configuration }}" {{ args }} - -# Clean the solution with build_configuration (default: Debug) -[group('Build and Test')] -clean *args: - echo "==> Cleaning {{ BLUE }}{{ solution_file }}{{ NORMAL }} with configuration {{ YELLOW }}{{ build_configuration }}{{ NORMAL }}" - dotnet clean "{{ solution_file }}" --configuration "{{ build_configuration }}" {{ args }} - -# Run the tests matching a tree-node filter (default: every test) -# -# just test "/*/*/*/*[Category=Unit]" -# just test "/*/*/ProjectHarnessTests/*" -# -# Exit code 8 - "no test ran" - is ignored, so a filter that matches nothing in one test project does -# not fail the run for the others. -[doc('Run the tests matching a tree-node filter (default: every test)')] -[group('Build and Test')] -test filter=test_filter *args: - echo "==> Testing {{ BLUE }}{{ solution_file }}{{ NORMAL }} ({{ YELLOW }}{{ build_configuration }}{{ NORMAL }}) with filter {{ GREEN }}{{ filter }}{{ NORMAL }}" - dotnet test --project "{{ solution_file }}" --configuration "{{ build_configuration }}" --treenode-filter "{{ filter }}" --ignore-exit-code 8 {{ args }} - -# Pack every packable project into artifacts_folder (default: ./artifacts) -[group('Build and Test')] -pack artifact_folder=artifacts_folder *args: - echo "==> Packing {{ BLUE }}{{ solution_file }}{{ NORMAL }} ({{ GREEN }}{{ current_version }}{{ NORMAL }}) to {{ YELLOW }}{{ artifact_folder }}{{ NORMAL }}" - dotnet pack "{{ solution_file }}" --configuration "{{ build_configuration }}" --output "{{ artifact_folder }}" {{ args }} diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/env.just b/.agents/skills/purview-buildsdk-justfile/assets/just/env.just deleted file mode 100644 index 6156f34b..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/env.just +++ /dev/null @@ -1,56 +0,0 @@ -# The environment every recipe runs in: telemetry opt-outs, and the .NET CLI speed-ups. -# -# `export` hands each value to every process a recipe starts - dotnet, bun, pwsh, git. Each one is a -# default: `env(NAME, value)` keeps whatever the caller's environment already says, so a developer -# who has opted back in, or a CI job that sets its own value, is never overridden. - -# -- Telemetry and tracking -------------------------------------------------------------------------- - -# The .NET CLI, MSBuild and Aspire. -export DOTNET_CLI_TELEMETRY_OPTOUT := env("DOTNET_CLI_TELEMETRY_OPTOUT", "1") -export MSBUILD_TELEMETRY_OPTOUT := env("MSBUILD_TELEMETRY_OPTOUT", "1") -export ASPIRE_CLI_TELEMETRY_OPTOUT := env("ASPIRE_CLI_TELEMETRY_OPTOUT", "true") -export ASPIRE_DASHBOARD_TELEMETRY_OPTOUT := env("ASPIRE_DASHBOARD_TELEMETRY_OPTOUT", "true") - -# The Azure SDKs and the Azure MCP server. -export AZURE_CORE_COLLECT_TELEMETRY := env("AZURE_CORE_COLLECT_TELEMETRY", "0") -export AZURE_MCP_COLLECT_TELEMETRY := env("AZURE_MCP_COLLECT_TELEMETRY", "0") - -# PowerShell, for scripts a recipe runs through pwsh, and Git Credential Manager. -export POWERSHELL_TELEMETRY_OPTOUT := env("POWERSHELL_TELEMETRY_OPTOUT", "1") -export GCM_TELEMETRY_OPTOUT := env("GCM_TELEMETRY_OPTOUT", "1") - -# JavaScript tooling: Next.js, Astro, Yarn, and the funding banners printed by postinstall scripts. -export NEXT_TELEMETRY_DISABLED := env("NEXT_TELEMETRY_DISABLED", "1") -export ASTRO_TELEMETRY_DISABLED := env("ASTRO_TELEMETRY_DISABLED", "1") -export YARN_ENABLE_TELEMETRY := env("YARN_ENABLE_TELEMETRY", "0") -export DISABLE_OPENCOLLECTIVE := env("DISABLE_OPENCOLLECTIVE", "true") - -# Claude Code, when a recipe launches it. -export CLAUDE_CLI_TELEMETRY_OPTOUT := env("CLAUDE_CLI_TELEMETRY_OPTOUT", "1") -export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC := env("CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC", "1") -export DISABLE_ERROR_REPORTING := env("DISABLE_ERROR_REPORTING", "1") -export DISABLE_TELEMETRY := env("DISABLE_TELEMETRY", "1") - -# The cross-tool conventions, honoured by Bun and many other CLIs. -export DO_NOT_TRACK := env("DO_NOT_TRACK", "1") -export TELEMETRY_DISABLED := env("TELEMETRY_DISABLED", "1") - -# -- .NET CLI speed and noise ------------------------------------------------------------------------ - -# No welcome banner or first-run notice. -export DOTNET_NOLOGO := env("DOTNET_NOLOGO", "1") - -# The NativeAOT CLI host (.NET 11): near-instant `dotnet --version`, `--help` and tool launches, with -# everything else falling back to the managed CLI. On by default; opt out with DOTNET_CLI_ENABLEAOT=false. -export DOTNET_CLI_ENABLEAOT := env("DOTNET_CLI_ENABLEAOT", "true") - -# The MSBuild server (DOTNET_CLI_USE_MSBUILD_SERVER) is deliberately left to the SDK's own default. -# Forcing it on makes every `dotnet build` share one long-lived MSBuild process, and its NuGet SDK -# resolver keeps the settings it first read: a build under a different nuget.config - a test -# harness's throwaway consumer, a second repository - then resolves SDKs with the wrong sources and -# fallback folders, and fails with MSB4242. Set it yourself where every build shares one NuGet -# configuration; `just scrub` shuts the server down. - -# Multithreaded MSBuild (-mt) is deliberately not set here. Purview.BuildSdk bootstraps it into the -# repository's Directory.Build.rsp, so a plain `dotnet build` and an IDE build get it as well. diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/index.just b/.agents/skills/purview-buildsdk-justfile/assets/just/index.just deleted file mode 100644 index 1d73bbe6..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/index.just +++ /dev/null @@ -1,41 +0,0 @@ -# The barrel for the shared just modules. The root Justfile imports this file, and nothing else: -# -# set allow-duplicate-variables -# set allow-duplicate-recipes -# -# import ".build/just/index.just" -# -# Every module gives its variables a default. The root Justfile overrides one by defining the same -# name - `solution_file := "src/Acme.slnx"` - and overrides a no-op hook such as `_after-bump` the -# same way. Both settings are what let a root definition win; without them a duplicate is an error. -# -# The required modules are imported unconditionally. The optional ones use `import?`, so a module is -# switched on by copying its file into this folder and off by deleting it: this file never changes. -# -# These files are copied verbatim from the purview-buildsdk-justfile skill. Change a recipe there, -# not here, and put anything specific to one repository in its root Justfile. - -# Telemetry opt-outs and the .NET CLI speed-ups, exported to every recipe. -import "env.just" - -# version, bump -import "version.just" - -# ensure-tools, restore, build, clean, test, pack -import "dotnet.just" - -# lint-check, lint-fix, vs, scrub -import "utilities.just" - -# pipeline-pr, pipeline-build, pipeline-tests - local runs of the Purview.Build pipeline -import "purview-build.just" - -# skills-* - the Purview.BuildSdk agent-skill targets -import "skills.just" - -# Optional. pipeline-pack-validate, pipeline-local-release, pipeline-release - for a repository that -# packs NuGet packages. -import? "purview-build-nuget.just" - -# Optional. docs, docs-install, docs-check - for a pm-docs-site project site (purview-dev/pm-skills). -import? "docs.just" diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/purview-build-nuget.just b/.agents/skills/purview-buildsdk-justfile/assets/just/purview-build-nuget.just deleted file mode 100644 index 21548760..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/purview-build-nuget.just +++ /dev/null @@ -1,30 +0,0 @@ -# Optional: Purview.Build pipeline runs that pack, validate and publish NuGet packages. Copy this file -# into the module folder only when the repository packs packages; the barrel imports it if present. -# -# Pack validation reads PackValidation in .config/purview-build.json. Its RequiredContent lists every -# file each package must contain, and a packed file it does not list fails the run - so a new file -# under a package's Sdk/, build/ or buildTransitive/ needs a RequiredContent entry too. - -# Run the pipeline through pack and pack validation (restore, build, lint, tests, pack, validate), publishing nothing -[group('Pipeline')] -pipeline-pack-validate *args: ensure-tools - echo "==> Running the pack and validate pipeline" - {{ pipeline_tool }} --Build:RunPack=true --Build:ValidatePack=true --Release:Mode=None {{ args }} - -# Run the release pipeline, publishing to a local NuGet feed (restore, build, lint, tests, pack, validate, publish) -# -# `just` runs recipes through sh, which strips backslashes from unquoted arguments. Set the -# LOCAL_NUGET_FEED_PATH environment variable, or use forward slashes: -# -# just pipeline-local-release --PublishLocalNuGet:LocalFeedPath=p:/_sync-projects/.local-nuget/ -[doc('Run the release pipeline, publishing to a local NuGet feed (restore, build, lint, tests, pack, validate, publish)')] -[group('Pipeline')] -pipeline-local-release *args: ensure-tools - echo "==> Running the local release pipeline" - {{ pipeline_tool }} --Release:Mode=LocalNuGet {{ args }} - -# Run the release pipeline, publishing to NuGet (restore, build, lint, tests, pack, validate, publish, GitHub release) -[group('Pipeline')] -pipeline-release *args: ensure-tools - echo "==> Running the release pipeline" - {{ pipeline_tool }} --Release:Mode=NuGet {{ args }} diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/purview-build.just b/.agents/skills/purview-buildsdk-justfile/assets/just/purview-build.just deleted file mode 100644 index 244e44cd..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/purview-build.just +++ /dev/null @@ -1,24 +0,0 @@ -# Local runs of the Purview.Build pipeline - the same `dotnet purview-build` tool, and the same -# .config/purview-build.json, that CI runs. Every Build stage - tests, lint, pack and pack validation - -# runs unless that file or an argument turns it off. Anything after the recipe name is passed to the -# tool, so a setting can be overridden for one run: `just pipeline-pr --Build:TestFilter="/*/*/*/*[Category=Unit]"`. - -pipeline_tool := "dotnet purview-build" - -# Run the PR pipeline (restore, build, lint, tests, pack, validate), as configured -[group('Pipeline')] -pipeline-pr *args: ensure-tools - echo "==> Running the PR pipeline" - {{ pipeline_tool }} {{ args }} - -# Run the build pipeline (restore, build, lint, pack, validate), without tests -[group('Pipeline')] -pipeline-build *args: ensure-tools - echo "==> Running the build pipeline" - {{ pipeline_tool }} --Build:RunTests=false --Release:Mode=None {{ args }} - -# Run the pipeline with tests forced on and release off (restore, build, lint, tests, pack, validate) -[group('Pipeline')] -pipeline-tests *args: ensure-tools - echo "==> Running the tests pipeline" - {{ pipeline_tool }} --Build:RunTests=true --Release:Mode=None {{ args }} diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/skills.just b/.agents/skills/purview-buildsdk-justfile/assets/just/skills.just deleted file mode 100644 index 0d339023..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/skills.just +++ /dev/null @@ -1,52 +0,0 @@ -# The Purview.BuildSdk agent-skill targets. Each recipe names one target; the behaviour lives there. -# -# The targets are a thin wrapper over the standard skills CLI (`bun x skills` by default), run from the -# repository root. Every skill target runs once for the whole solution, however many projects it holds, -# so the recipes name the solution, not a hand-picked project. -# -# Every recipe here is run by a person, on purpose. Never make one a dependency of build, test or -# default, or call skills-add, -install, -update or -fix from a git hook: they change the repository, -# and the SDK refuses to run them inside a build (PRSKL0009). skills-check is read-only. -# -# The runner and agents are MSBuild properties (PurviewSkillsRunner, PurviewSkillsAgents), set once in -# Directory.Build.props. Pass a one-off through *args; `dotnet msbuild -p:` splits on `,` and `;`, so -# escape the separator: `just skills-update -p:PurviewSkillsAgents=claude-code%2Ccodex`. - -skills_project := solution_file - -# Install skills from another repository through the skills CLI (append '#' to pin it) -# -# just skills-add purview-dev/engineering-playbook -[doc("Install skills from another repository through the skills CLI (append '#' to pin it)")] -[group('Agent Skills')] -skills-add source *args: - echo "==> Installing skills from {{ BLUE }}{{ source }}{{ NORMAL }}" - dotnet msbuild "{{ skills_project }}" -t:InstallPurviewSkills -p:PurviewSkillsSource={{ source }} -v:n {{ args }} - -# Restore every skill skills-lock.json records - how a fresh clone gets the repository's skills back -[group('Agent Skills')] -skills-install *args: - dotnet msbuild "{{ skills_project }}" -t:InstallPurviewSkills -v:n {{ args }} - -# Update the agent skills by re-adding every unique source in skills-lock.json -# -# Each source is re-added at its latest with every skill it has, which refreshes the installed skills -# and adds any a source has gained; `skills update` is never run. FixPurviewSkills then removes links -# from agent directories PurviewSkillsAgents does not select, and does nothing when it is unset. -# The -t: value is quoted because sh would otherwise end the command at the `;`. -# -# just skills-update -p:PurviewSkillsDryRun=true -[doc('Update the agent skills by re-adding every unique source in skills-lock.json')] -[group('Agent Skills')] -skills-update *args: - dotnet msbuild "{{ skills_project }}" "-t:UpdatePurviewSkills;FixPurviewSkills" -v:n {{ args }} - -# Check that only the skill directories of the agents in PurviewSkillsAgents exist -[group('Agent Skills')] -skills-check *args: - dotnet msbuild "{{ skills_project }}" -t:CheckPurviewSkills -v:n {{ args }} - -# Remove the skills CLI's links from agent directories PurviewSkillsAgents does not select -[group('Agent Skills')] -skills-fix *args: - dotnet msbuild "{{ skills_project }}" -t:FixPurviewSkills -v:n {{ args }} diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/utilities.just b/.agents/skills/purview-buildsdk-justfile/assets/just/utilities.just deleted file mode 100644 index d813497b..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/utilities.just +++ /dev/null @@ -1,44 +0,0 @@ -# Formatting, opening the solution, and scrubbing the build output. - -csharpier := "dotnet csharpier" - -# Check formatting with CSharpier -[group('Utilities')] -lint-check: - {{ csharpier }} check . - -# Format the code with CSharpier -[group('Utilities')] -lint-fix: - {{ csharpier }} format . - -# Open the solution in Visual Studio, or whichever application is registered for it -[group('Utilities')] -[windows] -vs: - start "" "{{ solution_file }}" - -# Open the solution in whichever application is registered for it -[group('Utilities')] -[macos] -vs: - open "{{ solution_file }}" - -# Open the solution in whichever application is registered for it -[group('Utilities')] -[linux] -vs: - xdg-open "{{ solution_file }}" - -# Delete every bin/, obj/ and artifacts_folder, stop the build servers, and restore from scratch -# -# The build servers go first: the MSBuild server and the compiler server hold files open under obj/, -# which on Windows stops them being deleted. node_modules/ and .git/ are never searched. -[doc('Delete every bin/, obj/ and artifacts_folder, stop the build servers, and restore from scratch')] -[group('Utilities')] -scrub: - echo "==> Scrubbing build output and stopping the build servers" - dotnet build-server shutdown - find . \( -name node_modules -o -name .git \) -prune -o -type d \( -name bin -o -name obj \) -prune -exec rm -rf {} + - rm -rf "{{ artifacts_folder }}" - just restore --force-evaluate diff --git a/.agents/skills/purview-buildsdk-justfile/assets/just/version.just b/.agents/skills/purview-buildsdk-justfile/assets/just/version.just deleted file mode 100644 index 09dbb375..00000000 --- a/.agents/skills/purview-buildsdk-justfile/assets/just/version.just +++ /dev/null @@ -1,28 +0,0 @@ -# The package version, from package.json: the single source of truth Purview.BuildSdk versions every -# project and package from. - -version_file := "package.json" - -# Read by just itself rather than by spawning bun, so `just --list` needs no Node tooling. -current_version := if path_exists(version_file) == "true" { replace_regex(read(version_file), '(?s).*?"version"\s*:\s*"([^"]*)".*', '$1') } else { "0.0.0" } - -# Display the current version, from package.json -[group('Version')] -version: - echo "==> Current version: {{ GREEN }}{{ current_version }}{{ NORMAL }} (from {{ version_file }}, stamped into every build by Purview.BuildSdk)" - -# Bump one part of the version in package.json - major, minor or patch - resetting the parts after it -# -# just bump minor # 2.0.1 -> 2.1.0 -# just bump patch --dry-run # print the new version, write nothing -# -# A pre-release suffix is dropped. Requires Bun. Afterwards it runs `_after-bump`, which does nothing -# unless the root Justfile overrides it to refresh whatever else pins the version. -[doc('Bump one part of the version in package.json - major, minor or patch - resetting the parts after it')] -[arg("part", pattern="major|minor|patch")] -[group('Version')] -bump part *args: && _after-bump - bun "{{ source_directory() / 'bump-version.ts' }}" "{{ part }}" "{{ version_file }}" {{ args }} - -# Runs after a successful `bump`. Override it in the root Justfile, e.g. `_after-bump: version-sync`. -_after-bump: diff --git a/.agents/skills/purview-buildsdk-justfile/references/skills-recipes.md b/.agents/skills/purview-buildsdk-justfile/references/skills-recipes.md deleted file mode 100644 index 5c850f5f..00000000 --- a/.agents/skills/purview-buildsdk-justfile/references/skills-recipes.md +++ /dev/null @@ -1,100 +0,0 @@ -# The agent-skill recipes - -`skills.just` gives each SDK skill target a recipe. The targets are a thin wrapper over the standard -skills CLI (`bun x skills` by default), which finds a repository's skills in its root `skills/` -folder and records what it installed in `skills-lock.json`. Their behaviour is covered by -`purview-buildsdk-skill-installation`; this page is about the recipes that run them. - -## The rule that matters most - -**Every skill recipe is run by a person, on purpose.** `InstallPurviewSkills`, `UpdatePurviewSkills` -and `FixPurviewSkills` change the repository, and the SDK refuses to run them inside a build, a -restore or a design-time build (`PRSKL0009`). Keep the `Justfile` consistent with that: - -- never make a skills recipe a dependency of `build`, `test`, `default` or any other recipe; -- never call `skills-add`, `skills-install`, `skills-update` or `skills-fix` from a git hook - (`lefthook.yml`, `.husky/`) or from a CI job that commits — `PRSKL0009` cannot see those, because they - run the target on its own; -- `skills-check` is read-only and safe anywhere. - -## The recipes - -| Recipe | Target | Runs | Changes the repository | -| -- | -- | -- | -- | -| `skills-add ` | `InstallPurviewSkills` with `PurviewSkillsSource` | `skills add --skill "*"` | yes | -| `skills-install` | `InstallPurviewSkills` | `skills experimental_install` — restore `skills-lock.json` | yes | -| `skills-update` | `UpdatePurviewSkills;FixPurviewSkills` | `skills add --skill "*"` once per lockfile source | yes | -| `skills-check` | `CheckPurviewSkills` | nothing | no | -| `skills-fix` | `FixPurviewSkills` | nothing; removes links itself | yes | - -A repository that *authors* skills usually adds `skills-validate` to its root `Justfile`. It runs -`ValidatePurviewSkills` against the one project that packs, because that target runs once per -project it is invoked on: - -```just -[group('Agent Skills')] -skills-validate *args: - dotnet msbuild "src/src/Acme/Acme.csproj" -t:ValidatePurviewSkills -v:n {{ args }} -``` - -## Why the recipes name the solution - -`skills_project` defaults to `solution_file`. Every skill target runs once for the whole solution, -however many projects it holds: each project hands the work to the same elected leader, and MSBuild -runs it once. A single project works too. An old `Justfile.skills.just` pointed at a hand-picked -"small" project gets the same treatment: delete it, and let `skills.just` name the solution. - -## Details that break a recipe if missed - -- **Quote a multi-target `-t:`.** `"-t:UpdatePurviewSkills;FixPurviewSkills"` — unquoted, `sh` ends the - command at the `;` and runs `FixPurviewSkills` as a separate, failing command. The same holds under - PowerShell. -- **Keep `*args` last** so a caller can pass properties: `just skills-update -p:PurviewSkillsDryRun=true`. -- `FixPurviewSkills` after `UpdatePurviewSkills` does nothing unless `PurviewSkillsAgents` is set, so - it is safe in the recipe either way. -- `skills-install` with no lockfile fails with `PRSKL0007`: add a source first with `skills-add`. - -## Runner and agents belong in MSBuild, not in the recipe - -Set repository-wide choices once in `Directory.Build.props`, not as flags repeated in each recipe, so -a plain `dotnet msbuild -t:...` behaves the same as the recipe: - -```xml - - - bun - - universal - -``` - -One-off overrides go on the command line. `dotnet msbuild -p:` splits values on `,` and `;`, so escape -the separator: `just skills-update -p:PurviewSkillsAgents=claude-code%2Ccodex`. - -| Property | Effect | -| -- | -- | -| `PurviewSkillsDryRun=true` | Print every CLI command; run none | -| `PurviewSkillsRunner=npx` | Launch the CLI through another runner (`bunx`, `pnpm`, `yarn`, `deno`) | -| `PurviewSkillsSource=owner/repo#ref` | What `skills-add` sets: the source to install from | - -## Replacing hand-written skill scripts - -| Hand-written | Replace with | -| -- | -- | -| `scripts/update-agent-skills.ts`, `"skills:update"` | `skills-update` (`UpdatePurviewSkills`) | -| `--update` / `--no-update` | Nothing: the re-add refreshes installed skills and adds new ones, so there is no separate `skills update` step to switch | -| `--dry-run` | `-p:PurviewSkillsDryRun=true` | -| `scripts/ensure-universal-skills.ts check`, `"skills:check"` | `skills-check` with `PurviewSkillsAgents=universal` | -| `scripts/ensure-universal-skills.ts fix`, `"skills:fix"` | `skills-fix` | -| a hard-coded `-a universal` | `PurviewSkillsAgents` — or leave it empty to auto-detect | - -Update is `skills add`, not `skills update`, so it also installs skills a source has **gained**: each -source is re-added with `--skill "*"`. Mention that when migrating. - -Before deleting the scripts, run `just skills-update -p:PurviewSkillsDryRun=true` and compare the -printed commands with what the old script ran. Then delete the scripts and their `package.json` -entries — but keep `package.json` itself, which Purview.BuildSdk reads the version from. - -An existing `skills-recommend`, `skills-verify` or `skills-list` recipe has no target behind it any -more: delete it, and its callers. diff --git a/.agents/skills/purview-buildsdk-msbuild-properties/SKILL.md b/.agents/skills/purview-buildsdk-msbuild-properties/SKILL.md deleted file mode 100644 index 00111249..00000000 --- a/.agents/skills/purview-buildsdk-msbuild-properties/SKILL.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -name: purview-buildsdk-msbuild-properties -description: Add, rename, deprecate or remove an MSBuild property in a package built with Purview.BuildSdk, and describe it in an MSBuild Editor .buildschema.json sidecar so it gets csproj IntelliSense. Use when a package ships .props/.targets under Sdk/, build/ or buildTransitive/ and needs a new setting, a compiler-visible (build_property.*) value for its analyzers, a documented default, or a check that its schema and props agree (ValidatePurviewPropertySchema, PRPSC0001-PRPSC0004). Also covers where a sidecar must sit to be loaded, when a property must be set before the Sdk.props import, and declaring a new sidecar in .config/purview-build.json PackValidation.RequiredContent - including a Purview.Build "contains undeclared content ... not defined in RequiredContent" failure. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# MSBuild properties and their schema - -A property a package ships is described in several places: its definition and default, the -`CompilerVisibleProperty` list when an analyzer reads it, the package's docs, and an MSBuild Editor -sidecar schema that gives it csproj IntelliSense. They drift unless one of them is canonical and the -others are checked against it. - -**The sidecar is canonical.** Write the description, type and default there first, then make the code -and the docs agree with it. `ValidatePurviewPropertySchema` checks the part that can be checked -mechanically. - -## Where a sidecar goes - -MSBuild Editor reads `.buildschema.json` — the **full** file name plus the -suffix, in the **same folder** as the file it describes. Verified in the editor's source -(`MSBuildSchemaProvider.GetSchema`: `path + ".buildschema.json"`). - -| The package ships | The consumer's build imports | The sidecar is | -| -- | -- | -- | -| an MSBuild SDK (`Sdk/Sdk.props`, `Sdk/Sdk.targets`) | `Sdk/Sdk.props` | `Sdk/Sdk.props.buildschema.json` | -| `build/Acme.Kit.props` | `build/Acme.Kit.props` | `build/Acme.Kit.props.buildschema.json` | -| `buildTransitive/Acme.Kit.props` | `buildTransitive/Acme.Kit.props` | `buildTransitive/Acme.Kit.props.buildschema.json` | - -Three consequences: - -- `Sdk.buildschema.json` or `Acme.Kit.buildschema.json` is **never loaded**: the extension of the - described file is part of the name. `PRPSC0004` reports a sidecar with no file beside it. -- One sidecar is enough per package. The editor loads every sidecar for every file it imports and - applies them project-wide, so describe all the package's properties beside the file a consumer - always imports — usually the `.props` — even those its `.targets` defines. -- A package that ships the same file under both `build/` and `buildTransitive/` needs the sidecar in - both, because a direct and a transitive reference import different copies. - -With Purview.BuildSdk, author the files under the project's `Sdk/` folder: `PurviewAutoSdkPack` maps -`Sdk/build/**` to `build/**` and `Sdk/buildTransitive/**` to `buildTransitive/**`, and a sidecar -travels with its neighbour because it sits in the same folder. An MSBuild SDK project disables -`PurviewAutoSdkPack` and packs `Sdk/**` to `Sdk/` itself; a sidecar there is picked up by that same -item. - -### Declare the sidecar to pack validation - -A sidecar is a new file in the package, and a repository built with Purview.Build validates every -package's contents against `.config/purview-build.json`. Whenever you add a sidecar — or any other -`.props`/`.targets` the package ships — open that file and check `PackValidation.RequiredContent`. -It is keyed by lower-case package id, and lists the package-relative path of every file the package -must contain: - -```json -"PackValidation": { - "RequiredContent": { - "acme.kit": [ - "build/Acme.Kit.props", - "build/Acme.Kit.props.buildschema.json", - "buildTransitive/Acme.Kit.props", - "buildTransitive/Acme.Kit.props.buildschema.json" - ] - } -} -``` - -Add each sidecar beside the file it describes, in the list's existing order. Both directions fail -the pipeline's `ValidatePackModule`, and neither shows up until `just pipeline-pack-validate` or a -release: - -- **A packed file the list does not name** — `contains undeclared content 'Sdk/Sdk.props.buildschema.json' - that is not defined in RequiredContent`. The package is right; the list is stale. -- **A listed file the package lacks** — the sidecar was renamed, or did not pack. Fix the pack, not - the list. - -With no `.config/purview-build.json`, or no entry for the package, there is nothing to update. To -check, pack and validate without publishing: - -```bash -just pipeline-pack-validate # or: dotnet purview-build --Build:RunPack=true --Build:ValidatePack=true --Release:Mode=None -``` - -## Add a property - -1. **Define it, with its default, in the `.props`.** Guard it so a value set earlier wins: - - ```xml - false - ``` - - Give a boolean an explicit `true`/`false` default. Leave a property unset only when "unset" is a - real third state — "detected", "inherited from another property" — and say so in the schema. - -2. **Decide whether it must be set before the import.** A `.props` file is evaluated before the - project body. If anything in the `.props` (or a file it imports) *reads* the property — in a value - or a `Condition`, other than its own `'$(X)' == ''` guard — a value set in the project file arrives - too late. Then it must be set in `Directory.Build.props` **before** the ``, and its - description says so. If only the `.targets` reads it, a project file can set it too; prefer that - shape for anything per-project. - -3. **Make it compiler-visible only if an analyzer or generator reads it.** Add it beside the package's - other exports, with a ``: - - ```xml - - - When true, the Acme analyzers report ACME0001 as an error. - - - ``` - - The analyzer reads `build_property.AcmeKitStrict` from - `AnalyzerConfigOptionsProvider.GlobalOptions`. Nothing else exposes an MSBuild property to the - compiler, and an export nothing reads is noise in every consumer's generated `.editorconfig`. - -4. **Describe it in the sidecar.** See [references/schema-format.md](references/schema-format.md) for - the entry format, types and enumerations: - - ```json - "AcmeKitStrict": { - "description": "Reports ACME0001 as an error instead of a warning.", - "type": "bool", - "defaultValue": "false" - } - ``` - - - `defaultValue` is the value a plain project evaluates to — not what it is "usually". - - No default? End the description with `No default: .` — "detected from the project", - "unset, which is treated as false". - - Must be set before the import? Say `Set it before the \`Sdk.props\` import.` (or name the - package's own `.props`). - -5. **Document it** in the package's README or docs table, with the same default. - -6. **Record it** in `CHANGELOG.md` under the heading for the version in `package.json` → - `### Added`. Not `[Unreleased]`: a merge to `main` publishes that version, so the entry would read as - unreleased until it was already live. `[Unreleased]` is only for a pre-release version. - -7. **Check it.** Run `dotnet msbuild -t:ValidatePurviewPropertySchema` (see below), then the - package's own tests. If this property brought the package's **first** sidecar, or a new - `.props`/`.targets` file, declare it to pack validation as well - ([above](#declare-the-sidecar-to-pack-validation)). - -## Rename a property - -Never rename a released property in place: every consumer that sets the old name silently loses it. - -1. Add the new name as in *Add a property*, defaulting from the old one so an existing setting still - works: - - ```xml - $(AcmeKitStrict) - false - ``` - -2. Read only the new name everywhere else, including the `CompilerVisibleProperty` export. Export the - old one too until it is removed if analyzers in the wild read it. -3. Keep the old entry in the sidecar, with a `deprecationMessage` naming the replacement, so the editor - flags the old name where it is set: - - ```json - "AcmeKitStrict": { - "description": "Replaced by AcmeKitStrictMode.", - "type": "bool", - "deprecationMessage": "Use AcmeKitStrictMode instead." - } - ``` - -4. Changelog: `### Added` for the new name, `### Deprecated` for the old. - -## Deprecate a property - -Keep its behaviour and its default, add a `deprecationMessage` to its sidecar entry saying what to do -instead, mark the docs row deprecated, and add a `### Deprecated` changelog entry. A deprecated -property is still a property: it keeps its schema entry until it is removed. - -## Remove a property - -Only in a major version, and in one change: the definition, every read, the `CompilerVisibleProperty` -item, the sidecar entry and the docs row. Leaving any one behind is exactly what the checks catch — -`PRPSC0002` for a sidecar entry nothing defines. Changelog: `### Removed`, naming what to set instead. - -## Checking a package: `ValidatePurviewPropertySchema` - -Purview.BuildSdk ships an opt-in target for any package that authors `.props`/`.targets`: - -```xml - - - true - - RootNamespace;Version - -``` - -With it on, the check runs before `Pack`. Run it by name at any time: - -```bash -dotnet msbuild src/Acme.Kit/Acme.Kit.csproj -t:ValidatePurviewPropertySchema -``` - -It reads every `.props`/`.targets` under `PurviewPropertySchemaDirectory` (default: the project's -`Sdk/` folder) and every sidecar beside them, and fails with: - -| Id | Meaning | Fix | -| -- | -- | -- | -| `PRPSC0001` | a `CompilerVisibleProperty` no sidecar describes | add the entry, or list the name in `PurviewPropertySchemaIgnoredProperties` | -| `PRPSC0002` | a sidecar entry no file defines, reads or exports | remove the entry, or define the property | -| `PRPSC0003` | a sidecar that is not JSON, or has no `"properties"` object | fix the file | -| `PRPSC0004` | a sidecar with no `.props`/`.targets` beside it | rename it to `.buildschema.json` | - -It is off by default and never runs in an ordinary build, so turning it on changes nothing for the -package's consumers. It checks agreement, not prose: whether a description is *right* is the review's -job. - -## Getting the IntelliSense - -Install the **MSBuild Editor** extension in Visual Studio -(). It loads the sidecar of every file a project imports, SDKs resolved -through `global.json` `msbuild-sdks` included, and offers completion, the description, the default -and — for an enumeration — the allowed values. Without the extension a sidecar is inert. - -## Guardrails - -- **Do not change a released default** as part of documenting it. A wrong document is fixed in the - document; a default change is a behaviour change with its own changelog entry. -- **Do not export a property "in case".** Each `CompilerVisibleProperty` lands in every consumer's - generated analyzer config. -- **Do not hand-edit generated sidecars.** If a package generates its sidecar, change the generator. -- **Keep the meta-schema draft as it is** (`draft-04`): Visual Studio rejects newer drafts. diff --git a/.agents/skills/purview-buildsdk-msbuild-properties/references/schema-format.md b/.agents/skills/purview-buildsdk-msbuild-properties/references/schema-format.md deleted file mode 100644 index 1f4e7b30..00000000 --- a/.agents/skills/purview-buildsdk-msbuild-properties/references/schema-format.md +++ /dev/null @@ -1,87 +0,0 @@ -# The `.buildschema.json` format, for properties - -The meta-schema is -. -It declares **JSON Schema draft-04** on purpose — Visual Studio fails to validate against anything -newer — and sets `additionalProperties: false` almost everywhere, so an unknown key is an error, not -an extension point. There is no slot for custom metadata: anything a property needs to say goes in -its `description`. - -## The file - -```json -{ - "$schema": "https://github.com/mhutch/MonoDevelop.MSBuildEditor/raw/main/MonoDevelop.MSBuild/Schemas/buildschema.json", - "license": "MIT", - "properties": { - "AcmeKitStrict": { - "description": "Reports ACME0001 as an error instead of a warning.", - "type": "bool", - "defaultValue": "false" - } - }, - "types": {} -} -``` - -Top-level keys: `$schema`, `license`, `properties`, `items`, `targets`, `metadata`, `types`, -`intellisenseImports`. All optional. - -## A property entry - -A string is shorthand for `{ "description": "..." }`. The object form allows only: - -| Key | Use | -| -- | -- | -| `description` | What it does, what its values mean, whether it must be set before the import, and — when there is no `defaultValue` — `No default: .` | -| `type` | An intrinsic type name, an inline type, or `{ "$ref": "#/types/" }`. | -| `defaultValue` | The evaluated default, as a string. Omit it rather than guess. | -| `isList`, `listSeparators` | A list value. `listSeparators` is `";"`, `","` or `";,"`. | -| `isLiteral` | Only literal values, no `$(...)` expressions. | -| `deprecationMessage` | Marks the property deprecated; shown where it is set. Must not be empty. | -| `versionInfo`, `helpUrl` | Optional. | - -## Intrinsic types - -`bool`, `int`, `string`, `guid`, `url`, `version`, `version-suffixed`, `nuget-id`, `nuget-version`, -`file`, `folder`, `folder-with-slash`, `file-or-folder`, `extension`, `target-framework`, -`target-framework-moniker`, `runtime-id`, `configuration`, `platform`, `warning-code`, -`clr-namespace`, `clr-type`, `clr-type-name`, `sdk`, `sdk-version`, `target-name`, `item-name`, -`property-name`, `culture`, `lcid` and a few more — the meta-schema's `valueTypeIntrinsic` is the -complete list. Pick the narrowest: `warning-code` with `isList` for a `NoWarn`-style list, -`target-framework` with `isList` for a TFM set, `folder` for a directory. - -## Enumerations - -Define the values once under `types` and reference them: - -```json -"properties": { - "AcmeKitMode": { - "description": "How strictly the kit applies its rules.", - "type": { "$ref": "#/types/acme-kit-mode" }, - "defaultValue": "Warn" - } -}, -"types": { - "acme-kit-mode": { - "description": "A strictness level.", - "values": { - "Off": "No checks.", - "Warn": "Report as warnings.", - "Error": "Report as errors." - } - } -} -``` - -A type name is lowercase and hyphenated (`^[a-z][a-z\d-]*$`). Set `"allowUnknownValues": true` when -the listed values are suggestions rather than the whole set — a package runner, a provider package. -A value can be an object with `description`, `deprecationMessage`, `aliases` and `helpUrl` instead of -a plain description. - -## Validating - -The meta-schema can be associated in VS Code (`json.schemas` → `fileMatch: ["/*.buildschema.json"]`) -or in Visual Studio's JSON editor *Schema* box. Purview.BuildSdk validates its own sidecar against a -vendored copy of the meta-schema in its test suite, so the check runs offline. diff --git a/.agents/skills/purview-buildsdk-project-detection/SKILL.md b/.agents/skills/purview-buildsdk-project-detection/SKILL.md deleted file mode 100644 index a893896b..00000000 --- a/.agents/skills/purview-buildsdk-project-detection/SKILL.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -name: purview-buildsdk-project-detection -description: Explain why Purview.BuildSdk classified a project as test, shared, shared-testing, ServerShared, client-side, CLI, web, worker, Aspire host, container, Roslyn component, Blazor WebAssembly client, Razor class library, Blazor host or BFF, or why it picked the target framework(s) it did, and why it added a package, a project reference, a namespace or an analyzer automatically. Use when SDK behaviour looks surprising, when a test project gets no runner or no InternalsVisibleTo, or when reasoning about RootNamespace, AssemblyName and TargetProjectName. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Why Purview.BuildSdk did that - -Use this skill when the question is **why** the SDK applied something automatically. - -For where a project should live, use `purview-buildsdk-project-layout`. For the property that turns -a behaviour off, use `purview-buildsdk-configuration`. - -## Diagnose from computed properties, never from the folder name - -Read what the SDK actually computed: - -```bash -dotnet msbuild -getProperty:PurviewLogicalProjectName -getProperty:RootNamespace \ - -getProperty:TestingType -getProperty:TargetProjectName -getProperty:IsTestProject -``` - -The values worth inspecting first: `MSBuildProjectName`, `NamespacePrefix`, -`PurviewLogicalProjectName`, `RootNamespace`, `TestingType`, `TargetProjectName`, `SdkProjectName`, -`IsTestProject`, `IsSharedProject`, `IsServerSharedProject`, `IsClientSideProject`, -`IsSharedTestingProject`, `IsContainerProject`, `IsCLIProject`, -`IsWebSdkProject`, `IsAspireHostProject`, `IsBlazorWebAssemblyProject`, `IsRazorClassLibraryProject`, -`IsBlazorHostProject`, `IsBffProject`. - -## Detection rules - -### Test projects - -Name matches `^.*\.([\w|_]\w*)Tests?$` — a target name, a dot, then any word before `Test`/`Tests`. -The captured word becomes `TestingType`. - -This is a pattern, **not** a lookup. `MyProject.GoldenTests` is detected exactly as readily as -`MyProject.UnitTests`, with `TestingType=Golden` and `Category=Golden`, even though `Golden` is not a -name the SDK ships. - -**The dot is required.** A project named plainly `UnitTests` does not match, and silently gets no -runner, no coverage, no `InternalsVisibleTo` and no category. This is the single most common -surprise. - -Derived: `IsTestProject=true`, `TestingType=`, `PurviewTestType=Tests`, -`TargetProjectName=`. - -The SDK's explicit `TestType` item group governs **`InternalsVisibleTo` generation**, not detection: -a non-test project grants access to `{AssemblyName}.{TestType}Tests` for each name in the group. A -suffix outside it still builds, runs and gets a category — it just cannot see `internal` members. -The 53 names are in [references/test-types.md](references/test-types.md). - -### Shared, shared-testing and ServerShared projects - -Recognised by **exact name**, never by substring. The three lists are in -[references/detection.md](references/detection.md). Derived: `IsSharedProject`, -`IsSharedTestingProject`, `IsServerSharedProject`. - -`ServerShared` is separate from `Shared` for a reason: a `Shared` project is referenced by almost -everything, including code that ends up in a browser, so server-only helpers get their own name and -are referenced automatically only by a project that cannot be downloaded. `IsClientSideProject` is the -classification that decides it. - -### SDK and content based - -| Signal | Result | -| -- | -- | -| the project's `Sdk="..."` declaration | `IsSdkProject`, `SdkProjectName` | -| `Microsoft.NET.Sdk.Web` | `IsWebSdkProject=true` | -| `Microsoft.NET.Sdk.Worker` | `IsWorkerSdkProject=true` | -| SDK starts with `Aspire.Sdk.Host` or `Aspire.AppHost.Sdk` | `IsAspireHostProject=true` | -| `Dockerfile`, `dockerfile` or `Dockerfile.dev` in the project directory | `IsContainerProject=true` | -| name ends with `CLI`, `Console`, `CommandLine`, `QuickStart`, `QuickStarts` | `IsCLIProject=true` | -| `Microsoft.NET.Sdk.BlazorWebAssembly` | `IsBlazorWebAssemblyProject=true` | -| `Microsoft.NET.Sdk.Razor` | `IsRazorClassLibraryProject=true` | -| a web SDK project whose name ends with `Bff` (case-sensitive, like `CLI`), or that sets `IsBffProject=true` | `IsBffProject=true` | -| a web SDK project that references an `IsBlazorWebAssemblyProject` project | `IsBlazorHostProject=true` | - -`IsBffProject=false` opts a `*Bff` project out. `IsBlazorHostProject` is **never** inferred into -`IsBffProject`: a host that keeps no tokens is not a BFF, and BFF rules do not describe it. - -`IsBlazorHostProject` is known at evaluation for the ``/`.Client` pairing. A host -referencing a client under any other name is resolved during the build, so ask for it with the -target that resolves it: - -```bash -dotnet msbuild -t:ResolvePurviewBlazorHostProject -getProperty:IsBlazorHostProject -``` - -What each Blazor and BFF classification applies - and the browser-safe library check - is in -[references/blazor.md](references/blazor.md). - -### Target frameworks - -A project that declares neither `TargetFramework` nor `TargetFrameworks` gets the SDK's default set, -`net10.0;net11.0` (`Current`). A `PurviewTargetFrameworkSet` (`Current`, `Latest`, `Supported`, `Broad`, -`All`) resolves the same way; an unknown name fails with `PurviewInvalidTargetFrameworkSet`. A Roslyn -component keeps `netstandard2.0` and ignores the sets (`PurviewTargetFrameworkSetIgnored`). - -An explicit `TargetFramework` or `TargetFrameworks` always wins, wherever it is set: one the SDK cannot -see in the project XML (a `Condition`, an imported file, a `Directory.Build.props` value) is reconciled -after the project body, before the .NET SDK decides whether to multi-target. `PurviewTargetFrameworkSet` -is still read from the **project XML**, so a `Condition` on it is not seen and is reported as -`PurviewConditionedProjectDeclaration`. See `purview-buildsdk-configuration` for how to set them. - -## Namespace and identity - -1. `PurviewLogicalProjectName` is `NamespacePrefix` plus the project name, de-duplicated when the - project name already starts with the prefix's tail. -2. `RootNamespace` defaults to `PurviewLogicalProjectName`. -3. Known suffixes are stripped from `RootNamespace` in two passes: while `Sdk.props` evaluates, the - shared, server-shared and shared-testing names plus `Core`, `EF`, `Shared`, `ClientShared` and - `ServiceDefaults`; then, during the build, the wider `NamespaceRemoveSuffix` list (`Infrastructure`, - `Abstractions`, `Contracts`, …). A `RootNamespace` declared in the project file is left as written. -4. Test suffixes are stripped too, so `Acme.Api.UnitTests` maps back to `Acme.Api`. -5. `AssemblyName` and `PackageId` default to the fully evaluated `RootNamespace` — except where - stripping removed a segment, where they use the full `PurviewLogicalProjectName` so the artifact - stays distinct from its parent. Test and shared-testing projects keep their detected suffix. - Explicit `AssemblyName`/`PackageId`/`RootNamespace` always win. -6. The naming defaults are applied during `Sdk.props`, before the Microsoft SDK computes - `TargetName`, so the compiled output name always matches `AssemblyName`. - -## Automatic packages and references - -- **Non-test C# projects**: a SourceLink provider package (`SourceLinkPackageName`, default - `Microsoft.SourceLink.GitHub`; `DisableSourceLink=true` opts out), the Purview telemetry packages - (unless `ExcludePurviewTelemetry`), `GenerateDocumentationFile=true`, and `InternalsVisibleTo` - generation (unless `DisableAutoInternalsVisibleTo`). -- **Test and shared-testing projects**: test-friendly `NoWarn` defaults, not packable or - publishable, and the packages selected by `TestingFramework`, `SubstituteFramework` and - `TestDataFramework`. TUnit test projects get Microsoft.Testing.Platform wiring automatically. - Shared-testing projects skip the runnable test package. -- **Packable projects**, **Roslyn components** and **special project types** (CLI, container, web, - Aspire host): see [references/detection.md](references/detection.md). -- **Blazor WebAssembly clients, Blazor hosts, BFFs and browser-safe libraries**: see - [references/blazor.md](references/blazor.md). - -Project-reference probing is layout-driven and covered by `purview-buildsdk-project-layout`. - -## The shipped analyzers - -The SDK adds `Purview.BuildSdk.Analyzers` as an `` item to every C# project, so its rules -surface in command-line builds and in Visual Studio. The code-fix assembly ships beside it. The rules -read the SDK's compiler-visible properties (`build_property.*`) rather than re-deriving project state — -`PDS0008`/`PDS0009`, for example, are gated on `build_property.IsBffProject`. The exported set is in -`purview-buildsdk-configuration`. - -| Rule | What it enforces | -| -- | -- | -| `PDS0002` | Extensions classes live under `Extensions//` | -| `PDS0003` | Explicit types with target-typed `new()` | -| `PDS0004` | Correct acronym capitalisation | -| `PDS0008` | A BFF's authentication cookie is not set `HttpOnly = false` | -| `PDS0009` | A BFF's authentication cookie is not set `SameSite = None` | - -`PDS0004` follows .NET naming guidance: well-known framework spellings (`Sql`, `Uuid`, `Url`, `Dns`, -`Tcp`, `Http`, `Xml`, `Db`, …) are exempt — `Db` among them, so `DbContext`, `DbConnection` and `DbSet` -are never flagged. A small set is still uppercased: `Api`, `Ai`, `Ui`, `Io`, `Os`, `Cpu`, `Gpu`, `Cli`, -`Gui`, `Ram`, `Ssh`, `Dsl`. Members mandated by a contract — interface -implementations and base-class overrides — are never renamed. - -Customise through `dotnet_analyzer_configuration.pds0004.allowed_words` (exempt segments), -`.acronym_map` (segment renames, e.g. `Sql:SQL`, or `Db:DB` to re-enable it) and -`.allowed_identifiers` (brand names, exact or word-boundary prefix, first match wins — `CosmosDb` -covers `CosmosDbServer`). All three merge with and override the shipped defaults. - -The shipped `.editorconfig` marks generated content (`Migrations/`, `*.g.cs`, `Generated/`, -`*.Designer.cs`, `obj/`, `bin/`) as `generated_code = true`, and suppresses namespace-conflict -diagnostics under `Extensions/`, so no `#pragma` suppressions are needed there. - -Two Visual Studio refactorings ship with them, both described in -[references/detection.md](references/detection.md). - -## When a classification is wrong - -1. Confirm the computed value with `dotnet msbuild -getProperty:` before changing - anything. -2. Prefer fixing the name or placement so the convention applies; keep the `.csproj` filename equal - to its directory name. -3. Otherwise set the flag explicitly before the SDK import (`IsBffProject` and `IsClientSideProject` - can also be set in the project), and say why in a comment. diff --git a/.agents/skills/purview-buildsdk-project-detection/references/blazor.md b/.agents/skills/purview-buildsdk-project-detection/references/blazor.md deleted file mode 100644 index 8c2e6f92..00000000 --- a/.agents/skills/purview-buildsdk-project-detection/references/blazor.md +++ /dev/null @@ -1,128 +0,0 @@ -# Blazor WebAssembly, browser-safe libraries and BFF hosts - -Every behaviour below applies only to the project type it names, and each one names the failure it -prevents. Nothing here changes a project that is not a WebAssembly client, a Blazor host, a BFF or a -`PurviewBrowserSafe` library. - -## Blazor WebAssembly client (`IsBlazorWebAssemblyProject`) - -| Applied | Failure it prevents | Opt out | -| -- | -- | -- | -| `IsPackable=false` | packing an app's `wwwroot` as a package nobody can consume | `IsPackable=true` in the project | -| `IsContainerProject=false`, so no `PublishAot`, `InvariantGlobalization` or Docker defaults | `PublishAot` on a client is a publish that fails, and the Blazor SDK owns globalisation | `DisablePurviewBlazorWebAssemblyDefaults=true` before the SDK import | -| no automatic `../Shared*/Shared*.csproj` reference | a server-side library joining the browser download because of a folder name | `DisablePurviewBlazorWebAssemblyDefaults=true` before the SDK import | -| the browser-safe reference check (`PRBLZ0001`) | a library joining the download without anyone deciding it was safe there | `DisablePurviewBrowserSafeReferenceCheck=true` | -| the managed `Directory.Build.rsp` written as `-mt:false`, naming the client | the WebAssembly SDK's `ReadWasmProps` failing under `-mt` with `MSB4060`, an error that points nowhere near the response file | `PurviewMultiThreadedBuild=true` (which then fails with `PRBLZ0002`) | -| `PRBLZ0002` when a `net11.0`+ client is built under `-mt` anyway | the same failure, reported before `PrepareForBuild` and naming where `-mt` came from | none: the build would fail anyway | - -Globalisation, trimming mode and the Blazor runtime settings are deliberately left alone: the Blazor -SDK owns them, and a second default would compete with it. - -### The multithreaded build (`PRBLZ0002`) - -A `net11.0` client cannot build under MSBuild's `-mt`, because the WebAssembly SDK's `ReadWasmProps` -task comes from a custom task factory that cannot run in the out-of-process task host. The -`Directory.Build.rsp` the SDK manages is per repository, so with `PurviewMultiThreadedBuild` unset: - -- a client writes `-mt:false` and a `# -mt:false: the Blazor WebAssembly client '' ...` line; -- every other project leaves that file alone while `` exists, and writes `-mt` again once it - does not; -- a `PurviewMultiThreadedBuild` the user set always wins, and a file without the marker line is never - rewritten. - -A client built under `-mt` anyway (the command line, a response file the user owns, -`PurviewMultiThreadedBuild=true`, or the first build after upgrading from 2.0.x) stops with `PRBLZ0002`. -The message says whether `-mt` came from the command line or which `Directory.Build.rsp`, and gives the -fix: `false`, or `-mt:false`. After an upgrade, -the managed file has already been rewritten, so building again is the fix. A `net10.0` client builds -under `-mt` and is not checked. - -### The automatic packages - -The SDK adds `Purview.Telemetry.SourceGenerator` and `Microsoft.Extensions.Telemetry.Abstractions` -to every non-test project, a client included. Both were checked rather than assumed: - -- the generator is analyzer-only (`PrivateAssets=all`), so nothing of it is downloaded; -- its generated `ActivitySource`, `ILogger` and `Meter` code, and `Telemetry.Abstractions` itself, - publish with no trim warnings and run on the WebAssembly runtime - (`BlazorWebAppTests.AutomaticTelemetryPackages_RunInsideTheWebAssemblyRuntime` boots it); -- the SDK adds no exporter. An OTLP exporter cannot work from a browser, which is exactly why the SDK - never adds one - that is the application's choice. - -Nothing is therefore excluded from a client by default. `ExcludePurviewTelemetry` and -`ExcludeMSTelemetryExtension` still remove them. - -## Blazor host (`IsBlazorHostProject`) - -A web SDK project named `` beside a WebAssembly client named `.Client` is the Blazor Web -App pairing. The host gets an automatic `ProjectReference` to the client - probed the same way a test -project's target is, and skipped when the project already references it - so the client's framework -files are served. Opt out with `PurviewAutoBlazorClientReference=false`. - -`IsBlazorHostProject` says nothing about `IsBffProject`. In a Blazor Web App the host is the BFF only -if it keeps the tokens. - -## BFF host (`IsBffProject`) - -- **No packages are added.** YARP, OpenID Connect and any BFF library are the application's choice, - and Duende.BFF carries a commercial licence. -- The `Microsoft.AspNetCore.OpenApi.Generated` interceptor namespace every other web project gets is - removed, because a BFF that only forwards has no API document to generate. A BFF referencing - `Microsoft.AspNetCore.OpenApi` keeps it; `PurviewBffExposesApi` decides explicitly. -- `PDS0008` reports `HttpOnly = false` on the `CookieAuthenticationOptions` cookie (script could read - the session). `PDS0009` reports `SameSite = None` on it (cross-site requests would carry it). Only a - constant assigned to that cookie is reported - never the antiforgery cookie, which script may - legitimately read, nor the OpenID Connect correlation and nonce cookies, which need - `SameSite=None`. - -Deliberately **not** checked, because a build cannot check them precisely: - -- **a persisted Data Protection key ring.** The call that persists it (`PersistKeysTo*`) is routinely - made in a shared ServiceDefaults project, which the BFF's compilation cannot see, so the rule would - fire on correctly configured BFFs - and a noisy rule gets suppressed wholesale. -- **anti-forgery on forwarded routes.** It stays a review obligation. - -## Browser-safe library (`PurviewBrowserSafe=true`) - -Applies to class libraries only, and only what the project has not set: - -- `IsAotCompatible=true` (on a TFM that supports it), which turns on `IsTrimmable` and the trim, - single-file and AOT analyzers; -- ``, so `CA1416` reports an API the browser does not support; -- `WarningsAsErrors` for every trim (`IL2001`-`IL2128`), single-file (`IL3000`-`IL3005`) and AOT - (`IL3050`-`IL3059`) diagnostic and `CA1416`, listed in `PurviewBrowserSafeWarningCodes`. - `TreatWarningsAsErrors` is not touched (it is `true` for every project by default), so these stay - errors in a project that turns it off. - -`CA1416` is `suggestion` in the shipped `.editorconfig`. The compiler's `/warnaserror+:CA1416` -outranks an `.editorconfig` severity, so the error still fires without the repository's setting -changing. The consequence of `PurviewBrowserSafeWarningsAsErrors=false` is that the trim and AOT -diagnostics follow `TreatWarningsAsErrors` (`true` by default) while `CA1416` falls back to the -repository's configured severity. - -What it cannot catch: file and network I/O. `File` works against the browser's in-memory file system -and `HttpClient` works through `fetch`, so neither is annotated as unsupported, and no analyzer reports -them. Reviewing for them stays a human obligation. - -### The reference check (`PRBLZ0001`) - -A WebAssembly client asks each `ProjectReference` - through an MSBuild call on the referenced project, -never by guessing from its name - for its `PurviewBrowserSafe` value, and warns for each one that does -not set it. A browser-safe library runs the same check over its own references, so the guarantee -covers the whole download, not only the first level. - -- `PurviewBrowserSafe="true"` metadata on the `ProjectReference` records the decision for a project - that does not use this SDK. -- References with `ReferenceOutputAssembly="false"` or an `OutputItemType` are not downloaded and are - not checked. Package references are not checked either. -- `PurviewBrowserSafeReferenceCheckAsError=true` makes it an error. - -### Purview packages a Contracts library builds on - -Checked against a `PurviewBrowserSafe` library, then run on the WebAssembly runtime: - -| Package | Result | -| -- | -- | -| `Purview.Results` 1.0.4 | clean | -| `Purview.ZodSharp` 2.4.2 | clean, including `[ZodSchema]` | -| `Purview.ValueObjects` 1.2.3 | the runtime assembly is AOT-compatible, but the JSON converter the generator emits for a scalar calls the reflection-based `JsonSerializer.Serialize`/`Deserialize(..., options)` overloads, which is `IL2026` and `IL3050` - errors in a browser-safe library. Set `GenerateJsonConverter = false` on the scalar until the generator writes the value directly. | diff --git a/.agents/skills/purview-buildsdk-project-detection/references/detection.md b/.agents/skills/purview-buildsdk-project-detection/references/detection.md deleted file mode 100644 index 155e345b..00000000 --- a/.agents/skills/purview-buildsdk-project-detection/references/detection.md +++ /dev/null @@ -1,99 +0,0 @@ -# Detection detail - -## Shared project names (exact) - -`Shared`, `SharedFramework`, `SharedInfrastructure`, `SharedInfra`, `SharedUtilities`, -`SharedUtils`, `SharedLibrary`, `SharedLib`, `SharedHelpers` - -## ServerShared project names (exact) - -`ServerShared`, `ServerSharedFramework`, `ServerSharedInfrastructure`, `ServerSharedInfra`, -`ServerSharedUtilities`, `ServerSharedUtils`, `ServerSharedLibrary`, `ServerSharedLib`, -`ServerSharedHelpers` - -A `ServerShared` project is referenced automatically by every non-client-side project, and never by a -WebAssembly client, a `PurviewBrowserSafe` library, a Razor class library, a project named with a -client-side segment (`*.Client`, `*.ClientShared`, `*.Browser`, `*.Wasm`, `*.WebAssembly`, -`*.Components`, or exactly `Components`/`ClientShared`), or a `Shared`/`SharedTesting` project. -`IsClientSideProject` overrides the classification. `PRSHR0001` reports a client-side reference and -`PRSHR0002` a `Shared` reference; `PurviewBrowserSafe="true"` on the reference records an accepted -decision. - -## Shared testing project names (exact) - -`SharedTestingFramework`, `SharedTestingInfrastructure`, `SharedTestingInfra`, -`SharedTestingUtilities`, `SharedTestingUtils`, `SharedTestingLibrary`, `SharedTestingLib`, -`SharedTestingHelpers` - -These are matched whole, not as substrings. `SharedModels` is not a shared project. - -A shared-testing project is forced to `PurviewSharedTestingOutputType` (default `Library`), with -`IsTestProject` and `IsTestingPlatformApplication` cleared, because the test packages otherwise flip -it into an executable test host. Set `PurviewSharedTestingOutputType=Exe` to -keep that package-driven shape. - -## Packable projects - -Defaults applied only where the project supplied nothing: `GenerateDocumentationFile`, -`IncludeSymbols`, `SymbolPackageFormat=snupkg`, `PublishRepositoryUrl`, `EmbedUntrackedSources` and -`DebugType=portable`. `IncludeSource` stays `false`. - -- Portable PDBs ship in the `.snupkg`. The `.nupkg` receives none unless the project opts in. -- A README is packed and registered as `PackageReadmeFile` unless one is configured: the project's own - `README.md` wins, else the repository-root one; a README-named file already being packed (an - `Sdk/README.md`) is used instead. -- Non-packable projects, web apps included, default `WarnOnPackingNonPackableProject=false`, so a - solution-wide `dotnet pack` skips them silently. -- `ContinuousIntegrationBuild` is set only by real CI environment variables. Packability alone never - forces SourceLink's CI-mode dirty-repository checks. - -## Roslyn components - -A project that explicitly declares `IsRoslynComponent=true` gets: - -- a single `netstandard2.0` target, `LangVersion=latest`, `Nullable=enable`, - `TreatWarningsAsErrors=true`, `Deterministic=true`, extended analyzer rules -- SourceLink with `EmbedUntrackedSources=true`, no dependency file, telemetry excluded -- compiler-generated output under the framework-specific intermediate directory -- `PrivateAssets=all` on `Microsoft.CodeAnalysis.*` and `Microsoft.CodeAnalysis.Analyzers`, so they - never leak into the packed nuspec - -`IsRoslynComponentOnly` defaults to `true`: `IncludeBuildOutput=false`, `IncludeSymbols=false`, no -`.symbols.nupkg` or `.snupkg`, and the analyzer PDB shipped inside the main `.nupkg` under -`analyzers/dotnet/cs/` beside the assembly (`PurviewPackAnalyzerPdb=true`). Set it to `false` for a -dual-role component that wants normal library symbol packaging. - -`ValidateRoslynComponentCompilerSettings` fails the pack of a packable Roslyn component missing -`LangVersion`, `Nullable`, `TreatWarningsAsErrors` or `EnforceExtendedAnalyzerRules`. Opt out with -`DisableRoslynCompilerDefaultsValidation=true`. - -`PackProjectReferencedSourceGenerators` (default `true`) makes a packable project include analyzer -`ProjectReference` outputs and their runtime dependencies under `analyzers/dotnet/cs/`. Set it -`false` globally, or `Pack="false"` on one analyzer reference. - -## Special project types - -| Type | Applied | -| -- | -- | -| CLI | `OutputType=Exe`, `appsettings*.json` included as content | -| Container | `InvariantGlobalization`, `PublishAot`, Linux Docker defaults, container tooling packages | -| Web SDK | `Microsoft.AspNetCore.OpenApi.Generated` added to `InterceptorsNamespaces`, unless `IsWebProject=true` | -| Aspire host | `OutputType=Exe` (unless a test or shared-testing project), `CA1515` suppressed | -| Blazor WebAssembly client | not packable, no container defaults, no automatic `Shared`/`ServerShared` reference, the browser-safe reference check - see [blazor.md](blazor.md) | -| ServerShared project | referenced automatically by every non-client-side project; never by a WebAssembly client, browser-safe library, Razor class library, client-side name, or `Shared`/`SharedTesting` project | -| Blazor host | an automatic reference to its `.Client` - see [blazor.md](blazor.md) | -| BFF | no packages, no OpenAPI interceptor unless it exposes an API, `PDS0008`/`PDS0009` - see [blazor.md](blazor.md) | -| `PurviewBrowserSafe` library | `IsAotCompatible`, `SupportedPlatform browser`, trim/AOT/`CA1416` as errors - see [blazor.md](blazor.md) | - -## The Visual Studio refactorings - -Two ship with the code-fix assembly, both serving the `PDS0002` convention: - -- **Split extensions class into one class per receiver type** — offered on a static extensions class - targeting several receiver types. It produces one `Extensions` class per receiver - (a generic `this TBuilder where TBuilder : IHostApplicationBuilder` receiver becomes - `HostApplicationBuilderExtensions`) and places each under `Extensions//`. -- **Move extensions class to conventional location** (or **Rename extensions class to '…'** when it is - already in place but not conventionally named) — offered on a single-receiver extensions class. It re-paths the file to `Extensions//`, fixes the namespace - to the receiver's, and updates `using` directives in other referencing documents so the move - compiles. diff --git a/.agents/skills/purview-buildsdk-project-detection/references/test-types.md b/.agents/skills/purview-buildsdk-project-detection/references/test-types.md deleted file mode 100644 index dace44fc..00000000 --- a/.agents/skills/purview-buildsdk-project-detection/references/test-types.md +++ /dev/null @@ -1,35 +0,0 @@ -# The shipped `TestType` group - -These 53 names drive **`InternalsVisibleTo` generation**, not test detection. A non-test project -grants friend access to `{AssemblyName}.{TestType}Tests` for each name here. - -Detection is the pattern `^.*\.([\w|_]\w*)Tests?$`, so a suffix outside this group is still detected, -still runs and still gets its category — it simply cannot reach the target project's `internal` -members. Prefer a name from this group unless the test type genuinely needs its own word. - -```text -Unit Integration E2E EndToEnd Acceptance -Functional Performance Load Smoke Stress -Regression Security Chaos Scenario System -Threat BlackBox WhiteBox GrayBox GreyBox -Accessibility Usability Visual Interactive Localization -Globalization Environment Configuration Deployment Architecture -Contract Component Sanity Property Fuzz -Mutation Snapshot Approval Benchmark Capacity -Concurrency Endurance Soak Spike Failover -Recovery Resilience Compatibility Interoperability Migration -Upgrade Penetration Compliance -``` - -## The five to reach for first - -`Unit`, `Integration`, `E2E`, `Functional`, `Contract`. Everything else is available, but a reader -has to ask what it means — use one only when the test type itself carries operational weight. - -## What a suffix buys you - -| | detected as a test project | gets a category | gets a runner and coverage | sees `internal` members | -| -- | -- | -- | -- | -- | -| `Api.UnitTests` | yes | `Unit` | yes | yes | -| `Api.GoldenTests` | yes | `Golden` | yes | **no** | -| `UnitTests` *(no dot)* | **no** | no | **no** | no | diff --git a/.agents/skills/purview-buildsdk-project-layout/SKILL.md b/.agents/skills/purview-buildsdk-project-layout/SKILL.md deleted file mode 100644 index e339bd1a..00000000 --- a/.agents/skills/purview-buildsdk-project-layout/SKILL.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -name: purview-buildsdk-project-layout -description: Decide where a project goes and what to call it in a repository that uses Purview.BuildSdk. Use when creating, moving, splitting or renaming a project or test project, choosing a test suffix, choosing the target framework(s) for a project, aligning namespaces and assembly identity with NamespacePrefix, laying out a Blazor Web App host, WebAssembly client and browser-safe Contracts library, or relying on the SDK's automatic project references. Also use when rationalising a repository's shape so the SDK's conventions work without overrides. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Project layout and naming for Purview.BuildSdk - -Use this skill when physically adding, moving, splitting or renaming a project. - -For *why* the SDK classified an existing project a particular way, use -`purview-buildsdk-project-detection`. For the property that changes a behaviour, use -`purview-buildsdk-configuration`. - -## First principle - -**Treat naming and placement as configuration, not decoration.** - -The SDK infers namespaces, assembly identity, test categories, package wiring and project references -from a small set of conventions. The closer a repository sits to them, the fewer overrides it needs. - -The corollary matters just as much: **preserve the host repository's existing layout first.** Only -introduce new structure when no established pattern exists. - -## Canonical layout - -```text -/ - package.json version source - .editorconfig bootstrapped by the SDK - skills/ authored agent skills, if any - src/ - .slnx - src//.csproj - tests/.Tests/.Tests.csproj -``` - -- The `.csproj` filename must equal its containing directory name, unless - `DisableProjectFileNamingConventionCheck=true`. -- Source projects under `src/src/`, test projects under `src/tests/`, the solution in `src/`. -- Place a new project beside similar ones — same language, layer and test type. -- One test type per project by default. - -A repository that already uses a different shape keeps it; add to it rather than converting it. - -## Naming and identity - -`NamespacePrefix` is the root identity source. Keep project names short and let the SDK apply the -prefix: - -| `NamespacePrefix` | Project | `RootNamespace` | -| -- | -- | -- | -| `Aspire` | `Hosting` | `Aspire.Hosting` | -| `Acme.Sales.RegionalPipeline` | `Identity.API` | `Acme.Sales.RegionalPipeline.Identity.API` | -| `Acme.Sales.RegionalPipeline` | `Identity.Core` | `Acme.Sales.RegionalPipeline.Identity` | - -`AssemblyName` and `PackageId` follow the resolved `RootNamespace` — except where suffix-stripping -removed a segment (`Core`, `Shared`, `ServiceDefaults`), in which case they keep the fuller logical -name so the artifacts stay distinct from their parent. Explicit values always win, and -`EnableAssemblyNameGeneration=false` (before the SDK import) restores standard behaviour. - -Do not hand-author an alternate namespace scheme when one is already in use. - -## Test project naming - -Test detection is a **pattern**, not a list: `^.*\.([\w|_]\w*)Tests?$`. A target name, a dot, then -any word before `Test` or `Tests`. The captured word becomes `TestingType` and the baseline category. - -**The dot is required.** A project named plainly `UnitTests`, with no target in front of it, is not -detected as a test project at all — no runner, no coverage, no `InternalsVisibleTo`, no category. -Always name a test project `.Tests`. - -Prefer these by default: `UnitTests`, `IntegrationTests`, `E2ETests`, `FunctionalTests`, -`ContractTests`. Use another suffix only when the test type itself carries operational meaning. - -A suffix outside the SDK's shipped `TestType` group still builds, runs and gets its category — it -just cannot reach the target project's `internal` members, because that group drives -`InternalsVisibleTo` generation. The full list is in `purview-buildsdk-project-detection`. - -## Shared projects: exact names only - -The SDK recognises these names exactly — a near miss gets none of the behaviour. - -Shared: `Shared`, `SharedFramework`, `SharedInfrastructure`, `SharedInfra`, `SharedUtilities`, -`SharedUtils`, `SharedLibrary`, `SharedLib`, `SharedHelpers`. - -Shared testing: `SharedTestingFramework`, `SharedTestingInfrastructure`, `SharedTestingInfra`, -`SharedTestingUtilities`, `SharedTestingUtils`, `SharedTestingLibrary`, `SharedTestingLib`, -`SharedTestingHelpers`. - -## Target frameworks - -A new project should inherit the SDK's default set (`net10.0;net11.0`) rather than pin its own TFMs, so -a lifecycle change is one SDK bump rather than an edit in every project. When a project genuinely needs -a different set, select one with `PurviewTargetFrameworkSet` (`Current`, `Latest`, `Supported`, `Broad`, -`All`) or declare `TargetFramework`/`TargetFrameworks` — an explicit value always wins over every set, -with or without a `Condition`. A Roslyn component targets `netstandard2.0`. -See `purview-buildsdk-configuration`. - -## Automatic project references to preserve - -Layout is what makes these work. Move a project off the convention and you own the reference. - -Test projects probe for their target, in order: - -- `../$(TargetProjectName)/$(TargetProjectName).csproj` -- `../../$(TargetProjectName)/$(TargetProjectName).csproj` -- `../src/$(TargetProjectName)/$(TargetProjectName).csproj` -- `../../src/$(TargetProjectName)/$(TargetProjectName).csproj` - -Non-test projects pick up sibling shared projects via `../Shared*/Shared*.csproj`; test projects -pick up `../SharedTesting*/SharedTesting*.csproj`. A Blazor WebAssembly client is the exception: it -does not pick up `Shared*`, because everything it references is downloaded to the browser. - -## Blazor Web App: host and client - -```text -src/src/ - Shop/Shop.csproj Microsoft.NET.Sdk.Web - the host - Shop.Client/Shop.Client.csproj Microsoft.NET.Sdk.BlazorWebAssembly - the client - Shop.ClientShared/Shop.ClientShared.csproj a PurviewBrowserSafe library both use - Shop.Bff/Shop.Bff.csproj a BFF, when tokens are kept server-side in a separate host -src/tests/ - Shop.Client.UnitTests/ TargetProjectName = Shop.Client -``` - -- A web host named `` beside a WebAssembly client named `.Client` is the pairing the SDK - recognises: the host gets `IsBlazorHostProject=true` and a reference to the client automatically - (skipped when declared; `PurviewAutoBlazorClientReference=false` opts out). -- Identities with `NamespacePrefix=Acme`: `Shop.Client` is `Acme.Shop.Client`; `Shop.Bff` is - `Acme.Shop.Bff`; `ClientShared` is a stripped segment, so `Shop.ClientShared` has namespace - `Acme.Shop` and assembly `Acme.Shop.ClientShared`. -- Every library the client references must set `true`, or the - build reports `PRBLZ0001`. Keep server-only code (file, process, database access) out of anything - the client references. -- Name a BFF host `*Bff` (case-sensitive) for `IsBffProject=true`. Being the client's host does not - make a project a BFF. - -## Creating a new project - -1. Match the SDK and style of sibling projects. -2. Use Central Package Management if the repository has it. -3. Add only the dependencies the project's scope needs — the SDK supplies the testing stack, - SourceLink and telemetry by default. -4. Add the project to the solution. -5. Keep target frameworks, nullability, analyzers and warning settings consistent with neighbours. - -## Moving or splitting - -1. Create the destination using the established layout. -2. Move the files. -3. Update namespaces, usings and references for the destination. -4. Verify the destination still produces the intended `TestingType`, `TargetProjectName` and - `RootNamespace` — ask MSBuild rather than assuming: - `dotnet msbuild -getProperty:RootNamespace -getProperty:TargetProjectName`. -5. Remove dependencies the source no longer needs. -6. Update solution membership and project references. -7. Build, then run the affected tests. - -## Guardrails - -- Prefer minimal, targeted diffs; avoid cross-cutting renames unrelated to the move. -- Keep test intent unchanged while relocating. -- When the structure is ambiguous, infer from the nearest sibling projects and say which assumption - you made. -- When in doubt, preserve compatibility with the SDK's automatic naming, namespace and - project-reference behaviour. diff --git a/.agents/skills/purview-buildsdk-repository-review/SKILL.md b/.agents/skills/purview-buildsdk-repository-review/SKILL.md deleted file mode 100644 index 15f90c00..00000000 --- a/.agents/skills/purview-buildsdk-repository-review/SKILL.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -name: purview-buildsdk-repository-review -description: Review a repository that uses Purview.BuildSdk for naming, placement, test-structure and agent-skill-management alignment, and report what the SDK can and cannot do automatically as a result. Use when asked to audit, rationalise or health-check a repo against the SDK's conventions, when onboarding an existing codebase onto Purview.BuildSdk, or when deciding whether a layout quirk is worth changing. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Reviewing a repository against the SDK's conventions - -This is an audit, not a refactor. The deliverable is a prioritised list of findings and the cost of -each, so somebody else can decide what to change. - -For the conventions themselves use `purview-buildsdk-project-layout`; for why one project was -classified as it was, `purview-buildsdk-project-detection`. - -## The governing judgement - -**Deviation is only a finding when it costs the repository something.** The SDK infers behaviour -from naming and placement, so a deviation is interesting precisely to the extent that it turns an -automatic behaviour off. A layout that differs from the canonical one but still gets every automatic -behaviour is not debt, and reporting it as such wastes the reader's attention. - -Sort every finding into one of three buckets, and say which: - -| Bucket | Meaning | -| -- | -- | -| **Acceptable variance** | Differs from the canonical layout, costs nothing. Preserve it. | -| **Structural debt** | Blocks an automatic behaviour the repository would benefit from. | -| **Incremental opportunity** | Low-risk tidying worth doing when the area is touched anyway. | - -## 1. Read before concluding - -Inspect, in this order, before forming any opinion: - -- `Directory.Build.props` and `Directory.Build.targets` — where the SDK is imported, and what is set - before the import -- `global.json` (the pinned SDK version) and repo `package.json` (the product version) -- the solution entry point, for what is actually in the build -- `Directory.Packages.props`, for Central Package Management -- the project layout on disk - -## 2. Check the structural signals - -- Source projects under `src/src/`, test projects under `src/tests/`, the solution in `src/`. -- `.csproj` filename equals its containing directory name — unless - `DisableProjectFileNamingConventionCheck=true`, which is itself a finding worth surfacing. -- Short project names, with `NamespacePrefix` carrying the repository identity. -- Test project names match `^.*\.([\w|_]\w*)Tests?$`. **The dot is required**; a project named - plainly `UnitTests` is not detected at all and silently gets no runner, no coverage, no - `InternalsVisibleTo` and no category. This is the single highest-value thing to check. -- Test suffixes come from the SDK's shipped `TestType` group where `internal` access is wanted — a - suffix outside it still runs, it just cannot see `internal` members. -- Shared and shared-testing projects use the **exact** recognised names. A near miss gets none of - the behaviour. -- Target frameworks: a project should inherit the SDK's default set (`net10.0;net11.0`) or select a - curated `PurviewTargetFrameworkSet` (`Current`, `Latest`, `Supported`, `Broad`, `All`), not hard-code - a TFM list. A hard-coded list is an incremental opportunity. A TFM set in `Directory.Build.targets` - is structural debt: it is evaluated after the .NET SDK decides whether to multi-target, so it does - not take effect. A `Condition`-guarded `PurviewTargetFrameworkSet` is not seen at all - (`PurviewConditionedProjectDeclaration`). - -## 3. Verify with MSBuild, do not infer from folder names - -A review that reasons from directory names will be wrong about at least one project. Ask: - -```bash -dotnet msbuild -getProperty:RootNamespace -getProperty:AssemblyName \ - -getProperty:IsTestProject -getProperty:TestingType -getProperty:TargetProjectName -``` - -Quote the computed values in the findings. "`Api.Tests` resolves `TestingType=` empty, so it has no -runner" is actionable; "`Api.Tests` looks like it might not be detected" is not. - -## 4. Review test readability - -- Subject-based suites: `{SubjectName}Tests`, with - `{SubjectOrMemberUnderTest}_{Scenario}_{Expectation}` methods. -- Non-subject-based suites — build, generator, workflow, package, full-system — named clearly for - their broader role. A forced `{Subject}Tests` on one of these is worse, not better. -- TUnit categories and display names used where a suite is large enough to need navigating. - -See `purview-buildsdk-testing`. - -## 5. Check the test dependencies are earned - -The SDK already supplies `TUnit`, `TUnit.Mocks`, `Bogus` and the Microsoft.Testing.Platform wiring -to every detected test project. Anything beyond that was a deliberate choice, and deliberate choices -go stale: - -- `TUnit.Aspire` and `Purview.Containers` are **not** universal defaults. Confirm each reference is - genuinely needed by that project rather than copied from a sibling. -- Where a project references `Testcontainers` directly, check whether a `Purview.Containers` typed - module now covers it — the module set grows, and a direct reference that was once necessary often - is not any more. -- A package the SDK already adds, restated in a project file, is maintenance cost with no effect. - -## 6. Check how agent skills are managed - -Only relevant when the repository has a `skills-lock.json` or an agent skills directory: - -- **Anything that runs `InstallPurviewSkills`, `UpdatePurviewSkills` or `FixPurviewSkills` - implicitly** — an `AfterTargets`/`BeforeTargets` hook, a `*DependsOn` property, a git hook, a - `just` recipe dependency — is structural debt: skill changes should only happen when somebody asks. - The SDK fails the build-time cases with `PRSKL0009` (inside a build, a restore or a design-time - build); a git hook or a recipe dependency that runs the target on its own is **not** caught, so - look for those by reading the hook configuration and the `Justfile`. -- **Hand-written skill scripts** (`update-agent-skills.ts`, `ensure-universal-skills.ts`, - `package.json` `skills:*` entries) are an incremental opportunity: the SDK targets wrap the same - standard CLI, from the repository root, once per solution. See `purview-buildsdk-justfile`. -- **A fresh clone**: a committed `skills-lock.json` with no agent skills directory beside it means the - skills were never restored — `-t:InstallPurviewSkills` (`skills experimental_install`) restores them. -- **Layout**: if `PurviewSkillsAgents` is set, run `-t:CheckPurviewSkills` and quote any `PRSKL0015`. - If it is not set, every agent directory is legitimate — that is acceptable variance, not a finding. - -## 7. Explain consequences, not just mismatches - -For each finding, name the specific automatic behaviour that is lost: `RootNamespace`, -`AssemblyName`, `PackageId`, `TargetProjectName`, the automatic target-project reference, the -sibling `Shared*` reference, `InternalsVisibleTo` generation, the test runner and coverage wiring. - -"Project is not under `src/`" is not a finding. "Project is not under `src/`, so the test project's -four probe paths all miss and the `ProjectReference` has to be maintained by hand" is. - -## Reporting the result - -1. One sentence on whether the repository broadly fits the SDK's conventions. -2. The findings, ordered by impact, each with its bucket and the behaviour it costs. -3. The low-risk rationalisation steps, as concrete renames or moves. -4. An explicit split of what is **already automatic** versus what this repository has configured by - hand — that list is usually the most useful part of the review, because hand-configuration that - merely restates a default is pure maintenance cost. - -Do not propose a cross-cutting rename as a first step. Name the one change with the best -cost-to-benefit ratio and say what it unlocks. diff --git a/.agents/skills/purview-buildsdk-settings-docs-sync/SKILL.md b/.agents/skills/purview-buildsdk-settings-docs-sync/SKILL.md deleted file mode 100644 index 728a0a61..00000000 --- a/.agents/skills/purview-buildsdk-settings-docs-sync/SKILL.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -name: purview-buildsdk-settings-docs-sync -description: Change or document a Purview.BuildSdk setting without leaving part of the surface behind. Use when flipping a .NET 11 compiler feature default (Runtime Async, memory-safety rules), adding or renaming a property, or making sure every skill and doc explains how to set required settings and versions, the target framework(s), and the compiler-visible (build_property.*) settings. Repository-local guidance for purview-dev/build-sdk. -license: MIT -metadata: - scope: repository-local - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Keeping settings, docs and skills in step - -> **Repository-local.** This skill lives in `.agents/skills/` and is tracked by name (the rest of that -> folder is gitignored); it is not packed and not published. It is deliberately **not** linked from -> `AGENTS.md`: `RepositorySkillsSelfTests` fails any AGENTS.md link that points into `.agents/skills/`. -> The published skills are authored under `skills/` and are a different thing entirely. - -## The general sweep is a published skill - -This skill is the **settings** sweep for this repository. Any other documentation change — a renamed -recipe, a new wiki page, a moved page, a skill whose scope grew, an audit of whether the docs are -still true — follows the published -[`purview-buildsdk-docs-sync`](../../../skills/purview-buildsdk-docs-sync/SKILL.md) skill: every -claim checked against the code, and the wiki kept hierarchical. In this repository the wiki's root -pages are exactly `Getting-Started.md` (the site's `docs.rootPage`), `Configuration-Reference.md` and -`Repository-Bootstrap.md` (the site catalogue's `docsPage` deep links); every other page lives in one -topic folder, and `DocumentationWikiTests` holds the folders, `_Sidebar.md` and `Home.md` to that. - -## Start from the schema - -`src/src/BuildSdk/Sdk/Sdk.props.buildschema.json` is the canonical description of every SDK property — -description, type and default — and `PropertySchemaTests` holds the code, the `CompilerVisibleProperty` -list, `README.md` and `docs/wiki/Configuration-Reference.md` to it. The generic method (where a -sidecar goes, when a property is pre-import, when to export it, how to rename or retire one) is the -published [`purview-buildsdk-msbuild-properties`](../../../skills/purview-buildsdk-msbuild-properties/SKILL.md) -skill. In this repository, adding a property means: - -1. `Sdk/Props/Defaults.props` — the default, guarded with `'$(X)' == ''`. -2. `Sdk/Sdk.props.buildschema.json` — the entry. `defaultValue` is what a plain class library evaluates - to; without one, end the description with `No default: .`; when `Sdk.props` (or a file it - imports) reads the property, say `Set it before the \`Sdk.props\` import.` The test computes both - from the XML and fails if the description disagrees. -3. `Sdk/Sdk.props` — a `CompilerVisibleProperty` with a ``, only if an analyzer reads it. -4. `README.md` and `docs/wiki/Configuration-Reference.md` — a row in the table for its area (the - Default cell opens with the backticked default, or italics when there is none), plus a row in each - *Compiler-visible SDK properties* table when exported. -5. `CHANGELOG.md` — under the `package.json` version's heading (see the Changelog row below). -6. `just properties-check` — every failure names the file and the row to add. - -A property that must not appear in IntelliSense goes in -`src/tests/BuildSdk.IntegrationTests/PropertySchema/SdkPropertyClassification.cs` with a reason: -`ExternallyOwned` (MSBuild/.NET/NuGet), `Internal` (unprefixed implementation detail), -`ComputedDefaults` (machine- or project-dependent value). Prefer a `_` prefix for anything new and -internal — then no list is needed. - -## The rule this exists for - -A property is written down in several places, and only some of them are checked by a test. The failure -mode this repository keeps hitting is a change that lands in one place and stops there — the property -declaration, its validation, `README.md`, the wiki page and the shipped skills drift apart, and the -only evidence is a consumer following a doc that still describes last release's default. - -So: **treat a settings change as a sweep, not an edit.** Work the surfaces below, then prove it with -the validation commands at the end. - -## When to use this - -- Flipping a .NET 11 compiler feature default (`MemorySafetyRules`, `PurviewRuntimeAsync`). -- Adding, renaming, re-defaulting or removing a user-facing property. -- Making required settings, versions, target frameworks or compiler-visible settings clearer in the - docs and the shipped skills. -- Auditing whether a property is documented everywhere before you change it. - -For auditing a *consumer* repository, use `purview-buildsdk-repository-review`. For what a project -detection rule does, use `purview-buildsdk-project-detection`. - -## The surfaces — one property, many homes - -Find the row and make sure every file agrees. - -| Surface | File | What changes | -| -- | -- | -- | -| Runtime default (all projects) | `src/src/BuildSdk/Sdk/Props/Defaults.props` | The default when unset, plus the explanatory comment. Sets the value in `Sdk.props`, which is also what makes it compiler-visible. | -| Per-TFM default | `src/src/BuildSdk/Sdk/Targets/Modern.targets` | The `net11.0`+ feature selection. Must agree with `Defaults.props`. | -| Property schema | `src/src/BuildSdk/Sdk/Sdk.props.buildschema.json` | Description, type and `defaultValue` — what csproj IntelliSense shows. `PropertySchemaTests` fails when it disagrees with the code or the docs. | -| Compiler-visible description | `src/src/BuildSdk/Sdk/Sdk.props` | The `CompilerVisibleProperty` ``, which is what an analyzer author reads. | -| Pinning test | `src/tests/BuildSdk.IntegrationTests/Dotnet11FeaturesTests.cs` | The test that fails when the default changes silently. | -| Changelog | `CHANGELOG.md` | An entry under `## [] - `: `### Changed` for behaviour, `### Documentation` for docs-only. Never `[Unreleased]` during active development — a merge to `main` publishes the version, so the entry would read as unreleased until it was already live. `[Unreleased]` is only for a pre-release version (`-alpha`, `-beta`, `-rc`). | -| README | `README.md` | The feature table row, the property table(s), the quick start, and the `.NET 11 features` section + tiers paragraph. | -| Wiki | `docs/wiki/Configuration-Reference.md`, `Getting-Started.md`, `configuration/Version-Detection.md`, `concepts/Project-Type-Detection.md` | The property tables, the required-settings and target-framework sections, and the compiler-visible section. | -| Shipped skills | `skills/purview-buildsdk-*/SKILL.md` and `references/*.md` | The property tables and the sections below. | -| AGENTS.md | `AGENTS.md` | The "authored set, and what each one answers" table, when a skill's scope grows. | - -Two traps worth naming: - -- **The default lives in two places.** `Defaults.props` defaults the property for every project (which - is what exposes it to the compiler); `Modern.targets` re-defaults it per-TFM. Change one and the - other silently disagrees. -- **`Sdk.props` vs `Sdk.targets` decides *where* a value may be set.** A property read during - `Sdk.props` evaluation must be set before the import; everything else can be set in the project. Say - which it is, in the docs, next to the property. - -A **feature** bigger than a single property gets its own guide as well. SourceLink is the worked -example, because the decision is per repository host: add a wiki page in its topic folder -(`docs/wiki/packaging/SourceLink.md`) and register it in `_Sidebar.md` **and** that section's table in -`Home.md` — `DocumentationWikiTests` fails until both list it — add a `## ` section to `README.md`, and — when -it is configuration — a `references/.md` under -`skills/purview-buildsdk-configuration/` that the `SKILL.md` links. Fix any wrong package or property -name you find while documenting: the SourceLink pages used to name `Microsoft.SourceLink.AzureDevOps.Git`, -which does not exist. - -## Worked example — flip a .NET 11 compiler feature default - -1. `Defaults.props` — change the default and the comment. Say **why** (an experimental compiler feature - is opt-in), not just what. -2. `Modern.targets` — change the same default in the per-TFM block and its header comment. -3. `Sdk.props` — the `CompilerVisibleProperty` `` ("0 off (default), …"). -4. `Dotnet11FeaturesTests.cs` — make the default test assert the switch is **absent**, rename it to say - so, and add an explicit opt-in test. De-couple any other test that asserted the switch was on by - default (for example, the project-features-survive test). -5. `README.md` — the `.NET 11 opt-ins` row, the `.NET 11 features` table row and the tiers paragraph, - and the property table row. -6. `docs/wiki/Configuration-Reference.md` — the General row **and** the `.NET 11 features` table. -7. Skills — the `MemorySafetyRules`/`PurviewRuntimeAsync` rows in - `skills/purview-buildsdk-configuration/SKILL.md` and `references/properties.md`. -8. `CHANGELOG.md` — a `### Changed` entry under the `package.json` version's heading that names the old default, the new one, how to - opt in, and what is unchanged. - -Keep `AllowUnsafeBlocks` (and anything else) at its compiler default: a feature flip must not quietly -change a second setting. - -## Required settings and versions — where it must be said - -Four values, stated as a table wherever a reader lands first: - -| Setting | Home | -| -- | -- | -| `NamespacePrefix` (required, pre-import) | `Directory.Build.props`, above the `` | -| SDK version | `global.json` → `msbuild-sdks.Purview.BuildSdk` (`PurviewBuildSdkVersionForGlobalJson` decides what the bootstrap writes) | -| Product version | repo-root `package.json` → `version` (`UsePackageJsonVersion`, `RootPackageJson`) | -| Package versions | `Directory.Packages.props` (CPM; a `PackageVersion` is a minimum) | - -Keep it identical in all four homes: `README.md` quick start, `docs/wiki/Configuration-Reference.md`, -`docs/wiki/Getting-Started.md`, and the `purview-buildsdk-adoption` and -`purview-buildsdk-configuration` skills. - -## Target framework(s) — where it must be said - -Every skill and doc that talks about configuring a project must explain how to set the target -framework(s), consistently: - -- the default set is `net10.0;net11.0` (`Current`); -- an explicit `TargetFramework`/`TargetFrameworks` always wins over every set, wherever it is set - except `Directory.Build.targets` (`Targets/TargetFrameworkOwnership.targets` reconciles it); -- a curated `PurviewTargetFrameworkSet` (`Current`, `Latest`, `Supported`, `Broad`, `All`) or a - redefined `PurviewTargetFrameworks` (pre-import, in `Directory.Build.props`); -- a Roslyn component keeps `netstandard2.0` and ignores the sets (`PurviewTargetFrameworkSetIgnored`). - -The canonical home is `skills/purview-buildsdk-configuration/SKILL.md` and its -`references/properties.md`; the other skills point at it rather than restating the whole thing. - -## Compiler-visible settings — where it must be said - -The `CompilerVisibleProperty` → `build_property.*` mechanism, plus a one-line -`AnalyzerConfigOptionsProvider.GlobalOptions.TryGetValue("build_property.X", …)` example, belongs in: - -- `skills/purview-buildsdk-configuration/SKILL.md` and `references/properties.md`, -- `skills/purview-buildsdk-project-detection/SKILL.md` (the analyzers section), -- `README.md`, `docs/wiki/Configuration-Reference.md` and `docs/wiki/concepts/Project-Type-Detection.md`. - -Say both halves: **consume** the exported property instead of re-deriving SDK behaviour, and **add a -new one** by listing it as a `CompilerVisibleProperty` item (with a ``) in `Sdk.props` — -nothing else exposes an MSBuild property to the compiler. - -## Skills sweep - -Each published skill that touches project configuration gets the change; a skill that is only about -skills tooling does not. - -| Skill | What to update | -| -- | -- | -| `purview-buildsdk-configuration` | required settings, target framework(s), compiler-visible properties, the property table, `references/properties.md` | -| `purview-buildsdk-adoption` | the required-settings table and `global.json` example, the target-framework step | -| `purview-buildsdk-project-layout` | the target-framework section | -| `purview-buildsdk-project-detection` | the target-framework subsection, the `build_property.*` note | -| `purview-buildsdk-repository-review` | the read list (`global.json`, `package.json`), the target-framework finding | -| `purview-buildsdk-testing` | the test-project target-framework paragraph | -| `purview-buildsdk-skill-tests`, `-skill-installation`, `-justfile` | **not** project configuration — leave them alone | - -Also update each skill's frontmatter `description` so the change makes the skill **fire** on the right -question ("setting the target framework(s)", "pinning the SDK version in global.json"). - -## Validate - -```bash -just build -just skills-validate # PRSKL0005, the pack-time check -just version-sync-check # the version pins must still match package.json -just lint-check # CSharpier over the repo -just properties-check # schema vs props, defaults, compiler-visible list, README and wiki tables - -# Targeted and fast (MTP: --treenode-filter, never --filter): -dotnet test --project src/BuildSdk.slnx --configuration Debug \ - --treenode-filter "/*/*/Dotnet11FeaturesTests/*" --ignore-exit-code 8 -dotnet test --project src/BuildSdk.slnx --configuration Debug \ - --treenode-filter "/*/*/(TargetFrameworkSetTests)|(PropertySchemaTests)|(CoreDefaultsTests)/*" --ignore-exit-code 8 -dotnet test --project src/BuildSdk.slnx --configuration Debug \ - --treenode-filter "/*/*/(RepositorySkillTests)|(RepositorySkillsSelfTests)|(PurviewSkillValidationTests)/*" --ignore-exit-code 8 -``` - -State the commands you ran before declaring the change done. - -## Guardrails - -- **Do not publish repository-local advice.** Anything under `skills/` ships to every consumer through - `npx skills add purview-dev/build-sdk`; guidance about working *in this repository* stays here, in - `.agents/skills/`, or in `AGENTS.md`. -- **Do not add a link into `.agents/skills/` from `AGENTS.md`** — it is gitignored, so the link is - broken in a fresh clone and `RepositorySkillsSelfTests` fails the build. -- **Do not give a local skill an authored skill's name.** - `AuthoredSkillsAreNotInstalledIntoTheAgentDirectories` fails when a folder here collides with one - under `skills/`. -- **Preserve a default unless the task explicitly changes product behaviour.** A docs task is not - licence to re-default anything. -- **Do not restate a default in a consumer project file** — recommend deleting the repetition instead. -- **Never force-add `.agents/skills/`.** Everything the CLI writes is reproducible from - `skills-lock.json`; `InstalledSkillsAreNotTracked` fails if any of it is committed. -- Keep changes small, use Conventional Commits, and do not mix an unrelated refactor into the sweep. - diff --git a/.agents/skills/purview-buildsdk-skill-installation/SKILL.md b/.agents/skills/purview-buildsdk-skill-installation/SKILL.md deleted file mode 100644 index 545eb9fa..00000000 --- a/.agents/skills/purview-buildsdk-skill-installation/SKILL.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -name: purview-buildsdk-skill-installation -description: Install, update, check and tidy agent skills in a repository that uses Purview.BuildSdk, through the standard skills CLI (bun x skills). Use for the InstallPurviewSkills, UpdatePurviewSkills, CheckPurviewSkills and FixPurviewSkills MSBuild targets, for installing skills from a repository's root skills/ folder (owner/repo#ref), for restoring skills-lock.json in a fresh clone, for choosing agents with PurviewSkillsAgents, for any PRSKL diagnostic, for choosing a package runner (bun x, npx, pnpm dlx, bunx, yarn dlx, deno), or when an agent cannot see a skill that should be installed. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Installing agent skills - -For *authoring* skills, use `purview-buildsdk-skill-tests`; for `just` recipes that run these -targets, `purview-buildsdk-justfile`. - -## The one thing to understand first - -**The SDK is a thin wrapper over the standard skills CLI, and adds nothing bespoke.** A repository -publishes skills in its root `skills/` folder; the skills CLI installs them with -`bun x skills add owner/repo` and records each install in `skills-lock.json`. The SDK's targets only -run that CLI — from the repository root, once per solution, never during a build — and keep the -agent directories tidy. There is no package-to-skill mapping: a NuGet package carries .NET artifacts, -and skills come from git. - -The SDK writes nothing into an agent directory itself. The CLI is the single writer, because its -universal install location is `.agents/skills/` and a second writer on the same paths would overwrite -a pinned install. - -```bash -dotnet msbuild -t:InstallPurviewSkills -p:PurviewSkillsSource=purview-dev/build-sdk # add a source -dotnet msbuild -t:InstallPurviewSkills # restore skills-lock.json (a fresh clone) -dotnet msbuild -t:UpdatePurviewSkills # re-add every lockfile source at its latest -dotnet msbuild -t:CheckPurviewSkills # only the PurviewSkillsAgents directories exist -dotnet msbuild -t:FixPurviewSkills # remove the CLI's links from any other agent directory -``` - -They run **only when named**. None has `BeforeTargets` or `AfterTargets`, nothing in the SDK depends -on them, and `InstallPurviewSkills`, `UpdatePurviewSkills` and `FixPurviewSkills` refuse to run when -something pulls them into a build, a restore or a design-time build (`PRSKL0009`). A git hook or a -`just` recipe dependency that runs one on its own is not caught by that — do not wire them up that way. - -Name **the solution**. Skills belong to the repository, so each target runs once however many projects -the solution holds: every project hands the work to the same elected leader, and MSBuild runs it once. -A single project works too. - -## Installing - -| Command | Runs | -| -- | -- | -| `-t:InstallPurviewSkills -p:PurviewSkillsSource=owner/repo` | `skills add "owner/repo" --skill "*"` — every skill in that repository's root `skills/` | -| `-t:InstallPurviewSkills -p:PurviewSkillsSource=owner/repo#` | the same, pinned to a commit, tag or branch | -| `-t:InstallPurviewSkills` | `skills experimental_install` — restore exactly what `skills-lock.json` records | - -The caller owns the ref: append `#` to pin it. With no source and no `skills-lock.json` there is -nothing to install, which is `PRSKL0007`. `bun x skills add` works just as well run directly; the -target exists so a repository uses one runner, one root and one agent selection everywhere. - -## Updating - -```bash -dotnet msbuild -t:UpdatePurviewSkills -p:PurviewSkillsDryRun=true # see the commands first -dotnet msbuild -t:UpdatePurviewSkills -``` - -`UpdatePurviewSkills` re-adds every unique source recorded in `skills-lock.json` with -`skills add "" --skill "*"`, at its latest. That is the whole update: `skills add` reinstalls -every skill it selects, so one re-add both refreshes the installed skills and adds any the source has -gained, whereas `skills update` would only re-fetch what the lockfile already lists, and is never run. -Every source is attempted even when one fails, and each failure is named (`PRSKL0008`). No lockfile is -`PRSKL0007`. - -## Choosing agents - -`PurviewSkillsAgents` is **empty by default**, which passes no `--agent` and lets the CLI auto-detect -the agents on the machine. Set it to choose — in `Directory.Build.props` -(`universal`), or on a command line with the separator -escaped, because `dotnet msbuild -p:` itself splits on `,` and `;`: - -```bash -dotnet msbuild -t:UpdatePurviewSkills -p:PurviewSkillsAgents=claude-code%2Ccodex -``` - -Each agent becomes its own `--agent` flag; the CLI does not split a comma-separated value. A restore -(`experimental_install`) is passed no agent flag. - -When `PurviewSkillsAgents` is set, `CheckPurviewSkills` fails (`PRSKL0015`) for any agent skill -directory at the repository root that belongs to an agent it does not name. `.agents/skills` is always -allowed — it is the CLI's canonical store — and the authored `skills/` folder is never touched. -`FixPurviewSkills` removes links (symlinks, junctions) from those directories, never their targets, -and then any folder left empty; a real file is kept and reported, because it is not provably the -CLI's. The agent-to-directory map is the `PurviewSkillsAgentDirectory` item group, taken from the -CLI's own agent table; an agent it does not know is `PRSKL0016`, fixed by adding an item: - -```xml - -``` - -With `PurviewSkillsAgents` empty, both targets say so and do nothing: every agent directory is then a -legitimate destination. - -## Diagnostics - -| Code | Meaning | Fix | -| -- | -- | -- | -| `PRSKL0003` | No repository root resolved | Pass `-p:PurviewSkillsInstallRoot=`, or add an `AGENTS.md` at the root | -| `PRSKL0004` | No skills CLI and no package runner found | Install Bun or Node, or set `PurviewSkillsCommand` | -| `PRSKL0005` | An authored skill is malformed | See `purview-buildsdk-skill-tests` | -| `PRSKL0007` | Nothing to install or update: no `PurviewSkillsSource`, and no `skills-lock.json` | Install from a source first | -| `PRSKL0008` | Re-adding a lockfile source failed | Read the CLI output above it | -| `PRSKL0009` | Install, update or fix was pulled into a build, a restore or a design-time build | Remove the hook; run the target on its own | -| `PRSKL0015` | An agent skill directory exists for an agent `PurviewSkillsAgents` does not name | `-t:FixPurviewSkills`, then remove anything it kept by hand | -| `PRSKL0016` | `PurviewSkillsAgents` names an agent with no known skills directory | Warning. Add a `PurviewSkillsAgentDirectory` item | - -`PRSKL0001`, `PRSKL0002`, `PRSKL0006`, `PRSKL0010`–`PRSKL0014` and `PRSKL0017` are retired: they -belonged to the package-to-skill mapping and recommendation targets, which are gone. - -## Package runners - -The CLI is published to npm, and every runner spells "run this npm package" differently. -`PurviewSkillsRunner` selects one, defaulting to `bun` (`bun x skills`). - -| Runner | Invocation | -| -- | -- | -| `bun` *(default)* | `bun x skills@1` | -| `npx` | `npx -y skills@1` | -| `bunx` | `bunx skills@1` | -| `pnpm` | `pnpm dlx skills@1` | -| `yarn` | `yarn dlx skills@1` — Yarn 2+ only | -| `deno` | `deno run -A npm:skills@1` | -| `skills` | `skills` — already on `PATH`, no download | - -An unknown runner falls through to ` $(PurviewSkillsPackage)`, so it still works. The launcher -pins the CLI to a major (`PurviewSkillsPackage`, default `skills@1`). - -`DetectPurviewSkillsCli` probes `PATH` for `skills` first, then `$(PurviewSkillsRunner)`, then -`$(PurviewSkillsRunnerCandidates)`, honouring `PATHEXT` on Windows where these are `.cmd` shims. -`PATH` is read directly rather than by spawning a version check: deterministic, no process, and it -cannot hang on a cold download. **The runner actually found wins over the configured preference.** -`PurviewSkillsCommand` overrides the launcher entirely and skips detection. A dry run with no runner -on `PATH` prints the configured runner's command rather than failing. - -## Always the repository root - -`skills-lock.json` and the agent directories belong to the repository, not to a project, so every -skill target runs from one resolved root: - -1. `PurviewSkillsInstallRoot` — an explicit override -2. `PurviewSkillsRepoRoot` — only when the **user** set it -3. the `PurviewRepositoryRootMarkers` walk -4. `PurviewSkillsRepoRoot` / `RepoRoot` as the SDK guessed them -5. CI workspace variables -6. SourceLink's git `SourceRoot` - -There is deliberately **no project-directory fallback**. That would scatter a lockfile and an agent -directory through the tree, one per project. An unresolved root is `PRSKL0003`. - -The marker walk is described in [references/repository-root.md](references/repository-root.md); its -two-pass behaviour and its home-directory bound are both load-bearing. - -## Why the CLI rather than a reimplementation - -The CLI owns the agent-specific destinations and their discovery conventions, which differ per agent -and change independently of this SDK. It also owns `skills-lock.json`, which is what lets a fresh -clone restore the same set with `-t:InstallPurviewSkills` (`skills experimental_install`). There is -deliberately no competing lockfile and no competing metadata. diff --git a/.agents/skills/purview-buildsdk-skill-installation/references/repository-root.md b/.agents/skills/purview-buildsdk-skill-installation/references/repository-root.md deleted file mode 100644 index 64cd1c49..00000000 --- a/.agents/skills/purview-buildsdk-skill-installation/references/repository-root.md +++ /dev/null @@ -1,58 +0,0 @@ -# The repository-root marker walk - -`FindPurviewRepositoryRoot` is an inline MSBuild task driven by `PurviewRepositoryRootMarkers`: - -```text -.git/;.github/;.gitattributes;LICENSE.md;AGENTS.md;.agents/;CLAUDE.md;.claude/;package.json -``` - -A trailing slash marks a directory. A directory marker still matches a **file** of that name, -because `.git` is a directory in a clone but a file in a worktree or a submodule, and both identify -a repository root. - -## Three things that are load-bearing - -### It cannot be an MSBuild intrinsic - -`GetDirectoryNameOfFileAbove` matches **files only** and returns nothing for `.git/`, `.github/`, -`.agents/` or `.claude/` — four of the nine markers. Verified, not assumed. - -### Two passes - -- **Pass 1** — the first marker in the list is *definitive* and is searched all the way up. `.git/` - *is* the repository root, so a monorepo sub-package with its own `package.json` does not win. -- **Pass 2** — every other marker resolves nearest-ancestor-first, with list order breaking ties - inside a single directory. Searching them all to the top would let a stray `.claude/` in a - developer's home directory outrank the real root. - -### The home directory is never a candidate - -The home directory and everything above it are excluded. Without that bound, a project outside any -repository resolves to `~` and installs into it — and a `.claude/` or a `.github/` very commonly -sits there. A repository *below* the home directory is unaffected, because it is below it. - -## Why the marker walk outranks the evaluation-time guess - -`PurviewSkillsRepoRoot` is computed during evaluation from `RepoRoot` and an `AGENTS.md` walk-up. -An `AGENTS.md` can legitimately sit in a subdirectory, and resolving to it would put a lockfile and -an agent directory somewhere that is not the repository. - -`_PurviewSkillsRepoRootWasSpecified` is captured in `Sdk.props` *before* defaulting, so a value the -**user** set still outranks the walk while a value the SDK guessed does not. - -## A target's Condition is evaluated before its DependsOnTargets - -A property a dependency computes is still empty in the depending target's `Condition`. That is why -the unresolved-root check (`PRSKL0003`) is an `Error` inside a dependency target rather than a -`Condition` on the public target, and why the explicit-only guard (`PRSKL0009`) is a dependency target with -its own `Error` rather than a `Condition` on `InstallPurviewSkills`, `UpdatePurviewSkills` or -`FixPurviewSkills`. - -## The managed port - -`Purview.Skills.Testing` ships `SkillRepositoryRoot`, a managed port of the same walk with the same -default markers, so a test that validates a repository's skills resolves the same root the build -installs them into. In the Purview.BuildSdk repository the two are kept in step twice over: -`SkillRepositoryRootParityTests` runs the real MSBuild target and the managed port over the same -folders and compares the root and the matched marker, and `SkillRepositoryRootTests` pins the default -marker list itself — both are defaults nobody sets, so nothing else would notice them drifting apart. diff --git a/.agents/skills/purview-buildsdk-skill-tests/SKILL.md b/.agents/skills/purview-buildsdk-skill-tests/SKILL.md deleted file mode 100644 index e6def7d3..00000000 --- a/.agents/skills/purview-buildsdk-skill-tests/SKILL.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -name: purview-buildsdk-skill-tests -description: Author agent skills in a repository that uses Purview.BuildSdk, and validate them with Purview.Skills.Testing or the SDK's pack-time ValidatePurviewSkills target. Use when adding or renaming a skill, writing SKILL.md frontmatter, splitting content into references/ or scripts/, fixing a PRSKL0005 pack failure or a skill-name, skill-description or skill-bundled-resources test failure, or deciding where skills belong in a repository. -license: MIT -metadata: - package: Purview.Skills.Testing - repository: purview-dev/build-sdk ---- - -# Authoring and validating agent skills - -For installing skills a package ships, use `purview-buildsdk-skill-installation`. - -## Where skills live - -**At the repository root, in `skills//SKILL.md`.** Always. - -The skills CLI only discovers skills at a root `skills/` folder, and it reaches a repository by -cloning it, so nothing else is visible to it. Nothing is packed into a NuGet package — a package -carries .NET artifacts, and skills are delivered by the CLI from git. - -```text -skills/ - my-skill/ - SKILL.md required - references/ loaded on demand - scripts/ executable, run on demand - assets/ templates and static resources -``` - -Link to a skill by its **authored** path, `./skills//SKILL.md`. A link into `.agents/skills/` -points at a gitignored file that does not exist in a fresh clone. - -## `SKILL.md` format - -```markdown ---- -name: my-skill -description: What it does, and when to use it. Include the words a task would contain. -license: MIT -metadata: - package: My.Package ---- - -# My skill - -Instructions. -``` - -| Field | Required | Constraint | -| -- | -- | -- | -| `name` | yes | 1–64 chars, lowercase `a-z0-9` and single hyphens, no leading, trailing or consecutive hyphen, **must equal the folder name** | -| `description` | yes | 1–1024 chars, non-empty | -| `license` | no | A licence name, or the name of a bundled licence file | -| `compatibility` | no | ≤500 chars, only when the skill has real environment requirements | -| `metadata` | no | A map of string to string. Anything not defined above belongs here | -| `allowed-tools` | no | Space-separated pre-approved tools. Experimental | - -**There are no other top-level fields.** `category`, `roles` and `tags` are common inventions and a -strict client rejects them; put them under `metadata`. - -The full specification is at . -[references/authoring.md](references/authoring.md) covers description writing, naming for a shared -namespace, and progressive disclosure. - -## Progressive disclosure - -An agent loads a skill in three stages: the `name` and `description` at startup, the whole -`SKILL.md` body once the skill activates, and `references/`, `scripts/` or `assets/` only when the -task reaches them. - -So: keep `SKILL.md` **under 500 lines**, and move detail into `references/`. The body is a cost paid -on every activation; a reference file is paid only when it is needed. - -Keep file references one level deep from `SKILL.md`, and relative to the skill root. A path that -climbs out of the skill folder is broken everywhere except the authoring repository, because only -the skill's own folder is installed. - -## Validating - -### In tests — `Purview.Skills.Testing` - -```csharp -[InheritsTests] -public sealed class SkillTests : PurviewSkillTests; -``` - -**`[InheritsTests]` is load-bearing.** TUnit does not walk base types during discovery, so without -it the class compiles, the run is green and nothing is validated. TUnit reports `TUnit0030`; treat -it as an error. - -| Rule id | What it checks | -| -- | -- | -| `skills-discovery` | The folder, when present, holds at least one skill | -| `skill-structure` | Every folder has a `SKILL.md` whose frontmatter parses | -| `skill-name` | Spec-legal, unique, and equal to the folder name | -| `skill-description` | Present, non-empty, within 1024 characters | -| `skill-optional-fields` | Only spec-defined fields, each within its limit | -| `skill-bundled-resources` | Every linked file exists, inside the skill folder | -| `skill-body-size` | `SKILL.md` stays under the recommended 500 lines | - -A repository with **no** `skills/` folder passes every rule — authoring skills is optional. An -**empty** folder fails `skills-discovery`, because every other rule is vacuous against an empty -catalogue. - -Overrides: `RepositoryRoot` (default: the SDK's repository-root marker walk), -`SkillsFolderName` (default `skills`), and `SkipRule(string)`. - -The evaluator takes a `SkillCatalogue`, so a rule can be exercised against a fixture folder rather -than a real repository: a reader (`SkillManifestReader`/`SkillCatalogue`), an evaluator over the -in-memory model (`SkillPolicyEvaluator`), and a thin test base class (`PurviewSkillTests`). - -### At pack time — `ValidatePurviewSkills` - -It runs `BeforeTargets="Pack"`, so a malformed skill fails in the repository that owns it rather -than reaching the CLI, which would silently skip it. - -```bash -dotnet msbuild -t:ValidatePurviewSkills -``` - -Failures are reported as `PRSKL0005`, one per problem. Every authored skill is checked. - -The two checks overlap deliberately: the pack-time one runs without a test host, the test one -covers more of the specification. - -## What is deliberately not checked - -Prose quality, and whether an agent actually obeys the skill. A build can only check that a skill is -well formed. Treat a green run as "installable", not "good". diff --git a/.agents/skills/purview-buildsdk-skill-tests/references/authoring.md b/.agents/skills/purview-buildsdk-skill-tests/references/authoring.md deleted file mode 100644 index 03d9bbf8..00000000 --- a/.agents/skills/purview-buildsdk-skill-tests/references/authoring.md +++ /dev/null @@ -1,81 +0,0 @@ -# Authoring a skill that fires, and keeps firing - -## The description is the whole activation decision - -`name` and `description` are the only things loaded at startup. Everything else — the body, the -references, the scripts — is invisible until an agent has already decided to activate the skill on -the strength of those two fields. - -So write the description for a *matcher*, not for a reader: - -- Say **what it does** and **when to use it**, in that order. -- Include the words a real task would contain: the tool names, the file names, the error codes, the - property names, the phrases a person would type. -- Name the thing the skill is *not*, when a neighbouring skill could be confused with it. - -| | | -| -- | -- | -| Poor | `Helps with the build SDK.` | -| Better | `Configure Purview.BuildSdk from Directory.Build.props or a .csproj. Use when setting NamespacePrefix, choosing a testing framework, or working out whether a property must be set before the SDK import.` | - -The limit is 1024 characters. Most of that budget is better spent on trigger words than on prose. - -## Naming for a shared namespace - -Skills install into one flat directory per agent, shared with every other skill a developer has -installed from anywhere. A generic name is a collision waiting to happen, and the loser is whichever -one installed second. - -- Prefix with the vendor and the product: `purview-buildsdk-configuration`, not `sdk-configuration`. -- `sdk-*`, `project-*`, `test-*`, `build-*` are all too common to use unprefixed. -- The name must be 1–64 characters, lowercase `a-z0-9` with single hyphens, no leading, trailing or - consecutive hyphen — and it must equal the folder name, because the CLI installs by the - frontmatter name while a human reads the folder. - -Renaming a skill means renaming the folder and the frontmatter together, and re-running the install. - -## Progressive disclosure in practice - -| Stage | Loaded | Budget | -| -- | -- | -- | -| Metadata | `name`, `description` | ~100 tokens, always | -| Instructions | the whole `SKILL.md` body | under 5000 tokens recommended; keep the file under 500 lines | -| Resources | `references/`, `scripts/`, `assets/` | only when the task reaches them | - -What belongs where: - -- **`SKILL.md`** — the decisions, the rules, the things that are wrong by default, and a pointer to - everything else. If a reader needs it to make the *first* correct move, it goes here. -- **`references/`** — long tables, full option lists, grammars, enumerations. Keep each file - focused; an agent loads the whole file. -- **`scripts/`** — executable code. Self-contained, or documenting its dependencies clearly, with - helpful error messages. -- **`assets/`** — templates, schemas, images, lookup data. - -Keep references one level deep. Avoid a chain where one reference sends an agent to another. - -## Links - -Use relative paths from the skill root: - -```markdown -See [the reference](references/REFERENCE.md) for detail. -Run `scripts/extract.py`. -``` - -Only the skill's own folder is installed, so a link that climbs out of it (`../other-skill/...`) is -broken on every machine except the one that authored it. To point at another skill, name it in prose -and let the agent find it by name. - -## Keeping a skill true - -A skill that describes a product goes stale the moment the product changes, and nothing about a -stale skill looks broken — it just gives confidently wrong advice. - -- Change the skill in the **same commit** as the behaviour it documents. -- Prefer stating the property name, the diagnostic code or the target name over paraphrasing the - behaviour; those are greppable when the code changes. -- Where a number or a list is authoritative somewhere else — a default, an enumeration — say where - it comes from, so a reader can check it. -- To bring skills, agent instructions, READMEs and docs back in line with the code after a change, - use `purview-buildsdk-docs-sync`. diff --git a/.agents/skills/purview-buildsdk-skills-justfile/SKILL.md b/.agents/skills/purview-buildsdk-skills-justfile/SKILL.md deleted file mode 100644 index 2da36a29..00000000 --- a/.agents/skills/purview-buildsdk-skills-justfile/SKILL.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -name: purview-buildsdk-skills-justfile -description: Add or update Justfile recipes that run Purview.BuildSdk's agent-skill targets - skills-update, skills-check, skills-fix, skills-install, skills-recommend and skills-verify. Use when a repository wants a just recipe to update, install, check or clean up its agent skills, when replacing hand-written skill scripts (update-agent-skills.ts, ensure-universal-skills.ts, package.json skills:* scripts) with the SDK targets, or when an existing skills recipe runs the wrong project, the wrong runner or the wrong agents. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Justfile recipes for the agent-skill targets - -The recipes are thin: each one names one SDK target. The behaviour lives in the targets, which are -covered by `purview-buildsdk-skill-installation`; this skill is about wiring them into a `Justfile` -correctly. - -## The rule that matters most - -**Every skill recipe is run by a person, on purpose.** `InstallPurviewSkills`, `UpdatePurviewSkills` -and `FixPurviewSkills` change the repository, and the SDK refuses to run them inside a build, a -restore or a design-time build (`PRSKL0009`). Keep the Justfile consistent with that: - -- never make a skills recipe a dependency of `build`, `test`, `default` or any other recipe; -- never call `skills-update`, `skills-install` or `skills-fix` from a git hook (`lefthook.yml`, - `.husky/`) or a CI job that commits; -- `skills-verify` is the one recipe CI may call: it is read-only and fails on missing or drifted skills. - -## Recipes - -Put them in their own file beside the `Justfile`, and import it from the `Justfile`: - -```just -# Justfile -import "Justfile.skills.just" -``` - -The only line that differs between repositories is `skills_project`. Work it out from the repository -as described in [Choosing `skills_project`](#choosing-skills_project) — do not ask for it, and do not -leave a placeholder: - -```just -skills_project := solution_file # or a path, when the Justfile has no such variable - -# Update agent skills: re-add every skills-lock.json source, refreshing installed skills and adding new ones -[group('Agent skills')] -skills-update *args: - dotnet msbuild "{{ skills_project }}" "-t:UpdatePurviewSkills;FixPurviewSkills" -v:n {{ args }} - -# Check that only the skill directories of the agents in PurviewSkillsAgents exist -[group('Agent skills')] -skills-check *args: - dotnet msbuild "{{ skills_project }}" -t:CheckPurviewSkills -v:n {{ args }} - -# Remove the skills CLI's links from agent directories PurviewSkillsAgents does not select -[group('Agent skills')] -skills-fix *args: - dotnet msbuild "{{ skills_project }}" -t:FixPurviewSkills -v:n {{ args }} - -# Install the skills the referenced packages ship (pass -p:PurviewSkillsSource=owner/repo for others) -[group('Agent skills')] -skills-install *args: - dotnet msbuild "{{ skills_project }}" -t:InstallPurviewSkills -v:n {{ args }} - -# Report missing, drifted or unverifiable skills without changing anything -[group('Agent skills')] -skills-recommend *args: - dotnet msbuild "{{ skills_project }}" -t:RecommendPurviewSkills -v:n {{ args }} - -# Fail when a referenced package's skills are missing or drifted - the CI gate -[group('Agent skills')] -skills-verify *args: - dotnet msbuild "{{ skills_project }}" -t:VerifyPurviewSkills -v:n {{ args }} -``` - -Only add the recipes the repository will use. `skills-update` and `skills-check` are the usual pair. - -### Choosing `skills_project` - -Take the first of these that applies: - -1. **The `Justfile` already names the solution in a variable** — `solution_file`, `solution`, `sln` - or similar, typically used by `build`, `test` and `restore`. Reference it: - `skills_project := solution_file`. An imported file shares the importing file's variables, so the - skill recipes then follow the solution if it is ever renamed or moved, with nothing to keep in step. -2. **An existing recipe runs `dotnet build`, `test` or `restore` on a literal solution path.** Use that - path. If several recipes repeat it, offer to lift it into a `solution_file` variable and reference - that, but do not restructure the `Justfile` unasked. -3. **No `Justfile`, or one that never names a solution.** Search for `*.slnx` and `*.sln`, ignoring - `bin/`, `obj/`, `node_modules/` and `artifacts/`. If there is exactly one, use its path relative to - the `Justfile`. With several, prefer the one the CI workflow or README builds; ask only if that - still leaves more than one. -4. **No solution at all.** Name a project that imports the SDK and references every package that - ships skills, and say in a comment that it sees only its own packages. - -An existing `Justfile.skills.just` pointed at a hand-picked project gets the same treatment: replace -the project with the solution, chosen as above. Remove any comment explaining why that project was -picked, because the reason no longer holds. - -### Details that break a recipe if missed - -- **Name the solution.** Every skill target runs once for the whole solution, however many projects - it holds: each project hands the work to the same elected leader, and MSBuild runs it once. Package - resolution reads every project in the solution, so a package only a test project references is - still pinned. There is no project to choose and nothing to keep in step as projects come and go. - A single project also works, but sees only that project's packages. (SDK releases before this - behaviour ran the target once per project; there, name one project that references every package - that ships skills.) -- **Restore first.** The targets read `project.assets.json` and never restore on their own - (`PRSKL0001`). A fresh clone needs `dotnet restore` (or `just restore`) before `skills-update`. -- **Quote a multi-target `-t:`.** `"-t:UpdatePurviewSkills;FixPurviewSkills"` — unquoted, `sh` treats - the `;` as the end of the command and runs `FixPurviewSkills` as a separate, failing command. -- **Keep `*args` last** so a caller can pass properties: `just skills-update -p:PurviewSkillsDryRun=true`. -- `FixPurviewSkills` after `UpdatePurviewSkills` does nothing unless `PurviewSkillsAgents` is set, so - it is safe in the recipe either way. - -## Runner and agents belong in MSBuild, not in the recipe - -Set repository-wide choices once in `Directory.Build.props`, not as flags repeated in each recipe, -so a plain `dotnet msbuild -t:...` behaves the same as the recipe: - -```xml - - - bun - - universal - -``` - -One-off overrides go on the command line. `dotnet msbuild -p:` splits values on `,` and `;`, so -escape the separator: `just skills-update -p:PurviewSkillsAgents=claude-code%2Ccodex`. - -Useful properties to pass through `*args`: - -| Property | Effect | -| -- | -- | -| `PurviewSkillsDryRun=true` | Print every CLI command; run none | -| `PurviewSkillsRunner=npx` | Launch the CLI through another runner (`bunx`, `pnpm`, `yarn`, `deno`) | -| `PurviewSkillsSource=owner/repo#ref` | `skills-install` from an explicit source with no package behind it | - -## Replacing hand-written skill scripts - -Repositories often carry their own scripts for this. The SDK targets replace them: - -| Hand-written | Replace with | -| -- | -- | -| `scripts/update-agent-skills.ts`, `"skills:update"` | `skills-update` (`UpdatePurviewSkills`) | -| `--update` / `--no-update` | Nothing: the re-add refreshes installed skills and adds new ones, so there is no separate `skills update` step to switch | -| `--dry-run` | `-p:PurviewSkillsDryRun=true` | -| `scripts/ensure-universal-skills.ts check`, `"skills:check"` | `skills-check` with `PurviewSkillsAgents=universal` | -| `scripts/ensure-universal-skills.ts fix`, `"skills:fix"` | `skills-fix` | -| a hard-coded `-a universal` | `PurviewSkillsAgents` — or leave it empty to auto-detect | - -Two behaviours differ, deliberately — mention them when migrating: - -- A source a referenced package ships is re-added **at that package's commit**, not at latest, so its - skills keep matching the package version. Other sources are re-added at latest, as before. -- Update is `skills add`, not `skills update`, so it also installs skills a source has **gained**: a - package source gets every skill its referenced version ships, and any other source is re-added with - `--skill "*"`. - -After switching, delete the scripts and their `package.json` entries, and remove `package.json` -itself if nothing else uses it. Run `just skills-update -p:PurviewSkillsDryRun=true` and compare the -printed commands with what the old script ran before deleting anything. - -## Updating an existing Justfile - -1. Read the whole `Justfile` first: match its group names, comment style, and any `set shell` - (a PowerShell shell still needs the `-t:` value quoted). -2. Keep recipe names the repository already uses; change only what they run. If `skills-check` - already means "report", rename it to `skills-recommend` rather than silently changing its meaning, - and say so. A recipe pointed at a hand-picked "small" project, to avoid running once per project, - can point at the solution instead. -3. Check nothing depends on a changing recipe: `just --list`, then search the Justfile, CI workflows - and hook configuration for the recipe name. -4. Verify: `just --list` shows the group, `just skills-update -p:PurviewSkillsDryRun=true` prints the - commands, and `just skills-check` passes or names a real problem. diff --git a/.agents/skills/purview-buildsdk-testing/SKILL.md b/.agents/skills/purview-buildsdk-testing/SKILL.md deleted file mode 100644 index c7a79950..00000000 --- a/.agents/skills/purview-buildsdk-testing/SKILL.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -name: purview-buildsdk-testing -description: Write and run tests in a repository that uses Purview.BuildSdk. Use when authoring or refactoring TUnit tests (AAA structure, Subject_Scenario_Expectation naming, awaited assertions, CancellationToken), when choosing a test project's framework packages or matching its target framework to its subject, and when running or filtering tests - the SDK wires Microsoft.Testing.Platform, so `dotnet test --filter` reports "Zero tests ran" and `--treenode-filter` is the one that works. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Testing in a Purview.BuildSdk repository - -Two things to know before anything else: - -1. A test project is detected by **name**, and detection is what wires the runner. See - `purview-buildsdk-project-layout` if the project is new or being moved. -2. The runner is **Microsoft.Testing.Platform (MTP)**, not VSTest. `--filter` does nothing useful. - -## What a test project gets automatically - -With the defaults (`TestingFramework=TUnit`, `SubstituteFramework=TUnitMocks`, -`TestDataFramework=Bogus`), a detected test project receives: - -- `TUnit`, `TUnit.Mocks`, `Bogus` -- Microsoft.Testing.Platform integration -- `CollectCoverage=true` -- test-friendly `NoWarn` defaults (`PurviewTestContextNoWarn`), while keeping the strict style - contract — `IDE0040`, field naming, formatting, `IDE1006` -- `IsPackable=false`, `IsPublishable=false` - -A test project inherits the SDK's default target framework set (`net10.0;net11.0`). When it must match -its subject — a project still on one TFM, or a subject that multi-targets — set -`TargetFramework`/`TargetFrameworks` on the **test** project (an explicit value always wins), or select a -`PurviewTargetFrameworkSet`. See `purview-buildsdk-configuration`. - -Add nothing else unless the project's purpose demands it. Two that stay explicit: - -- `TUnit.Aspire` — Aspire lifecycle and AppHost-backed integration tests -- `Purview.Containers` — container-backed integration tests. One API over Microsoft WSL Containers - (no Docker install needed on Windows) or Docker, with typed modules for SQL Server, PostgreSQL, - Redis, MySQL, RabbitMQ, NATS, Azurite and the Azure Key Vault and Service Bus emulators. - Experimental and prerelease, so pin the version. - Reference `Testcontainers` directly only where no typed module exists yet. - -## Authoring rules - -- Use TUnit (`TUnit.Core`, `TUnit.Assertions`). Do not introduce xUnit, NUnit, MSTest or - FluentAssertions unless explicitly asked. -- Every test method carries `[Test]`. -- **Every assertion is awaited**: `await Assert.That(actual).IsEqualTo(expected);`. An un-awaited - assertion silently passes. -- Arrange / Act / Assert, with the `// Arrange`, `// Act`, `// Assert` comments present. -- Test classes are `{SubjectName}Tests`, in the **same namespace** as the subject. -- Test methods are `{SubjectOrMemberUnderTest}_{Scenario}_{Expectation}`. Use `ctor` as the subject - for constructor tests. Methods, constructors, properties, operators, conversions and validation - hooks are all valid subjects. -- When any method called in the test body accepts a `CancellationToken`, take - `CancellationToken cancellationToken` as the **last parameter** and pass it through. - -```csharp -[Test] -public async Task ProcessAsync_GivenAnEmptyBatch_ReturnsZero(CancellationToken cancellationToken) -{ - // Arrange - var sut = new BatchProcessor(); - - // Act - var result = await sut.ProcessAsync([], cancellationToken); - - // Assert - await Assert.That(result).IsEqualTo(0); -} -``` - -For a suite that is not subject-based — a build, generator, workflow, package or full-system suite — -a broader, more truthful class name is better than a forced `{Subject}Tests`. Use TUnit display -names and categories to keep it navigable. - -When refactoring existing tests, bring them into compliance with all of the above while preserving -test intent. - -## Categories - -The detected test type becomes the baseline category automatically — `Api.IntegrationTests` yields -`Category=Integration`. Add further categories when they make a large suite easier to navigate; -they are what `--treenode-filter` property predicates select on. - -## Running tests - -```bash -dotnet test # the whole suite -dotnet test --treenode-filter "/*/*/LoginTests/*" # one class -dotnet test --project --treenode-filter "/*/*/*/*[Category=Unit]" -``` - -Prefer the repository's own task (`just test`, or equivalent) for a full run. - -The filter path is `////`, with `*` wildcards, `=`/`!=` property -predicates, `&`/`|` inside a single bracket group, and `**` only at the end. The full grammar, the -`--` separator rules across SDK versions, and the zero-tests checklist are in -[references/treenode-filter.md](references/treenode-filter.md). - -### "Zero tests ran" - -In order: - -1. Are you using `--treenode-filter` and not `--filter`? This is the cause most of the time. -2. Try `dotnet test --treenode-filter "..."`; on an older SDK use `dotnet test -- --treenode-filter "..."`. -3. Broaden to `/*/*/*/*`, then narrow one segment at a time. -4. Does the project actually contain `[Test]` methods? -5. Is the project **detected** as a test project? A name without the dot — `UnitTests` rather than - `Api.UnitTests` — gets no runner at all. Check with - `dotnet msbuild -getProperty:IsTestProject`. -6. Are all property predicates inside one bracket group, `[(A=1)&(B=2)]`? - -## Cross-platform requirement - -A test that only passes on Windows fails on a Linux CI runner, so write every test to pass on Windows, -Linux and macOS. - -- Never hardcode a platform-specific path — no `C:\...`, no backslash-only separators, no - case-insensitive path assumptions. -- Build paths with `Path.Combine`, `Path.GetTempPath()`, `Path.DirectorySeparatorChar`, - `Path.GetFullPath()`. -- Feed production path-math code only native-format paths. Normalise a fixed Windows-style literal - to the current platform before passing it in. -- Do not rely on a case-insensitive filesystem, a `C:` drive, or trailing-separator behaviour. -- Keep `SyntaxTree` file paths and `build_property.*` values consistent and native when writing - analyzer tests. diff --git a/.agents/skills/purview-buildsdk-testing/references/treenode-filter.md b/.agents/skills/purview-buildsdk-testing/references/treenode-filter.md deleted file mode 100644 index 35d032bc..00000000 --- a/.agents/skills/purview-buildsdk-testing/references/treenode-filter.md +++ /dev/null @@ -1,107 +0,0 @@ -# `--treenode-filter` reference - -TUnit runs on Microsoft.Testing.Platform, not VSTest, so the VSTest `--filter` syntax does not -apply. Narrowing is done with `--treenode-filter`. - -## The path - -```text -//// -``` - -Each segment maps to one level of the tree: - -| Position | Matches | -| -- | -- | -| 1 | Assembly | -| 2 | Namespace | -| 3 | Class | -| 4 | Test name | - -```text -/*/*/LoginTests/* every test in LoginTests -/*/*/*/AcceptCookiesTest one test by name -/*/MyProject.Tests.Integration/*/* every test in a namespace -/*/*/*/* everything -``` - -## Operators - -### `*` — wildcard - -Matches a whole segment or part of one. - -```text -/*/*/LoginTests*/* -/*/*/MyProject.Tests.Api*/* -``` - -### `=` and `!=` — property predicates - -In the last segment, inside `[...]`. - -```text -/*/*/*/*[Category=Unit] -/*/*/*/*[Category!=Slow] -/*/*/*/*[Owner=*Team-Backend*] -``` - -### `&` and `|` — combining - -Inside a **single** bracket group, or a single parenthesised segment. - -```text -/*/*/*/*[(Category=Unit)&(Priority=High)] -/**[(Category=Unit)|(Priority=High)] -/*/*/(LoginTests)|(SignupTests)/* -``` - -### `**` — match all - -Any depth, but **only at the end** of the path. - -```text -/** -/MyAssembly/** -``` - -`/**/Path` is not valid. - -## Rules that catch people out - -- Only **one** property group `[...]` per path segment. `[Category=Smoke]|[Priority=High]` is not - valid; write `[(Category=Smoke)|(Priority=High)]`. -- `**` must be last. -- A segment left empty is not a wildcard — write `*`. - -## The `--` separator - -```bash -dotnet test --treenode-filter "/*/*/*/*[Category=Unit]" # preferred -dotnet test -- --treenode-filter "/*/*/*/*[Category=Unit]" # older SDKs -``` - -Newer .NET SDKs forward unrecognised arguments to the MTP runner directly. On an older SDK the `--` -separator is required, and omitting it produces an argument error rather than a filter. - -## Common selections - -| Intent | Filter | -| -- | -- | -| Everything | `/*/*/*/*` | -| All unit tests | `/*/*/*/*[Category=Unit]` | -| High-priority unit tests | `/*/*/*/*[(Category=Unit)&(Priority=High)]` | -| One class | `/*/*/MyFeatureTests/*` | -| A name pattern | `/*/*/*/MyScenario*` | -| Critical integration tests | `/*/MyProject.Tests.Integration/*/*[Priority=Critical]` | - -## Zero tests ran - -1. `--treenode-filter`, not `--filter`. -2. Try without the `--` separator first, then with it. -3. Broaden to `/*/*/*/*`, then narrow one segment at a time. -4. Confirm the project has `[Test]` methods. -5. Confirm the project is **detected** as a test project — - `dotnet msbuild -getProperty:IsTestProject`. A name without the dot, such as - `UnitTests` rather than `Api.UnitTests`, is not detected and gets no runner. -6. Confirm every property predicate sits in one bracket group. diff --git a/.agents/skills/purview-component-compatibility/SKILL.md b/.agents/skills/purview-component-compatibility/SKILL.md deleted file mode 100644 index b017681a..00000000 --- a/.agents/skills/purview-component-compatibility/SKILL.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -name: purview-component-compatibility -description: >- - Use when developing, reviewing or releasing a published component - a NuGet package, or an npm - package - and choosing which dependency version to declare, when a consumer reports a version - conflict or an unexpected upgrade, or when a component's supported target frameworks change. Applies - the golden rule that a published component declares the LOWEST compatible version rather than the - latest, walks the Purview component hierarchy to find each floor, and verifies it by building - against it. Not for applications: they take the latest compatible version instead. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview component compatibility - -A published component makes a promise with every version it declares: *this is the least I require of -you*. Raise that number and every consumer is pulled up with you, whether or not they wanted it. - -**The golden rule: declare the lowest version that compiles, passes your tests, and is supported on -every target framework you claim.** The version you happen to have installed is never the answer, and -neither is the latest. - -## Which direction? - -| What you are publishing | Declare | Why | -| -- | -- | -- | -| an application, a test suite, a tool — it runs, and nobody installs it | the **latest** compatible version | you own the runtime, and a version you skip is a fix you did not take | -| a component — a NuGet or npm package somebody else installs | the **lowest** compatible version | dependency resolution takes the highest minimum in the graph, so your floor becomes theirs | - -This skill is about the second row. If the repository only ever runs, stop here and take the latest. - -## Why a floor matters - -NuGet and npm resolve a graph to the **highest** minimum among all constraints. If a package declares -`Testcontainers` 4.16 because 4.16 is what its author had installed, every consumer is forced onto 4.16, -including the one whose own constraint is 4.0 and whose runtime is pinned to it. The consumer cannot -refuse an upgrade the package never needed to ask for, and the symptom appears in *their* build, not -yours. - -## The workflow - -### 1. Name the component and its frameworks - -The floor is per target framework, not per package. Write down every `TargetFramework` the component -publishes; a multi-targeting component has a different floor on each, and the one that matters is the -oldest framework still supported, not the newest one you build against. - -### 2. Read the hierarchy, do not remember it - -The dependencies — and their minimums — are in the published `.nuspec`, not in anyone's memory: - -```bash -node scripts/dependencies.mjs Purview.Containers -node scripts/dependencies.mjs Purview.Architecture.Testing --tfm net11.0 -node scripts/dependencies.mjs Purview.Containers --walk -``` - -A bare version is a **minimum**; a bracketed one (`[1.2.3]`, `[1.0,2.0)`) is a range. The script prints -the distinction, because it is the whole rule: a minimum you raise is a minimum every consumer inherits. - -`references/purview-components.md` records which Purview package depends on which, and which target -frameworks each family supports. Where the two disagree the registry wins — that file is the map, the -`.nuspec` is the territory. - -### 3. Fix the floor, per framework - -For each dependency, find the oldest version that: - -- exposes every API the component calls (the compiler decides this, not the changelog); -- passes the component's own tests and its consumer-verification suite; -- is supported on every framework in that dependency group. - -Then declare that version. Not `latest`, not floating (`1.*`), and never the version that resolved on -your machine by accident. - -### 4. Prove the floor - -A floor nobody builds against is a guess. Add a CI leg that restores the component with every dependency -held at its declared floor and runs the suite — the ordinary leg keeps resolving the latest, which is -what a consumer will actually get. `references/lowest-compatible.md` has the mechanics. - -### 5. Keep the ceiling visible, and the floor written down - -A component's README carries a badge for the current release and a sentence naming the floor it -supports. Badges are generated from the registry, so they cannot go stale; a version written into prose -is wrong within one release. - -## Pitfalls that produce a floor nobody meant - -| Pitfall | What it looks like | The fix | -| -- | -- | -- | -| Declaring what is installed | `dotnet add package X` writes the latest; right for an application, wrong for a component | edit the version down, then prove it in step 4 | -| Transitive uplift | a dependency pulls in a newer transient package than your floor allows | override it deliberately — the persistence sample does this for a security-patched package — and comment why | -| One framework's floor | a `net10.0-windows` group needs a higher floor than `net10.0` | read each group; never average them | -| Prerelease in the graph | a family that ships prereleases depends on them at the same version | pin the family to one property so the floor moves together | -| Analyzer and source-generator packages | compile-time only, so they rarely constrain a consumer | still declare a real floor; they appear in the graph and in transitive audits | -| Floating versions | `1.*` resolves differently on every restore | banned: a floor is a number | - -## Checks before you answer - -- Is each declared version the lowest that passes, or the one that happened to be installed? -- Does every declared target framework have a floor that compiles on that framework? -- Was the floor proved by a build, or only by your machine? -- Does any page state a version number? It should be a badge or a link to the registry. -- If a floor was raised, is that a breaking change the version number admits to? - -## See also - -`references/lowest-compatible.md` for the CI mechanics and the override patterns, and -`references/purview-components.md` for the Purview hierarchy. The rule itself, and the application-side -half of it, is stated in the Engineering Playbook's Dependency Versions page; the -`purview-engineering-principles` skill summarises it as one of the eleven conventions. - diff --git a/.agents/skills/purview-component-compatibility/references/lowest-compatible.md b/.agents/skills/purview-component-compatibility/references/lowest-compatible.md deleted file mode 100644 index ccdb3b69..00000000 --- a/.agents/skills/purview-component-compatibility/references/lowest-compatible.md +++ /dev/null @@ -1,93 +0,0 @@ -# Proving the floor - -The rule is "declare the lowest compatible version". This file is the mechanics: how to find the floor, -how to prove it in a build, and the patterns that keep it from silently rising. - -## What "compatible" means, precisely - -A version is a valid floor when all three hold: - -1. **It compiles against every API the component uses.** The compiler decides this, not a changelog. If - you cannot say which member forced the version up, you have not found the floor. -2. **The component's own tests pass against it**, including the consumer-verification suite, which - builds a throwaway consumer rather than the component's own test project. -3. **It is supported on every target framework in that dependency group.** A floor is per group, and a - multi-targeting component can have several. - -## Finding it - -```bash -dotnet list package --outdated # what you declared against what exists -dotnet list package --include-transitive # what actually resolved -dotnet nuget why # which path pulled a version in -``` - -Then work downward: lower the declared version, build, and read the compiler. The first version that -compiles *and* passes is the floor. Do not stop at the first failure and pick the version above it — -that is how a floor ends up one minor above what the code needs. - -## Making the floor a build leg - -Keep one property per family (so a family cannot be bumped halfway) and make each conditional on a floor -switch. Nothing here is NuGet-specific magic: it is MSBuild, and central package management already -gives you the single place to put it. - -```xml - - LATEST - FLOOR - -``` - -```bash -dotnet restore -p:DependencyFloor=true -dotnet build -p:DependencyFloor=true --no-restore -dotnet test -p:DependencyFloor=true --no-build -``` - -`LATEST` and `FLOOR` are literals in the file; the point is that they are two properties, not two files. -Run the ordinary leg at `LATEST` and a second, slower leg at `FLOOR`, and give the floor leg its own CI -job so a failure names the floor rather than the build. - -Where a component multi-targets, add the framework dimension and run the pair per framework: - -```bash -for tfm in net8.0 net9.0 net10.0; do - dotnet build -p:DependencyFloor=true -f "$tfm" -done -``` - -## Transitive pins - -A floor can be raised by something you never declared. Transitive pinning puts those versions where you -can see them: - -```xml - - true - -``` - -Then an override is a deliberate line with a reason beside it — the persistence sample in this -repository does exactly that for a security-patched package the SQL client drags in. An override without -a comment is indistinguishable from an accident, and the next person deletes it. - -## The ceiling, and the API surface - -- The floor leg proves the **bottom**; the ordinary leg proves the **top**. Both, or you know neither. -- An API-compatibility check against the previous release catches the other direction of the same - mistake: a floor can stay put while the public surface grows a member that only the newest dependency - provides. `Microsoft.DotNet.ApiCompat.Task` wires that into the build; `Microsoft.DotNet.ApiCompat.Tool` - runs it from a pipeline. -- A prerelease dependency is a floor with an expiry: it cannot be consumed by anyone who has not opted - into prereleases. Say so in the package's README rather than letting the error message explain it. - -## What not to do - -| Temptation | Why it is wrong | -| -- | -- | -| `dotnet add package X` and commit | it writes the latest; correct for an application, wrong for a component | -| floating versions (`1.*`) | resolves differently on every restore, so the floor is nobody's decision | -| "it restores on my machine" | that proves one graph, on one date, with one SDK | -| raising a floor in a patch release | the consumer's build changes without their version changing | -| one floor leg for all frameworks | the framework with the lowest floor is the one nobody tested | diff --git a/.agents/skills/purview-component-compatibility/references/purview-components.md b/.agents/skills/purview-component-compatibility/references/purview-components.md deleted file mode 100644 index 6e13b659..00000000 --- a/.agents/skills/purview-component-compatibility/references/purview-components.md +++ /dev/null @@ -1,60 +0,0 @@ -# The Purview component hierarchy - -Which Purview package depends on which, and which target frameworks each family supports, so a harvest -or a floor decision starts from the shape rather than from a memory of it. - -Every row was read from the registry with `scripts/dependencies.mjs`, which reads the published -`.nuspec`. **The registry is the authority; this file is the map.** Re-run the script before acting on -any row — a family that multi-targets changes its floors on every release. - -## The families - -| Family | Packages | Target frameworks | Depends on | -| -- | -- | -- | -- | -| Build SDK | `Purview.BuildSdk` | `netstandard2.0` (an MSBuild SDK) | nothing | -| Test-support rule sets | `Purview.Skills.Testing`, `Purview.Architecture.Testing`, `Purview.Architecture.Testing.Cli` | `net10.0`; `Architecture.Testing` also `net11.0` | `TUnit.Core`, `TUnit.Assertions`, `JsonSchema.Net` | -| Telemetry | `Purview.Telemetry.SourceGenerator` | `netstandard2.0` (an analyzer) | nothing | -| Containers | `Purview.Containers` + `.Core`, `.Docker`, `.Wsl`, `.MsSql`, `.PostgreSql` | `net10.0`; `.Wsl` adds `net10.0-windows10.0.19041` | its own family at the same version, `Microsoft.Extensions.Telemetry.Abstractions`, `Testcontainers` | -| Results | `Purview.Results`, `.AspNetCore`, `.ZodSharp`, `.ZodSharp.AspNetCore` | `net10.0`, `net11.0` | nothing; the adapters depend on the core and on ZodSharp | -| ZodSharp | `Purview.ZodSharp`, `.AspNetCore`, `.SystemTextJson`, `.NewtonsoftJson` | `net9.0`, `net10.0`, `net11.0` | `Microsoft.Extensions.Options`, `Microsoft.Extensions.DependencyInjection.Abstractions` | -| Value Objects | `Purview.ValueObjects` | `net8.0`, `net9.0`, `net10.0`, `net11.0` | nothing | -| Source Generator Framework | `Purview.SourceGeneratorFramework`, `.Testing`, `.Testing.TUnit` | `netstandard2.0` | Roslyn (`Microsoft.CodeAnalysis.CSharp`), `System.Collections.Immutable`, `System.Reflection.Metadata` | -| Aspire ResourceKit | `Purview.Aspire.ResourceKit` | `net8.0`, `net9.0`, `net10.0` | `Aspire.Hosting`, OpenTelemetry exporter and hosting, `Microsoft.Extensions.*` | -| Astroc4 | `@purview-dev/astroc4` (npm, not NuGet) | an Astro/Starlight plugin | `likec4`, `@astrojs/starlight`, `astro` as peers | - -## Reading the shape - -Three patterns are worth internalising, because each one changes what "the floor" means: - -- **A family ships at one version.** `Purview.Containers.Core` is required at the umbrella's own version, - and `Purview.Results.ZodSharp` requires `Purview.Results` and `Purview.ZodSharp` at their current ones. - Declare the family with one property, so its floor moves as a unit. -- **An analyzer has no consumer-side floor worth arguing about.** `Purview.BuildSdk`, - `Purview.Telemetry.SourceGenerator` and `Purview.SourceGeneratorFramework` target `netstandard2.0` and do - their work at compile time. They still appear in a transitive audit, so they still get a real version. -- **A multi-targeting component has a different floor per framework**, and ZodSharp shows it most - clearly: the `net11.0` group declares older `Microsoft.Extensions.*` minimums than the `net10.0` group, - because the lower framework carries the newer requirements. Reading one group and applying it to - another is how a floor is set wrong in the direction that breaks consumers. - -## What the script prints - -```text -Purview.Containers 1.0.0-prerelease.11 - net10.0: Purview.Containers.Core >= 1.0.0-prerelease.11 - net10.0: Purview.Containers.Docker >= 1.0.0-prerelease.11 - net10.0: Purview.Containers.Wsl >= 1.0.0-prerelease.11 - net10.0: Microsoft.Extensions.Telemetry.Abstractions >= 10.11.0 - net10.0: Testcontainers >= 4.16.0 - Purview.Containers.Core 1.0.0-prerelease.11 - net10.0: Microsoft.Extensions.Telemetry.Abstractions >= 10.11.0 -``` - -A bare version is a minimum; brackets would mean a range. The numbers above are what the registry said -when this page was written — the shape is the part that lasts, which is why the command is here and the -versions are not presented as targets. - -## Related components that are not Purview packages - -`AspireC4.Hosting` is published under its own name and versions on its own schedule, so it is not part of -a Purview family floor. Read it the same way, with the same script. diff --git a/.agents/skills/purview-component-compatibility/scripts/dependencies.mjs b/.agents/skills/purview-component-compatibility/scripts/dependencies.mjs deleted file mode 100644 index 3069ef62..00000000 --- a/.agents/skills/purview-component-compatibility/scripts/dependencies.mjs +++ /dev/null @@ -1,239 +0,0 @@ -#!/usr/bin/env node -/** - * Prints a package's dependency groups exactly as NuGet declares them, so the floor a component - * inherits can be read rather than guessed. - * - * The golden rule of package development is to declare the LOWEST compatible version, and that decision - * needs the real graph: which dependency, at what minimum, on which target framework. This script reads - * it from the registry - the `.nuspec` the published package carries - instead of from a table that - * would be stale by the next release. - * - * Zero dependencies: it uses the platform `fetch`, so it runs anywhere Node 18 or later does. - * - * node dependencies.mjs Purview.Containers - * node dependencies.mjs Purview.Architecture.Testing --tfm net11.0 - * node dependencies.mjs Purview.Containers --walk # recurse into Purview.* dependencies - * node dependencies.mjs Purview.Results --json - * - * An npm package is not a NuGet id; read it with `npm view versions --json`. - * - * Exit codes: 0 on success, 1 when the package, version or network is not available. - */ - -/** The NuGet flat-container root: the same host that serves the package's own `.nuspec`. */ -const REGISTRY = "https://api.nuget.org/v3-flatcontainer"; - -/** How deep `--walk` follows dependencies before it stops. */ -const MAX_DEPTH = 3; - -/** True when a version string carries a prerelease label. */ -function isPrerelease(version) { - return version.includes("-"); -} - -/** Every published version of a package, oldest first. */ -async function versionsOf(id) { - const response = await fetch(`${REGISTRY}/${id.toLowerCase()}/index.json`); - if (!response.ok) { - throw new Error(`${id} is not on nuget.org (HTTP ${response.status}).`); - } - - const body = await response.json(); - return body.versions; -} - -/** The version to describe: the one asked for, else the newest stable, else the newest anything. */ -function chooseVersion(available, requested) { - if (requested) { - const match = available.find((version) => version.toLowerCase() === requested.toLowerCase()); - if (!match) { - throw new Error(`'${requested}' is not a published version. Newest is ${available.at(-1)}.`); - } - - return match; - } - - const stable = available.filter((version) => !isPrerelease(version)); - return stable.at(-1) ?? available.at(-1); -} - -/** The package's `.nuspec`, which is what a consumer's restore actually reads. */ -async function readNuspec(id, version) { - const name = id.toLowerCase(); - const response = await fetch(`${REGISTRY}/${name}/${version.toLowerCase()}/${name}.nuspec`); - if (!response.ok) { - throw new Error(`No .nuspec for ${id} ${version} (HTTP ${response.status}).`); - } - - return response.text(); -} - -/** The value of one XML attribute on a tag, or null. */ -function attribute(tag, name) { - const match = new RegExp(`${name}\\s*=\\s*"([^"]*)"`).exec(tag); - return match ? match[1] : null; -} - -/** - * How a nuspec version string constrains a consumer: a bare version is a MINIMUM, and a bracketed one is - * a range. This is the distinction the whole rule turns on, because a minimum you raise is a minimum - * every consumer inherits. - */ -function classify(range) { - if (!range) { - return "any"; - } - - return range.startsWith("[") || range.startsWith("(") ? "range" : "minimum"; -} - -/** The dependency elements inside a fragment, normalized. */ -function dependenciesIn(fragment) { - const dependencies = []; - const pattern = /]*)\/?>/g; - let match; - - while ((match = pattern.exec(fragment)) !== null) { - const tag = match[1]; - const version = attribute(tag, "version"); - dependencies.push({ id: attribute(tag, "id"), version, constraint: classify(version) }); - } - - return dependencies; -} - -/** The dependency groups a nuspec declares, one per target framework. */ -function dependencyGroups(nuspec) { - const groups = []; - const pattern = /]*)>([\s\S]*?)<\/group>/g; - let match; - - while ((match = pattern.exec(nuspec)) !== null) { - groups.push({ - framework: attribute(match[1], "targetFramework") ?? "(any)", - dependencies: dependenciesIn(match[2]), - }); - } - - if (groups.length === 0) { - const flat = dependenciesIn(nuspec); - if (flat.length > 0) { - groups.push({ framework: "(any)", dependencies: flat }); - } - } - - return groups; -} - -/** A printable name for a target framework, spelled the way the ecosystem usually writes it. */ -function shortFramework(framework) { - return framework - .replace(/^\.NETStandard/i, "netstandard") - .replace(/^\.NETCoreApp/i, "net") - .replace(/^\.NETFramework/i, "netframework") - .toLowerCase(); -} - -/** Prints one package's groups, recursing into Purview components when asked. */ -async function describe(id, requestedVersion, options, depth, seen) { - const version = chooseVersion(await versionsOf(id), requestedVersion); - const groups = dependencyGroups(await readNuspec(id, version)); - const indent = " ".repeat(depth); - - console.log(`${indent}${id} ${version}`); - - for (const group of groups) { - const framework = shortFramework(group.framework); - if (options.tfm && framework !== options.tfm.toLowerCase()) { - continue; - } - - if (group.dependencies.length === 0) { - console.log(`${indent} ${framework}: no dependencies`); - continue; - } - - for (const dependency of group.dependencies) { - const relation = dependency.constraint === "minimum" ? ">=" : dependency.constraint; - console.log( - `${indent} ${framework}: ${dependency.id} ${relation} ${dependency.version ?? "any"}`, - ); - } - - if (options.walk && depth < MAX_DEPTH) { - for (const dependency of group.dependencies) { - const isPurview = /^purview\./i.test(dependency.id ?? ""); - if (!(options.all || isPurview) || seen.has(dependency.id.toLowerCase())) { - continue; - } - - seen.add(dependency.id.toLowerCase()); - await describe(dependency.id, null, options, depth + 1, seen); - } - } - } - - return { id, version, groups }; -} - -/** Parses the command line. An unknown argument is a mistake worth failing on. */ -function parseArguments(argv) { - const options = { packages: [], tfm: null, walk: false, all: false, json: false }; - - for (let index = 0; index < argv.length; index += 1) { - const argument = argv[index]; - - if (argument === "--walk" || argument === "-w") { - options.walk = true; - } else if (argument === "--all") { - options.all = true; - } else if (argument === "--json") { - options.json = true; - } else if (argument === "--tfm") { - options.tfm = argv[(index += 1)]; - if (!options.tfm) { - throw new Error("--tfm needs a value, e.g. --tfm net10.0."); - } - } else if (argument.startsWith("-")) { - throw new Error(`Unknown argument '${argument}'.`); - } else { - options.packages.push(argument); - } - } - - if (options.packages.length === 0) { - throw new Error( - "Name at least one package, e.g. `node dependencies.mjs Purview.Containers`.\n" + - "A package may carry a version: `Purview.Containers@1.0.0-prerelease.11`.", - ); - } - - return options; -} - -/** The command. */ -async function main() { - const options = parseArguments(process.argv.slice(2)); - const results = []; - - for (const entry of options.packages) { - const separator = entry.indexOf("@", 1); - const id = separator === -1 ? entry : entry.slice(0, separator); - const version = separator === -1 ? null : entry.slice(separator + 1); - - results.push(await describe(id, version, options, 0, new Set([id.toLowerCase()]))); - - if (!options.walk && !options.json) { - console.log(""); - } - } - - if (options.json) { - console.log(JSON.stringify(results, null, "\t")); - } -} - -main().catch((error) => { - console.error(`error: ${error.message}`); - process.exitCode = 1; -}); diff --git a/.agents/skills/purview-engineering-principles/SKILL.md b/.agents/skills/purview-engineering-principles/SKILL.md deleted file mode 100644 index 24fe707c..00000000 --- a/.agents/skills/purview-engineering-principles/SKILL.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -name: purview-engineering-principles -description: >- - Use when setting up, reviewing or rationalising a .NET repository against the Purview engineering - conventions - convention over configuration, derived identity, architecture as tests, warnings as - errors, proving consumer-facing claims, documentation ownership, test data builders, agent - legibility, tiering verification by risk, the version policy for applications and for published - components, and the conditional persistence rules. Each rule names the failure it prevents and - whether a build or a reviewer enforces it. -metadata: - product: Purview engineering playbook - repository: purview-dev/engineering-playbook ---- - -# Purview engineering principles - -Eleven rules, each with the failure it prevents and the mechanism that makes it true. The distinction -that matters throughout: **a convention a build can check is checked by the build; a convention only -a reviewer can check is labelled a review obligation and never described as enforced.** A rule that -claims enforcement it does not have is worse than no rule, because people stop looking. - -## 1. Convention over configuration - -A repository declares as little as possible. One MSBuild SDK supplies the defaults, and a project -file is short because the SDK already knows what a project of that shape needs. - -Configuration copied between repositories diverges. When the rule lives in one package, fixing it -once fixes it everywhere; when it lives in eleven project files, it is fixed eleven times — or, more -often, once. - -*Enforced by:* `` in a single -`Directory.Build.props`. The SDK detects project type from the filename and the `Sdk` attribute. - -*At your scale:* a single-project repository still benefits. The import is two lines and removes the -target framework, language version, nullable context, analyzer set and package metadata. - -## 2. Identity is derived, never repeated - -`RootNamespace` comes from `$(NamespacePrefix).$(ProjectName)`, and `AssemblyName` follows the -resolved `RootNamespace`. A name appears once — in the folder and file name — and everything else is -computed. - -A hand-typed namespace drifts from the assembly it lives in, and the drift is invisible until -something reflects over types: an architecture test, a serializer, a DI scan. - -*Enforced by:* the SDK during `.props` evaluation, plus a build-time check -(`PurviewProjectFileNameMismatch`) when a `.csproj` filename does not match its parent directory. - -*At your scale:* always. It costs nothing and removes a class of bug. - -## 3. Architecture is a test, not a diagram - -The dependencies a layer may have are asserted by tests that read the compiled assemblies. A -`ProjectReference` pointing the wrong way fails the build. - -A diagram is a claim about the past. Dependency direction erodes one convenient reference at a time, -and every such reference looks reasonable in isolation. - -*Enforced by:* a test project that references every layer and inspects their metadata references. - -*At your scale:* small repositories can skip it. Adopt it the moment a **second layer** exists — -that is when the wrong direction first becomes possible. - -## 4. The build is the only authority - -Style is enforced by analyzers and `EnforceCodeStyleInBuild`, and the SDK's own style policy is -re-validated on every compile, so a repository cannot quietly downgrade a rule. - -*At your scale:* always. If a rule matters and cannot be checked, say so plainly. - -## 5. Warnings are not acceptable output - -A clean build has no warnings. One that will never be fixed is either fixed, suppressed *where it -occurs* with a stated justification, or turned off deliberately. - -Warnings are a budget. A build that emits twenty is a build where the twenty-first is invisible — and -the twenty-first is the one that mattered. - -*Enforced by:* severity, partly. The SDK's shipped `.editorconfig` sets many rules to `error`. The -rest is review, backed by the pipeline running `dotnet build` with the repository's configuration. - -*At your scale:* a small repository can tolerate `warning`; a large one cannot. Decide deliberately -rather than by accumulation. - -## 6. Every claim about a consumer is proved by a consumer - -When a package documents how it must be used — a target framework, an asset, a guard, a workaround — -something in the repository builds that documented consumer and asserts the documented outcome. - -Consumer-facing documentation is the part of a library least likely to be exercised by its own tests, -because **the library's own build is not a consumer**. It drifts silently and fails in somebody -else's repository. - -*Enforced by:* a verification script that packs, then builds throwaway consumer projects against the -produced packages, asserting the happy path *and* the documented guard errors. `purview-dev/containers` -is the worked example (`just verify-consumers`), deliberately excluded from the default unit filter -because it restores from nuget.org. - -*At your scale:* only once a package is consumed outside its own repository. Before that, the -repository's own tests already are the consumer. - -## 7. Documentation is a build artefact of the repository - -The wiki lives in the repository it describes, in `docs/wiki`, as plain Markdown. The repository owns no -site configuration at all: `_Sidebar.md` is the navigation, `Home.md` is the hub, and the site that -publishes them lives in one place outside the repository. - -Documentation that lives elsewhere is updated elsewhere. A page with no owner and no review path is -wrong within one release. - -*Enforced by:* review, plus the navigation file — a page absent from `_Sidebar.md` is not published. - -*At your scale:* always. Even a repository with one page should own that page. - -## 8. Everything a test needs is built by one builder - -Domain content in a test comes from `TestBuilder`. A test never constructs a domain object inline, -and it overrides **only** the value it is proving. - -Inline construction encodes a type's shape into every test that touches it, so one constructor change -becomes a repository-wide edit. It also hides which values the test actually depends on, because -every value looks deliberate. - -*Enforced by:* review. - -*At your scale:* adopt from the first test. Retrofitting is a mechanical edit across every test file, -and exactly the kind of edit that is postponed forever. - -## 9. An agent is a reader with no memory - -A repository states its purpose, its layout and its conventions in `AGENTS.md`. **Nothing important -is discoverable only by reading the code.** - -A coding agent has the repository and nothing else — no colleague to ask, no institutional memory, no -intuition about which of two plausible patterns is intended. It will confidently generalise from -whatever it finds first. That is also every new-joiner failure mode; the agent just makes the cost -visible sooner, because an agent does not ask. - -*Enforced by:* review, plus publishing skills so agent-facing guidance tracks the library version -rather than a repository's memory of it. - -*At your scale:* always. `AGENTS.md` is cheaper than the questions it prevents. - -## 10. A change is verified in proportion to its risk - -Checks are tiered, and a repository declares which tiers its pipeline runs. A pull request runs the -fast tier; the slow tier runs deliberately, locally or on a dedicated runner. - -A pipeline that runs everything on every pull request gets made optional. One that runs too little -gets ignored. Tiering is what keeps the gate credible. - -*Enforced by:* the pipeline's `TestFilter` and the test project's own **name** — the SDK categorises -a `*UnitTests` project as `Unit`, so the tier is a property of the project rather than of a -hand-written attribute. - -*At your scale:* one tier is fine until the slow tests exist. Then split by project name, not by -attribute. - -## 11. A version is a range, not a number - -An application takes the latest version its runtime supports. A published component declares the -**lowest** version that compiles, passes its tests and satisfies the contract it documents, on each -target framework it claims — because dependency resolution is a set of lower bounds, so the floor a -component declares becomes the floor every consumer inherits. - -A page states no release number. It shows a badge generated from the registry, or links to the -registry, so a version cannot be wrong within a release. - -*Enforced by:* a lowest-compatible CI leg that restores against the declared floor, and an -API-compatibility check per target framework. Nothing enforces the floor of a package that has no -consumer yet — that tier arrives with the first release. - -*At your scale:* with one application there is nothing to earn yet; take the latest and let -`dotnet list package --outdated` report the rest. The golden rule starts at the first published package. - -## Applying these in review - -Three questions catch most of it: - -1. **Is this configuration, or is it a default the SDK should own?** If two repositories would copy - it, it belongs in the SDK. -2. **Is this rule enforced, or merely stated?** If stated, say so where it is stated. -3. **Could an agent — or a new joiner — find this without being told?** If not, it goes in - `AGENTS.md` or the wiki. - -## The conditional persistence rules - -Three further rules apply only when a repository actually stores data: a value known before storage is -derived with UUIDv5, every other GUID key uses one strategy per store, and EF Core is the persistence -boundary. They are not part of the eleven because a stateless CLI or a pure library must not inherit them. -`purview-persistence` owns them and stays silent when persistence is not real. - -## Related skills - -`purview-architecture` for project-shape decisions, `purview-architecture-testing` for turning a -boundary into a failing build, `purview-telemetry` and `purview-persistence` for the per-concern -guidance, and `purview-component-compatibility` for deciding and verifying a published component's -lowest compatible dependency versions. diff --git a/.agents/skills/purview-org-harvest/SKILL.md b/.agents/skills/purview-org-harvest/SKILL.md deleted file mode 100644 index 2c05ea19..00000000 --- a/.agents/skills/purview-org-harvest/SKILL.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -name: purview-org-harvest -description: >- - Use when a Purview repository's conventions may have fallen behind the organisation - - inventorying every public purview-dev repository at main, deciding which repository is - best-in-class for each concern before adopting anything, and recording the result in a dated - snapshot. Always reads the remote: a local clone is a cache, and it may be stale, renamed or - missing entirely. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview organisation harvest - -Seventeen public repositories, each with its own wiki, its own `skills/` folder and its own `AGENTS.md`. -They are not equally up to date, and the one you have cloned is not necessarily the one that has the -answer. Two failures follow, and this skill exists to prevent both. - -**Copying from a stale clone.** A clone is a cache with no expiry. The convention you read there may -be two months behind the one the owner now documents, and nothing about the local file says so. - -**Copying from the wrong owner.** "How do we ship?" is answered by `build`. "How do we keep a boundary -honest?" is answered by `architests`. Asking a library that does neither produces a confident answer -with no evidence, which is worse than no answer. - -So: establish membership, read at `main`, name one owner per concern, write down what you found. - -## 1. Scope - -Name two things before reading anything: - -| Input | Example | -| -- | -- | -| The repository being changed | `containers` | -| The concern in question | "how a test reaches a real database" | - -A harvest without a named concern becomes a tour, and a tour produces a list of differences nobody -acted on. The concern is what makes "best-in-class" a decision rather than a preference. - -## 2. Discover membership - -`gh repo list` is the membership authority. A catalogue, a README table, an `llms.txt` and a local -folder listing are all convenience indexes: they are maintained by hand, so they under-count, and the -omission is silent. - -```bash -gh auth status -gh repo list purview-dev --limit 200 \ - --json name,visibility,isArchived,pushedAt,defaultBranchRef -``` - -Drop `isArchived` and anything that is not `PUBLIC`. **If `gh auth status` fails, stop.** Degrading to -the local clone is the exact failure this skill prevents, and it degrades silently. - -The filter denies by default: a repository must be exactly `PUBLIC` and exactly not archived to be -recorded, so a visibility you have never seen fails closed. `gh repo list` also only lists what your -token can see, which is why the token's visibility and the file's contents are two separate questions: -the section below is about the second one. - -A local clone is admissible only when its `HEAD` equals the SHA the snapshot recorded: - -```bash -git -C ../containers rev-parse HEAD -``` - -That is a speed optimisation, never a substitute. - -## 3. Read it at `main` - -Every repository is read at `main`, and the commit is recorded. The snapshot is what makes the claim -checkable a month later, when nobody remembers which commit the analysis saw. - -```bash -node scripts/inventory.mjs # drift between the organisation and the snapshot -node scripts/inventory.mjs --write # regenerate .config/org-inventory.json -node scripts/inventory.mjs --repo containers -``` - -The script is deterministic and dependency-free: it shells out to `gh`, so it reuses the CLI's own -authentication, and it runs the same on Windows and on a Linux agent — it is Node, not a shell script, -so there is no PowerShell edition and no Bash edition to keep in step. It writes -`.config/org-inventory.json` in the repository you run it from — generated, never hand-edited. - -To inspect a decision without a network call, replay a recorded harvest with `--from` and `--details`. -That is the same script, not a variant, so what you review is what runs. - -## 4. Harvest in two tiers - -Seventeen repositories is not a reading list; it is a budget. Two tiers keep it affordable. - -| Tier | Call | Answers | -| -- | -- | -- | -| 1 — shape | `gh api repos/purview-dev//git/trees/main?recursive=1`, for all seventeen | Which folders exist, how many pages the wiki has, whether `skills/` is authored, whether `AGENTS.md` exists. Cheap enough for everything. | -| 2 — content | `gh api -H 'Accept: application/vnd.github.raw' repos/purview-dev//contents/`, **only for the owner of the concern** | What the convention actually says. | - -Tier 1 tells you where the evidence is. Tier 2 reads it, in the one repository that wrote it down. - -```bash -gh api repos/purview-dev/architests/git/trees/main?recursive=1 --jq '.tree[].path' -gh api -H 'Accept: application/vnd.github.raw' \ - repos/purview-dev/architests/contents/docs/wiki/Architecture-As-Tests.md -``` - -More invocations, and what each one is for: `references/harvest-commands.md`. - -## 5. Classify: one owner per concern - -Pick exactly one owner per concern, from `references/best-in-class.md`. Two signs the classification -is wrong: - -- **Two owners for one concern.** `build-sdk` and this playbook's `purview-engineering-principles` - both answer "review this repository". That overlap is a finding to resolve, not a tie to break by - preferring whichever you read first. -- **An owner that has never run the thing it documents.** Check the tree before trusting the page. - -## 6. Divergence register - -Write the differences down before changing anything, with an adopt-or-reject for each. A divergence -with no decision recorded is the same divergence next quarter. - -| Column | Answers | -| -- | -- | -| Concern | What is being compared | -| Owner | The repository the convention comes from, and the path it is stated at | -| Here | What this repository does now | -| Decision | Adopt, or reject with the reason | -| Mechanism | The build rule, test or review obligation that keeps it true | - -Rejecting is a legitimate outcome and is usually the right one at a smaller scale. What is not -legitimate is adopting a convention whose failure the repository cannot have. - -## 7. Adopt - -A convention arrives as a set of changes that land together, or it is a claim with no mechanism: - -```text -the page states the rule, why, how it is enforced, and what a smaller repository does instead -src/ demonstrates it, or says why it does not -the snapshot records the commit it was read at -the skill points at the owner, and never paraphrases it -``` - -**Link to the owner; do not restate it.** A paraphrase is a second source of truth, and the copy with -no owner is the one that loses. - -## 8. Verify - -```bash -just build # zero warnings -just test # architecture, skill and documentation rules -just lint-check -node scripts/inventory.mjs --print -``` - -If the harvest changed what the snapshot should record, regenerate it and commit the diff. The -snapshot being current is a review obligation rather than a build failure — a build that goes red on -a Tuesday because a clock passed is a build people disable. - -## Private repositories - -A private repository may inform a maintainer's judgement. It is never evidence, and it is never -written down. This is not a preference, and it is not a heuristic an agent gets to weigh against a -good argument. Five statements, in order of how often they are broken: - -1. A committed snapshot contains public, non-archived repositories only. The writer denies by default - and refuses to persist anything else, and a test asserts it. -2. A private repository may be read when `gh` is authenticated for it, and what it teaches may shape - a rule. -3. Nothing published names it: not the snapshot, not the page, not the skill, not a workflow, not a - config, not a commit message. Attribute the rule to "a Purview application repository", or to - nothing. -4. **If a rule cannot be justified without the private source, it is not published.** -5. **If you cannot say where a name came from, do not write the name.** A repository the snapshot - does not list is either private or gone, and both fail the same test. - -The fourth is the one an agent rationalises around, because the evidence is often excellent. A rule -whose only justification is out of reach of the people it is published to cannot be reviewed by them, -which makes it folklore with a citation they cannot follow. - -## Checks before you answer - -- Did you read membership from the organisation rather than from a catalogue or a folder? -- Is every claim about a repository true at the SHA the snapshot recorded, not at your clone? -- Did you name exactly one owner per concern, and resolve any overlap rather than duplicating it? -- Did you reject anything? A harvest with no rejections usually means nothing was understood. -- Does every change you propose have a mechanism, or is it labelled a review obligation? -- Is every repository you named public? - -## See also - -- `references/best-in-class.md` — which repository owns which concern, and where to read it -- `references/harvest-commands.md` — the `gh` invocations, and the trap in each one -- `purview-engineering-principles` — the conventions themselves, once you know which owner to read -- `purview-architecture` — the project-shape decisions a harvest most often touches diff --git a/.agents/skills/purview-org-harvest/references/best-in-class.md b/.agents/skills/purview-org-harvest/references/best-in-class.md deleted file mode 100644 index 9ab69ccd..00000000 --- a/.agents/skills/purview-org-harvest/references/best-in-class.md +++ /dev/null @@ -1,77 +0,0 @@ -# Best-in-class, by concern - -One owner per concern. Read the owner, not the nearest repository that happens to have a wiki. - -Every row was read from the organisation with `gh repo list purview-dev` and -`gh api repos//git/trees/main?recursive=1`. The page counts and skill counts are the shape at -the time of writing, not a promise: they are what the snapshot records, and the snapshot is -regenerated rather than trusted. - -## The matrix - -| Concern | Owner | Read it at | -| -- | -- | -- | -| Repository shape, MSBuild defaults, analyzers, skill authoring | `build-sdk` | `docs/wiki`, `templates/`, `skills/purview-buildsdk-*` | -| Pipeline, release, pack validation | `build` | `docs/wiki`, `skills/purview-build-*` | -| Architecture policy: dependency direction, naming rules | `architests` | `docs` (nine pages; `Policy-Reference.md` is the reference, `Extending.md` the how-to), `skills/purview-architests-*` | -| Local dependencies in tests | `containers` | `docs/wiki`, `skills/purview-containers-*` | -| TypeScript contracts generated from C# | `zodsharp` | `docs/wiki`, `skills/purview-zodsharp-*` | -| Logging, tracing, metrics | `telemetry-sourcegenerator` | `docs/wiki`, `skills/purview-telemetry-*` | -| Event streams and event storage | `event-sourcing` | `docs/wiki` — **no skills folder** | -| Operation outcomes without exceptions | `results` | `docs/wiki`, `skills/purview-results-*` | -| Validated identity types | `value-objects` | `docs` — **no `docs/wiki`** | -| Aspire hosting resources | `aspire-resourcekit` | `docs/wiki`, `skills/purview-resourcekit-*` | -| Architecture diagrams generated from source | `aspirec4` | `docs/wiki`, `skills/purview-aspirec4-*` | -| LikeC4 diagrams inside an Astro or Starlight site | `astroc4` | `docs/wiki`, `skills/purview-astroc4-*` — an npm package, not .NET | -| Source generator authoring | `sourcegenerator-framework` | `docs/wiki`, `skills/purview-sourcegenerator-*` | -| Skill-set design, and the dated-snapshot pattern | `pm-skills` | `skills/pm-*` — **no documentation folder at all** | -| OpenAPI generated from XML comments | `openapi-xmlcomments` | `docs/wiki`, `skills/purview-openapi-xmlcomments-*` | -| The reusable conventions themselves | `engineering-playbook` | `docs/wiki`, `skills/purview-*` | -| The public project catalogue | `purview-dev.github.io` | `src/src/data/projects/*.yml` | - -`purview-dev.github.io` is the catalogue, and a catalogue is an index rather than a membership list: -an entry is added by hand, so a repository missing from it is silent. `gh repo list` is the authority. - -## The overlaps worth knowing about - -**`build-sdk` and `engineering-playbook` both answer "review this repository".** They are not -duplicates, and the split is worth stating because a harvest will hit it immediately: - -- `build-sdk` owns *what the tooling does* — project detection, the props and targets, the analyzer - set, the packaged test-support rule sets. -- `engineering-playbook` owns *why a repository is shaped that way, and what it costs* — the rule, - the failure it prevents, and what a smaller repository does instead. - -A question about a property name goes to `build-sdk`. A question about whether a project should exist -goes here. - -**`containers` and `aspire-resourcekit` both look like "local dependencies".** `containers` owns the -test-time resource — a real SQL Server, PostgreSQL or queue — and `aspire-resourcekit` owns the -development-time orchestration. A test that needs a database is `containers`; an AppHost that needs -one is `aspire-resourcekit`. - -**`aspirec4` and `astroc4` both draw LikeC4 diagrams.** `aspirec4` owns the diagram generated from a -running Aspire resource graph; `astroc4` owns putting a `.c4` model inside an Astro or Starlight site — -the fence transform and the LikeC4 syntax highlighting. A question about the .NET host is `aspirec4`; a -question about the documentation site is `astroc4`, which is the one owner here that is not a .NET -package, so it is read for its TypeScript conventions rather than for its MSBuild ones. - -## Reading a repository you have not cloned - -Tier 1 first — the shape, for everything: - -```bash -gh api repos/purview-dev//git/trees/main?recursive=1 --jq '.tree[].path' -``` - -Then Tier 2 — the content, for the one owner: - -```bash -gh api -H 'Accept: application/vnd.github.raw' \ - repos/purview-dev//contents/docs/wiki/_Sidebar.md -``` - -`_Sidebar.md` is the fastest index of a wiki, because the repository's own documentation rule says a -page that is not in it does not exist. Where a repository publishes no wiki, its `AGENTS.md` is the -next best entry point, and where it has neither, read `skills/*/SKILL.md` — the trigger in each -`description` says what the repository thinks it is for. diff --git a/.agents/skills/purview-org-harvest/references/harvest-commands.md b/.agents/skills/purview-org-harvest/references/harvest-commands.md deleted file mode 100644 index f4b46537..00000000 --- a/.agents/skills/purview-org-harvest/references/harvest-commands.md +++ /dev/null @@ -1,121 +0,0 @@ -# Harvest commands - -Every invocation here is safe to run read-only, and each one is followed by the trap that cost -somebody time. Both shells are shown because the harvest runs on a developer's Windows machine and on -a Linux agent, and the quoting rules are not the same. - -## Membership - -```bash -gh auth status -gh repo list purview-dev --limit 200 --json name,visibility,isArchived,pushedAt,defaultBranchRef -``` - -```powershell -gh auth status -gh repo list purview-dev --limit 200 --json name,visibility,isArchived,pushedAt,defaultBranchRef | - ConvertFrom-Json | Sort-Object name | - Format-Table name, visibility, isArchived, pushedAt -``` - -**Trap: the default limit is 30.** Without `--limit` the list is silently short, and a short list is -worse than a failed one because the omission never announces itself. - -**Trap: `gh repo list` shows what your token can see.** An organisation member sees private -repositories too; filter to `visibility -eq 'PUBLIC'` and `-not isArchived` before recording anything. - -## The SHA a convention was read at - -```bash -gh api repos/purview-dev//git/ref/heads/main --jq .object.sha -``` - -**Trap: a renamed repository resolves by redirect.** Asking for a repository under its former name -answers `purview-dev/purview-dev.github.io` and exits 0, so a stale name never fails. Compare the -returned `full_name` with the name you asked for. - -## Tier 1: the shape - -```bash -gh api repos/purview-dev//git/trees/main?recursive=1 --jq '.tree[].path' -``` - -**Trap: `truncated`.** GitHub caps a recursive tree, and the response says so with `"truncated": true` -rather than erroring. A truncated tree under-counts skills and pages, so check the flag before -believing a zero. - -**Trap: the tree lists blobs and trees.** Filter to `type == "blob"` when counting files, or a folder -whose name matches your pattern is counted as its contents. - -## Tier 2: the content - -```bash -gh api -H 'Accept: application/vnd.github.raw' \ - repos/purview-dev//contents/docs/wiki/_Sidebar.md -``` - -**Trap: `contents` returns JSON unless you ask for raw.** Without the `Accept` header the response is -a base64 `content` field, and the analysis quietly proceeds on a JSON document. - -**Trap: `contents` caps at 1000 files for a directory listing.** Use the tree API for enumerating and -`contents` for reading one file. - -## Windows PowerShell, specifically - -**Embedded double quotes are stripped from a native command's arguments.** This looks correct and is -not: - -```powershell -gh repo list purview-dev --jq '.[] | [.name, (.pushedAt // "-")] | @tsv' -``` - -`gh` receives `// -` and answers `failed to parse jq expression ... unexpected token`. Either keep the -jq program free of string literals, or do the shaping in PowerShell: - -```powershell -$repos = gh repo list purview-dev --limit 200 --json name,visibility | ConvertFrom-Json -$repos | Sort-Object name | ForEach-Object { '{0}|{1}' -f $_.name, $_.visibility } -``` - -**A filtered result is a scalar when it is one item.** `(... | Where-Object { ... }).Count` returns -nothing rather than `1`, so `.Count` in a summary line reads as empty. Wrap it: `@(...).Count`. - -## The snapshot - -```bash -node skills/purview-org-harvest/scripts/inventory.mjs -node skills/purview-org-harvest/scripts/inventory.mjs --write -node skills/purview-org-harvest/scripts/inventory.mjs --repo containers --write -``` - -It resolves the snapshot path from `git rev-parse --show-toplevel`, so it writes into the repository -you are standing in rather than into the one the script was installed from. That is what lets another -repository adopt it unchanged. - -`--repo` merges on write, so reading one repository does not erase the other sixteen. - -## Replaying a harvest, with no network - -Two flags replace the two `gh` calls. This is how the repository's own tests exercise the script on -every platform without touching GitHub, and how a reviewer reproduces what a harvest decided: - -```bash -node skills/purview-org-harvest/scripts/inventory.mjs \ - --from recorded-membership.json \ - --details recorded-details.json \ - --print -``` - -`--from` takes exactly what `gh repo list --json name,visibility,isArchived,pushedAt,defaultBranchRef` -printed. `--details` takes an object keyed by repository name, each with the `commitSha` a tier-1 -harvest found and the `paths` the tree contained. A repository that is in the membership and missing -from the details is an error, not a silent omission — a replay that quietly skipped a repository would -look like a clean run. - -Two behaviours worth knowing before you trust a run: - -- **A snapshot carrying a byte-order mark is accepted.** It is the one file in this workflow a person - is likely to open and re-save, and a BOM is not a corruption. -- **A snapshot containing anything that is not public and unarchived is refused**, and nothing is - written. This includes an entry a hand edit left behind, which the merge would otherwise carry - forward: delete it and re-run `--write`. diff --git a/.agents/skills/purview-org-harvest/scripts/inventory.mjs b/.agents/skills/purview-org-harvest/scripts/inventory.mjs deleted file mode 100644 index affc46fa..00000000 --- a/.agents/skills/purview-org-harvest/scripts/inventory.mjs +++ /dev/null @@ -1,466 +0,0 @@ -#!/usr/bin/env node -/** - * Snapshots every public, non-archived `purview-dev` repository at `main` into - * `.config/org-inventory.json`, and reports the drift between that snapshot and the organisation. - * - * The snapshot is what makes the harvest rule checkable offline: `OrgInventoryTests` reads the file - * the pipeline has, never the network. This script is the only thing that writes it, so a repository - * cannot appear in the snapshot by being remembered. - * - * Zero dependencies: it shells out to `gh` and so reuses the CLI's own authentication rather than - * asking for a token. - * - * node inventory.mjs # print the drift against the snapshot (default) - * node inventory.mjs --write # rewrite the snapshot from the organisation - * node inventory.mjs --repo containers # narrow to one repository; merges on --write - * node inventory.mjs --out # write somewhere else, e.g. while adopting the skill - * node inventory.mjs --help - * - * Exit codes: 0 on success, including when drift is found - a stale snapshot is a review obligation, - * not a red pull request for whoever happened to push next. 1 when `gh` is missing, unauthenticated, - * or the organisation cannot be read. - */ -import { execFileSync } from "node:child_process"; -import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs"; -import { dirname, join } from "node:path"; - -/** The organisation this playbook describes. */ -const ORG = "purview-dev"; - -/** The branch a convention is read at. A local clone is a cache; this is the authority. */ -const BRANCH = "main"; - -/** Bumped when a field is added or its meaning changes. */ -const SCHEMA_VERSION = 1; - -/** Past this age the snapshot is reported as stale. Advisory: nothing fails on a clock. */ -const STALE_AFTER_DAYS = 30; - -/** Files a repository may put at its root to guide an agent. Recorded in this order. */ -const AGENT_GUIDANCE_FILES = ["AGENTS.md", "CLAUDE.md", ".github/copilot-instructions.md", "llms.txt"]; - -/** Directories a published documentation site is read from, most specific first. */ -const DOCS_DIRECTORIES = ["docs/wiki", "docs"]; - -/** - * The concern each repository is best-in-class for, so a harvest reads one owner instead of sixteen - * repositories. `references/best-in-class.md` is the long form of this table and is the file to edit - * first; this map only records the answer in the snapshot. - */ -const CONCERNS = new Map([ - ["architests", ["architecture policy", "dependency and naming rules"]], - ["aspire-resourcekit", ["Aspire hosting resources"]], - ["aspirec4", ["architecture diagrams from source"]], - ["astroc4", ["architecture diagrams in an Astro site"]], - ["build", ["pipeline", "release"]], - ["build-sdk", ["repository shape", "analyzers and style", "MSBuild defaults", "skill authoring"]], - ["containers", ["local dependencies in tests"]], - ["engineering-playbook", ["the conventions themselves"]], - ["event-sourcing", ["event streams", "event storage"]], - ["openapi-xmlcomments", ["OpenAPI from XML comments"]], - ["pm-skills", ["skill-set design"]], - ["purview-dev.github.io", ["the public project catalogue"]], - ["results", ["operation outcomes"]], - ["sourcegenerator-framework", ["source generator authoring"]], - ["telemetry-sourcegenerator", ["logging", "tracing", "metrics"]], - ["value-objects", ["validated identity types"]], - ["zodsharp", ["TypeScript contracts from C#"]], -]); - -/** Runs `gh` and returns stdout, turning a CLI failure into an actionable message. */ -function gh(args) { - try { - return execFileSync("gh", args, { - encoding: "utf8", - maxBuffer: 256 * 1024 * 1024, - stdio: ["ignore", "pipe", "pipe"], - }); - } catch (error) { - const detail = (error.stderr ?? "").toString().trim() || error.message; - throw new Error( - `gh ${args.join(" ")} failed.\n${detail}\n\n` + - "This script reads the organisation, not a local clone. Run `gh auth status`, then retry.", - ); - } -} - -/** Calls one GitHub REST endpoint and parses the JSON response. */ -function api(endpoint) { - return JSON.parse(gh(["api", endpoint])); -} - -/** The root of the repository the command was run in, so the skill works from any repository. */ -function repositoryRoot() { - try { - return execFileSync("git", ["rev-parse", "--show-toplevel"], { - encoding: "utf8", - stdio: ["ignore", "pipe", "pipe"], - }).trim(); - } catch { - throw new Error("Not inside a git repository. Run this from a clone, or pass --out ."); - } -} - -/** Membership, as the organisation reports it. The catalogue is a convenience index, not the list. */ -function readMembership(source) { - const listed = source - ? JSON.parse(readFileSync(source, "utf8")) - : JSON.parse( - gh([ - "repo", - "list", - ORG, - "--limit", - "200", - "--json", - "name,visibility,isArchived,pushedAt,defaultBranchRef", - ]), - ); - - return ( - listed - // Deny by default. The filter is "exactly public and not archived" rather than "not - // private", so a visibility value this script has never seen fails closed instead of - // falling through into a file that is committed to a public repository. - .filter((repository) => repository.visibility === "PUBLIC" && repository.isArchived === false) - .sort((left, right) => left.name.localeCompare(right.name, "en")) - ); -} - -/** The recorded commit and file list for each repository, when a run replays a previous harvest. */ -function readDetails(source) { - return new Map(Object.entries(JSON.parse(readFileSync(source, "utf8")))); -} - -/** The Markdown pages directly inside a docs directory. */ -function countPages(paths, directory) { - const prefix = `${directory}/`; - return paths.filter((path) => { - if (!path.startsWith(prefix)) { - return false; - } - - const remainder = path.slice(prefix.length); - return remainder.endsWith(".md") && !remainder.includes("/"); - }).length; -} - -/** A skill is a folder under `skills/` that carries a `SKILL.md`. */ -function authoredSkills(paths) { - const names = paths - .filter((path) => /^skills\/[^/]+\/SKILL\.md$/.test(path)) - .map((path) => path.split("/")[1]); - - return [...new Set(names)].sort((left, right) => left.localeCompare(right, "en")); -} - -/** Everything the snapshot records about one repository, read at `BRANCH`. */ -function describeRepository(repository, details) { - // The filter above already excluded these, and this is the second lock on the same door: a - // private repository must never reach the snapshot, so the guard is here as well as there. - if (repository.visibility !== "PUBLIC" || repository.isArchived !== false) { - throw new Error( - `${ORG}/${repository.name} is ${repository.visibility} and archived ${repository.isArchived}. ` + - "The snapshot records public, unarchived repositories only, so nothing was written.", - ); - } - - const defaultBranch = repository.defaultBranchRef?.name ?? BRANCH; - if (defaultBranch !== BRANCH) { - throw new Error( - `${ORG}/${repository.name} has default branch '${defaultBranch}', not '${BRANCH}'. ` + - "The snapshot pins one branch, so either the rule or the repository has to change.", - ); - } - - const recorded = details?.get(repository.name); - if (details && !recorded) { - throw new Error( - `${repository.name} has no recorded detail, so --details cannot describe it. ` + - "Replay a membership the details file was captured with, or run without --details.", - ); - } - - const commitSha = recorded?.commitSha ?? api(`repos/${ORG}/${repository.name}/git/ref/heads/${BRANCH}`).object.sha; - const paths = recorded?.paths ?? readTree(repository.name); - const docsDir = DOCS_DIRECTORIES.find((candidate) => - paths.some((path) => path.startsWith(`${candidate}/`)), - ); - - return { - name: repository.name, - visibility: repository.visibility.toLowerCase(), - archived: repository.isArchived, - commitSha, - pushedAt: repository.pushedAt, - docsDir: docsDir ?? null, - docsPages: docsDir ? countPages(paths, docsDir) : 0, - skills: authoredSkills(paths), - agentGuidance: AGENT_GUIDANCE_FILES.filter((file) => paths.includes(file)), - concerns: CONCERNS.get(repository.name) ?? [], - }; -} - -/** The blob paths of one repository at `BRANCH`. */ -function readTree(name) { - const tree = api(`repos/${ORG}/${name}/git/trees/${BRANCH}?recursive=1`); - - if (tree.truncated) { - process.stderr.write( - `warning: ${name}'s tree is truncated, so its skills and docs are undercounted\n`, - ); - } - - return tree.tree.filter((entry) => entry.type === "blob").map((entry) => entry.path); -} - -/** The snapshot document. */ -function snapshotOf(repositories) { - return { - schemaVersion: SCHEMA_VERSION, - org: ORG, - branch: BRANCH, - fetchedAt: new Date().toISOString().replace(/\.\d{3}Z$/, "Z"), - repositories, - }; -} - -/** The snapshot on disk, or null when the repository has not committed one yet. */ -function readSnapshot(path) { - if (!existsSync(path)) { - return null; - } - - // The snapshot is the one file in this workflow a person is likely to open and save by hand, and - // an editor that writes a byte-order mark produces a file JSON.parse rejects with a message that - // names neither the file nor the cause. - return JSON.parse(readFileSync(path, "utf8").replace(/^\uFEFF/, "")); -} - -/** A field's value in the form the drift report prints. */ -function render(value) { - if (value === null || value === undefined) { - return "none"; - } - - if (Array.isArray(value)) { - return value.length === 0 ? "none" : value.join(", "); - } - - return String(value); -} - -/** A field's value in the form the drift report compares: structured values compare as one string. */ -function fingerprint(value) { - return JSON.stringify(value ?? null); -} - -/** The fields whose change is worth reporting, in the order a reader cares about them. */ -const COMPARED_FIELDS = [ - "commitSha", - "docsDir", - "docsPages", - "skills", - "agentGuidance", - "concerns", - "visibility", - "archived", -]; - -/** The differences between the organisation and the snapshot. */ -function drift(existing, observed) { - const findings = []; - const before = new Map((existing?.repositories ?? []).map((entry) => [entry.name, entry])); - const after = new Map(observed.map((entry) => [entry.name, entry])); - - for (const [name, entry] of after) { - if (!before.has(name)) { - findings.push(`${name}: not in the snapshot`); - continue; - } - - const previous = before.get(name); - for (const field of COMPARED_FIELDS) { - if (fingerprint(previous[field]) === fingerprint(entry[field])) { - continue; - } - - findings.push(`${name}: ${field} ${render(previous[field])} -> ${render(entry[field])}`); - } - } - - for (const name of before.keys()) { - if (!after.has(name)) { - findings.push(`${name}: in the snapshot but no longer a public repository`); - } - } - - return findings; -} - -/** How long ago the snapshot was taken, in whole days, or null when it carries no usable date. */ -function ageInDays(fetchedAt) { - const fetched = Date.parse(fetchedAt ?? ""); - return Number.isNaN(fetched) ? null : Math.floor((Date.now() - fetched) / 86_400_000); -} - -/** Parses the command line. Unknown arguments are a mistake worth failing on. */ -function parseArguments(argv) { - const options = { write: false, repos: [], out: null, from: null, details: null, help: false }; - - for (let index = 0; index < argv.length; index++) { - const argument = argv[index]; - if (argument === "--write") { - options.write = true; - } else if (argument === "--print") { - options.write = false; - } else if (argument === "--help" || argument === "-h") { - options.help = true; - } else if (argument === "--repo") { - const value = argv[++index]; - if (!value) { - throw new Error("--repo needs a repository name."); - } - - options.repos.push(value); - } else if (argument === "--out") { - const value = argv[++index]; - if (!value) { - throw new Error("--out needs a path."); - } - - options.out = value; - } else if (argument === "--from") { - const value = argv[++index]; - if (!value) { - throw new Error("--from needs a path to a recorded `gh repo list` response."); - } - - options.from = value; - } else if (argument === "--details") { - const value = argv[++index]; - if (!value) { - throw new Error("--details needs a path to a recorded detail file."); - } - - options.details = value; - } else { - throw new Error(`Unknown argument '${argument}'. Run with --help.`); - } - } - - return options; -} - -/** The documented usage. */ -const HELP = `Snapshot every public, non-archived ${ORG} repository at ${BRANCH}. - - node inventory.mjs print the drift between the organisation and the snapshot - node inventory.mjs --write rewrite the snapshot from the organisation - node inventory.mjs --repo narrow to one repository; merges when writing - node inventory.mjs --out write somewhere other than .config/org-inventory.json - node inventory.mjs --from replay a recorded "gh repo list --json" response instead of - asking the organisation - node inventory.mjs --details replay recorded commits and file lists, so a run touches no - network at all; pair it with --from - node inventory.mjs --help this text - -The snapshot is generated, never hand-edited. A stale snapshot is a review obligation rather than a -build failure, so drift prints and the exit code stays 0.`; - -/** Runs the command. */ -function main() { - const options = parseArguments(process.argv.slice(2)); - if (options.help) { - console.log(HELP); - return; - } - - const snapshotPath = options.out ?? join(repositoryRoot(), ".config", "org-inventory.json"); - const existing = readSnapshot(snapshotPath); - - let observed = readMembership(options.from); - if (options.repos.length > 0) { - const known = new Set(observed.map((repository) => repository.name)); - for (const name of options.repos) { - if (!known.has(name)) { - throw new Error( - `'${name}' is not a public, non-archived ${ORG} repository. ` + - `Run without --repo to include all ${observed.length}.`, - ); - } - } - - observed = observed.filter((repository) => options.repos.includes(repository.name)); - } - - const details = options.details ? readDetails(options.details) : null; - const described = observed.map((repository) => describeRepository(repository, details)); - - if (options.write) { - const merged = new Map((existing?.repositories ?? []).map((entry) => [entry.name, entry])); - for (const entry of described) { - merged.set(entry.name, entry); - } - - const written = snapshotOf( - [...merged.values()].sort((left, right) => left.name.localeCompare(right.name, "en")), - ); - - // The merge carries forward whatever the file already held, which is how a hand-edited entry - // would survive a regeneration. Refuse to write a snapshot that records anything else. - const notPublic = written.repositories.filter( - (entry) => entry.visibility !== "public" || entry.archived !== false, - ); - if (notPublic.length > 0) { - throw new Error( - "Refusing to write a snapshot that records a repository which is not public and " + - `unarchived: ${notPublic.map((entry) => entry.name).join(", ")}. ` + - "Delete the entries and re-run --write.", - ); - } - - mkdirSync(dirname(snapshotPath), { recursive: true }); - writeFileSync(snapshotPath, `${JSON.stringify(written, null, "\t")}\n`, "utf8"); - console.log( - `wrote ${written.repositories.length} repositories to ${snapshotPath} at ${written.fetchedAt}`, - ); - return; - } - - const findings = drift(existing, described); - const age = ageInDays(existing?.fetchedAt); - - console.log(`${ORG}: ${observed.length} public, non-archived repositories at ${BRANCH}`); - if (existing) { - console.log( - `snapshot: ${existing.repositories?.length ?? 0} repositories, fetched ${existing.fetchedAt}` + - (age === null ? "" : ` (${age} day${age === 1 ? "" : "s"} old)`), - ); - } else { - console.log(`no snapshot at ${snapshotPath} - run with --write to create one`); - } - - if (findings.length === 0) { - console.log("no drift"); - } else { - console.log(`${findings.length} difference${findings.length === 1 ? "" : "s"}:`); - for (const finding of findings) { - console.log(` ${finding}`); - } - } - - if (age !== null && age > STALE_AFTER_DAYS) { - console.log( - `warning: the snapshot is older than ${STALE_AFTER_DAYS} days. ` + - "Re-run with --write and review the diff.", - ); - } -} - -try { - main(); -} catch (error) { - console.error(`error: ${error.message}`); - process.exitCode = 1; -} diff --git a/.agents/skills/purview-persistence/SKILL.md b/.agents/skills/purview-persistence/SKILL.md deleted file mode 100644 index 7d6ad911..00000000 --- a/.agents/skills/purview-persistence/SKILL.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -name: purview-persistence -description: >- - Use when a .NET project actually persists data and you are choosing a storage approach, integrating - or abstracting EF Core, deriving a well-known identifier, or selecting a GUID primary-key strategy. - Gives provider-specific guidance — SQL Server and PostgreSQL differ and must not be treated alike — - and stays silent for projects that do not persist anything. -license: MIT -metadata: - author: Purview-Dev - version: "1.2" - repository: purview-dev/engineering-playbook ---- - -# Purview persistence - -**Activation condition:** this skill applies only when persistence is real. If the project is a -stateless CLI, a pure library, or a service that calls an API and stores nothing, stop here — none of -this is relevant, and raising a database GUID strategy with that project is noise. - -Confirm persistence from the repository before proceeding (see `purview-architecture`): a data-access -`PackageReference`, a `DbContext`, a connection string, or an explicit requirement to store state. - -## 1. Shape the data access proportionally - -| Scale | Shape | -| -- | -- | -| Small | `DbContext` used directly from the code that needs it. No repository, no unit-of-work wrapper — `DbContext` already is both. | -| Medium | A boundary when domain rules must not know about EF Core, or when a query is complex enough to deserve a name. Often that is a few focused query types, not a generic `IRepository`. | -| Large | Independent infrastructure implementations where there genuinely are several, with the dependency direction enforced by a test. | - -**Do not wrap EF Core in a repository for testability.** `Purview.Containers` gives you a real -database in tests, which is both more faithful and less code than an abstraction built to be mocked. -A repository earns its place when you must swap the store or when `DbContext` is genuinely leaking -into domain decisions — not before. - -## 2. Local dependencies - -`Purview.Containers` provides Aspire resource integrations for the dependencies you need in -development and integration tests — including `MsSql`, `PostgreSql`, `MySql`, `Redis`, `Nats`, -`RabbitMq`, `Azurite` and an Azure Key Vault emulator. Prefer a real container over an in-memory -provider: the in-memory provider does not enforce the constraints that break you in production. - -## 3. EF Core integration - -When EF Core is the store, keep the integration in four places: - -- **`DbContext` is the boundary.** Use it directly; do not add `IRepository` or a unit-of-work wrapper - for testability. `Purview.Containers` gives you a real database in tests. -- **Choose the provider where the context is registered.** Carry the choice as context-options data, not - a `Database.ProviderName` branch at model-build time. -- **Map value objects once.** Configure converters and comparers in the model, not per property. A - value-object key needs a converter-aware value generator. -- **Keep design time and runtime in step.** Both paths make the same provider, strategy and - `ReplaceService` choices, or the migration snapshot describes a different model. - -Migrations are code, reviewed and applied by a deliberate step; the API does not migrate at startup in -production. The full rule, composition sample and checks are in `references/ef-core-integration.md`. - -## 4. Identifiers — derived or generated - -Two decisions live here, and they are independent. Ask them in this order. - -### The deterministic-identifier gate - -Derive an identifier only when its **value must be known before storage** — a system tenant, a seeded -reference row, an installation's service principal, or an ingested object whose provider key is stable -and never recycled. Then derive it with UUIDv5 over an installation-scoped namespace and configure -`ValueGeneratedNever()`, so the sequential convention below leaves it alone. A project with random keys -and no seeding has no use for UUIDv5. An outbox row that merely needs an id before `SaveChanges` takes -the generated strategy below, not a derived one. - -The full rule, catalogue, naming rules, migration caveat and tests are in -`references/well-known-identifiers.md`. - -### The generated-key decision - -Resolve these before recommending anything; most are answered by the repository: - -1. Are GUIDs primary keys, or merely external identifiers over an integer key? -2. Is the value generated by the application or by the database? -3. Which provider, and which version? -4. Does index locality matter at the expected write volume? -5. Must the identifier exist before the row is persisted? - -Question 5 usually decides it. If the application needs the identifier before `SaveChanges` — for an -outbox row, a correlation value, or to build an object graph client-side — the database cannot be the -generator, and the remaining questions are about *which* client-side strategy. - -### The rule that matters most - -**SQL Server and PostgreSQL do not benefit from the same sequential GUID implementation.** Their -index structures and their GUID comparison semantics differ, and a "sequential GUID" that helps one -can be no better than random on the other. Never carry a strategy from one to the other without -re-deriving it. - -- SQL Server specifics: `references/sqlserver.md` -- PostgreSQL specifics: `references/postgresql.md` -- Choosing between them, and when a custom generator is justified: `references/guid-generation.md` - -### Prefer built-in capability - -Use the framework or database capability when it is sufficient — `Guid.CreateVersion7()` on .NET 9+, -`NEWSEQUENTIALID()`, EF Core's own value generators, a provider's native UUIDv7 function. A custom -generator is a maintenance obligation and a correctness risk; introduce one only against a measured -requirement. - -**No NuGet package provides this pattern.** A reviewed generator such as `FastGuid` supplies a -store-ordered implementation, but the strategy witness, options extension, value generator with -value-converter support, and model-finalising convention are repository-local: copy them, do not depend -on a package that claims to own the wiring. Introduce it only for a measured requirement: a second -provider, or an identifier needed before `SaveChanges`. Until the second provider exists, a built-in -capability is the answer. - -## 5. Value objects as keys - -`Purview.ValueObjects` gives strongly-typed identifiers that stop an `OrderId` being passed where a -`CustomerId` belongs. They need an EF Core value converter; configure it once in the model rather -than per property. - -This is about type safety at the boundary, not about the generation strategy — the two decisions are -independent. - -## 6. Migrations and schema - -- Migrations are code: reviewed, tested against a real container, and applied by a deliberate step — - not by the application at startup in production. -- Expect the schema to be ahead of or behind the code during a deployment; design changes to be - compatible in both directions. -- Keep the connection string out of source. Keep it out of telemetry too. - -## Checks before you answer - -- Have you confirmed persistence is actually required? -- If the project uses EF Core, are you recommending the `DbContext` directly rather than a repository - wrapper added for testability? -- Does the design-time path make the same provider and strategy choices as the runtime path? -- Does every generated value have one owner — application, store or derivation — and no second writer? -- If you are deriving an identifier, is its value genuinely known before storage, and is it keyed - `ValueGeneratedNever()`? -- If you are recommending a GUID strategy, do you know the provider *and* its version? -- If you are proposing the strategy/convention, is there a second provider or a pre-save identifier? -- Are you proposing an abstraction you can justify by something other than testability? -- Have you preferred a built-in capability over a custom generator? - -## See also - -- `purview-architecture` — context discovery and proportional structure -- `purview-telemetry` — instrument the data access too; it is where the latency is diff --git a/.agents/skills/purview-persistence/references/ef-core-integration.md b/.agents/skills/purview-persistence/references/ef-core-integration.md deleted file mode 100644 index 77c75731..00000000 --- a/.agents/skills/purview-persistence/references/ef-core-integration.md +++ /dev/null @@ -1,83 +0,0 @@ -# EF Core integration - -Read this when the project actually uses EF Core. The identifier decisions are in `guid-generation.md` -and `well-known-identifiers.md`; this page is the rest of the integration. - -## The rule - -1. **`DbContext` is the boundary.** Read and write through it directly, or through a narrow query type - when a query deserves a name. Do not add `IRepository` or a unit-of-work wrapper for testability. - `DbContext` already is both, and a real container is a more faithful test than a substitute. -2. **The provider is chosen where the context is registered.** Carry the choice as context-options data; - never branch on `Database.ProviderName` while the model is being built. The model is built once and - cached, so that branch serves one provider's model to the other. -3. **Map a value object once.** Configure the converter and comparer in the model, not on each property. - The `Purview.ValueObjects` generator emits the converters when EF Core is referenced. A value-object - key also needs a converter-aware value generator, or the property receives a raw `Guid`. -4. **One owner per generated value.** The application supplies it, the store generates it, or it is - derived — never two. A derived identifier is `ValueGeneratedNever()`; a store default or computed - column is left to the store. -5. **Design time and runtime agree.** The design-time factory or host registration makes the same - provider, strategy and `ReplaceService` choices as the application. Otherwise the migration snapshot - describes a model the application does not run. -6. **The model cache key covers every input that varies the model.** Provider, strategy, tenant and - design time. EF's service-provider cache and model cache are separate; both need a key that matches - the decision. -7. **Migrations are code.** Persistence owns the definitions; a deliberate step applies them. The API - does not migrate at startup in production. -8. **Integration tests use a real store.** The in-memory provider does not enforce foreign keys, unique - indexes, computed columns or SQL semantics. Use `Purview.Containers` and a `.IntegrationTests` - project. -9. **The connection string is configuration.** Keep it out of source, out of `appsettings.json` in the - repository, and out of telemetry. A redaction test is worth more than a convention. - -## The composition - -The provider, the strategy and the service replacements belong together, where the context is -registered: - -```csharp -services.AddDbContext>((serviceProvider, options) => -{ - ConfigureStore(options, connectionString); - - options - .UseSequentialGuids() - .ReplaceService() - .ReplaceService>(); -}); - -services.AddSingleton>(); -``` - -- `ConfigureStore` is the only place that names `UseSqlServer` or `UseNpgsql`. -- `UseSequentialGuids` adds an options extension; the model reads it instead of asking about the provider. -- `IModelCacheKeyFactory` is replaced because the service-provider hash alone does not key the model - cache. -- The application-facing factory is registered separately, because EF's internal registration is not - reachable from an outbox writer or a correlation-id generator. - -## Migrations - -- Generation and application are separate: `dotnet ef migrations add` in development, a controlled - `Migrator` step in a deployment. -- A migration and `HasData` are compiled and replayed, so they need a literal GUID. A derived identifier - cannot be computed there; print the constant from the derivation and guard it with a test. -- Expect the schema to be ahead of or behind the code during a rollout, and design the change to be - compatible in both directions. -- Never let the API apply migrations at startup in production: a deploy then mutates the schema without - review and without a clean rollback. - -## Checks to write - -| Check | Shape | -| -- | -- | -| Model covers every GUID key | Each non-foreign-key GUID key is generated on add with the expected factory | -| Foreign keys are not generated | A foreign-key GUID keeps the value copied from its principal | -| Explicit configuration wins | A `ValueGeneratedNever()` key keeps its supplied value through `SaveChanges` | -| Two strategies, one context type | Different strategies produce different service providers and models | -| Design time matches runtime | Both models produce the same migration snapshot | -| Real store semantics | A unique index, a foreign key and a computed column behave as the model says in a container | - -The Engineering Playbook's *EF Core Integration* page states the same rules with the sample as evidence; -the runnable implementation is `samples/Acme.Persistence` in that repository, run with `just samples`. diff --git a/.agents/skills/purview-persistence/references/guid-generation.md b/.agents/skills/purview-persistence/references/guid-generation.md deleted file mode 100644 index fb644bb8..00000000 --- a/.agents/skills/purview-persistence/references/guid-generation.md +++ /dev/null @@ -1,103 +0,0 @@ -# Choosing a GUID generation strategy - -The cross-provider decision procedure. Provider detail lives in `sqlserver.md` and `postgresql.md`. - -## Step 0 — is this question in scope? - -Ask nothing and recommend nothing unless **both** are true: - -- The project persists data, and -- GUIDs are (or are about to be) primary keys. - -A stateless CLI, a pure library, a service with an integer key, or a project using GUIDs only as -external correlation identifiers does not need this decision. Raising it anyway is the failure this -page is written to prevent. - -## Step 1 — must the identifier exist before persistence? - -This question decides more than any other. - -**Yes** — the application needs the value before `SaveChanges` for an outbox row, a correlation -identifier, an object graph built client-side, or an identifier returned before commit. The database -cannot be the generator. Go to step 2 with client-side options only. - -**No** — the database may generate it, and database generation is available to you. - -## Step 2 — which provider, and which version? - -Do not skip the version. It changes the available options materially: - -| Provider | Version matters because | -| -- | -- | -| SQL Server | `NEWSEQUENTIALID()` is long-standing; the comparison semantics that make byte-ordered UUIDs useless have never changed | -| PostgreSQL | Native `uuidv7()` exists only from 18; `gen_random_uuid()` is built in from 13 | -| .NET | `Guid.CreateVersion7()` exists from .NET 9 | - -**The two databases do not share an answer.** SQL Server compares `uniqueidentifier` with the last -six bytes most significant, so a byte-ordered UUIDv7 is effectively random to its clustered index. -PostgreSQL compares `uuid` in byte order, so UUIDv7 is genuinely sequential there. A strategy that is -optimal on one is unremarkable or wrong on the other. - -## Step 3 — does locality actually matter? - -Sequential keys exist to reduce index fragmentation and page splits under write pressure. If the -table takes tens of inserts a minute, this is not your problem and a random GUID is the simpler, -more private choice. - -Reach for a sequential strategy when you can point at write volume, measured fragmentation, page -splits, or buffer-pool pressure. "It's best practice" is not a measurement. - -Note also that on SQL Server the problem is often better solved by making the clustered index -something other than the GUID key — see `sqlserver.md`. - -## Step 4 — is unpredictability required? - -Sequential and time-ordered identifiers are guessable, and UUIDv7 discloses creation time to the -millisecond. Where an identifier appears in a URL, is handed to a third party, or acts as a -capability, use a random UUID — or keep the ordered value internal and expose a random surrogate. - -Never use `NEWSEQUENTIALID()` output as a secret. - -## Decision summary - -| Provider | Needs value before insert | Locality matters | Recommendation | -| -- | -- | -- | -- | -| SQL Server | No | Yes | `NEWSEQUENTIALID()` as a store default, or EF Core's client-side `SequentialGuidValueGenerator` | -| SQL Server | Yes | Yes | EF Core `SequentialGuidValueGenerator`, or a store-ordered `FastGuid` strategy when both providers share a model | -| SQL Server | Either | No | `Guid.NewGuid()` | -| PostgreSQL | Yes | Yes | `Guid.CreateVersion7()` with `ValueGeneratedNever()` | -| PostgreSQL | No | Yes | `uuidv7()` on 18+, otherwise generate v7 in the application | -| PostgreSQL | Either | No | `Guid.NewGuid()` or `gen_random_uuid()` | -| SQL Server **and** PostgreSQL, one context type | Either | Yes | A store-specific strategy carried as context-options data. One strategy per provider; see below. | -| Any | Either | Either, but must be unpredictable | Random v4 | - -The two-provider row is the one that needs code: an `ISequentialGuidProvider` witness, an options -extension and a model-finalising convention. Copy them from the Engineering Playbook's *GUID Key -Strategy* page. Never expect one byte-ordered generator to order for both stores. - -A value whose identity is known before storage does not belong in this table. Derive it with UUIDv5 and -key it `ValueGeneratedNever()`; see `well-known-identifiers.md`. - -## Prefer built-in capability - -In order of preference: - -1. A framework capability — `Guid.CreateVersion7()`, EF Core's value generators. -2. A database capability — `NEWSEQUENTIALID()`, `uuidv7()`, `gen_random_uuid()`. -3. A reviewed, tested implementation of a published standard, when neither of the above is available - on your target versions — `FastGuid` is the one the sample uses for store-ordered values. -4. A bespoke generator — only against a measured requirement the first three cannot meet. - -A hand-written sequential GUID generator is easy to get subtly wrong — endianness, clock regression, -counter rollover within a millisecond, and thread safety are all live hazards, and the failure mode -is duplicate or badly-ordered keys found in production. - -## No NuGet package provides this - -No NuGet package provides the strategy/convention pattern. It is repository-local: copy the strategy -witness, options extension, value generator and model-finalising convention from the Engineering -Playbook's *GUID Key Strategy* page. Do not depend on a package that claims to own it, and do not -create one without a measured requirement the built-in options cannot meet. - -The abstraction is earned by a second provider, or by an identifier needed before `SaveChanges` on -both — not by anticipation. Until then a built-in capability is the answer. diff --git a/.agents/skills/purview-persistence/references/postgresql.md b/.agents/skills/purview-persistence/references/postgresql.md deleted file mode 100644 index 603987d6..00000000 --- a/.agents/skills/purview-persistence/references/postgresql.md +++ /dev/null @@ -1,142 +0,0 @@ -# PostgreSQL UUID keys - -Read this only when the provider is PostgreSQL and UUIDs are primary keys. The SQL Server answer is -different — see `sqlserver.md`. - -## Why PostgreSQL differs from SQL Server - -Two differences drive everything on this page: - -1. **PostgreSQL has no clustered index.** Tables are heaps; the primary key is a separate B-tree. A - random UUID therefore does not cause row-level page splits the way it does on a clustered SQL - Server table. The cost is in the index: random inserts touch scattered index pages, which hurts - cache locality and WAL volume, but it is a smaller and differently-shaped problem. -2. **`uuid` compares in byte order.** Unlike SQL Server, PostgreSQL orders UUIDs by their bytes. A - UUID that is sequential in byte layout *is* sequential to the index. - -The consequence: **UUIDv7 works here.** It is the natural answer on PostgreSQL and the wrong answer -on SQL Server. Never carry a sequential-GUID choice across the two. - -## The options - -### `Guid.CreateVersion7()` — .NET 9+, application-generated - -The default recommendation for new PostgreSQL schemas with UUID keys. - -```csharp -public sealed class Order -{ - public Guid Id { get; init; } = Guid.CreateVersion7(); -} -``` - -- Time-ordered in byte layout, so index locality is good. -- The value exists before persistence, so outbox rows, correlation and client-side graphs all work. -- Standard (RFC 9562), so it is portable and readable by other systems. -- Embeds a millisecond timestamp — which is also its disclosure caveat. - -Tell EF Core the application supplies it: - -```csharp -builder.Property(o => o.Id).ValueGeneratedNever(); -``` - -Without that, EF Core may treat the key as store-generated and skip your value. - -### Application-generated, store-ordered strategy - -When one context type serves both PostgreSQL and SQL Server, or the identifier must exist before -`SaveChanges` on both, use a store-specific strategy carried as context-options data. The PostgreSQL -implementation returns `FastGuid.NewPostgreSqlGuid()`; a model-finalising convention applies it to -every GUID key and leaves explicitly keyed derived identifiers alone. - -```csharp -public sealed class PostgreSqlSequentialGuidProvider : ISequentialGuidProvider -{ - public static string Name => "PostgreSql"; - - public static Guid NewGuid() => FastGuid.NewPostgreSqlGuid(); - - public static Guid NewGuid(DateTime timestampUtc) => - FastGuid.NewPostgreSqlGuid(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static DateTime GetTimestamp(Guid value) => FastGuid.PostgreSql.GetTimestamp(value); - - public static Guid MinValueFor(DateTime timestampUtc) => - FastGuid.PostgreSql.MinGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static Guid MaxValueFor(DateTime timestampUtc) => - FastGuid.PostgreSql.MaxGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); -} -``` - -- PostgreSQL compares `uuid` in plain big-endian byte order, so both `FastGuid.NewPostgreSqlGuid()` - and `Guid.CreateVersion7()` are genuinely sequential here. `FastGuid` is also correct for SQL Server, - which is the point of the strategy abstraction. -- Set `ValueGeneratedNever()` through the convention; never let EF fetch a store-generated value that - does not exist. - -#### RFC caveat - -`FastGuid.NewPostgreSqlGuid()` values are **not** RFC 9562 UUIDs. They are ordinary GUIDs with a -PostgreSQL-ordered layout, so PostgreSQL's `uuid_extract_timestamp()` will not read them even though -they are valid `uuid` values. Use the provider's `GetTimestamp` (above) instead. If another system -needs a standard timestamp, generate `Guid.CreateVersion7()` there and accept that the layout differs. - -The full sample is the Engineering Playbook's *GUID Key Strategy* page. The abstraction is earned by -the second provider, not by anticipation. - -### Database-generated UUIDv7 — PostgreSQL 18+ - -PostgreSQL 18 added a native `uuidv7()` function. Earlier versions do not have it; on 13–17 you have -`gen_random_uuid()` (v4, from the built-in pgcrypto-derived function) and nothing native for v7. - -**Check the server version before recommending `uuidv7()`.** It is the single most common way this -guidance goes wrong — the function simply does not exist on the version most deployments are running. - -```sql --- PostgreSQL 18 and later only -ALTER TABLE orders ALTER COLUMN id SET DEFAULT uuidv7(); -``` - -Prefer application-side generation anyway unless rows are inserted by paths that bypass the -application, because the value-before-persistence property is worth more than the marginal -difference. - -### `gen_random_uuid()` — database-generated v4 - -Available without an extension from PostgreSQL 13. Random, so index locality is poor, but -unpredictable and simple. - -### `Guid.NewGuid()` — application-generated v4 - -Random and unpredictable. Fine at low to moderate write volume, which covers most applications. - -## Npgsql and EF Core notes - -- `Guid` maps to `uuid` natively. Do not store UUIDs as `text` or `varchar` — it costs space, loses - index efficiency and defeats comparison. -- Npgsql's `uuid` mapping is byte-order faithful, so a v7 value sorts in the index as you expect. -- If the application generates the key, set `ValueGeneratedNever()` so EF Core does not fetch a - store-generated value that does not exist. -- A legacy database may have UUIDs in `text` columns. Migrating to `uuid` is usually worth it, but it - is a data migration, not a model change. - -## Choosing - -| Situation | Use | -| -- | -- | -| New schema, .NET 9+, UUID keys | `Guid.CreateVersion7()`, `ValueGeneratedNever()` | -| .NET 8 or earlier, high write volume | A reviewed UUIDv7 implementation, or accept v4 after measuring | -| Rows inserted outside the application, PostgreSQL 18+ | `uuidv7()` as a column default | -| Rows inserted outside the application, PostgreSQL 13–17 | `gen_random_uuid()` | -| One model serving PostgreSQL and SQL Server | A store-specific `FastGuid` strategy carried as context-options data — never one byte-ordered generator for both | -| Key must be unpredictable | `Guid.NewGuid()` or `gen_random_uuid()` — v7 leaks creation time | -| Low or moderate volume | v4 — the locality difference will not be your bottleneck | - -## The timestamp caveat - -A UUIDv7 exposes when the row was created, to the millisecond. Where identifiers are public, that can -leak signup times, order rates or activity patterns — and it makes identifiers partially guessable by -time window. Where that matters, use a random UUID for the public identifier and keep the v7 value -internal, or use a surrogate. diff --git a/.agents/skills/purview-persistence/references/sqlserver.md b/.agents/skills/purview-persistence/references/sqlserver.md deleted file mode 100644 index 22629721..00000000 --- a/.agents/skills/purview-persistence/references/sqlserver.md +++ /dev/null @@ -1,144 +0,0 @@ -# SQL Server GUID keys - -Read this only when the provider is SQL Server and GUIDs are primary keys. The PostgreSQL answer is -different — see `postgresql.md`. - -## Why SQL Server is a special case - -A clustered index determines physical row order. A `uniqueidentifier` primary key is clustered by -default, so random GUIDs insert into the middle of the index, causing page splits, fragmentation and -a larger buffer-pool working set. On a write-heavy table this is measurable. - -The complication is that **SQL Server does not compare `uniqueidentifier` values the way the bytes -are laid out.** Its ordering weights the last six bytes (node field) most significantly, then earlier -groups. So a GUID that is sequential in big-endian byte order — including a standard UUIDv7 — is -**not** sequential under SQL Server's comparison. This is precisely why the SQL Server and PostgreSQL -answers diverge. - -## The options - -### `NEWSEQUENTIALID()` — database-generated - -A column default that produces values ascending in SQL Server's own ordering. Best index locality -available. - -```sql -ALTER TABLE [Orders] ADD CONSTRAINT [DF_Orders_Id] - DEFAULT NEWSEQUENTIALID() FOR [Id]; -``` - -EF Core does **not** map `ValueGeneratedOnAdd` to `NEWSEQUENTIALID()` by default. For a `Guid` key on -SQL Server the provider generates the value client-side with `SequentialGuidValueGenerator` (below). -Configure a store default explicitly when the database must own the value: - -```csharp -builder.Property(o => o.Id).HasDefaultValueSql("NEWSEQUENTIALID()"); -``` - -Trade-offs: - -- The value does not exist until the row is inserted. EF Core retrieves it, but you cannot build an - object graph around the key beforehand. -- Values are **not** unpredictable: the sequence restarts on service restart but is otherwise - guessable. Never use one as a security token or capability URL. -- It reveals rough insert ordering, which can be an information-disclosure concern on a public - surface. - -### EF Core's `SequentialGuidValueGenerator` — client-generated - -EF Core ships a value generator that produces GUIDs ordered for SQL Server's comparison semantics, -generated in the application. - -```csharp -builder.Property(o => o.Id) - .HasValueGenerator() - .ValueGeneratedOnAdd(); -``` - -Use this when the identifier must exist before `SaveChanges`. It keeps most of the index locality -while letting the application own the value. - -### Application-generated, store-ordered strategy - -When one context type serves both SQL Server and PostgreSQL, or the identifier must exist before -`SaveChanges` on both, a single built-in generator is not enough: the two stores order GUIDs -differently. The answer is a store-specific strategy carried as context-options data — a -`static abstract` witness whose SQL Server implementation returns `FastGuid.NewSqlServerGuid()`, plus a -value generator and a model-finalising convention that applies it to every GUID key. - -```csharp -public sealed class SqlServerSequentialGuidProvider : ISequentialGuidProvider -{ - public static string Name => "SqlServer"; - - public static Guid NewGuid() => FastGuid.NewSqlServerGuid(); - - public static Guid NewGuid(DateTime timestampUtc) => - FastGuid.NewSqlServerGuid(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static DateTime GetTimestamp(Guid value) => FastGuid.SqlServer.GetTimestamp(value); - - public static Guid MinValueFor(DateTime timestampUtc) => - FastGuid.SqlServer.MinGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static Guid MaxValueFor(DateTime timestampUtc) => - FastGuid.SqlServer.MaxGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); -} -``` - -- The increasing part must sit where SQL Server sorts it. The trailing six bytes dominate - `uniqueidentifier`; a byte-ordered UUIDv7 does not. -- The generator must hand the value through the property's value converter, or a `readonly record - struct OrderId` key receives a raw `Guid`. -- Apply it at convention precedence, so explicit `ValueGeneratedNever()`, a store default and a - computed column all win. - -The full sample is the Engineering Playbook's *GUID Key Strategy* page. The abstraction is earned by -the second provider; on one SQL Server provider `NEWSEQUENTIALID()` or EF Core's generator is enough. - -### `Guid.NewGuid()` — random - -Correct, portable and unpredictable; poor index locality. - -Appropriate when write volume is low (the fragmentation never matters), when the key is -non-clustered, or when unpredictability is a requirement. Do not dismiss it by default — for most -applications it is fine, and "most applications" includes more than people expect. - -### `Guid.CreateVersion7()` — .NET 9+ - -Ordered in byte layout, but **not** ordered under SQL Server's comparison. On SQL Server it behaves -roughly like a random GUID for clustered-index purposes. It is the right answer on PostgreSQL and the -wrong answer here, which is the trap this page exists to prevent. - -Use it on SQL Server only when you want the embedded timestamp for application reasons and accept -random-like insert locality. - -## Decoupling the key from the index - -Often the best answer is not a different GUID but a different index. Keep the GUID as the primary key -and make the clustered index something naturally ascending: - -```csharp -builder.HasKey(o => o.Id).IsClustered(false); -builder.HasIndex(o => o.CreatedAt).IsClustered(); -``` - -This removes the page-split problem entirely and leaves the key unpredictable. Consider it before -reaching for a sequential generator. - -## Choosing - -| Situation | Use | -| -- | -- | -| High insert volume, key may be database-generated | `NEWSEQUENTIALID()` | -| High insert volume, identifier needed before persisting | EF Core `SequentialGuidValueGenerator`, or a store-ordered `FastGuid` strategy when both providers share a model | -| Key must be unpredictable (public surface, security boundary) | `Guid.NewGuid()`, with a non-clustered PK | -| Low or moderate volume | `Guid.NewGuid()` — do not optimise what does not hurt | -| You want a sortable timestamp in the key and accept the locality cost | `Guid.CreateVersion7()` | - -## Measure before optimising - -Index fragmentation from random GUIDs is real but frequently irrelevant. Before changing a key -strategy, confirm it matters: check page splits, fragmentation and buffer-pool pressure on the actual -table at the actual volume. Changing a primary key strategy on a live table is expensive; do it -against evidence. diff --git a/.agents/skills/purview-persistence/references/well-known-identifiers.md b/.agents/skills/purview-persistence/references/well-known-identifiers.md deleted file mode 100644 index 372d5855..00000000 --- a/.agents/skills/purview-persistence/references/well-known-identifiers.md +++ /dev/null @@ -1,93 +0,0 @@ -# Deriving well-known identifiers with UUIDv5 - -Read this only when an identifier's **value must be known before storage**: a system tenant, a seeded -reference row, an installation's service principal, or an ingested object whose provider key is stable -and never recycled. A project with random keys and no seeding has no use for UUIDv5 — say nothing and -move on. An outbox row that merely needs an id before `SaveChanges` takes a generated strategy instead. - -## The rule - -1. Derive the value: `Uuid5.Create(namespace, name)` is RFC 4122 version 5 (SHA-1), byte-identical for - the same namespace and name in every process, language and restart. -2. Scope the namespace to the isolation boundary — one installation or one deployment. Never a global - constant shared by every deployment. -3. Fix the name as a canonical constant of the identity kind. Not a display name, not user data, not a - secret. -4. Once persisted, the value is authoritative. Never recompute it and update the row. -5. Key it explicitly with `ValueGeneratedNever()`, so a sequential-GUID convention never generates over - a value the application already knows. - -## The catalogue - -Write the known identities down in one place. - -| Identity | Namespace | Name | Derived when | Immutable | -| -- | -- | -- | -- | -- | -| System tenant of an installation | installation id | `system-tenant` | first bootstrap | yes | -| System principal of an installation | installation id | `system-service-principal` | first bootstrap | yes | -| Seeded reference row | installation id | `:` | seed step | yes | -| Ingested external object (optional) | installation id | `:` | first ingest | yes | - -Derive the ingested row only when the provider guarantees the external key is stable and never -recycled. If it can be recycled, keep the local key sequential and make the external key a unique -column. - -## Naming rules - -- Lowercase ASCII, hyphen-separated, no whitespace, no locale-dependent casing. -- Never from a display name, email, URL, title, or anything a user can edit. -- Never from a secret, and never as a capability token. A name is guessable. -- Renaming a name creates a new identity. Renaming a persisted one is a data migration. - -## Bootstrap sequence - -Read the persisted identity; if present it wins, and a configured value must match or the operation -fails. If absent, insert it. Derive dependants from the persisted id. Save once. A second run changes -nothing. - -The guard matters as much as the insert: - -```csharp -if (persisted is not null && persisted.Id != configured) -{ - throw new InvalidOperationException( - $"Configured installation id '{configured.Value}' does not match the persisted id '{persisted.Id.Value}'."); -} -``` - -## Migrations cannot call the helper - -`HasData` and migration SQL need a literal GUID. A small script prints ready-to-paste constants from -the same derivation, and a test asserts every printed constant equals `Uuid5.Create(...)`. Changing the -namespace or a name after a migration has shipped is a data migration, not an edit. - -## Checks to write - -| Check | Shape | -| -- | -- | -| RFC 4122 conformance | Fixed vectors for DNS/URL/OID/X500 and the empty name; exact GUIDs | -| Determinism | Same pair twice equal; different names differ | -| Version and variant bits | Byte 6 high nibble `0x5`; byte 8 high bits `10` | -| Cross-language equality | Python `uuid.uuid5` or Node `crypto` reproduces the vectors | -| Catalogue uniqueness | The catalogue's constants are distinct | -| Bootstrap idempotency | Seeding twice changes zero rows; a mismatched configured id throws | -| Explicit keying | The key is `ValueGenerated.Never`, and the sequential convention leaves it alone | - -```text -uuid5(6ba7b810-9dad-11d1-80b4-00c04fd430c8, "example.com") = cfbff0d1-9375-5685-968c-48ce8b15ae17 -uuid5(6ba7b811-9dad-11d1-80b4-00c04fd430c8, "www.example.com") = b63cdfa4-3df9-568e-97ae-006c5b8fd652 -uuid5(6ba7b812-9dad-11d1-80b4-00c04fd430c8, "1.2.3.4") = 67448b45-6d15-536b-bef7-8a78c3d10ac6 -uuid5(6ba7b814-9dad-11d1-80b4-00c04fd430c8, "CN=Bob") = 0840e90d-9ca0-5f14-970e-26294d44cb1d -``` - -The hash path is big-endian. `Guid.ToByteArray()` and `new Guid(byte[])` use a mixed-endian layout and -produce a different hash; that is the most common way a "UUIDv5" implementation is wrong. - -**UUIDv5 is not sequential.** Never use it for a high-write table's primary key. It is for a small, -known set of identities; everything else takes `guid-generation.md`. - -RFC 4122 is the version-5 specification; RFC 9562 is the current UUID specification and retains the -algorithm. The .NET BCL has no UUIDv5 API, so the helper is a small hand-written function. - -The Engineering Playbook's *Well-Known Identifiers* page carries the full helper, catalogue and -bootstrap samples, and their test shapes. diff --git a/.agents/skills/purview-site-assessment/SKILL.md b/.agents/skills/purview-site-assessment/SKILL.md deleted file mode 100644 index 64afe45b..00000000 --- a/.agents/skills/purview-site-assessment/SKILL.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -name: purview-site-assessment -description: Assess how well a Purview repository integrates with purview.dev and recommend fixes - runs a dependency-free script over the checkout (docs layout and hierarchy, root page, slugs and collisions, titles, broken links and images, ASCII-art and unlabelled Mermaid diagrams, purview:likec4 diagram pairs and their .c4 models, _redirects.yml and page moves in git history that left no redirect, agent skills front matter), cross-checks the site's catalogue entry and the live GitHub metadata, and produces a prioritised report with a concrete fix for each finding. Use before a repository joins purview.dev, after reorganising docs, when the site shows something wrong for the project, or when asked to audit or "assess" site integration. -license: MIT -metadata: - site: https://purview.dev - repository: purview-dev/purview-dev ---- - -# Assessing a repository's purview.dev integration - -The rules being checked are in `purview-site-docs` (how documentation is written) and -`purview-site-integration` (everything else the site reads). This skill finds where a repository -departs from them, ranks the findings, and proposes fixes. It **reports first and edits only when -asked**; and it never edits `purview-dev/purview-dev` — catalogue changes are proposed as a snippet for -the site maintainers. - -## 1. Fetch the catalogue entry (when the project is on the site) - -The entry carries contracts the repository must keep: the docs path, the root page, every use case's -`docsPage` deep link, and any redirects recorded on the site side. - -```shell -curl -sfL https://raw.githubusercontent.com/purview-dev/purview-dev/main/src/src/data/projects/.yml -o .purview-entry.yml -``` - -`` is normally the repository name (`unions`, `build-sdk`, `pm-skills`). A 404 means the project is -not on the site yet — assess without it and include the entry proposal from -`purview-site-integration` (references/catalogue-contract.md) in the report. Delete -`.purview-entry.yml` when done; never commit it. - -## 2. Run the script - -```shell -node /scripts/assess.mjs . --catalogue .purview-entry.yml -``` - -`` is where the skill was installed (for example `.agents/skills/purview-site-assessment`). -Options: `--docs ` to name the docs folder (default `docs/wiki`, then `docs`), `--json` for -machine-readable output. It reads files and `git log` only, needs Node 18+, and exits 1 when an -error-level finding exists, so it can also run in CI. - -Every rule id it prints is explained, with how to fix it, in [references/rules.md](references/rules.md). - -## 3. Check what the script cannot see - -```shell -gh api repos/purview-dev/ --jq '{description, topics, archived, default_branch, has_discussions}' -gh api "repos/purview-dev//releases?per_page=5" --jq '.[] | {tag_name, prerelease, published_at}' -``` - -| Check | Finding when it fails | -| -- | -- | -| 6–15 topics, lower-case and hyphenated | **META-001** warning — the card shows no or weak tags | -| a description that agrees with the entry's `shortDescription` | **META-002** info | -| `default_branch` is `main` (or the entry says otherwise) | **META-003** error — the docs and edit links follow it | -| at least one release, tagged `vX.Y.Z` or `vX.Y.Z-prerelease.N`, matching the package version | **META-004** warning — no version is shown | -| entry `status` agrees: stable registry version → `stable`; prerelease only → `preview`; archived repository → `archived` | **META-005** warning | -| the repository is not archived while the entry says `stable`/`preview` | **META-006** error | - -Then read what a script cannot judge: - -- **Hierarchy.** Do the topic folders match how a reader looks for things? Are pages in the folder - for their topic? A DOCS-003 finding needs a proposed tree, not just "add folders". -- **Diagrams.** For each DIAG-001 (ASCII art) and DIAG-008 (Mermaid in a text fence), decide whether it - is an architecture or flow diagram (→ LikeC4 model + Mermaid pair) or a small sketch (→ a labelled - ```` ```mermaid ```` fence is enough). Draft the model for the most important one. -- **README vs docs.** Does the README point into the docs, or duplicate them? -- **Skills.** Does each `description` say what the skill does *and when to use it*? - -## 4. Report - -Lead with a one-paragraph verdict, then the findings grouped by priority, each with the fix written -out — the redirect line, the renamed path, the converted fence — not just the rule: - -```markdown -# purview.dev integration: - - - -## Blockers (break the site's sync or build) -| Rule | Where | Problem | Fix | - -## Should fix (readers see something wrong) -| Rule | Where | Problem | Fix | - -## Improvements -| Rule | Where | Problem | Fix | - -## Proposed changes -- `docs/wiki/_redirects.yml` — the full file. -- The proposed docs tree, when DOCS-003 fired. -- One converted diagram pair (model + Mermaid), when DIAG-001/008 fired. -- The catalogue entry snippet for the site maintainers, when the entry is missing or drifts. -``` - -Blockers are every `error`; "should fix" is every `warning` plus META errors; improvements are -`info`. Collapse repeated findings into one row with a count and the list of places. - -## 5. Fixing (only when asked) - -Work in this order — each step changes what the next one sees: - -1. Blockers: unclosed fences, broken links and images, slug collisions, missing deep-link pages. -2. Redirects for moves already made (RED-004), before any further move. -3. Reorganise a flat tree into topic folders (`git mv`), adding each move to `_redirects.yml` and fixing - inbound links in the same commit. Leave catalogue deep-linked pages at the root. -4. Convert diagrams. Validate each model with `npx likec4 validate `. -5. Rerun the script; the report should show no errors, and only warnings you have explained. diff --git a/.agents/skills/purview-site-assessment/references/rules.md b/.agents/skills/purview-site-assessment/references/rules.md deleted file mode 100644 index 245e5853..00000000 --- a/.agents/skills/purview-site-assessment/references/rules.md +++ /dev/null @@ -1,79 +0,0 @@ -# Assessment rules - -Severity is what the finding costs: an **error** breaks the site's sync or build, or loses content; a -**warning** is visible to readers; an **info** is an improvement. - -## Repository - -| Rule | Severity | Finding | Fix | -| -- | -- | -- | -- | -| REPO-001 | error | no `README.md` | add one: what it is, install, a minimal example, a link into the docs | - -## Documentation - -| Rule | Severity | Finding | Fix | -| -- | -- | -- | -- | -| DOCS-001 | warning / info | no docs folder; warning when the README is long enough to be a docs tree (≥ 8 `##` sections or ≥ 300 lines) | create `docs/wiki/` with topic folders; keep the README as the front door | -| DOCS-002 | warning | no `Home.md`/`index.md`/`README.md` at the docs root | add `Home.md`, or have the entry set `docs.rootPage` | -| DOCS-003 | warning / info | a flat folder of 7+ pages, or 10+ pages left at the root beside folders | group into topic folders; keep only the hub, getting-started and deep-linked pages at the root | -| DOCS-004 | info | folders more than two levels deep | flatten unless a sub-area has several pages of its own | -| DOCS-005 | error / warning | a path that reduces to an unpublishable slug (error), a name the site has to rewrite (warning), or a page or folder named `prerelease` (error) | letters, digits and single dashes | -| DOCS-006 | error | two files publish at the same URL | rename one | -| DOCS-007 | warning | no `#` title, or more than one | exactly one `# Title` first | -| DOCS-008 | error | a relative link to a file that does not exist | fix the path; it resolves from the page's own folder | -| DOCS-009 | error | a relative image that does not exist | fix the path or add the image | -| DOCS-010 | info | a fence with no language | label it | -| DOCS-011 | info / warning | no `_Sidebar.md` (info), a sidebar link to a missing page (warning), a page not in the sidebar (info) | list every page once, by section | -| DOCS-012 | info | `mkdocs.yml` present | delete it; the site ignores it | -| DOCS-013 | error | a code fence never closed | close it | - -## Diagrams - -| Rule | Severity | Finding | Fix | -| -- | -- | -- | -- | -| DIAG-001 | warning | ASCII-art diagram in a text fence | LikeC4 model + Mermaid fence in a `purview:likec4` block; legends become tables | -| DIAG-002 | info | a ```` ```mermaid ```` fence with no LikeC4 pair | fine as is; pair architecture and flow diagrams | -| DIAG-003 | warning | a bare ```` ```likec4 ```` fence — GitHub shows source | move the model to a `.c4` file and use a pair | -| DIAG-004 | error | a malformed pair: unclosed or orphan marker, no `file`, a model that is missing or outside the repository, or a `view` the model does not declare | fix the marker or the model; the site shows the Mermaid until then | -| DIAG-005 | warning | a model that imports or has no `specification` | one self-contained file per diagram | -| DIAG-006 | warning | a pair with no Mermaid fence, so GitHub shows nothing | add the Mermaid rendering between the markers | -| DIAG-007 | info | a pair that does not name its `view` | add `view=""` | -| DIAG-008 | warning | Mermaid source inside a ```` ```text ```` fence | label it ```` ```mermaid ````; both renderers draw it | - -The text-fence classifier skips folder trees (`├──`, `└──`), which are listings rather than diagrams. - -## Redirects - -| Rule | Severity | Finding | Fix | -| -- | -- | -- | -- | -| RED-001 | error | `_redirects.yml` unreadable, or a pair that cannot become a URL or points at itself — the site's sync fails | one `previous: current` per line under `redirects:` | -| RED-002 | warning | a destination that is not a page | point at the page's current path | -| RED-003 | info | a source that is still a page, so the redirect is inactive | expected while the move is unreleased | -| RED-004 | warning | a page renamed or deleted in git history with no redirect (here or in the catalogue's `docs.redirects`) | add the pair the finding suggests, unless the page was never published | -| RED-005 | warning | a chain (`a → b`, `b → c`) | point every old slug at the final page | - -RED-004 reads the last 300 commits that touched the docs folder. A page that existed only between two -site builds was never published; ignore those. - -## Catalogue (with `--catalogue`) - -| Rule | Severity | Finding | Fix | -| -- | -- | -- | -- | -| CAT-001 | error | the entry's `docs.path` (or `--docs`) has no Markdown | create it, or correct the entry | -| CAT-002 | error | the entry's `docs.rootPage` does not exist | restore the page, or change the entry in the same release | -| CAT-003 | error | a use case's `docsPage` is not a page — the site's build fails | keep the page at the root under its name, or move the deep link | -| CAT-004 | info | the entry carries `docs.redirects` | move them into `_redirects.yml`, then drop them from the entry | - -## Agent skills - -| Rule | Severity | Finding | Fix | -| -- | -- | -- | -- | -| SKILL-001 | error | a `skills//` folder with no `SKILL.md` | add it, or move the folder | -| SKILL-002 | error | no front matter, or no `name` / `description` | add them | -| SKILL-003 | error | `name` differs from the folder | make them equal | -| SKILL-004 | warning | `name` is not a lower-case slug | rename | -| SKILL-005 | error | `SKILL.md` links a file that is not in the skill folder | ship it beside `SKILL.md` — only the folder is installed | - -## Metadata (checked by hand with `gh`) - -META-001 … META-006 are listed in `SKILL.md`, step 3. diff --git a/.agents/skills/purview-site-assessment/scripts/assess.mjs b/.agents/skills/purview-site-assessment/scripts/assess.mjs deleted file mode 100644 index 644c8b59..00000000 --- a/.agents/skills/purview-site-assessment/scripts/assess.mjs +++ /dev/null @@ -1,669 +0,0 @@ -#!/usr/bin/env node -// Assess a repository's readiness for purview.dev. -// -// node assess.mjs [repository-root] [--docs ] [--catalogue ] [--json] -// -// Reads files only (plus `git log`, when git is available). No network, no -// dependencies, Node 18+. Exit code 1 when an error-level finding exists. -// -// `--catalogue` is a local copy of this project's purview.dev catalogue entry -// (purview-dev/purview-dev: src/src/data/projects/.yml). With it, the -// docs path, root page, deep links and catalogue redirects are checked too. -// -// The rules mirror what purview.dev's docs sync does (purview-dev/purview-dev, -// src/src/lib/docs/). Each finding names a rule id the SKILL.md explains. - -import { execFileSync } from 'node:child_process'; -import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs'; -import { basename, dirname, join, posix, relative, resolve, sep } from 'node:path'; - -// --------------------------------------------------------------------------- -// Arguments -// --------------------------------------------------------------------------- - -const args = process.argv.slice(2); -const json = args.includes('--json'); -const option = (name) => { - const index = args.indexOf(name); - return index >= 0 ? args[index + 1] : undefined; -}; -const VALUE_OPTIONS = new Set(['--docs', '--catalogue']); -const root = resolve( - args.find((arg, index) => !arg.startsWith('--') && !VALUE_OPTIONS.has(args[index - 1])) ?? '.', -); -const cataloguePath = option('--catalogue'); - -/** - * The few catalogue fields the checks need, read line by line from the entry's - * fixed layout (no YAML dependency): docs source/path/rootPage, docs.redirects - * and every use case's docsPage. - */ -function readCatalogueEntry(path) { - const lines = readFileSync(path, 'utf8').replace(/\r\n?/g, '\n').split('\n'); - const entry = { source: undefined, path: undefined, rootPage: undefined, redirects: {}, docsPages: [] }; - let section = null; - let sectionIndent = 0; - for (const line of lines) { - const indent = line.length - line.trimStart().length; - const text = line.trim().replace(/\s+#.*$/, ''); - if (text === '' || text.startsWith('#')) continue; - if (indent === 0) { - section = text === 'docs:' ? 'docs' : null; - continue; - } - if (section === 'docs' && text === 'redirects:') { - section = 'redirects'; - sectionIndent = indent; - continue; - } - if (section === 'redirects') { - if (indent <= sectionIndent) { - section = 'docs'; - } else { - const pair = /^["']?([^"':]+)["']?\s*:\s*["']?([^"']+?)["']?$/.exec(text); - if (pair) entry.redirects[pair[1].trim()] = pair[2].trim(); - continue; - } - } - if (section === 'docs') { - const field = /^(source|path|rootPage):\s*["']?([^"']+?)["']?$/.exec(text); - if (field && indent === 2) entry[field[1]] = field[2]; - } - const deepLink = /^docsPage:\s*["']?([^"'\s]+)["']?$/.exec(text); - if (deepLink) entry.docsPages.push(deepLink[1]); - } - return entry; -} - -const catalogue = cataloguePath ? readCatalogueEntry(resolve(cataloguePath)) : null; -const docsOverride = option('--docs') ?? (catalogue?.source === 'github-path' ? catalogue.path : undefined); - -/** @type {{ id: string; severity: 'error' | 'warning' | 'info'; file?: string; line?: number; message: string; fix: string }[]} */ -const findings = []; -const report = (id, severity, file, line, message, fix) => - findings.push({ id, severity, file, line, message, fix }); - -// --------------------------------------------------------------------------- -// File helpers -// --------------------------------------------------------------------------- - -const toPosix = (path) => path.split(sep).join('/'); -const repoPath = (absolute) => toPosix(relative(root, absolute)); -const read = (absolute) => readFileSync(absolute, 'utf8').replace(/\r\n?/g, '\n'); -const IGNORED_DIRS = new Set(['.git', 'node_modules', 'bin', 'obj', 'dist', '.vs', '.idea', 'artifacts']); - -function walk(directory, predicate, found = []) { - for (const entry of readdirSync(directory, { withFileTypes: true })) { - const absolute = join(directory, entry.name); - if (entry.isDirectory()) { - if (!IGNORED_DIRS.has(entry.name)) { - walk(absolute, predicate, found); - } - } else if (predicate(absolute)) { - found.push(absolute); - } - } - return found; -} - -// --------------------------------------------------------------------------- -// Slugs — the same reduction purview.dev applies (src/src/lib/docs/links.ts) -// --------------------------------------------------------------------------- - -const reduceSegment = (segment) => - segment - .replace(/[^a-zA-Z0-9-]+/g, '-') - .replace(/^-+|-+$/g, '') - .toLowerCase(); - -function docSlug(relativePath) { - const segments = relativePath.split('/').filter((segment) => segment !== '' && segment !== '.'); - return segments - .map((segment, index) => { - if (index < segments.length - 1) { - return reduceSegment(segment); - } - const name = segment.replace(/\.(md|mdx)$/i, ''); - return segments.length > 1 && /^readme$/i.test(name) ? 'index' : reduceSegment(name); - }) - .join('/'); -} - -const SAFE_SEGMENT = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/; -const isIndexName = (name) => /^(home|index|readme)\.md$/i.test(name); - -// --------------------------------------------------------------------------- -// Markdown helpers -// --------------------------------------------------------------------------- - -/** Lines with fenced code blanked (fences reported separately), so headings and links are read from prose only. */ -function scanFences(text) { - const lines = text.split('\n'); - const fences = []; - const prose = [...lines]; - let open = null; - lines.forEach((line, index) => { - const match = /^ {0,3}(`{3,}|~{3,})(.*)$/.exec(line); - if (!open && match) { - open = { start: index, run: match[1], info: match[2].trim(), body: [] }; - prose[index] = ''; - return; - } - if (open) { - if (match && match[1][0] === open.run[0] && match[1].length >= open.run.length && match[2].trim() === '') { - fences.push({ ...open, end: index }); - open = null; - } else { - open.body.push(line); - } - prose[index] = ''; - } - }); - if (open) { - fences.push({ ...open, end: lines.length - 1, unclosed: true }); - } - return { lines, prose, fences }; -} - -const stripInlineCode = (line) => line.replace(/`+[^`]*`+/g, ''); - -const MERMAID_START = /^\s*(flowchart|graph|sequenceDiagram|classDiagram|stateDiagram(-v2)?|erDiagram|gantt|journey|mindmap|timeline|C4Context|C4Container|C4Component|gitGraph|pie|quadrantChart|block-beta|architecture-beta)\b/; - -/** - * What an unlabelled or `text` fence holds: `mermaid` source (the old - * "Mermaid goes in a text block" convention), a folder `tree` (a listing, not a - * diagram), an ASCII-art `diagram`, or null for ordinary text. - */ -function classifyTextFence(fence) { - const language = fence.info.split(/\s+/)[0].toLowerCase(); - if (!['', 'text', 'txt', 'plaintext', 'ascii', 'none'].includes(language)) { - return null; - } - const body = fence.body.filter((line) => line.trim() !== ''); - if (body.length === 0) { - return null; - } - if (MERMAID_START.test(body[0])) { - return 'mermaid'; - } - const treeLines = body.filter((line) => /[├└]──|^\s*│|^\s*[\w.<>-]+\/\s*$/.test(line)).length; - if (treeLines >= Math.ceil(body.length / 2)) { - return 'tree'; - } - if (body.length < 3) { - return null; - } - const boxDrawing = body.some((line) => /[┌┐┘┬┴┼═║╔╗╚╝▶▼◀▲]/.test(line)); - const arrows = body.filter((line) => /(-{1,}>|<-{1,}|={1,}>|\+-{2,}|-{3,}\+|→|↓)/.test(line)).length; - const connectors = body.filter( - (line) => /^\s*[|^v+]\s*($|\s{2,})|\s{2,}[|^v+]\s*$/.test(line) || /\s[|^]\s{3,}[|^]/.test(line), - ).length; - return boxDrawing || (arrows >= 1 && connectors >= 1) || arrows >= 3 ? 'diagram' : null; -} - -// --------------------------------------------------------------------------- -// Diagram pairs — mirrors src/src/lib/docs/diagrams.ts -// --------------------------------------------------------------------------- - -const DIAGRAM_OPEN = /^ {0,3}\s*$/; -const DIAGRAM_CLOSE = /^ {0,3}\s*$/; - -function parseOptions(source) { - const options = {}; - for (const match of source.matchAll(/([A-Za-z][\w-]*)\s*=\s*(?:"([^"]*)"|'([^']*)'|([^\s"']+))/g)) { - options[match[1]] = match[2] ?? match[3] ?? match[4] ?? ''; - } - return options; -} - -function declaredViews(source) { - return new Set( - [...source.matchAll(/(?:^|[\s{;])(?:dynamic\s+|deployment\s+)?view\s+([A-Za-z_][\w-]*)/g)].map((m) => m[1]), - ); -} - -function checkDiagramBlocks(file, scan) { - const page = repoPath(file); - const inFence = new Set(); - for (const fence of scan.fences) { - for (let index = fence.start; index <= fence.end; index++) inFence.add(index); - } - const blocks = []; - let open = null; - scan.lines.forEach((line, index) => { - if (inFence.has(index)) return; - const opening = DIAGRAM_OPEN.exec(line); - if (opening) { - if (open) { - report('DIAG-004', 'error', page, open.line, 'A purview:likec4 block is not closed before the next one opens.', 'Add `` after the Mermaid fence.'); - } - open = { line: index + 1, start: index, options: parseOptions(opening[1]) }; - } else if (DIAGRAM_CLOSE.test(line)) { - if (!open) { - report('DIAG-004', 'error', page, index + 1, 'A closing purview:likec4 marker has no opening marker.', 'Remove it, or add the opening marker with file="…" and view="…".'); - } else { - blocks.push({ ...open, end: index }); - open = null; - } - } - }); - if (open) { - report('DIAG-004', 'error', page, open.line, 'A purview:likec4 block is never closed.', 'Add `` after the Mermaid fence.'); - } - - for (const block of blocks) { - const inner = scan.fences.filter((fence) => fence.start > block.start && fence.end < block.end); - if (!inner.some((fence) => fence.info.split(/\s+/)[0] === 'mermaid')) { - report('DIAG-006', 'warning', page, block.line, 'The diagram block has no ```mermaid fence, so GitHub readers see no diagram.', 'Put the Mermaid rendering of the view between the markers.'); - } - const file = block.options.file; - if (!file) { - report('DIAG-004', 'error', page, block.line, 'The purview:likec4 marker has no file="…"; the site will show the Mermaid instead.', 'Add file="./diagrams/.c4" (relative to the page).'); - continue; - } - const target = file.startsWith('/') ? posix.normalize(file.slice(1)) : posix.normalize(posix.join(posix.dirname(page), file)); - if (target.startsWith('..')) { - report('DIAG-004', 'error', page, block.line, `file="${file}" leaves the repository.`, 'Keep the model inside the repository.'); - continue; - } - const absolute = join(root, target); - if (!existsSync(absolute)) { - report('DIAG-004', 'error', page, block.line, `file="${file}" does not exist (${target}); the site will show the Mermaid instead.`, 'Create the model or fix the path (it is relative to the page).'); - continue; - } - const model = read(absolute); - const views = declaredViews(model); - if (block.options.view && !views.has(block.options.view)) { - report('DIAG-004', 'error', page, block.line, `${target} declares no view "${block.options.view}" (declared: ${[...views].join(', ') || 'none'}).`, 'Name an existing view, or add it to the model.'); - } else if (!block.options.view) { - report('DIAG-007', 'info', page, block.line, 'The diagram block does not name a view, so the first view in the model is shown.', 'Add view="" so a new view added first does not change this page.'); - } - if (/^\s*import\s/m.test(model) || !/\bspecification\s*\{/.test(model)) { - report('DIAG-005', 'warning', target, 1, 'The model is not self-contained (it imports, or has no specification block). The site compiles each file on its own.', 'Give the file its own `specification`, `model` and `views`, and remove imports.'); - } - } - return blocks; -} - -// --------------------------------------------------------------------------- -// `_redirects.yml` — a tolerant reader for the simple shape the site documents -// --------------------------------------------------------------------------- - -function parseRedirects(text) { - const pairs = []; - const errors = []; - text.split('\n').forEach((raw, index) => { - const line = raw.replace(/\s+#.*$/, '').replace(/^#.*$/, ''); - if (line.trim() === '' || /^redirects:\s*$/.test(line.trim())) return; - const match = /^\s*(?:"([^"]+)"|'([^']+)'|([^:#\s][^:#]*?))\s*:\s*(?:"([^"]*)"|'([^']*)'|(.*?))\s*$/.exec(line); - if (!match) { - errors.push({ line: index + 1, message: `cannot read "${raw.trim()}" as \`previous: current\`` }); - return; - } - const from = match[1] ?? match[2] ?? match[3]; - const to = match[4] ?? match[5] ?? match[6]; - if (!to) { - errors.push({ line: index + 1, message: `"${from}" has no destination` }); - return; - } - pairs.push({ line: index + 1, from, to }); - }); - return { pairs, errors }; -} - -const redirectSlug = (value) => { - const trimmed = value.trim().replace(/^\/+|\/+$/g, ''); - return docSlug(/\.(md|mdx)$/i.test(trimmed) ? trimmed : `${trimmed}.md`); -}; - -// --------------------------------------------------------------------------- -// Repository-level checks -// --------------------------------------------------------------------------- - -if (!existsSync(root) || !statSync(root).isDirectory()) { - console.error(`Not a directory: ${root}`); - process.exit(2); -} - -const readmePath = ['README.md', 'readme.md', 'Readme.md'].map((name) => join(root, name)).find(existsSync); -if (!readmePath) { - report('REPO-001', 'error', undefined, undefined, 'No README.md at the repository root.', 'Add one: what the project is, install, a minimal example, a link into the docs.'); -} -for (const site of ['mkdocs.yml', 'mkdocs.yaml', 'docs/mkdocs.yml', 'docs/wiki/mkdocs.yml']) { - if (existsSync(join(root, site))) { - report('DOCS-012', 'info', site, undefined, `${site} is a site configuration purview.dev ignores.`, 'Delete it; the site reads the Markdown directly. Rewrite any Material-only markup it enabled as plain Markdown.'); - } -} - -// --------------------------------------------------------------------------- -// Documentation -// --------------------------------------------------------------------------- - -const docsCandidates = docsOverride ? [docsOverride] : ['docs/wiki', 'docs']; -const docsRootRelative = docsCandidates.find((candidate) => { - const absolute = join(root, candidate); - return existsSync(absolute) && statSync(absolute).isDirectory() && walk(absolute, (path) => path.endsWith('.md')).length > 0; -}); - -if (docsOverride && !docsRootRelative) { - report('CAT-001', 'error', docsOverride, undefined, `The docs folder "${docsOverride}" has no Markdown${catalogue ? " (the catalogue's docs.path)" : ''}; the site publishes nothing.`, 'Create the folder, or correct docs.path.'); -} - -/** Every Markdown file the checks read: the docs tree and the README. */ -const markdownFiles = []; -let pageSlugs = new Set(); - -if (!docsRootRelative) { - const readme = readmePath ? read(readmePath) : ''; - const sections = (readme.match(/^## /gm) ?? []).length; - const lines = readme.split('\n').length; - if (sections >= 8 || lines >= 300) { - report('DOCS-001', 'warning', 'README.md', undefined, `No docs folder, and the README has ${sections} sections over ${lines} lines — it is a documentation tree in one file.`, 'Move the reference material into docs/wiki/ topic folders (see purview-site-docs) and keep the README as the front door.'); - } else { - report('DOCS-001', 'info', undefined, undefined, 'No docs folder; purview.dev would publish README.md as the only page (docs.source: readme).', 'Fine for a small project. Create docs/wiki/ once the README outgrows one page.'); - } - if (readmePath) markdownFiles.push(readmePath); -} else { - const docsRoot = join(root, docsRootRelative); - const docFiles = walk(docsRoot, (path) => path.endsWith('.md')); - const relativeToDocs = (absolute) => toPosix(relative(docsRoot, absolute)); - const pages = docFiles.filter((path) => !/^_(Sidebar|Footer)\.md$/i.test(basename(path))); - markdownFiles.push(...pages); - if (readmePath && !pages.includes(readmePath)) markdownFiles.push(readmePath); - - // Root page: the catalogue's rootPage when it names one, else the conventional index. - const rootFiles = pages.filter((path) => dirname(path) === docsRoot); - const configuredRoot = catalogue?.rootPage - ? pages.find((path) => relativeToDocs(path).toLowerCase() === catalogue.rootPage.toLowerCase()) - : undefined; - if (catalogue?.rootPage && !configuredRoot) { - report('CAT-002', 'error', `${docsRootRelative}/${catalogue.rootPage}`, undefined, `The catalogue's docs.rootPage "${catalogue.rootPage}" does not exist; the site's sync fails.`, 'Restore the page, or ask the site maintainers to change docs.rootPage in the same release.'); - } - const index = configuredRoot ?? rootFiles.find((path) => isIndexName(basename(path))); - if (!index) { - report('DOCS-002', 'warning', docsRootRelative, undefined, 'No Home.md, index.md or README.md at the docs root.', 'Add Home.md as the hub, or have the catalogue entry name docs.rootPage.'); - } - - // Shape: flat corpus, depth. - const folders = new Set(pages.map((path) => dirname(relativeToDocs(path))).filter((folder) => folder !== '.')); - if (folders.size === 0 && pages.length >= 7) { - report('DOCS-003', 'warning', docsRootRelative, undefined, `${pages.length} pages in one flat folder.`, 'Group them into lower-case topic folders (guide/, configuration/, reference/); keep only the hub, getting-started and catalogue deep-linked pages at the root; add each move to _redirects.yml.'); - } else if (rootFiles.length >= 10 && folders.size > 0) { - report('DOCS-003', 'info', docsRootRelative, undefined, `${rootFiles.length} pages are still at the docs root beside ${folders.size} folder(s).`, 'Move pages into their topic folder unless the catalogue deep-links them (useCases[].docsPage).'); - } - for (const folder of folders) { - if (folder.split('/').length > 2) { - report('DOCS-004', 'info', `${docsRootRelative}/${folder}`, undefined, 'Folders nested more than two levels deep.', 'One level of topic folders is the default; nest only for a sub-area with several pages of its own.'); - } - } - - // Names and slugs. - const bySlug = new Map(); - for (const path of pages) { - const relativePath = relativeToDocs(path); - const slug = path === index ? 'index' : docSlug(relativePath); - const segments = slug.split('/'); - if (segments.some((segment) => !SAFE_SEGMENT.test(segment))) { - report('DOCS-005', 'error', repoPath(path), undefined, `"${relativePath}" reduces to the unpublishable slug "${slug}"; the site's sync fails on it.`, 'Rename every folder and the file with letters, digits and dashes.'); - } else { - const unsafe = relativePath.replace(/\.md$/i, '').split('/').filter((segment) => !/^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$/.test(segment)); - if (unsafe.length > 0) { - report('DOCS-005', 'warning', repoPath(path), undefined, `"${unsafe.join('/')}" is rewritten to publish (${slug}).`, 'Rename with letters, digits and single dashes so the file name and the URL agree.'); - } - } - if (slug === 'prerelease' || slug.startsWith('prerelease/')) { - report('DOCS-005', 'error', repoPath(path), undefined, '"prerelease" is reserved for the prerelease documentation channel.', 'Rename the page or folder.'); - } - const existing = bySlug.get(slug); - if (existing) { - report('DOCS-006', 'error', repoPath(path), undefined, `Publishes at the same URL as ${repoPath(existing)} (${slug}).`, 'Rename one of them.'); - } else { - bySlug.set(slug, path); - } - } - pageSlugs = new Set(bySlug.keys()); - - // Catalogue deep links: a use case's docsPage that is not a page fails the site's catalogue check. - for (const docsPage of catalogue?.docsPages ?? []) { - if (!pageSlugs.has(docsPage)) { - report('CAT-003', 'error', docsRootRelative, undefined, `The catalogue deep-links "${docsPage}" (useCases[].docsPage), which is not a page here; the site's build fails.`, 'Keep that page at the docs root under its name, or ask the site maintainers to update the use case in the same release.'); - } - } - if (catalogue && Object.keys(catalogue.redirects).length > 0) { - report('CAT-004', 'info', `${docsRootRelative}/_redirects.yml`, undefined, `The catalogue entry carries ${Object.keys(catalogue.redirects).length} docs.redirects pair(s).`, 'Move them into _redirects.yml here, then ask the site maintainers to drop them from the entry.'); - } - - // Sidebar. - const sidebar = docFiles.find((path) => /^_Sidebar\.md$/i.test(basename(path))); - if (!sidebar && pages.length > 3) { - report('DOCS-011', 'info', docsRootRelative, undefined, 'No _Sidebar.md; pages are ordered alphabetically on the site.', 'Add _Sidebar.md listing every page once, grouped by section, in reading order.'); - } else if (sidebar) { - const listed = new Set(); - const text = read(sidebar); - for (const match of text.matchAll(/\]\(([^)\s#]+\.md)(?:#[^)]*)?\)/g)) { - const target = posix.normalize(match[1]); - listed.add(target.toLowerCase()); - if (!existsSync(join(docsRoot, target))) { - report('DOCS-011', 'warning', repoPath(sidebar), undefined, `Lists ${match[1]}, which does not exist.`, 'Fix or remove the entry.'); - } - } - for (const path of pages) { - const relativePath = relativeToDocs(path); - if (path !== index && !listed.has(relativePath.toLowerCase())) { - report('DOCS-011', 'info', repoPath(path), undefined, 'Not listed in _Sidebar.md, so it sorts last on the site.', 'Add it to _Sidebar.md under its section.'); - } - } - } - - // Redirects. - const redirectsFile = join(docsRoot, '_redirects.yml'); - const redirected = new Set(); - if (existsSync(redirectsFile)) { - const { pairs, errors } = parseRedirects(read(redirectsFile)); - for (const error of errors) { - report('RED-001', 'error', repoPath(redirectsFile), error.line, `${error.message}; the site's sync fails on an unreadable redirects file.`, 'Use one `previous: current` pair per line under `redirects:`.'); - } - for (const pair of pairs) { - const from = redirectSlug(pair.from); - const to = redirectSlug(pair.to); - redirected.add(from); - if (from.split('/').some((segment) => !SAFE_SEGMENT.test(segment)) || to.split('/').some((segment) => !SAFE_SEGMENT.test(segment))) { - report('RED-001', 'error', repoPath(redirectsFile), pair.line, `"${pair.from}: ${pair.to}" does not reduce to publishable slugs.`, 'Use slugs or Markdown paths from the docs root.'); - } else if (from === to) { - report('RED-001', 'error', repoPath(redirectsFile), pair.line, `"${pair.from}" redirects to itself.`, 'Remove the line.'); - } else if (!pageSlugs.has(to)) { - report('RED-002', 'warning', repoPath(redirectsFile), pair.line, `"${pair.from}" points at "${to}", which is not a page; no redirect is written.`, 'Point it at the page\'s current path.'); - } else if (pageSlugs.has(from)) { - report('RED-003', 'info', repoPath(redirectsFile), pair.line, `"${from}" is still a page, so this redirect stays inactive.`, 'Expected only while the move is unreleased; otherwise remove the old page.'); - } - } - const sources = new Set(pairs.map((pair) => redirectSlug(pair.from))); - for (const pair of pairs) { - if (sources.has(redirectSlug(pair.to))) { - report('RED-005', 'warning', repoPath(redirectsFile), pair.line, `"${pair.from}" points at "${pair.to}", which itself redirects.`, 'Point every old slug at the final page.'); - } - } - } - - // Moves in git history that left no redirect (the catalogue's docs.redirects counts, when given). - for (const from of Object.keys(catalogue?.redirects ?? {})) { - redirected.add(redirectSlug(from)); - } - try { - const log = execFileSync( - 'git', - ['-C', root, 'log', '--max-count=300', '--find-renames', '--diff-filter=RD', '--name-status', '--format=', '--', docsRootRelative], - { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }, - ); - const missing = new Map(); - const fromDocs = (path) => path.slice(docsRootRelative.length + 1); - for (const line of log.split('\n')) { - const [status, oldPath, newPath] = line.split('\t'); - if (!status || !oldPath || !oldPath.endsWith('.md') || !oldPath.startsWith(`${docsRootRelative}/`)) continue; - if (/^_/.test(basename(oldPath)) || isIndexName(basename(oldPath))) continue; - const oldSlug = docSlug(fromDocs(oldPath)); - if (pageSlugs.has(oldSlug) || redirected.has(oldSlug) || missing.has(oldSlug)) continue; - const newSlug = - status.startsWith('R') && newPath?.startsWith(`${docsRootRelative}/`) ? docSlug(fromDocs(newPath)) : undefined; - missing.set(oldSlug, newSlug && pageSlugs.has(newSlug) ? newSlug : undefined); - } - for (const [slug, current] of missing) { - report( - 'RED-004', - 'warning', - `${docsRootRelative}/_redirects.yml`, - undefined, - current - ? `"${slug}" was renamed to "${current}" in git history and has no redirect.` - : `"${slug}" was moved or deleted in git history and has no redirect.`, - current - ? `Add \`${slug}: ${current}\` to _redirects.yml (unless it was never published).` - : `If it was published, add \`${slug}: \` to _redirects.yml. Pass --catalogue to count the site's docs.redirects.`, - ); - } - } catch { - // Not a git checkout, or git is unavailable: the history check is best-effort. - } -} - -// --------------------------------------------------------------------------- -// Per-page checks (docs pages and the README) -// --------------------------------------------------------------------------- - -for (const file of markdownFiles) { - const page = repoPath(file); - const scan = scanFences(read(file)); - - const titles = []; - scan.prose.forEach((line, index) => { - if (/^#\s+\S/.test(line)) titles.push(index + 1); - }); - if (titles.length === 0) { - report('DOCS-007', 'warning', page, 1, 'No `# Title` heading; the site falls back to the file name.', 'Open the page with exactly one `# Title`.'); - } else if (titles.length > 1) { - report('DOCS-007', 'warning', page, titles[1], `${titles.length} \`#\` headings; the site keeps the first as the title and demotes the rest.`, 'Use one `#` title and `##` for sections.'); - } - - scan.prose.forEach((rawLine, index) => { - const line = stripInlineCode(rawLine); - for (const match of line.matchAll(/(!?)\[[^\]]*\]\(([^)\s]+)(?:\s+"[^"]*")?\)/g)) { - const target = match[2]; - if (/^(?:[a-z][a-z0-9+.-]*:|#|\/\/|<)/i.test(target)) continue; - const path = decodeURI(target.split('#')[0].split('?')[0]); - if (!path) continue; - const absolute = path.startsWith('/') ? join(root, path) : join(dirname(file), path); - if (!existsSync(absolute)) { - const isImage = match[1] === '!'; - report(isImage ? 'DOCS-009' : 'DOCS-008', 'error', page, index + 1, `${isImage ? 'Image' : 'Link'} target ${target} does not exist.`, 'Fix the path — it resolves from the folder this page is in.'); - } - } - }); - - for (const fence of scan.fences) { - const language = fence.info.split(/\s+/)[0]; - if (fence.unclosed) { - report('DOCS-013', 'error', page, fence.start + 1, 'A code fence is never closed; everything after it renders as code.', `Close it with ${fence.run}.`); - } - if (!language) { - report('DOCS-010', 'info', page, fence.start + 1, 'A code fence has no language.', 'Label it (`csharp`, `json`, `shell`, `text`).'); - } - const kind = classifyTextFence(fence); - if (kind === 'diagram') { - report('DIAG-001', 'warning', page, fence.start + 1, 'An ASCII-art diagram.', 'Replace it with a LikeC4 model plus a Mermaid fence in a purview:likec4 block (purview-site-docs, references/diagrams.md). Move any legend into a table.'); - } else if (kind === 'mermaid') { - report('DIAG-008', 'warning', page, fence.start + 1, 'Mermaid source in a text fence, so neither GitHub nor the site draws it.', 'Label the fence ```mermaid — both render it — and, for an architecture or flow diagram, pair it with a LikeC4 model in a purview:likec4 block.'); - } - } - - const blocks = checkDiagramBlocks(file, scan); - const insideBlock = (line) => blocks.some((block) => line > block.start && line < block.end); - for (const fence of scan.fences) { - const language = fence.info.split(/\s+/)[0]; - if (insideBlock(fence.start)) continue; - if (language === 'likec4' || language === 'c4') { - if (language === 'likec4') { - report('DIAG-003', 'warning', page, fence.start + 1, 'A bare ```likec4 fence: GitHub shows it as source code.', 'Move the model to a .c4 file and use a purview:likec4 block with a Mermaid fence for GitHub.'); - } - } else if (language === 'mermaid') { - report('DIAG-002', 'info', page, fence.start + 1, 'A Mermaid diagram with no LikeC4 pair. Both GitHub and the site render it.', 'Optional: for an architecture or flow diagram, add a LikeC4 model and wrap this fence in a purview:likec4 block.'); - } - } -} - -// --------------------------------------------------------------------------- -// Agent skills -// --------------------------------------------------------------------------- - -const skillsRoot = join(root, 'skills'); -if (existsSync(skillsRoot) && statSync(skillsRoot).isDirectory()) { - for (const entry of readdirSync(skillsRoot, { withFileTypes: true })) { - if (!entry.isDirectory()) continue; - const folder = `skills/${entry.name}`; - const skillFile = join(skillsRoot, entry.name, 'SKILL.md'); - if (!existsSync(skillFile)) { - report('SKILL-001', 'error', folder, undefined, 'A skills folder with no SKILL.md.', 'Add SKILL.md, or move the folder out of skills/.'); - continue; - } - const text = read(skillFile); - const frontMatter = /^---\n([\s\S]*?)\n---/.exec(text)?.[1]; - if (!frontMatter) { - report('SKILL-002', 'error', `${folder}/SKILL.md`, 1, 'No YAML front matter.', 'Start the file with `---`, `name:` and `description:`, then `---`.'); - continue; - } - const name = /^name:\s*["']?([^"'\n]+?)["']?\s*$/m.exec(frontMatter)?.[1]; - const description = /^description:\s*(.*)$/m.exec(frontMatter)?.[1]; - if (!name) { - report('SKILL-002', 'error', `${folder}/SKILL.md`, 1, 'Front matter has no `name`.', `Add \`name: ${entry.name}\`.`); - } else if (name !== entry.name) { - report('SKILL-003', 'error', `${folder}/SKILL.md`, 1, `name "${name}" does not match the folder "${entry.name}".`, 'Make them equal; the CLI and the site key the skill on the folder.'); - } - if (name && !/^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(name)) { - report('SKILL-004', 'warning', `${folder}/SKILL.md`, 1, `name "${name}" is not a lower-case slug.`, 'Use lower-case letters, digits and dashes.'); - } - if (description === undefined || description.trim() === '') { - report('SKILL-002', 'error', `${folder}/SKILL.md`, 1, 'Front matter has no `description`.', 'Say what the skill does and when to use it, in one paragraph.'); - } - const scan = scanFences(text); - scan.prose.forEach((line, index) => { - for (const match of stripInlineCode(line).matchAll(/\]\(([^)\s#:]+)(?:#[^)]*)?\)/g)) { - if (!existsSync(join(skillsRoot, entry.name, match[1]))) { - report('SKILL-005', 'error', `${folder}/SKILL.md`, index + 1, `Links ${match[1]}, which is not in the skill folder.`, 'Ship the file beside SKILL.md, or fix the link.'); - } - } - }); - } -} - -// --------------------------------------------------------------------------- -// Report -// --------------------------------------------------------------------------- - -const order = { error: 0, warning: 1, info: 2 }; -findings.sort((a, b) => order[a.severity] - order[b.severity] || a.id.localeCompare(b.id) || String(a.file).localeCompare(String(b.file))); -const counts = { error: 0, warning: 0, info: 0 }; -for (const finding of findings) counts[finding.severity] += 1; - -if (json) { - console.log(JSON.stringify({ root, docsRoot: docsRootRelative ?? null, pages: pageSlugs.size, counts, findings }, null, 2)); -} else { - const lines = [ - `# purview.dev assessment: ${basename(root)}`, - '', - `Docs root: ${docsRootRelative ?? '(none — README only)'} · pages: ${pageSlugs.size || (readmePath ? 1 : 0)} · ` + - `${counts.error} error(s), ${counts.warning} warning(s), ${counts.info} note(s)`, - '', - ]; - if (findings.length === 0) { - lines.push('No findings.'); - } else { - lines.push('| Severity | Rule | Where | Finding | Fix |', '| -- | -- | -- | -- | -- |'); - const cell = (value) => String(value).replace(/\|/g, '\\|').replace(/\n/g, ' '); - for (const finding of findings) { - const where = finding.file ? `${finding.file}${finding.line ? `:${finding.line}` : ''}` : '—'; - lines.push(`| ${finding.severity} | ${finding.id} | ${cell(where)} | ${cell(finding.message)} | ${cell(finding.fix)} |`); - } - } - console.log(lines.join('\n')); -} - -process.exit(counts.error > 0 ? 1 : 0); diff --git a/.agents/skills/purview-site-docs/SKILL.md b/.agents/skills/purview-site-docs/SKILL.md deleted file mode 100644 index 9e916d34..00000000 --- a/.agents/skills/purview-site-docs/SKILL.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -name: purview-site-docs -description: Write and reorganise a Purview repository's documentation so purview.dev publishes it cleanly - a hierarchical docs/wiki tree (topic folders, not one flat folder), one H1 per page, relative links that resolve from the page they are in, GitHub alerts, labelled fences, LikeC4 diagrams paired with a Mermaid fence so GitHub and the site each render the one they can, and a _redirects.yml in the docs root that keeps old URLs working when pages move. Use when adding, moving, renaming or splitting documentation pages, when drawing a diagram (never ASCII art), when a docs folder has grown flat, or when asked how a page will look on purview.dev. -license: MIT -metadata: - site: https://purview.dev - repository: purview-dev/purview-dev ---- - -# Documentation that publishes cleanly on purview.dev - -purview.dev does not host your documentation; it **reads it out of your repository** at build time -and publishes it at `https://purview.dev/docs//`. The same Markdown is also read on -GitHub. Every rule here keeps one file correct in both places, with no site configuration in your -repository. - -The site's catalogue entry for your project (in `purview-dev/purview-dev`, -`src/src/data/projects/.yml`) decides **which** files are read — `docs.source`, `docs.path`, -`docs.rootPage`, `docs.exclude`. This repository decides **what they say and where they sit**. - -## The rules - -| # | Rule | Why | -| - | - | - | -| 1 | Docs live in `docs/wiki/` (or `docs/`), as plain `.md` files. No `mkdocs.yml`, theme or plugin list. | The site renders; the repository only writes. A site file is ignored and drifts. | -| 2 | **Hierarchical, not flat**: one lower-case topic folder per area (`guide/`, `configuration/`, `reference/`). Only the landing page, `Home.md`, `_Sidebar.md` and pages the catalogue deep-links stay at the root. | A folder is a sidebar group and a URL segment: `guide/Getting-Started.md` → `/docs//guide/getting-started/`. Twenty files in one folder is a list nobody scans. | -| 3 | File and folder names: letters, digits, single dashes (`Custom-Rules.md`). | The path *is* the URL, lower-cased; anything else is rewritten, and a name that reduces to nothing fails the sync. | -| 4 | Exactly one `# Title` per page, first; then one paragraph saying what the page answers. | The H1 is the page title and sidebar label; the first paragraph is the meta description (160 chars). | -| 5 | Relative links, resolved from the file they are in (`../reference/Options.md`, `Sibling.md#anchor`). | The site rewrites them to its own URLs; a link outside the docs folder becomes a GitHub link. | -| 6 | Relative images (`./images/flow.png`); badges may stay absolute. | Relative images are served from GitHub raw at the channel's ref. | -| 7 | Every fence declares a language (`csharp`, `json`, `shell`, `text`). | An unlabelled fence loses highlighting on both sides. | -| 8 | Callouts use GitHub alerts: `> [!NOTE]`, `> [!TIP]`, `> [!IMPORTANT]`, `> [!WARNING]`, `> [!CAUTION]`. | They become Starlight asides on the site and render natively on GitHub. | -| 9 | **Diagrams are never ASCII art.** A diagram is a LikeC4 model paired with a Mermaid fence (below). | ASCII art is unreadable on a phone, unsearchable, and drifts silently. | -| 10 | Moving or renaming a page adds a line to `_redirects.yml` in the same commit. | The old URL is in bookmarks, search results and other repositories. | -| 11 | `_Sidebar.md` lists every page once, grouped by section, in reading order. | The site orders pages by it; a page missing from it has no place in the navigation. | - -Full layout rules, a worked tree and what the site rewrites: [references/layout.md](references/layout.md). - -## Hierarchy: the default shape - -```text -docs/wiki/ - _Sidebar.md navigation (not published) - _redirects.yml moves (not published) - Home.md hub / landing page (docs.rootPage) - Getting-Started.md root only because the catalogue deep-links it - guide/ - README.md the folder's own page: /docs//guide/ - Installation.md - First-Project.md - configuration/ - Options.md - Environment-Variables.md - diagrams/ - request-flow.c4 LikeC4 models (not published as pages) -``` - -One level of folders is the default; go deeper only when a folder holds a sub-area with several pages -of its own. A nested `README.md` (or `index.md`) is that folder's landing page. A page the site's -catalogue deep-links from a use case (`useCases[].docsPage`) is a single URL segment, so it must stay -at the root until the catalogue entry moves with it — check the entry before moving one. - -## Diagrams: LikeC4 on the site, Mermaid on GitHub - -Draw each diagram once as a LikeC4 model in a `.c4` file, and once as Mermaid for GitHub. Wrap the -Mermaid fence in the `purview:likec4` markers: - -````markdown - -```mermaid -flowchart LR - client[Client] --> api[API] --> store[(Store)] -``` - -[LikeC4 model](./diagrams/request-flow.c4) - -```` - -- **On GitHub** the comments are invisible: the reader sees the Mermaid diagram and a link to the model. -- **On purview.dev** the sync replaces the whole block — markers, Mermaid and link — with the LikeC4 - view, rendered interactively. The Mermaid is never shown there. -- If the model cannot be read or does not declare the view, the site keeps the Mermaid and the sync - logs a warning, so a mistake costs fidelity, never the page. - -Marker options, the model rules (one self-contained file per diagram), and a full worked conversion of an -ASCII flow: [references/diagrams.md](references/diagrams.md). - -## Moving pages: `_redirects.yml` - -```yaml -# docs/wiki/_redirects.yml — previous: current (slugs, or paths from the docs root) -redirects: - getting-started: guide/getting-started - Custom-Rules.md: schemas/Custom-Rules.md -``` - -The site reads the file at each documentation channel's own ref and writes a redirect page for every -pair whose destination exists and whose source is no longer a page. A pair whose destination is missing, -or whose source still exists, is reported and skipped; an invalid file fails the site's sync with the -file name, so fix it rather than delete it. Never remove a line once released — the old URL lives in -someone's bookmark. Details: [references/redirects.md](references/redirects.md). - -## Moving a page — the checklist - -1. `git mv` the file, so history follows it. -2. Fix every inbound link: other pages (relative to *their* folder), `_Sidebar.md`, `Home.md`, the - READMEs, `AGENTS.md`, skills, and tests that name the path. -3. Add `old-slug: new/slug` to `_redirects.yml`. -4. If the page is a catalogue deep link (`docsPage`), it stays at the root, or ask the site maintainers - to move the deep link; do not edit `purview-dev/purview-dev` unasked. -5. Run the assessment (`purview-site-assessment`) and fix what it reports. - -## Related skills - -- `purview-site-integration` — everything else the site reads from a repository (topics, releases, - packages, skills) and how a project joins the catalogue. -- `purview-site-assessment` — a script and a procedure that check a repository against these rules. diff --git a/.agents/skills/purview-site-docs/references/diagrams.md b/.agents/skills/purview-site-docs/references/diagrams.md deleted file mode 100644 index 37103645..00000000 --- a/.agents/skills/purview-site-docs/references/diagrams.md +++ /dev/null @@ -1,174 +0,0 @@ -# Diagrams: a LikeC4 model paired with a Mermaid fence - -GitHub renders Mermaid and shows LikeC4 as source. purview.dev renders LikeC4 (interactive, with the -model behind it) and Mermaid. A diagram pair gives each reader the best diagram their renderer can show, -from one page. - -## The block - -````markdown - -```mermaid -flowchart LR - resume[pm-resume] --> next[pm-next] -``` - -[LikeC4 model](./diagrams/the-loop.c4) - -```` - -| Part | Rule | -| -- | -- | -| Opening marker | `` alone on its line | -| `file` | **required.** The `.c4` model, relative to the page (or `/`-rooted at the repository root). It may live anywhere in the repository, including outside the docs folder | -| `view` | the view to render; defaults to the first view the model declares. Name it explicitly | -| `title`, `description` | the heading and sub-heading of the diagram on the site | -| `height` | pixels, default `420` | -| `collapsible`, `defaultOpen` | `true`/`false`; the site's diagram shell is collapsible and open by default | -| Between the markers | what GitHub shows: one ```` ```mermaid ```` fence, then optionally a link to the model | -| Closing marker | `` alone on its line | - -Markers inside a code fence are ignored (that is how this page shows them). - -## What happens - -| Reader | Sees | -| -- | -- | -| GitHub | the Mermaid diagram and the "LikeC4 model" link; the comments are invisible | -| purview.dev | the LikeC4 view only. The sync swaps the whole block for a ```` ```likec4 ```` fence holding the model file's text | -| purview.dev, model unreadable or view undeclared | the Mermaid diagram, and a warning in the site's sync log naming the page, line and reason | - -## The model file - -- **One self-contained file per diagram**: its own `specification`, `model` and `views`. The site - compiles the file on its own, so it cannot see other `.c4` files — no shared specification across - files, no `import`. -- Keep models beside the docs (`docs/wiki/diagrams/.c4`). A `.c4` file is never published as a - page. -- Element and view ids: letters, digits, underscores, starting with a letter (`theLoop`, `apiGateway`). -- Validate before committing: `npx likec4 validate docs/wiki/diagrams` (or `bunx likec4 validate …`). -- Prefer `autoLayout LeftRight` for flows and `TopBottom` for hierarchies; `include *` for a small model. - -## The Mermaid rendering - -- It is the GitHub reader's diagram, so keep it equivalent: the same nodes and edges, the same labels. - It does not need the styling or descriptions the model carries. -- `flowchart LR`/`TB` for flows; `sequenceDiagram` when the LikeC4 view is a `dynamic view`. -- When the model changes, the Mermaid changes in the same commit — review them side by side. - -## Never ASCII art - -A fenced ```` ```text ```` block of boxes and arrows is a diagram nobody can read on a phone, search, -or keep in step. Convert it. A legend that sits under ASCII art ("pm-park: any time, capture only") -becomes a table or a list after the diagram, not part of it. - -## Worked conversion - -The PM skills README describes its loop as ASCII art: - -```text -pm-resume -> pm-next -> [design -> plan -> execute -> finish] - ^ | | | - | pm-checkpoint (stage updates) pm-checkpoint (done, on the branch) - | | - +-----------------------------------------+ - | - push branch -> one PR -> CI -> merge -``` - -**1. The model** — `docs/diagrams/the-loop.c4`: - -```likec4 -specification { - element skill { - style { - shape rectangle - } - } - element stage { - style { - shape rectangle - color secondary - } - } - element delivery { - style { - shape rectangle - color muted - } - } -} - -model { - resume = skill 'pm-resume' { - description 'Reads the planning files and recommends one action' - } - next = skill 'pm-next' { - description 'Claims the first item that is still the right one' - } - design = stage 'design' - plan = stage 'plan' - execute = stage 'execute' - finish = stage 'finish' - checkpoint = skill 'pm-checkpoint' { - description 'Writes where work stopped, so a compacted session can resume' - } - push = delivery 'push branch' - pr = delivery 'one PR' - ci = delivery 'CI' - merge = delivery 'merge' - - resume -> next - next -> design 'claims an item' - design -> plan - plan -> execute - execute -> finish - design -> checkpoint 'stage updates' - plan -> checkpoint 'stage updates' - execute -> checkpoint 'stage updates' - finish -> checkpoint 'done, on the branch' - checkpoint -> next 'next item' - checkpoint -> push - push -> pr - pr -> ci - ci -> merge -} - -views { - view theLoop { - title 'The loop' - include * - autoLayout LeftRight - } -} -``` - -**2. The README section**: - -````markdown -## The loop - - -```mermaid -flowchart LR - resume[pm-resume] --> next[pm-next] - next -- claims an item --> design - design --> plan --> execute --> finish - design & plan & execute -. stage updates .-> checkpoint[pm-checkpoint] - finish -- done, on the branch --> checkpoint - checkpoint -- next item --> next - checkpoint --> push[push branch] --> pr[one PR] --> ci[CI] --> merge -``` - -[LikeC4 model](./docs/diagrams/the-loop.c4) - - -| Skill | When it runs | -| -- | -- | -| `pm-park` | any time, capture only | -| `pm-review` | weekly | -| `pm-risk` | capture a risk any time; manage the register when no workflow is active | -```` - -The file path is relative to the page, so from the root `README.md` it is `./docs/diagrams/the-loop.c4`; -from `docs/wiki/guide/Loop.md` it would be `../../diagrams/the-loop.c4`. diff --git a/.agents/skills/purview-site-docs/references/layout.md b/.agents/skills/purview-site-docs/references/layout.md deleted file mode 100644 index ba8a033b..00000000 --- a/.agents/skills/purview-site-docs/references/layout.md +++ /dev/null @@ -1,92 +0,0 @@ -# Layout and what the site does to a page - -## Which files are read - -The catalogue entry's `docs.source` decides: - -| `docs.source` | Read | Use it when | -| -- | -- | -- | -| `github-path` | every `/**/*.md` at the channel's ref (default branch, or a release tag for a `live` channel) | **the default.** Any repository with more than one page. Supports folders, channels and redirects | -| `wiki` | the top-level `.md` files of the GitHub wiki (`.wiki.git`) | only for an existing GitHub wiki; it has no history the site can pin, and no folders | -| `readme` | `README.md` alone, as one page | a project small enough to be one page. Grows into `github-path` — a README with more than about eight `##` sections or a few hundred lines is a docs tree waiting to happen | - -Files that are never pages: `_Sidebar.md`, `_Footer.md`, `_redirects.yml`, `.c4` models, images, and -anything the entry lists in `docs.exclude` (matched on the base file name, `*` wildcards). - -## The landing page - -1. A conventional index at the docs root wins: `Home.md`, `index.md` or `README.md` (case-insensitive). -2. The entry's `docs.rootPage` may name another page only when the conventional one is excluded. -3. No index and no `rootPage` fails the sync: *"docs: no root page exists"*. - -Prefer `Home.md` as the hub (what the project is, then a table of sections linking every page) and a -`Getting-Started.md` beside it. - -## URL of every page - -The path from the docs root, each segment lower-cased with anything other than letters, digits and -dashes collapsed to `-`, and the `.md` dropped: - -| Source | Published at | -| -- | -- | -| `docs/wiki/Home.md` (root page) | `/docs//` | -| `docs/wiki/Getting-Started.md` | `/docs//getting-started/` | -| `docs/wiki/guide/README.md` | `/docs//guide/` | -| `docs/wiki/guide/First-Project.md` | `/docs//guide/first-project/` | -| `docs/wiki/Q&A/Why Not.md` | `/docs//q-a/why-not/` (works, but rename it) | -| `docs/wiki/___/Page.md` | **sync fails**: the folder reduces to nothing | - -Two files that reduce to the same URL collide; keep names distinct after lower-casing. A page may not -be named `prerelease` (that segment is reserved for the prerelease documentation channel). - -## Sidebar and order - -- Folders become collapsible sidebar groups labelled from the folder name (`getting-started` → - "Getting Started"), placed where their first page appears. -- Order: the entry's `docs.order` (explicit slugs) → the link order in `_Sidebar.md` → alphabetical. -- `_Sidebar.md` links pages by their path from the docs root: - -```markdown -- [Home](Home.md) -- **Guide** - - [Installation](guide/Installation.md) - - [First project](guide/First-Project.md) -- **Configuration** - - [Options](configuration/Options.md) -``` - -## What the site rewrites - -| In the source | On the site | -| -- | -- | -| `[Options](../configuration/Options.md#timeouts)` | a link to `/docs//configuration/options/#timeouts`; an anchor that is not a heading on the target page is dropped | -| `[Code](../../src/Thing.cs)` (outside the docs folder) | `https://github.com//blob//src/Thing.cs` | -| `![Flow](./images/flow.png)` | `https://github.com//raw///images/flow.png` | -| `![badge](https://img.shields.io/…)` | unchanged | -| `> [!WARNING]` blockquote | a Starlight caution aside | -| the first `# Title` | the page header (title, sidebar label); removed from the body so it shows once | -| a second `# Heading` | demoted to `##` — one title per page | -| a `purview:likec4` block | the LikeC4 view (see `diagrams.md`) | -| a bare ```` ```mermaid ```` fence | a Mermaid diagram (both sides render it) | -| a bare ```` ```likec4 ```` fence | a LikeC4 diagram on the site — but **source code on GitHub**; use a pair | -| mkdocs/Material markup (`!!! note`, `{ .md-button }`, `{% … %}`) | stripped or converted; do not write it | - -Front matter in a source page is not needed: the site writes its own (title, description, edit link, -last-reviewed date from the last commit, the repository's topics as tags). A page not touched for 365 -days is flagged as stale on the site. - -## Documentation channels - -A project whose default branch runs ahead of its last release can publish two versions of its docs: -`live` (pinned to the latest stable tag, at `/docs//`) and `prerelease` (the default branch, at -`/docs//prerelease/`). This is declared in the catalogue entry, not in the repository. What it means -for you: a page reorganisation is visible on the prerelease channel immediately and on live only after -the release that carries it, and `_redirects.yml` is read per channel, so each channel forwards its own -old URLs at the right moment. - -## Writing style that survives both renderers - -- ATX headings (`##`), sentence or title case consistently, no trailing punctuation. -- Tables for anything enumerable. -- Wrap prose near 100–110 columns, so documentation diffs stay reviewable. -- HTML only where Markdown cannot express it; the site renders it, but GitHub sanitises it. diff --git a/.agents/skills/purview-site-docs/references/redirects.md b/.agents/skills/purview-site-docs/references/redirects.md deleted file mode 100644 index 76585874..00000000 --- a/.agents/skills/purview-site-docs/references/redirects.md +++ /dev/null @@ -1,49 +0,0 @@ -# `_redirects.yml` — keeping moved pages reachable - -A page's path is its URL. Moving `Getting-Started.md` into `guide/` moves -`/docs//getting-started/` to `/docs//guide/getting-started/`, and every bookmark, search result -and link from another repository to the old address would 404. `_redirects.yml` records the move in the -same commit as the move. - -## Where and what - -`/_redirects.yml` — beside `Home.md` (for a GitHub wiki, at the wiki root). It is never a page. - -```yaml -# previous: current -# Either side may be a slug (`guide/getting-started`) or a Markdown path from the -# docs root (`guide/Getting-Started.md`); both are reduced to the published slug. -redirects: - getting-started: guide/getting-started - Custom-Rules.md: schemas/Custom-Rules.md - old-landing: index # `index` is the docs root, /docs// -``` - -A bare map without the `redirects:` key is accepted too. Keep to this shape: one `previous: current` -pair per line, comments with `#`, quotes only when a name needs them. - -## How the site uses it - -1. The sync reads the file at each documentation channel's ref — so a reorganisation on the default - branch forwards the prerelease channel's URLs straight away, and the live channel's only once the - release that contains it is published. -2. For each pair it writes a small redirect page at the old address pointing to the new one - (`noindex`, not searchable, not in the sitemap). -3. A redirect is **written only when its destination is a published page and its source is not.** A - real page always wins over a redirect. -4. A pair that points nowhere, or whose source still exists, is reported in the sync log and skipped. -5. A file that is not valid YAML, is not a map, or holds a pair that cannot become a URL, **fails the - site's sync** naming the file — the moves it was meant to protect would otherwise vanish silently. - -The site's catalogue entry may also carry `docs.redirects` for the same purpose; when both name the -same old slug the catalogue entry wins. Prefer the file: the move and its redirect then live in one -commit, in the repository that made them. - -## Rules - -- Add the pair in the commit that moves the page. Never remove a released pair. -- Point at the final address. When a page moves twice, update the first pair's destination rather than - chaining `a → b → c`. -- Redirect pages only — not anchors, not folders. A folder with a `README.md` is a page (`guide`), so - it can be a destination. -- After the move, fix inbound links anyway: a redirect is for readers outside the repository. diff --git a/.agents/skills/purview-site-integration/SKILL.md b/.agents/skills/purview-site-integration/SKILL.md deleted file mode 100644 index 24cd40a3..00000000 --- a/.agents/skills/purview-site-integration/SKILL.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -name: purview-site-integration -description: Make a Purview repository (a NuGet library, an MSBuild SDK, an npm package, or a pure agent-skills repository such as pm-skills) fully integrated with purview.dev - what the site reads from the repository and when, the GitHub metadata it shows (topics as tags, description, releases, default branch), the documentation contract, published agent skills, mirrored assets, and the catalogue entry the site maintainers write for it. Use when preparing a repository to join purview.dev, when its project page or docs look wrong or stale, when adding skills, packages or releases a reader should see, or when asked "how does this show up on purview.dev?". -license: MIT -metadata: - site: https://purview.dev - repository: purview-dev/purview-dev ---- - -# Integrating a repository with purview.dev - -purview.dev is a static site built from two inputs: - -1. **The catalogue** — one YAML file per project in `purview-dev/purview-dev` - (`src/src/data/projects/.yml`): the curated words (description, origin, when to use it, use - cases) and the pointers (which docs to read, which packages and skills to show). -2. **This repository** — read at build time through the GitHub API, raw file URLs and the package - registries. Nothing is pushed to the site; a scheduled build and every site deploy pull it. - -So integration has two halves: make this repository **readable** (this skill and -`purview-site-docs`), and give the site maintainers what they need to **write the entry** -([references/catalogue-contract.md](references/catalogue-contract.md)). Do not edit -`purview-dev/purview-dev` from this repository unless the user asks; propose the entry instead. - -## What the site reads from this repository - -| Site surface | Read from | Your responsibility | -| -- | -- | -- | -| Tag chips on cards, search, docs pages | GitHub **topics** | 6–15 lower-case, hyphenated topics (`csharp`, `source-generators`, `opentelemetry`). The first four are what a card shows. There is no other way to set tags | -| "From the repository" note on the project page | GitHub **description** | One sentence that agrees with the catalogue's `shortDescription` | -| Versions, release dates, "latest release" | GitHub **releases** + the NuGet / npm registry | Tag releases `vX.Y.Z`; prereleases `vX.Y.Z-prerelease.N`. Publish packages to the registry the entry names | -| Status checks (`stable`/`preview`/`archived`) | releases, registry versions, the archived flag | A stable registry version means `stable`; prerelease-only means `preview`; archive the repository rather than leave it idle | -| Documentation at `/docs//` | `docs/wiki/**/*.md` (or `docs/`, a wiki, or `README.md`) at the **default branch** (or a release tag) | Follow `purview-site-docs`: hierarchical folders, one H1, relative links, diagram pairs, `_redirects.yml` | -| Agent skills listed on the project page, served at `/skills///` | every `skills//SKILL.md` (discovered; the entry can opt out) and everything beside it | Front matter `name` (equal to the folder) and `description`. Skills reach users through `npx skills add purview-dev/`, never inside a package | -| Mirrored assets (JSON schemas and similar) | repository paths the entry lists under `assets:` | Keep the path stable; moving it breaks the site build until the entry follows | -| Build badge | the repository's GitHub Actions | A workflow that runs on the default branch | -| Discussions link | repository settings | Enable Discussions if you want readers to ask there | -| Star count | GitHub | — | - -The default branch must be `main` unless the entry says otherwise; the docs, the edit links and the -"last reviewed" dates all follow it. - -## The integration checklist - -1. **Metadata** — description set, 6–15 topics, the repository public, Discussions decided: - - ```shell - gh api repos/purview-dev/ --jq '{description, topics, archived, default_branch, has_discussions}' - ``` - -2. **Releases** — at least one GitHub release whose tag matches the packages' version, published to - NuGet or npm. A project with no release shows no version anywhere. -3. **Documentation** — a `docs/wiki/` tree (or a deliberate one-page `README.md`), laid out per - `purview-site-docs`. ASCII-art diagrams converted to LikeC4/Mermaid pairs. A `_redirects.yml` the - moment a page moves. -4. **Skills** — one folder per skill under `skills/`, each with a `SKILL.md` whose front matter `name` - matches the folder and whose `description` says what it does and when to use it. -5. **README** — the GitHub front door: what it is, install, a minimal example, a link into the docs. - It points into the docs rather than duplicating them (a `readme`-sourced project is the exception: - the README *is* the docs). -6. **The entry** — collect what [references/catalogue-contract.md](references/catalogue-contract.md) - asks for, and hand it to the site maintainers (an issue or pull request on - `purview-dev/purview-dev`). The site's own agents onboard projects from that information. -7. **Assess** — run the `purview-site-assessment` skill and fix every error before asking for the - entry. - -## Live examples and diagrams on the project page - -A project page can link a live example: an `.mdx` page in the site repository -(`src/src/pages/examples/.mdx`). That is authored on the site side; propose it with the entry when -the project has something visual to show. Diagrams inside your docs need nothing from the site — use -the diagram pairs from `purview-site-docs`. - -## When something looks wrong on the site - -| Symptom | Usual cause | -| -- | -- | -| No tags on the card | no GitHub topics | -| Version missing or old | no release, a tag that does not match the package version, or the registry has not indexed it yet | -| A docs page missing | not under the docs path, excluded by name, or a slug that collides with another | -| A link on a docs page goes to GitHub | it points outside the docs folder, or at a page that does not exist | -| A diagram shows Mermaid on the site | the `purview:likec4` model file or view was not found — the site's sync log says which | -| A bookmarked docs URL 404s | a page moved without a `_redirects.yml` line | -| Skills not listed | the skill is not at `skills//SKILL.md`, its front matter is missing a field, or the entry opts out with `skills: false` | - -## Related skills - -- `purview-site-docs` — how to write and organise the documentation itself. -- `purview-site-assessment` — check this repository against both skills and get a prioritised report. diff --git a/.agents/skills/purview-site-integration/references/catalogue-contract.md b/.agents/skills/purview-site-integration/references/catalogue-contract.md deleted file mode 100644 index d945fa47..00000000 --- a/.agents/skills/purview-site-integration/references/catalogue-contract.md +++ /dev/null @@ -1,93 +0,0 @@ -# The catalogue entry — what to hand the site maintainers - -The entry lives in `purview-dev/purview-dev` at `src/src/data/projects/.yml` and is validated by the -site's schema, so its vocabulary is fixed. Collect the answers below from this repository and propose -them; the maintainers (or the site's onboarding agent) turn them into the entry. - -## Identity - -| Field | What to provide | -| -- | -- | -| `id` | lower-case slug, normally the repository name without `purview-` (`unions`, `build-sdk`). It is the URL: `/projects//`, `/docs//` | -| `name` | display name; must slugify to `id` when the project has docs (`Build SDK` → `build-sdk`). Not prefixed with "Purview" | -| `repository` | `purview-dev/` | -| `category` | one of `application-framework`, `validation`, `observability`, `source-generation`, `aspire`, `build-tooling`, `developer-tooling` | -| `status` | `stable` (a stable release is published), `preview` (prereleases only), `archived` | -| `experimental` | `true` when the API and packaging may change without notice | - -## The words - -Write these for a reader deciding whether to use the project. Backticks become inline code on the site. - -| Field | Shape | -| -- | -- | -| `shortDescription` | one sentence; the card text | -| `description` | 2–4 sentences: the problem and what the project does about it | -| `origin` | why it became a reusable project rather than code in one application | -| `useWhen` / `avoidWhen` | the honest fit, including when something simpler is better | -| `useCases` | at least one, each: `audience` (`developer`, `team-lead`, `architect`, `contributor`), `title`, `scenario`, optional `code` + `language`, `outcome`, optional `evidence`, optional `docsPage` | -| `acknowledgments` | upstream work the project builds on: `name`, `url`, `description` | -| `related` | ids of related Purview projects | - -A use case is concrete: a real situation, real code, a measurable outcome, and evidence that can be -checked (a test, a benchmark, a diagnostic id). `docsPage` is a **single-segment** slug of a docs page -at the docs root — so a page used as a deep link stays at the root of the tree. - -## Pointers - -| Field | What to provide | -| -- | -- | -| `docs.source` | `github-path` (preferred), `wiki`, or `readme` | -| `docs.path` | the docs folder, e.g. `docs/wiki` | -| `docs.rootPage` | the landing page, e.g. `Home.md` or `Getting-Started.md` | -| `docs.exclude` | base file names that are not pages, e.g. `_Sidebar.md` | -| `docs.channels` | only when `main` runs ahead of the last release: `live: { ref: latest-stable }`, `prerelease: { ref: default }` | -| `packages` | each package id, its `registry` (`nuget` default, or `npm`), a one-line `description`, and which is `primary` | -| `install` | for NuGet: `nuget` (a `PackageReference`), `msbuild-sdk`, or `dotnet-tool` | -| `targetFrameworks` | what the packages actually ship (`net8.0`, `net10.0`, `netstandard2.0`) — the site checks them against NuGet | -| `skills` | usually omitted: every `skills/*/SKILL.md` is discovered and published. `false` opts out; a list of `{ name, path?, description? }` overrides discovery | -| `assets` | `{ path, output, description? }` for files the site should serve, e.g. a JSON schema at `/schemas/.json` | - -Redirects for moved pages belong in this repository's `_redirects.yml`, not in the entry. - -## A template to fill in - -```yaml -id: -name: -shortDescription: -description: >- - <2–4 sentences> -origin: >- - -useWhen: >- - -avoidWhen: >- - -repository: purview-dev/ -category: -status: -docs: - source: github-path - path: docs/wiki - rootPage: Home.md - exclude: - - _Sidebar.md -packages: - - id: - description: - primary: true -useCases: - - audience: developer - title: - scenario: >- - - code: | - - language: csharp - outcome: >- - - evidence: >- - - docsPage: -``` diff --git a/.agents/skills/purview-sourcegenerator-attribute-data-models/SKILL.md b/.agents/skills/purview-sourcegenerator-attribute-data-models/SKILL.md deleted file mode 100644 index 714ddbff..00000000 --- a/.agents/skills/purview-sourcegenerator-attribute-data-models/SKILL.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -name: purview-sourcegenerator-attribute-data-models -description: >- - Use when declaring or fixing a [Generate] attribute-data model in Purview.SourceGeneratorFramework - - mapping constructor and named arguments with [Argument]/[Property], defaults, reusing a shape with - [NestedModel], reading an ADM0001-ADM0015 diagnostic, or testing that a model reads the values an - attribute application supplies. -metadata: - product: Purview.SourceGeneratorFramework - repository: purview-dev/sourcegenerator-framework ---- - -# Attribute-data models - -`AttributeDataModelGenerator` turns a `readonly partial record struct` marked `[Generate(typeof(TAttribute))]` -into a parser for `TAttribute`'s `AttributeData`: `Exists`, `Empty`, `TargetAttribute`, the guarded -`FromAttributeData`/`TryFromAttributeData`/`AllAttributeData` overloads, and `FromAttributeDataUnchecked`. -The generated model is a value type, so it is safe to hold in an incremental pipeline (an `AttributeData` -is not). - -The one thing to keep in mind: **the generated code looks names up case-sensitively at run time, and a -name it cannot find quietly yields the default value.** A mapping mistake compiles and produces `null`/`0`. -The naming analyzer (`ADM0011`–`ADM0015`) exists to report those mistakes where they are declared; do not -suppress it without understanding the finding, and test the model against real applications. - -## Mapping each property - -Each primary-constructor parameter becomes a property, PascalCased (`message_template` → `MessageTemplate`). -Its sources are read in this order, first hit wins: - -| Declaration | Reads | -| --- | --- | -| *(no mapping attribute)* | the named argument with the property's name: `[Log(EventId = 7)]` | -| `[Property]` / `[Property(Name = "X")]` | the named argument `X` (default: the property name) | -| `[Argument("messageTemplate")]` | the constructor parameter **named** `messageTemplate` | -| `[Argument]` | the constructor parameter named after the property, camel-cased: `MessageTemplate` → `messageTemplate` | -| `[Argument(1)]` | the constructor argument at **position** 1 | -| `[Argument(...)] [Property]` | the named argument first, then the constructor argument | -| `[NestedModel]` | another generated model, read from the same attribute (below) | -| `[GenericTypeArgument]` | a generic type argument of the attribute class, as a `TypeIdentity` | -| `[Exclude]` | nothing; the parameter is left out of the model | - -Methodology: - -- **Map a constructor parameter by name, not by index.** A name survives a new overload or a reordered - parameter list; an index silently starts reading a different parameter. -- **Map both sources when the attribute accepts both.** `[Argument("name")] [Property] string? Name` reads - `[A(name: "x")]`, `[A("x")]` and `[A(Name = "x")]`. The named argument is read first because it is assigned - after the constructor runs, so it is the attribute instance's effective value. -- **Only map `[Property]` to a public settable property or field.** A property with a private or `internal` - setter can never be a named argument; read it through the constructor parameter that sets it (`ADM0012`). -- **Match case exactly.** `[Argument("MessageTemplate")]` never matches a parameter called - `messageTemplate` (`ADM0011`). -- **Give every property that might be absent a `DefaultValue`**: `[Property(DefaultValue = -1)] int EventId`. - A missing argument takes it; without one, it takes `default(T)`. `Empty` always uses `default(T)`. -- **Use `IsEnum = true` with a `string` property** when the enum type is not available to the generator; a - bare member-name default (`DefaultValue = "Inherit"`) is expanded to the fully-qualified member. -- **Never name a property `Exists`, `Empty`, `TargetAttribute`, `AllAttributeData`, `FromAttributeData`, - `TryFromAttributeData` or `FromAttributeDataUnchecked`** — they are generated (`ADM0014`, generation is - skipped). Keyword names (`Event`, `Class`) are fine. - -## Reusing a shape with `[NestedModel]` - -A `[NestedModel]` parameter is populated by the nested model's `FromAttributeDataUnchecked`, from the -**outer** attribute's arguments, with no `TargetAttribute` check. The outer attribute does not have to derive -from the nested model's target; it only has to use the same constructor parameter and property names. - -```csharp -[Generate(typeof(LogAttribute))] -readonly partial record struct LogAttributeData( - [Argument("level")] [Property(DefaultValue = 99)] int Level, - [Argument("messageTemplate")] [Property] string? MessageTemplate, - [Argument("eventId")] [Property(DefaultValue = -1)] int EventId, - [Property] string? Name -); - -// InfoAttribute has messageTemplate, eventId and Name, but no level. -[Generate(typeof(InfoAttribute))] -readonly partial record struct InfoAttributeData([NestedModel] LogAttributeData Log); -``` - -- The nested model's `Exists` is always `true`; a mapping the outer attribute does not declare (`level` - here) takes its `DefaultValue`. `ADM0013` (info) lists such mappings, so an intended absence is visible - and an accidental one is caught. -- Map nested properties **by name**. A constructor index means a different parameter on each attribute - (`ADM0015`). -- `MatchByInheritance = true` is for using a model on its own against derived attributes. A nested model - does not need it. -- Call `FromAttributeData`/`TryFromAttributeData` from generator code. `FromAttributeDataUnchecked` skips the - type check and is for nested models. - -## Diagnostics - -| Rule | Severity | Meaning and fix | -| --- | --- | --- | -| `ADM0001` | Error | The `[Generate]` target cannot be resolved. Use `typeof`, a resolvable full name, or a type-library `…FullName` constant. | -| `ADM0002` | Error | Unsupported property type (array, pointer, function pointer). | -| `ADM0003` | Error | `[Argument("name")]`/`[Argument(index)]` names no constructor parameter of the target. | -| `ADM0004` | Error | A `[NestedModel]` type is not itself a `[Generate]` model. | -| `ADM0005` | Error | A `DefaultValue` cannot be emitted for the property type. | -| `ADM0006` | Error | A non-nullable reference property has no default. Add a `DefaultValue` or make it nullable. | -| `ADM0007` | Error | `AutoDiscover` needs the `typeof` target overload. | -| `ADM0008` | Error | A `[GenericTypeArgument]` property must be `TypeIdentity`. | -| `ADM0009` | Error | An `IsEnum` property must be `string`/`string?`. | -| `ADM0010` | Error | An `ISymbol`/`Type` property is not cacheable; use `TypeIdentity` or a string. | -| `ADM0011` | Warning | A mapped name matches an attribute member only when case is ignored, so it is never read. Fix the case. | -| `ADM0012` | Warning | The mapped named argument is not a public settable member of the attribute, or a bare `[Argument]` implies a constructor parameter it lacks. Map the member that actually carries the value. | -| `ADM0013` | Info | A nested model property reads only names the outer attribute lacks, so it always takes its default. Expected for a deliberately absent value; otherwise rename to match. | -| `ADM0014` | Error | A property has a generated member's name. Rename the parameter. | -| `ADM0015` | Warning | A nested model reads a constructor index that names a different parameter on the outer attribute. Map it by name. | - -## Testing a model - -Test the attribute side and the model side separately, against what Roslyn actually produces. Use -`AttributeDataFactory` from `Purview.SourceGeneratorFramework.Testing` to compile an application, and the -`AttributeDataAssertions` from the TUnit package to pin each argument by ordinal, parameter name or named -argument, including how it was supplied (`AttributeArgumentForm`): - -```csharp -var options = new MyTestOptions { AdditionalNamespaces = ["My.Attributes"] }; -var attribute = AttributeDataFactory.FromUsage("[Info(\"custom {Value}\", Name = \"N\")]", options); - -await Assert.That(attribute).HasConstructorArgument("messageTemplate", "custom {Value}"); -await Assert.That(attribute).HasConstructorArgument("eventId", -1, AttributeArgumentForm.Defaulted); -await Assert.That(attribute).HasNamedArgument("Name", "N"); - -var model = InfoAttributeData.FromAttributeData(attribute); -await Assert.That(model.Log.MessageTemplate).IsEqualTo("custom {Value}"); -await Assert.That(model.Log.Level).IsEqualTo(99); -``` - -Cover, for each model: positional, by-name and named-argument applications; an application omitting every -optional argument (proves the `DefaultValue`s); for a nested model, an outer attribute that lacks a mapped -member; and the nested target's own `FromAttributeData` returning `Empty` for the outer attribute. -`FromUsage` places the application on a declaration its `AttributeUsage` allows and throws on a compile -error, so a misspelt argument name fails the test. `FromSource` reads applications from a full source. - -Generated-code assertions (`Contains("FromAttributeDataUnchecked(attributeData)")`) prove *what* the -generator emits; the tests above prove the model *reads the right values*. Prefer the latter. - -## Related skills - -`purview-sourcegenerator-testing` for the runner layer, `AttributeDataFactory` and `AttributeArguments`; -`purview-sourcegenerator-tunit-tests` for the assertion extensions; `purview-sourcegenerator-pipeline` for -holding models in an incremental pipeline; `purview-sourcegenerator-diagnostics` for the other analyzer -families. diff --git a/.agents/skills/purview-sourcegenerator-codewriter/SKILL.md b/.agents/skills/purview-sourcegenerator-codewriter/SKILL.md deleted file mode 100644 index b256caad..00000000 --- a/.agents/skills/purview-sourcegenerator-codewriter/SKILL.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -name: purview-sourcegenerator-codewriter -description: >- - Use when implementing, reviewing or refactoring C# source generators and analysers built on - Purview.SourceGeneratorFramework. Covers CodeWriter and XmlCommentWriter emission, scope safety, - incremental pipeline design, value equality, deterministic output, and migrating a legacy - string/StringBuilder emitter to CodeWriter. -metadata: - product: Purview.SourceGeneratorFramework - repository: purview-dev/sourcegenerator-framework ---- - -# Source generator CodeWriter modernization - -Use this skill for any work involving C# source generators, analysers, or generated output in `Purview.SourceGeneratorFramework`. It combines CodeWriter/XmlCommentWriter emission guidance with the incremental-source-generator and analyser best practices that ship with the framework. - -Refactoring an existing emitter off `string`/`StringBuilder`? The step-by-step playbook is in -[references/legacy-emitter-migration.md](references/legacy-emitter-migration.md). - -## Required implementation pattern - -When creating source output, favor this shape: - -1. Build immutable, value-equatable pipeline values first. -2. Register source output. -3. Inside the callback: `var writer = generationContext.CreateCodeWriter();` -4. Write header/usings/namespace. -5. Write structured types and members using declaration options records. -6. Add source once per output artifact. - -### CodeWriter lifetime: created in the output callback, never in pipeline state - -The line between "fine" and "forbidden" is the **incremental-cache boundary**, not the act of -creating a writer or handing it to a helper. - -**Fine — output-scoped use inside a `RegisterSourceOutput` callback.** Create the writer inside the -callback and pass it to any emitter/helper methods called from that same callback. It may be held in -local variables, passed as a parameter, or wrapped in a short-lived output context: - -```csharp -context.RegisterSourceOutput( - targets.CombineWithContext(contextProvider), - static (spc, pair) => - { - var (model, generationContext) = pair; - var writer = generationContext.CreateCodeWriter(); - EmitHeader(writer, model); - EmitType(writer, model); - spc.AddSource($"{model.Name}.g.cs", writer.ToString()); - } -); -``` - -**Forbidden — persisting the writer across the incremental-cache boundary.** Do not create it earlier -in the pipeline and pass it down, and do not store it anywhere Roslyn caches or another callback can -observe it: - -- Do not create a `CodeWriter` in a provider stage and carry it through the pipeline. -- Do not store a `CodeWriter` as a property or field on `GenerationContext` or a custom context. -- Do not return a `CodeWriter` (or an object holding one) from an incremental provider. -- Do not cache or reuse a writer for a later callback or a different output. - -A cached writer can retain previously written source, mix output from concurrently running -callbacks, and defeat scope tracking. A writer created in the callback and used only within that -callback is safe and expected. - -## Source generator & analyser best practices - -Apply the following rules to every generator, analyser, and refactor. - -### 1. Core principles - -- **Analyser for validation; generator for generation.** -- **Syntax for syntax, symbols for declarations, operations for executable semantics.** -- **Use `ForAttributeWithMetadataName` for attribute-driven generators.** -- **Remove Roslyn objects from the incremental pipeline as early as possible.** -- **Every value crossing a pipeline boundary must have meaningful value equality.** -- **Prefer many small incremental stages over one large transform.** -- **Keep broad inputs such as `Compilation` away from downstream generation.** -- **Generate deterministic output.** -- **Compile against the oldest Roslyn API version containing the functionality you need.** -- **Test caching, not just generated text.** - -The guiding principle for an incremental generator is: - -> Extract semantic information once, convert it into a small value model, and make everything downstream operate only on that value model. - -### 2. Analyser vs source generator - -Use a `DiagnosticAnalyser` when the question is: - -> Is the source code valid according to this library's rules? - -Use an `IIncrementalGenerator` when the question is: - -> Given valid source code, what source should be generated? - -| Requirement | Prefer | -| --- | --- | -| Require a class to be `partial` | Analyser | -| Require an attribute on a declaration | Analyser | -| Validate a method signature | Analyser | -| Reject unsupported property types | Analyser | -| Detect invalid attribute arguments | Analyser | -| Detect unsupported API usage | Analyser | -| Offer an automatic fix | Analyser + `CodeFixProvider` | -| Generate members for a marked class | Incremental generator | -| Generate serializers/validators/mappers | Incremental generator | -| Generate a registry from discovered types | Incremental generator | -| Read a schema file and generate C# | Incremental generator | -| Internal generation failure | Generator diagnostic | - -### 3. Choosing an analyser action - -Use the narrowest API that represents the concept being analysed: - -- `RegisterSyntaxNodeAction` — exact source syntax (e.g., modifier presence). -- `RegisterSymbolAction` — declaration semantics (e.g., attributes, interfaces, accessibility). -- `RegisterOperationAction` — executable behaviour (e.g., invocation, assignment, object creation). -- `RegisterOperationBlockStart/EndAction` — stateful method analysis. -- `RegisterSymbolStart/EndAction` — type-wide analysis across members. -- `RegisterCompilationStartAction` — resolve known framework symbols once. -- `RegisterAdditionalFileAction` — analyse `AdditionalFiles`. -- Avoid `RegisterSyntaxTreeAction`, `RegisterSemanticModelAction`, and compilation-end actions unless genuinely necessary. - -### 4. Syntax vs symbol vs operation - -Decision tree: - -1. Does exact source spelling/structure matter? → **Syntax** -2. Otherwise, is it a declaration? → **Symbol** -3. Otherwise, is it executable behaviour? → **Operation** - -Use `SymbolEqualityComparer.Default.Equals(...)` when comparing symbols. - -### 5. Analyser best practices - -- Enable concurrent execution with `context.EnableConcurrentExecution()`. -- Explicitly configure generated-code analysis with `context.ConfigureGeneratedCodeAnalysis(...)`. -- Resolve known framework/library symbols once in a `RegisterCompilationStartAction`. -- Prefer narrow registrations over scanning entire syntax trees or compilations. -- Treat diagnostic IDs as public contracts and maintain release tracking files when publishing public diagnostics. - -### 6. Incremental generator golden rules - -Implement `IIncrementalGenerator`. Simply implementing it is not enough; the pipeline must be incremental. - -> **Pipeline values must be immutable and value-equatable.** - -Never keep these in persistent pipeline models: - -| Type | Verdict | -| --- | --- | -| `ISymbol` / `INamedTypeSymbol` / `IMethodSymbol` / `IPropertySymbol` | Never retain | -| `Compilation` | Do not propagate | -| `SemanticModel` | Do not propagate | -| `IOperation` | Do not propagate | -| `SyntaxTree` | Do not propagate | -| `SyntaxNode` | Remove ASAP | -| `Location` | Remove ASAP | -| `AdditionalText` | Project immediately | -| `T[]` / `List` | Avoid | -| `ImmutableArray` | Wrap with sequence equality | - -Use immutable records and `EquatableArray` (sequence equality) for collection members. - -### 7. Designing the pipeline - -Pipeline shape: - -```text -Roslyn Input - ↓ -Cheap discovery - ↓ -Semantic extraction - ↓ -Small equatable model - ↓ -Validation/transformation - ↓ -Generation model - ↓ -Source output -``` - -Guidelines: - -- Project the semantic transform as the boundary where Roslyn objects disappear. -- Prefer `static` callbacks to avoid capturing generator state. -- Honour cancellation tokens. -- Split transformations into many small stages. -- Keep syntax predicates cheap. -- Avoid indirect discovery (every interface implementation, every subclass, entire-compilation scans). - -### 8. Syntax discovery - -- Prefer `context.SyntaxProvider.ForAttributeWithMetadataName(...)` for attribute-driven generators. -- Use `context.SyntaxProvider.CreateSyntaxProvider(...)` only when syntax itself is the trigger and there is no marker attribute. -- The predicate must be cheap; do not walk the tree or do semantic work in it. - -### 9. `Collect`, `Combine`, and invalidation - -- `Collect()` turns per-item outputs into one aggregate. Changing any item invalidates the aggregate. -- Use `Collect()` only for genuinely global output: registries, lookups, duplicate detection, aggregate switches. -- Prefer per-item `RegisterSourceOutput`. -- `Combine()` is correct when the output depends on two providers. -- Avoid `models.Combine(context.CompilationProvider)` — project the compilation to a tiny capability fact first. -- Use `.WithComparer(...)` only when logical equality differs from the default. - -### 10. Diagnostics - -- Prefer a separate `DiagnosticAnalyser` for normal user validation. -- Use generator diagnostics only for malformed additional files, generator-only configuration, conflicting output, or failures that cannot be expressed by an analyser. -- Report diagnostics on the most useful user-authored `Location`. -- Do not keep `Location` in long-lived pipeline models. - -### 11. Output generation - -- Output must be deterministic: no timestamps, random GUIDs, process IDs, machine paths, culture-dependent output, or unordered dictionary output. -- Hint names must be deterministic, unique, and stable. -- Prefer text generation or `CodeWriter` over building Roslyn syntax trees just to stringify them. -- Use `RegisterPostInitializationOutput` for constant source such as marker attributes. -- Add generated source once per output artifact. - -### 12. Testing incrementally - -- Snapshot-testing generated source is not enough. -- Test first execution, cached second execution, unrelated changes remaining cached, per-target invalidation, deletion, renaming, global options, additional files, and global registry invalidation. -- Use `GeneratorDriverOptions` with `trackIncrementalGeneratorSteps: true` and inspect reasons: `New`, `Modified`, `Unchanged`, `Cached`, `Removed`. - -### 13. Roslyn version compatibility and packaging - -- The `Microsoft.CodeAnalysis.*` version used to compile the analyser/generator sets the minimum compiler-host requirement. -- The consumer's `TargetFramework` does not determine analyser compatibility. -- Choose the oldest Roslyn version that contains the APIs you need. -- Common baselines: Roslyn 4.8 for VS 17.8 / .NET 8, 4.12 for VS 17.12 / .NET 9, 5.0 for VS 2026 18.0 / .NET 10, 5.12 for .NET 11. -- Ship one `netstandard2.0` analyser/generator binary unless you have a deliberate multi-version strategy. -- Do not mistake multi-targeting for automatic analyser asset selection. -- Use `PrivateAssets="all"` for Roslyn development dependencies. -- Enable `EnforceExtendedAnalyzerRules` and investigate `RSxxxx` diagnostics before suppressing them. - -### 14. Recommended project configuration - -A generator project should normally include: - -```xml - - netstandard2.0 - latest - enable - true - false - true - true - - - - - - - - - - -``` - -## Preferred API map for CodeWriter - -### File and namespace - -- `AutoGeneratedHeader(...)` -- `Using(...)` -- `FileScopedNamespace(...)` or `BlockNamespace(...)` -- `OpenPragmasScope(...)` for warning suppression scopes - -### Types and members - -- Types: `Class`, `Struct`, `RecordClass`, `RecordStruct`, `Union`, `Interface`, `Enum`, `Delegate` -- A C# 15 union declares its case types through `TypeDeclarationOptions.UnionCaseTypes` (for example - `writer.Union("Pet", [cat, dog])`); a closed hierarchy sets `IsClosed` on a class or record class - to emit `closed`, which replaces the default `sealed`. -- Members: `Method`, `MethodScope`, `Property`, `Field`, `Constructor` -- Attributes: `AttributeDeclarationOptions`, `AttributeArgumentOptions` -- Type syntax: `TypeReference` (nullable/generic/array/pointer-safe composition) - -### XML documentation - -Use `XmlCommentWriter` extension methods on `CodeWriter`: - -- `XmlSummary(...)`, `XmlParam(...)`, `XmlTypeParam(...)`, `XmlReturn(...)`, `XmlRemarks(...)`, `XmlExample(...)` -- `XmlCode(...)` / `XmlCodeBlock(...)` -- `XmlList(...)`, `XmlSeeAlso(...)`, `XmlException(...)` - -Static helpers: `CodeWriter.XmlInlineCode(...)`, `CodeWriter.XmlSee(...)`, `CodeWriter.XmlParamRef(...)`, `CodeWriter.XmlText(...)`. - -## Refactoring guide: string/StringBuilder -> CodeWriter - -Apply this checklist in order: - -1. **Move emission boundaries** — replace giant string assembly with phases: header, namespace, type, members. -2. **Replace manual braces/indentation** — use `using` scopes (`ClassScope`, `MethodScope`, `OpenBlockScope`, `IndentedScope`). -3. **Replace handwritten signatures** — use declaration option records. -4. **Replace raw XML lines** — use XML extension methods (`XmlSummary`, `XmlParam`, etc.). -5. **Normalize type strings** — use `TypeReference`. -6. **Preserve semantics and ordering** — generated members and diagnostics must remain equivalent. -7. **Validate scope safety** — keep or enable `PurviewSourceGeneratorFrameworkValidateCodeWriterScopes` for tests/dev. - -## Anti-patterns to remove during refactors - -- `StringBuilder.AppendLine("public class ...")` for declarations that can be structured. -- Manually writing `{` / `}` around methods and types where scope APIs exist. -- Hard-coded nullable type suffixes and generic syntax in arbitrary strings when `TypeReference` is available. -- Raw XML tag string composition when XML extension methods can enforce consistency. -- Creating a `CodeWriter` before the output callback and passing it through the pipeline. -- Storing a `CodeWriter` on `GenerationContext`, a custom context, or any incremental pipeline model. -- Sharing one `CodeWriter` across multiple generated outputs or callbacks. -- Keeping Roslyn objects, `CodeWriter`, or mutable state in incremental pipeline models. - -## Review checklist for pull requests - -- Generated declarations use structured APIs for types and members. -- XML docs use XML extension methods rather than raw `///` fragments. -- `CodeWriter` is created inside each output callback and never persists in pipeline state; passing it - to helper methods within that callback is expected. -- Header and generated attributes are deterministic and consistent. -- Existing diagnostics, generated member names, and public behavior are preserved. -- Roslyn objects are removed from pipeline models; `EquatableArray` is used for collections. -- Per-target output is preferred over collected global output unless global knowledge is required. -- `CompilationProvider` is not casually combined into output. -- Deterministic hint names and source text are used. -- Incremental caching behavior is tested, not just generated text. - -## See also - -- `agents/source-generator-framework-writer.agent.md` — specialist agent for `Purview.SourceGeneratorFramework` emitter authoring. -- `prompts/refactor-source-generator-to-codewriter.prompt.md` — prompt template for legacy-emitter refactor tasks. diff --git a/.agents/skills/purview-sourcegenerator-codewriter/references/legacy-emitter-migration.md b/.agents/skills/purview-sourcegenerator-codewriter/references/legacy-emitter-migration.md deleted file mode 100644 index 54efd09f..00000000 --- a/.agents/skills/purview-sourcegenerator-codewriter/references/legacy-emitter-migration.md +++ /dev/null @@ -1,58 +0,0 @@ -# Migrating a legacy emitter to CodeWriter - -A playbook for moving a source generator's emission from manual `string` / `StringBuilder` -construction to `CodeWriter` plus the `XmlCommentWriter` documentation extensions, with behaviour -parity. - -## Before you start, collect - -- The emitter file(s) being changed. -- The generator type name, and the version string it stamps into generated attributes or headers. -- Whether the output must stay **byte-identical**. If it must, every whitespace decision below is a - constraint rather than a preference, and the diff of the generated snapshots is the acceptance - test. - -## Requirements - -1. Use the structured declaration APIs rather than hand-written declaration text: - `Class` / `Struct` / `RecordClass` / `Interface` / `Enum`, and `Method`, `Property`, `Field`, - `Constructor`. -2. Use the XML helper extensions instead of composing `///` lines: `XmlSummary`, `XmlParam`, - `XmlReturn`, `XmlRemarks`, `XmlCode` / `XmlCodeBlock`. -3. Use `TypeReference` once the type text gets complex — nullability, generics, arrays. -4. Keep the writer **output-scoped**: `generationContext.CreateCodeWriter()` *inside* the output - callback. Never create it earlier in the pipeline, and never store it in incremental provider - state or in a custom context. -5. Preserve behaviour, diagnostics and generated names. -6. Keep the change minimal. Do not reformat logic the migration does not touch. - -## Strategy - -Work phase by phase, because each phase has a different mechanical replacement: - -| Emitter phase | Replace with | -| --- | --- | -| header | the header helper, not a literal banner string | -| namespace | the namespace scope API | -| type declarations | declaration option records, not signature strings | -| member declarations | `Method` / `Property` / `Field` / `Constructor` | -| indentation and braces | scoped APIs — never manual `{`/`}` and `\t` | -| `///` comment composition | `XmlSummary`, `XmlParam`, `XmlReturn`, `XmlRemarks`, `XmlCode` | - -Call out any intentional semantic delta explicitly; a migration that quietly changes emitted names or -diagnostics is the failure mode this playbook exists to avoid. - -## Verification - -- Run the impacted tests. -- Confirm the generated files still compile. -- Confirm there are **no scope leaks**: `OpenScopeCount == 0` when the writer is materialized. Enable - CodeWriter scope validation in the test run. -- Where byte-identical output was required, diff the generated snapshots. - -## Report - -1. Files changed. -2. Why each change was necessary. -3. Risks and behaviour differences, if any. -4. The verification that actually ran. diff --git a/.agents/skills/purview-sourcegenerator-diagnostics/SKILL.md b/.agents/skills/purview-sourcegenerator-diagnostics/SKILL.md deleted file mode 100644 index d5b43b4b..00000000 --- a/.agents/skills/purview-sourcegenerator-diagnostics/SKILL.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -name: purview-sourcegenerator-diagnostics -description: >- - Use when a Purview.SourceGeneratorFramework build reports a PSGFR, PSGF, PRSGD, TLB or ADM diagnostic, - when choosing which code fix applies, or when a source generator, diagnostic analyzer or code fix - provider is silently not running at all. -metadata: - product: Purview.SourceGeneratorFramework - repository: purview-dev/sourcegenerator-framework ---- - -# Purview.SourceGeneratorFramework diagnostics - -`Purview.SourceGeneratorFramework` ships `Purview.SourceGeneratorFramework.Analyzers` and -`Purview.SourceGeneratorFramework.CodeFixers` as analyzer assets inside the package, under -`analyzers/dotnet/cs/`. They are enabled automatically in any project that references the framework — -there is no separate package to add. - -Two compiler-analyzer families, plus a set of MSBuild-time diagnostics: - -- **Incremental generator best practice** — `PSGFR11`–`PSGFR33`: pipeline design, `CodeWriter` usage, - Roslyn component discovery, extension-class conventions. -- **C# 14 extension-member conventions** — `PSGFR34`–`PSGFR38`, with - `ReorganizeExtensionClassCodeFixProvider` and `ConvertToExtensionBlockCodeFixProvider`. -- **Merge and packaging** — `PSGFR39`–`PSGFR43`, where `PSGFR43` is the merge tool's blocked - public-surface code. - -## Start here when nothing runs - -A compiler host loads a generator, analyzer or code fix provider only when **three** conditions hold. -Missing any one means the component is **silently ignored** — no error, no output, a green build: - -1. **The type is public** (`PSGFR27`). -2. **The type is decorated** — `[Generator]` (`PSGFR26`), `[DiagnosticAnalyzer]` (`PSGFR25`), or - `[ExportCodeFixProvider]` (`PSGFR24`). -3. **The assembly is loaded as an analyzer** — packed under `analyzers/dotnet/cs/` in a package, or - referenced with `OutputItemType="Analyzer"` on a `ProjectReference`. - -A code fix provider additionally appears only when a diagnostic ID in its `FixableDiagnosticIds` is -actually produced by an analyzer loaded alongside it (`PSGFR28`). Visual Studio MEF-composes fix -providers when the analyzer set loads, so after adding or updating a fixer assembly you must restart -Visual Studio or reload the project before the fixes show up. - -## Build-time validation diagnostics - -These are MSBuild diagnostics, not compiler analyzers, so they are **not** tracked in -`AnalyzerReleases.*.md`: - -| Code | Raised by | Summary | -| --- | --- | --- | -| `PSGF0001` | `Purview.BuildSdk` | A Roslyn component did not produce (or declare) a source-generator analyzer file. | -| `PSGF0003` | `Purview.SourceGeneratorFramework` | A `PurviewGeneratorVisibleProperty` is not compiler-visible in the declaring project or its `Sdk/build`/`Sdk/buildTransitive` assets, so consumers cannot read `build_property.`. | -| `PRSGD0005` | `Purview.BuildSdk` | A file in the returned analyzer closure references an assembly that is neither in the closure nor a compiler-host assembly. | -| `PSGFR41` | merge tool | A component's public surface exposes framework types the merge internalizes. Reported by the analyzer at design time, and by the merge pass as `message` (default), `warning` or `error`. | -| `PSGFR43` | merge tool | The merged analyzer still exposes a public framework type, so it is not self-contained. Always an error; the merge fails with exit code 5. | - -Opt out with `PurviewSourceGeneratorFrameworkAnalyzerValidation=false` (`PRSGD0005`) or -`PurviewSourceGeneratorFrameworkGeneratorPropertyValidation=false` (`PSGF0003`). - -## Incremental pipeline rules - -| Rule | Summary | -| --- | --- | -| `PSGFR11` | Prefer `SyntaxProvider.ForAttributeWithMetadataName` over `CreateSyntaxProvider` for attribute-based detection. | -| `PSGFR12` | Use `IIncrementalGenerator` / `RegisterSourceOutput` instead of `ISourceGenerator`. | -| `PSGFR14` | Avoid `RegisterImplementationSourceOutput` unless implementation-only output is required. | -| `PSGFR15` | Pipeline model collection members should use sequence equality (`EquatableArray`). | -| `PSGFR30` | Prefer `static` lambdas in pipeline methods, so the compiler never allocates a closure on the per-item hot path. | -| `PSGFR31` | Prefer `GeneratorAttributeSyntaxContext.TargetSymbol` over `SemanticModel.GetDeclaredSymbol(ctx.TargetNode)`. | -| `PSGFR33` | Pipeline models must not retain Roslyn objects (`ISymbol`, `SyntaxNode`, `Location`, …); extract the information into value types. | - -## CodeWriter rules - -The rules that recommend a structured API are **warnings**, not IDE-only suggestions: `PSGFR16`, -`PSGFR18`–`PSGFR23`, and `PSGFR34`. A build that treats warnings as errors therefore fails until the -call is rewritten or explicitly suppressed. - -| Rule | Summary | -| --- | --- | -| `PSGFR16` | Prefer the nullable-context `Nullable()`/`MakeNullable()` overload, so annotations honour the target compilation. | -| `PSGFR17` | Consume scope-returning methods (`…Scope`, `IndentedScope`) with `using`. | -| `PSGFR18` | Prefer structured declaration APIs (`Class`, `Method`, `Property`, `Field`) over raw declaration text. | -| `PSGFR19` | Prefer structured statement APIs (`Return`, `MethodCall`, `Throw`, `Assignment`, `Using`, `Comment`) over raw statement text. | -| `PSGFR20` | Prefer the minimal `CodeWriter` overloads over hand-constructing `*DeclarationOptions` values. | -| `PSGFR21` | Prefer `HashDefines`/`HashDefinesScope` for `#if`/`#endif`. | -| `PSGFR22` | Prefer `PragmaDisable`/`OpenPragmasScope` for `#pragma warning`. | -| `PSGFR23` | Prefer structured `IfBlock`/`ElseIf`/`Else` over raw `if` block text. | -| `PSGFR29` | Do not embed a `CodeWriter` in a string; use `XmlCommentWriter.XmlInlineCode`. | -| `PSGFR32` | Avoid `NormalizeWhitespace` when generating source; use an indented text writer such as `CodeWriter`. | - -## Component, extension and merge rules - -| Rule | Summary | -| --- | --- | -| `PSGFR24` | `CodeFixProvider` is not marked `[ExportCodeFixProvider]`; Visual Studio will never discover it. | -| `PSGFR25` | `DiagnosticAnalyzer` is not marked `[DiagnosticAnalyzer]`; it will never run. | -| `PSGFR26` | A generator type is not marked `[Generator]`; it will never run. | -| `PSGFR27` | A Roslyn component type is not public; the compiler host cannot instantiate it. | -| `PSGFR28` | `FixableDiagnosticIds` names a diagnostic no analyzer in the compilation produces; the fix will never be shown. | -| `PSGFR34` | Prefer C# 14 `extension(Receiver)` blocks over classic static `this`-parameter extension methods. | -| `PSGFR35` | Extension class name must match the extended type (`{Receiver}Extensions`). | -| `PSGFR36` | Extension classes belong in the extended type's namespace, under an `Extensions` folder. | -| `PSGFR37` | One extension class per receiver type; split a class that extends several. | -| `PSGFR38` | Extension classes should carry `[EditorBrowsable(EditorBrowsableState.Never)]`. | -| `PSGFR39` | A non-packable Roslyn component opted out of the default self-contained analyzer output (`PurviewMergeSourceGeneratorFrameworkForAnalyzerFiles=false`) while embedding the framework; otherwise the package embeds the loose framework DLL under `analyzers/`. | -| `PSGFR40` | In a Roslyn component (`IsRoslynComponent=true`), reference SGF types as inline code (`Type`) rather than a `cref`: copied documentation must not depend on cref resolution. | -| `PSGFR41` | A public member (or generic constraint) whose signature references an SGF type in a component whose framework implementation is merged. The merge internalizes every SGF type, so the signature ends up referring to an internal type. Make the member, or its declaring type, non-public. | -| `PSGFR42` | A disposable Testing-harness result (`DriverRunResult`) is produced and never disposed, leaking the collectible `AssemblyLoadContext` and `MetadataLoadContext` of a compiled run. `warning` when the run syntactically compiles to an assembly (a `Compile` options member, or `CompileToAssembly = true`), otherwise `info`. Awaiting an assertion, or calling a helper handed the result — an extension on it, or a method taking it as a parameter — is not a production: both hand the same instance back, so only a task-like await or a genuine producer is reported. | - -## Type-library and attribute-model diagnostics - -The bundled generators carry their own families: `TypeLibraryValidationAnalyzer` -(`TLB0001`–`TLB0019`, plus `TLB0021`) and the attribute-data-model analyzers. They are documented on their -own wiki pages, `Type-Library.md` and `Attribute-Data-Models.md`. - -The attribute-data-model rules come from three analyzers: - -| Rules | Analyzer | Covers | -| --- | --- | --- | -| `ADM0001`–`ADM0009` | `AttributeDataModelValidationAnalyzer` | the target, property types, defaults, explicit constructor members | -| `ADM0010` | `AttributeDataModelSymbolPropertyAnalyzer` | non-cacheable `ISymbol`/`Type` properties | -| `ADM0011`–`ADM0015` | `AttributeDataModelNamingAnalyzer` | mapped names the generated code would never find, generated-member name clashes, `[NestedModel]` mappings the outer attribute does not line up with | - -Treat the naming rules as real defects: the generated code reads names case-sensitively and silently falls -back to a default, so a naming mistake never fails the build on its own. `ADM0013` is `Info` because a -nested model may deliberately read a value the outer attribute does not have; check each one. The -`purview-sourcegenerator-attribute-data-models` skill has the full table and the fix for each rule. - -## Code fixes - -Most rules above have a fix in `Purview.SourceGeneratorFramework.CodeFixers`: - -| Fix provider | Rule | -| --- | --- | -| `AddGeneratorAttributeCodeFixProvider` | `PSGFR26` | -| `AddDiagnosticAnalyzerAttributeCodeFixProvider` | `PSGFR25` | -| `AddExportCodeFixProviderAttributeCodeFixProvider` | `PSGFR24` | -| `MakeRoslynComponentPublicCodeFixProvider` | `PSGFR27` | -| `RemoveOrphanedFixableDiagnosticIdCodeFixProvider` | `PSGFR28` | -| `PreferTargetSymbolCodeFixProvider` | `PSGFR31` | -| `PreferStaticLambdaCodeFixProvider` | `PSGFR30` | -| `PreferNullableContextOverloadCodeFixProvider` (project-wide Fix All) | `PSGFR16` | -| `PipelineModelReferenceEqualityCollectionCodeFixProvider` | `PSGFR15` | -| `PreferStructuredCodeWriterIfBlockCodeFixProvider` | `PSGFR23` | -| `PreferStructuredCodeWriterStatementCodeFixProvider` (single-line statements) | `PSGFR19` | -| `PreferMinimalCodeWriterOverloadCodeFixProvider` | `PSGFR20` | -| `PreferPragmaDisableCodeFixProvider` (`disable` only) | `PSGFR22` | -| `CodeWriterToStringCodeFixProvider` | `PSGFR29` | -| `PreferInlineCodeForFrameworkCrefCodeFixProvider` | `PSGFR40` | -| `MakeComponentSurfaceNonPublicCodeFixProvider` | `PSGFR41` | -| `DisposeTestResultCodeFixProvider` | `PSGFR42` | -| `ReorganizeExtensionClassCodeFixProvider` (renames, splits, moves, updates referencing files) | `PSGFR35`, `PSGFR36`, `PSGFR37` | -| `ConvertToExtensionBlockCodeFixProvider` | `PSGFR34` | -| `AddExtensionClassMetadataCodeFixProvider` | `PSGFR38` | -| `MakeTypeLibrarySpecNonPublicCodeFixProvider` | `TLB0021` | -| `AttributeDataModelSymbolPropertyCodeFixProvider` | attribute-data-model symbol properties | -| `TypeLibraryMemberAccessibilityCodeFixProvider`, `TypeLibraryMarkerDefaultInitializerCodeFixProvider`, `MakeTypeLibrarySpecPartialCodeFixProvider`, `RenameTypeLibrarySpecCodeFixProvider`, `TypeLibraryMemberTypeCodeFixProvider` | type-library rules | - -## Related skills - -`purview-sourcegenerator-codewriter` for the emission patterns the `CodeWriter` rules push you -towards, `purview-sourcegenerator-testing` for proving a pipeline actually caches, and -`purview-sourcegenerator-attribute-data-models` for the `ADM` rules. diff --git a/.agents/skills/purview-sourcegenerator-packaging/SKILL.md b/.agents/skills/purview-sourcegenerator-packaging/SKILL.md deleted file mode 100644 index a34f72c4..00000000 --- a/.agents/skills/purview-sourcegenerator-packaging/SKILL.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -name: purview-sourcegenerator-packaging -description: >- - Use when packaging or referencing a source generator built on Purview.SourceGeneratorFramework - - the self-contained merged analyzer, GetSourceGeneratorAnalyzerFiles, embedding a generator in - another package, PurviewGeneratorVisibleProperty, analyzer-closure validation, Roslyn version - compatibility, and errors such as CS0433, CS8784 or MSB3073 from a loaded analyzer. -metadata: - product: Purview.SourceGeneratorFramework - repository: purview-dev/sourcegenerator-framework ---- - -# Packaging a source generator - -The rule everything else follows from: **a shipped Roslyn component carries its own copy of the -framework and references no loose `Purview.SourceGeneratorFramework.dll`.** Two generators built -against different framework versions must be able to load into one compiler host. A shared DLL under -`analyzers/` cannot give you that — whichever version loads first wins, and the other fails with -`MissingMethodException` or `CS0433`. - -The framework delivers this by IL-merging and internalizing its implementation into each component's -**intermediate** output, leaving the component's `bin` unmerged. - -## Referencing the framework from a component - -```xml - - true - - - - - -``` - -And from a consuming project, as an analyzer: - -```xml - -``` - -`Purview.BuildSdk` invokes `GetSourceGeneratorAnalyzerFiles` automatically — naming -`Targets="GetSourceGeneratorAnalyzerFiles"` explicitly still works but is not required. - -## The three consumption paths - -| Path | Trigger | What you get | -| --- | --- | --- | -| `GetSourceGeneratorAnalyzerFiles` (default) | a consuming project references the component as an analyzer | the **merged** component, from the content-addressed `purview-merged//`. `bin` stays unmerged, so an in-process test harness keeps shared framework type identity and `InternalsVisibleTo` access without `CS0433`. | -| `GetSourceGeneratorAnalyzerFiles` with `PurviewMergeSourceGeneratorFrameworkForAnalyzerFiles=false` | opt-out | unmerged component **plus** the loose framework DLL from the package `lib/`. | -| `GetPurviewMergedAnalyzerFile` | the framework's own bundled-component pack, or a third-party package embedding the generator | the merged component; `bin` is never overwritten. | -| `GetPurviewMergedAnalyzerFileForPack` (pack-time, via `TargetsForTfmSpecificContentInPackage`) | packing a standalone packable generator | the merged DLL and PDB contributed straight to `analyzers/dotnet/cs`. `bin` is never mutated, so its shape does not depend on whether `build` or `pack` ran last. | - -Two properties exist and both should normally be left alone: - -- `PurviewEmbedSourceGeneratorFramework=false` — only for a project that *is* the framework - compile-time library. A published generator package must never disable embedding. -- `PurviewMergeSourceGeneratorFrameworkForAnalyzerFiles=false` — only when the analyzer-files - consumer must keep the unmerged + loose-DLL shape (a generator shipped into one compiler process - alongside an incompatible framework version). - -`PSGFR39` errors when a **non-packable** component opts out while embedding the framework, because -that shape, packed through the GASF path, forces the loose DLL back under `analyzers/`. - -## A component that references another component - -A code-fix or analyzer component can reference the generator component normally (`ProjectReference`, -`ReferenceOutputAssembly` **not** `false`) when it needs the generator's internal diagnostic -identity. Both are `IsRoslynComponent`; only the generator references the framework. - -- The referenced component is returned as **its own merged assembly** and is never IL-merged into the - dependent one — that would duplicate its types, including `InternalsVisibleTo`-visible internals, - inside a second analyzer in the same host. -- The framework assembly is copied beside the generator's `bin` (a plain copy, not copy-to-output - content). A dependent component that references the generator as an assembly gets it copied - beside its own `bin` by ordinary assembly-reference resolution, which is what lets Visual Studio - load the dependent code-fix provider without a `FileNotFoundException` for the framework assembly. -- A project that references a component only as an analyzer (`ReferenceOutputAssembly="false"`) - never receives the framework assembly, and neither does any application downstream of it. Since - 1.2.2 it no longer leaks into app build output, `deps.json`, publish output, single-file bundles or - Blazor WebAssembly `_framework`, where it broke Native AOT and WebAssembly AOT publishing. -- Visual Studio's project system resolves an `OutputItemType=Analyzer` project reference to the - referenced project's **unmerged** `bin` assembly and adds it to the compiler's analyzers — the - command-line build does not. `Purview.BuildSdk` removes that item before adding the resolved - closure, so Roslyn only ever receives the merged artifact. Without that removal the unmerged copy - drags `Purview.SourceGeneratorFramework` into the compiler host - (`CS8784 FileNotFoundException: Could not load file or assembly 'Purview.SourceGeneratorFramework'`) - and every generator registers twice. - -## Analyzer-closure validation - -`Purview.BuildSdk` validates the whole closure `GetSourceGeneratorAnalyzerFiles` returns: every -file's PE `AssemblyRef` must resolve to another file in the returned set, or to a compiler-host -assembly (`Microsoft.CodeAnalysis*`, `System.Composition.*`, `System.*`, `netstandard`, …). A missing -component artifact fails the build with `PRSGD0005`. - -Extend the permitted set with `` or the -`PurviewAnalyzerClosurePermittedReferences` property. Opt out with -`PurviewSourceGeneratorFrameworkAnalyzerValidation=false`. - -## Generator-read MSBuild properties - -A generator reading `build_property.` is only correct if `` is a -`CompilerVisibleProperty` **wherever the generator runs** — including in a consumer's project. -Declare what the component reads: - -```xml - - - -``` - -`PSGF0003` fails the build when a declared property is neither a `CompilerVisibleProperty` in the -project nor declared by the project's own `Sdk/build` or `Sdk/buildTransitive` assets — which is what -consumers actually receive. Opt out with -`PurviewSourceGeneratorFrameworkGeneratorPropertyValidation=false`. - -NuGet imports `buildTransitive` assets for **PackageReference** consumers only. Inside the package -repository every project uses `ProjectReference`, so `Purview.BuildSdk`'s -`ImportProjectReferencedBuildTransitiveAssets` registers the referenced project's -`Sdk/buildTransitive/*.props|*.targets` `CompilerVisibleProperty` items for in-repo consumers. Opt -out with `PurviewImportProjectReferenceBuildTransitive=false`. - -## Embedding a generator in another package - -Pack the **merged** assembly, so the outer package ships no loose framework DLL: - -```xml - - false - $(TargetsForTfmSpecificContentInPackage);PackMyGenerator - - - - - - - - - analyzers/dotnet/cs/ - - - -``` - -If the generator is also embedded at compile time for the outer package's consumers, the outer -package must make the framework's compiler-visible properties visible to them — build assets from -`Purview.SourceGeneratorFramework` are **not** copied into the outer package. Ship a `.props` that -declares the property and its `CompilerVisibleProperty` entry, packed under the outer package's own -ID so NuGet imports it: - -```xml - -``` - -## `IsExternalInit` - -The framework assembly defines `System.Runtime.CompilerServices.IsExternalInit` **publicly**, so the -bundled generators can emit `init`-based attribute types into any consumer compilation and the merge -has a single marker definition to internalize. - -**Do not declare your own.** A generator-local marker gives calls to the framework's `init` setters a -different required-custom-modifier identity from the setter definitions. The merge tool normalizes -those modifiers in a temporary copy for compatibility with legacy tooling, but removing the redundant -marker is the preferred configuration. - -## Roslyn version compatibility - -> The version of `Microsoft.CodeAnalysis.*` you compile the component against sets a **minimum -> compiler-host API requirement**. The consumer's `` has nothing to do with it — -> analyzer code runs inside the compiler/IDE host. - -| Roslyn package | Minimum Visual Studio | Language / .NET generation | -| ---: | --- | --- | -| 4.8 | VS 2022 17.8 | C# 12 / .NET 8 | -| 4.12 | VS 2022 17.12 | C# 13 / .NET 9 | -| 5.0 | VS 2026 18.0 | C# 14 / .NET 10 | -| 5.12 | VS 2026 18.x | C# 15 / .NET 11 | - -**This framework is built against Roslyn 5.9**, so a host loading it must ship Roslyn 5.9 or later -(.NET 11 SDK / Visual Studio 2026). The .NET 11 SDK ships Roslyn 5.12. The testing packages -multi-target `netstandard2.0`, `net10.0`, and `net11.0`, and Roslyn 5.9 ships `net10.0`/ -`netstandard2.0` assets, so both test targets load the runner. - -## A generator project to start from - -```xml - - - netstandard2.0 - latest - enable - true - false - true - true - - - - - - - - - - - - -``` - -`Purview.BuildSdk` already defaults most of this for a project it classifies as a Roslyn component, -so in an SDK repository the project file is usually far shorter. The exact Roslyn baseline is a -product-support decision. - -## Release gates - -Acceptance criteria for self-contained packaging — check metadata, never "the sample compiled": - -1. **No framework reference, no public framework types.** Every `analyzers/dotnet/cs/*.dll` has no - assembly reference to `Purview.SourceGeneratorFramework` and exposes no public type in a - framework-owned namespace (including the generated `Generators` attribute set and the - framework-emitted `Microsoft.CodeAnalysis.EmbeddedAttribute`). The one exception is the - component's own Roslyn entry points, which must stay public — Roslyn only instantiates public - components (`PSGFR27`). -2. **No loose framework DLL in any package**, and no `*.pdb` in the `.nupkg` — symbols ship only - through the `.snupkg`. -3. **Merged entry points survive**: each merged DLL still exposes its `IIncrementalGenerator`, - `DiagnosticAnalyzer` or `CodeFixProvider`. -4. **Installed-package consumer test**: a generator project referencing the framework by - `PackageReference` packs one self-contained DLL under `analyzers/dotnet/cs`, and a consumer that - installs it builds with the generator producing output. -5. **Two-version coexistence test**: build Generator A against the current framework and Generator B - against an intentionally binary-incompatible version, install both into one consumer, and build - with both package-reference orders. Both must run against their own embedded copy. - -## Going deeper - -The merge pass, the content-addressed artifact, framework type internalization and the properties -that tune it are in [references/merge-internals.md](references/merge-internals.md) — read it when a -merge fails, when a type leaks, or when you hit `MSB3073` / `CS0433` / `CS8784` from a loaded -analyzer. diff --git a/.agents/skills/purview-sourcegenerator-packaging/references/merge-internals.md b/.agents/skills/purview-sourcegenerator-packaging/references/merge-internals.md deleted file mode 100644 index 5d8b6c9e..00000000 --- a/.agents/skills/purview-sourcegenerator-packaging/references/merge-internals.md +++ /dev/null @@ -1,139 +0,0 @@ -# The merge pass and the self-contained analyzer - -## Where the merged artifact lives - -`_PurviewMergeSourceGeneratorFramework` only ever writes to the component's **intermediate** output. -`GetSourceGeneratorAnalyzerFiles` returns that result by substituting the merged path into -`TargetPathWithTargetPlatformMoniker` immediately before its body runs, leaving `GetTargetPath` — -which resolves assembly references — pointing at the unmerged `bin`. That split is what keeps the -in-repo test harness working while shipped assemblies stay self-contained. - -The artifact is **content-addressed**: - -```text -$(IntermediateOutputPath)purview-merged//$(TargetFileName) -``` - -`` is a SHA-256 over the component, the framework assembly and the merge tool (the tool -computes it in its `--tag` mode). The tag is in the **directory**, never the file name, because -ILRepack derives the merged assembly's simple name from the output file name and an analyzer must -keep `.dll`. - -Two properties follow, and both matter: - -- A rebuild with identical inputs reuses the existing file and **skips the merge**, so - `_PurviewMergeSourceGeneratorFramework` is idempotent across the per-consumer — and potentially - parallel — invocations of `GetSourceGeneratorAnalyzerFiles`. -- Changed inputs select a **new directory**, so the merge never overwrites an assembly a compiler - host (csc, `VBCSCompiler`, Visual Studio) already has loaded. Overwriting such a file fails on - Windows with a sharing violation, which surfaced as `MSB3073` (merge tool exit code - `-532462766`) and left consumers loading a stale or partially written analyzer — the root cause of - `CS8784 FileNotFoundException: Could not load file or assembly 'Purview.SourceGeneratorFramework'`. - -The tool merges into a per-process `.staging-` directory and publishes it with a -non-overwriting directory rename. A concurrent invocation that loses the race simply observes the -published artifact rather than failing. - -Packaging needs the stable `.dll` name, so the pack paths -(`GetPurviewMergedAnalyzerFile`, `GetPurviewMergedAnalyzerFileForPack`) copy the content-addressed -artifact into `$(IntermediateOutputPath)purview-pack/` and pack that plainly named staging copy. - -## Framework type internalization - -ILRepack's `Internalize` is best-effort, and two gaps matter: - -- a framework type that reaches the merged component's public API surface stays public; and -- the types the framework's own generators emit **into** the component — the - `Purview.SourceGeneratorFramework.Generators` attribute set, generated type libraries, marker - attributes — are not part of the merged framework assembly at all, so ILRepack never sees them. - -Either gap leaks framework types out of what must be a self-contained analyzer, and any project -loading that analyzer alongside the real framework assembly fails with `CS0433` ambiguity for every -leaked type. - -So the merge tool runs a deterministic internalization pass (`FrameworkTypeInternalizer`) after -ILRepack finishes: - -- Every type in a framework-owned namespace (`Purview.SourceGeneratorFramework` and its children, - including the generated `Generators` attribute set) becomes non-public. Ownership is evaluated - through the **declaring chain**, because Mono.Cecil reports an empty namespace for a nested type: - the framework's nested containers — generated type-library namespace classes, nested operator/enum - groups, `CodeWriter` scopes — are only reachable through their declaring type. -- Types the framework's generators emitted into the component, recognized by the tool name on their - `System.CodeDom.Compiler.GeneratedCodeAttribute` (`TypeLibraryGenerator`, - `AttributeDataModelGenerator`), become non-public too, so a generated type library can never leak a - `TypeIdentity`/`TypeReference` member as public API. -- `Microsoft.CodeAnalysis.EmbeddedAttribute`, the framework-emitted marker, becomes non-public. -- **Roslyn component entry points are never internalized.** A generator, analyzer, code fix provider - or refactoring provider reachable from the framework namespace stays public, because Roslyn only - instantiates public components (`PSGFR27`). This is what keeps the framework's own bundled - analyzers working after the pass. -- The pass reports the result. Leftover public framework types fail the merge with **exit code 5** - (`PSGFR43`). Public component members whose signature exposes a framework type are logged - (`PSGFR41`) so the author can make them, or their declaring type, non-public. Visibility is - followed through the declaring chain here too: a public nested type inside an internal type — for - example the compiler-synthesised `$`/`$` extension containers emitted for an extension class - — is not reachable from outside the component, so it is not part of the public surface and is not - reported. - -Ownership is seeded with the framework assembly's own type identities, so a framework type living -*outside* the framework namespace (`Microsoft.CodeAnalysis.*Extensions`, `System.StringExtensions`) -is internalized as well. The artifact's assembly-level `InternalsVisibleTo` / -`IgnoresAccessChecksTo` grants are removed, because a shipped analyzer is not the component's own -assembly. - -## Tuning the pass - -| Property | Default | Effect | -| --- | --- | --- | -| `PurviewMergeOwnedNamespaces` | empty | Extra namespace prefixes (semicolon-separated) treated as framework-owned. | -| `PurviewMergeOwnedTypeFullNames` | empty | Extra type full names (semicolon-separated) treated as framework-owned. | -| `PurviewMergePublicSurfaceSeverity` | `message` | How a finding is reported: `message` (plain log text), `warning`/`error` (MSBuild diagnostics with code `PSGFR41`), or `none`. | -| `PurviewMergePublicSurfaceValidation` | `true` | `false` sets the severity to `none`. | -| `PurviewMergePublicSurfaceOrigin` | the merged component assembly | The origin reported with an MSBuild finding; point it at a source or project path for IDE navigation. | - -All five participate in the content tag, so changing one re-runs the merge — and re-emits its -findings — rather than reusing a cached artifact. The compiler analyzer with the same id (`PSGFR41`) -reports the same condition while you edit, so the surface is usually fixed before the merge runs. - -## Generated accessibility: bin versus merged artifact - -The component's own generated types — the type library, the attribute data models — keep their -generated accessibility in the component's **bin output**. `TLB0015` requires a hand-written partial -to be `public static partial` so it can merge with the generated library, and in-repo consumers such -as code fixers and sibling assemblies compile against it. - -Only the **merged analyzer artifact** internalizes them. Self-containment is therefore enforced at -the merge boundary without rewriting the accessibility an in-repo consumer compiles against, and that -split is safe precisely because a merged artifact is never referenced as a compile-time dependency. - -> A merged component is an analyzer artifact. Never reference it as a compile-time dependency. Tests -> that need to run a *packaged* generator load it out of band. - -## How the framework package itself is assembled - -`Purview.SourceGeneratorFramework` is dual-role: the framework assembly ships in `lib/` so generator -projects compile against it, and `analyzers/` carries self-contained generator, analyzer and -code-fixer assemblies. The bundled projects are: - -- `SourceGeneratorFramework.Generators` — `AttributeDataModelGenerator`, `TypeLibraryGenerator`; -- `SourceGeneratorFramework.Analyzers` — the `PSGFR*` and `TLB*` analyzers; -- `SourceGeneratorFramework.CodeFixers` — the code fix providers. - -Each has the framework implementation merged and internalized into it. The package deliberately does -**not** put `Purview.SourceGeneratorFramework.dll` under `analyzers/dotnet/cs`, so generators built -against different framework versions never ask Roslyn to load competing versions of a same-named -dependency. - -The shared models and helpers that once shipped as a separate -`Purview.SourceGeneratorFramework.Shared.dll` are compiled directly into the framework assembly -(`SourceGeneratorShared.Link.targets` links the sources). Consumers get one -`Purview.SourceGeneratorFramework.dll`, which removes the version-skew hazard a separately bundled -Shared assembly caused — generator packages loading a different Shared version in-process failed with -binary-incompatibility errors, such as removed `PurviewTypeLibrary` fields. - -Those projects are `IsRoslynComponent = true` and are **not** packable on their own. The -`SourceGeneratorFramework` project builds them via `GetPurviewMergedAnalyzerFile` and packs them -under `analyzers/dotnet/cs/` in `BuildAndPackBundledAnalyzerAssemblies`. They were previously -consumed as analyzer project references, but they now reference the framework assembly for the shared -types, which would form a project-reference cycle. diff --git a/.agents/skills/purview-sourcegenerator-pipeline/SKILL.md b/.agents/skills/purview-sourcegenerator-pipeline/SKILL.md deleted file mode 100644 index 373942fd..00000000 --- a/.agents/skills/purview-sourcegenerator-pipeline/SKILL.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -name: purview-sourcegenerator-pipeline -description: >- - Use when composing an incremental pipeline with Purview.SourceGeneratorFramework - - IncrementalPipeline helpers, GenerationContext and custom contexts, CreateCodeWriter lifetime, - GeneratorResult and blocking versus non-blocking diagnostics, disabling a generator from MSBuild, - scope validation, test logging, and stage tracking names. -metadata: - product: Purview.SourceGeneratorFramework - repository: purview-dev/sourcegenerator-framework ---- - -# Incremental pipeline composition - -`IncrementalPipeline` composes `IncrementalValueProvider` and `IncrementalValuesProvider`: -attribute-based discovery, generation-context creation, disable-property checks, and thin -source-output registration. - -Everything here follows from one rule: **pipeline values must be immutable and value-equatable.** -Roslyn caches the complete value a provider publishes, and offers no way to exclude one property of -it from caching. - -## `GenerationContext` - -A base execution-services context carrying the Roslyn `Compilation`, immutable `GenerationSettings`, -an optional `ISourceGenLogger`, and a factory for independently owned `CodeWriter` instances. - -```csharp -var contextProvider = IncrementalPipeline.DefaultGenerationContextValueProvider(context); -``` - -### Custom contexts - -A custom context does not need to accept or read build properties itself: - -```csharp -public sealed class MyGenerationContext : GenerationContext -{ - public MyGenerationContext(Compilation compilation, GenerationSettings settings, ISourceGenLogger? logger) - : base(compilation, settings, logger) - { - } -} - -var contextProvider = IncrementalPipeline.GenerationContextValueProvider( - context, - nameof(MyGenerator), - "1.0.0", - factory: static (compilation, settings, logger, cancellationToken) => - { - cancellationToken.ThrowIfCancellationRequested(); - return new MyGenerationContext(compilation, settings, logger); - }, - disablePropertyName: "MyGenerator_Disable" -); -``` - -The provider resolves scope validation, generator disabling and test logging from analyzer-config -properties *before* invoking the factory. The logger is created internally only when logging is -enabled and a sink is registered for that run. - -## `CodeWriter` lifetime — the rule that bites - -Treat `GenerationContext` as **cached incremental state** and each `CodeWriter` as **mutable, -output-scoped execution state**. Create the writer inside the registered source-output callback, -after the incremental cache boundary: - -```csharp -IncrementalPipeline.RegisterSourceOutput( - context, - targets, - contextProvider, - static (spc, target, generationContext) => - { - var writer = generationContext.CreateCodeWriter(); - EmitTarget(generationContext, writer, target); - spc.AddSource($"{target.Name}.g.cs", writer.ToString()); - } -); -``` - -Creating it in the callback and passing it to emitter helpers called from that same callback is the -intended pattern. The only forbidden thing is **persisting the writer in pipeline state**. - -Why, concretely: - -- Roslyn caches the whole published value; you cannot exempt a field. -- `CodeWriter` is mutable, so a cached one retains previously written source when the context is - reused for another output or run. -- Source-output callbacks may process independent targets **concurrently**; a shared writer mixes - their output and races. -- A fresh writer gives each generated source independent scope tracking and deterministic ownership. - -`CreateCodeWriter()` returns a new, independently owned instance every call. - -**Never add a `CodeWriter` property or field to a class derived from `GenerationContext`.** A custom -context is still produced by an incremental provider and cached as one complete value. Store only -compilation-derived services and immutable configuration there. - -When an emitter needs both services and writing, pass the context and the writer separately, or -compose a short-lived wrapper created inside the callback — which must never be returned from a -provider: - -```csharp -public sealed class GenerationOutputContext : ISourceGenLogger - where TContext : GenerationContext -{ - public GenerationOutputContext(TContext generation) - { - Generation = generation; - Writer = generation.CreateCodeWriter(); - } - - public TContext Generation { get; } - - public CodeWriter Writer { get; } - - public void Log(SourceGenLogLevel level, int indentation, string message, params object[] args) => - Generation.Log(level, indentation, message, args); -} -``` - -## `GeneratorResult` and diagnostics that do not stop generation - -`RegisterSourceOutput` combines targets with the generation context, reports diagnostics, and runs -the callback only for successful results: - -```csharp -var targets = IncrementalPipeline.ForAttributeWithMetadataName( - context, - AttributeType, - static (ctx, ct) => - { - var symbol = ctx.TargetSymbol; - - return symbol is null - ? GeneratorResult.Empty - : GeneratorResult.Create(symbol.Name); - } -); -``` - -The callback runs only when `GeneratorResult.ShouldProcess` is `true` — the result carries a value -**and** none of its diagnostics are blocking. - -`ReportableDiagnostic.IsBlocking` is an explicit per-diagnostic decision, **independent of -severity**. An `Error`-severity diagnostic can still allow generation to continue, which is what you -want when the generated code is what helps the developer fix the problem — a generator emitting an -abstract base class can report an error per missing override while still emitting the base class, so -the user can see exactly what to implement: - -```csharp -static readonly DiagnosticDescriptor MissingOverride = new( - "MYGEN001", - "Missing override", - "Type '{0}' must override '{1}'", - "Usage", - DiagnosticSeverity.Error, - isEnabledByDefault: true -); - -// IsBlocking is false, so ShouldProcess stays true and the base class is still emitted. -var diagnostic = ReportableDiagnostic.Create(MissingOverride, isBlocking: false, symbol, symbol.Name, "Execute"); - -return GeneratorResult.Create(model, diagnostic); -``` - -`isBlocking: true` stops generation for that target while still reporting. -`HasBlockingDiagnostics` reports whether any carried diagnostic blocked; -`HasErrorDiagnostics` reports the severity-based view. - -## Disabling a generator at build time - -Pass the compiler-visible disable property to the context provider; its resolved value lands in -`GenerationSettings` automatically: - -```xml - - true - -``` - -```csharp -var contextProvider = IncrementalPipeline.DefaultGenerationContextValueProvider( - context, - nameof(MyGenerator), - "1.0.0", - disablePropertyName: "MyGenerator_Disable" -); - -// In the output stage: -if (generationContext.Settings.IsSourceGeneratorDisabled) - return; -``` - -`IsDisabledValueProvider` is still there for when expensive upstream transforms must be filtered -before being combined with the generation context. - -Declare the property with `PurviewGeneratorVisibleProperty` so it is compiler-visible wherever the -generator runs — `PSGF0003` otherwise fails the build. See the `purview-sourcegenerator-packaging` -skill. - -## Scope validation - -The default context provider reads -`PurviewSourceGeneratorFrameworkValidateCodeWriterScopes` and threads it into -`GenerationSettings.ValidateCodeWriterScopes`. When enabled, `ToString()` throws -`CodeWriterScopeValidationException` if `OpenScopeCount` is not zero. - -## Test logging - -Framework logging is off in ordinary compiler runs. The testing integration enables it by registering -an isolated sink and supplying a per-run session ID through analyzer config. Context providers create -the internal logger automatically — generators implement no logging interface and no logging-support -source is generated. - -The sink registry stores **callbacks only**; it never buffers entries. With logging disabled, a -missing session ID, or no matching sink, the provider supplies no logger and log calls are discarded. -Test sinks own whatever they capture and are removed when the run completes. - -## Tracking names - -The pipeline helpers assign a tracking name to every stage, so a cache test can assert which stages -were recomputed. The `purview-sourcegenerator-testing` skill covers the stage matrix and the four -scenarios a cache test should assert. - -## Related skills - -`purview-sourcegenerator-codewriter` for emission, `purview-sourcegenerator-diagnostics` for the -`PSGFR` rules that enforce most of the above, and `purview-sourcegenerator-testing` for proving the -pipeline caches. diff --git a/.agents/skills/purview-sourcegenerator-testing/SKILL.md b/.agents/skills/purview-sourcegenerator-testing/SKILL.md deleted file mode 100644 index af56ece4..00000000 --- a/.agents/skills/purview-sourcegenerator-testing/SKILL.md +++ /dev/null @@ -1,444 +0,0 @@ ---- -name: purview-sourcegenerator-testing -description: >- - Use when writing or fixing tests for source generators, diagnostic analyzers, code fixes or - refactorings built on Purview.SourceGeneratorFramework - picking the right runner and base class, - configuring SourceGeneratorTestOptions, querying produced code with CodeQuery, testing attribute-data - models against real AttributeData with AttributeDataFactory, and asserting incremental pipeline caching - stage by stage. -metadata: - product: Purview.SourceGeneratorFramework - repository: purview-dev/sourcegenerator-framework ---- - -# Testing source generators, analyzers, code fixes and refactorings - -Use this skill whenever a task involves authoring, fixing, or modernising tests for Roslyn components -(generators, diagnostic analyzers, code fix providers, refactoring providers) built with -`Purview.SourceGeneratorFramework`. It covers the framework-agnostic test runner layer and the -`CodeQuery` syntax-lookup API. For the TUnit base classes and assertion extensions, also load the -`purview-sourcegenerator-tunit-tests` skill. - -Modernising an existing suite onto `CodeQuery` and adding a stage-by-stage cache test? The playbook -is in [references/test-modernisation.md](references/test-modernisation.md). - -## Picking the right runner - -| Roslyn type | Runner | -|---|---| -| `IIncrementalGenerator` / `ISourceGenerator` | `SourceGeneratorTestRunner` | -| `DiagnosticAnalyzer` | `DiagnosticAnalyzerTestRunner` | -| `CodeFixProvider` | `CodeFixTestRunner` (single) | -| — | `CodeFixTestRunner.RunFixAllAsync` (project-wide) | -| `CodeRefactoringProvider` | `RefactoringTestRunner` | - -TUnit projects should prefer the matching base class instead (see `purview-sourcegenerator-tunit-tests`): -`TUnitSourceGeneratorTestBase`, `TUnitDiagnosticAnalyzerTestBase`, `TUnitCodeFixTestBase`, -`TUnitRefactoringTestBase`. - -## Result types - -- `DriverRunResult` (generator) — `DriverResult`, `AllSyntaxTrees`/`PrimarySyntaxTrees`, - `CompilationResult.Compilation`, `GetGeneratedTree`, `GetSource`, `GetTypeByMetadataName`, `LogEntries`. -- `AnalyzerTestResult` — `Diagnostics`, `Compilation`. -- `CodeFixTestResult` — `Diagnostics`, `CodeActions`, `FixedSource`, `Compilation`, `ChangedSolution`. -- `CodeFixFixAllResult` — `Diagnostics`, `CodeActions`, `FixedSources`, `ChangedSolution`. -- `RefactorTestResult` — `CodeActions`, `FixedSources`, `ChangedSolution`, `Compilation`. - -Use `DriverRunResultExtensions` (`AssertNoCompilationErrors`, `AssertNoGenerationExceptions`, -`AssertSingleGeneratedSource`, `AssertGeneratedSourceContains`, …) for quick checks, but prefer -`CodeQuery` for structural assertions. - -## Querying produced code with `CodeQuery` - -Every result exposes a `CodeQuery` via extensions in `CodeQueryResultExtensions`: - -```csharp -result.Generated() // DriverRunResult: generated trees (default, generated-first) -result.Output() // DriverRunResult: entire output compilation (user + generated) -analyzerResult.Code() // AnalyzerTestResult: input compilation -codeFixResult.Code() // CodeFixTestResult: input compilation -codeFixResult.FixedCode() // CodeFixTestResult: parsed fixed source (or post-fix solution) -fixAllResult.FixedCode() // CodeFixFixAllResult: post-fix documents -refactorResult.FixedCode() // RefactorTestResult: post-refactor documents -``` - -Every `Get` has an accompanying `Has` (bool) and `TryGet` (out): `GetMethod`/`HasMethod`/`TryGetMethod`, -`GetClass`, `GetStruct`, `GetInterface`, `GetEnum`, `GetDelegate`, `GetRecord`, `GetProperty`, -`GetField`, `GetConstructor`, `GetNamespace`, `GetTypeDeclaration`, plus generic `Get`/`Has` -and `GetSyntaxTree`/`HasSyntaxTree`. `Get` throws `SyntaxNotFoundException` when nothing matches. - -Type lookups accept an optional generic arity — `GetClass(name, arity)` / `HasClass(name, arity)` — and the -`TypeReference`/`TypeIdentity` overloads match arity automatically from the identity, so -`new TypeIdentity("ResourceDefinition", ns, arity: 1)` finds `ResourceDefinition` without matching the -non-generic `ResourceDefinition`. - -Every `Get` returns a `CodeQueryResult` — the matched syntax node (`Node`) plus a query scoped to it -(`Query`), with implicit conversions to both the node and the scoped query. Use `.Node` for direct syntax -access, or chain member queries (the originating query is carried by the result, so it is not passed again). - -Types can be matched against `TypeReference`/`TypeIdentity`, resolved through the compilation's semantic -model (nullable value types are significant, so `int?` never matches `int`): - -```csharp -result.Generated().HasMethod("DoWork", TypeReference.Create(), TypeReference.Create().Nullable(), complexType); -result.Generated().HasReturnType("Compute", TypeReference.Create()); -result.Generated().GetMethod("Format").HasParameters(TypeReference.Create(), objectReference); -``` - -When a test expects a nullable annotation, prefer the test-only `query.MakeNullable(type)` extension (on a -`CodeQuery`, accepting a `TypeReference` or `TypeIdentity`). It resolves the annotation against the query's -compilation and, unlike `TypeReference.Nullable()`/`TypeIdentity.MakeNullable()`, does not trigger the -`PSGFR16` context-overload warning (tests have no generation context to pass). - -Member chaining from a type declaration (`MemberQueryExtensions`): - -```csharp -var service = result.Generated().GetClass("ServiceCollectionExtensions"); // or GetClass(name, "Namespace") -service.HasProperty("Count", intType); -service.HasIndexer(stringType, intType); -service.HasMethod("Add", intType, complexType); -service.HasMethodReturnType("Add", stringType); -service.HasConstructor(stringType); -service.HasAttribute("SomeAttribute"); -``` - -Node-inspection checks on scoped results: - -```csharp -result.Generated().GetClass("Service").HasAccessibility(Accessibility.Public); // resolves C# defaults -result.Generated().GetClass("Service").GetProperty("Name").HasSetterAccessibility(Accessibility.Private); -result.Generated().GetClass("ResourceDefinition", 1).HasGenericTypeParameters("TResourceType"); -result.Generated().GetClass("ResourceDefinition", 1).HasBaseType(new TypeIdentity("ResourceDefinition", ns)); -result.Generated().GetClass("Service").HasNestedType("Builder"); // GetNestedType(...) to fetch -result.Generated().GetClass("Service").IsInNamespace("Example.Models"); // IsInGlobalNamespace() for no namespace -result.Generated().IsInNamespace(cls.Node, "Example.Models"); // or on the query directly -``` - -## Configuring options and a reusable starting point - -`SourceGeneratorTestOptions` is the base record. Common knobs: - -- `AdditionalNamespaces` / `IncludeDefaultNamespaces` — namespaces prepended to test source. -- `AdditionalAssemblyTypes` / `AdditionalReferences` — assemblies referenced by the test compilation - (use `AdditionalAssemblyTypes = [typeof(SomeType)]` to pull in a whole assembly). -- `AdditionalSources` — extra source files added to every run. -- `AnalyzerConfigOptions` — `build_property.*` values; keys without the prefix are also exposed as MSBuild - properties. -- `DisableSourceGeneratorPropertyName` / `DisableSourceGeneratorValue` — generator disable toggle. -- `NullableContextOptions`, `OutputKind`, `LanguageVersion`, `CompileToAssembly`. -- `ValidateCodeWriterScopes`, `EnableLogging`. -- `ExcludeGeneratedSourceHintNames` — hides generated marker trees from `PrimarySyntaxTrees`. - -**Easy starting point recipe.** Derive an options record that seeds the namespaces and assemblies your -generator needs, so every test gets a working compilation with no boilerplate: - -```csharp -public sealed record MyGeneratorTestOptions : SourceGeneratorTestOptions -{ - public MyGeneratorTestOptions() - { - AdditionalNamespaces = AdditionalNamespaces.Add("My.Namespace"); - AdditionalAssemblyTypes = AdditionalAssemblyTypes.AddRange( - typeof(SomeDependencyType), - typeof(TypeIdentity) // the framework's Shared assembly, when needed - ); - DisableSourceGeneratorPropertyName = PropertyLibrary.DisableMyGenerator; - } -} -``` - -`Compile()` returns a copy with `CompileToAssembly = true`, preserving the derived options type. Use the -base class hooks `OnBeforeRun`/`OnBeforeRunAsync`/`OnAfterRun` to mutate sources/options per run (for -example to append a marker attribute source via `WithAdditionalSources`). - -When `CompileToAssembly` is enabled, emission is fully in-memory. On .NET 8+ the assembly loads into a -collectible `AssemblyLoadContext`, so the result is `IDisposable` — `using var result = ...` unloads it and -keeps repeated runs from polluting the default context. `result.CompilationResult.Assembly` is the runnable -assembly (generated code can execute); `result.CompilationResult.Metadata` / `.MetadataAssembly` give a -metadata-only reflection view (types, members, attributes) over the emitted assembly without executing code. - -**Always write `using var result = ...`.** `PSGFR42` ("Dispose test harness results with a using -declaration") flags a `DriverRunResult` that is produced and never disposed — including the indirect case -where a helper creates a result, projects a value out of it and returns only the projection. It is a -`warning` when the run syntactically compiles to an assembly (`.Compile()`, a `Compile` options member, or -`CompileToAssembly = true`) and `info` otherwise; the `DisposeTestResultCodeFixProvider` fix inserts the -`using`. A result that is returned to the caller, or disposed explicitly, is not flagged. Neither is awaiting -an assertion, nor calling a helper that is handed the result — an extension on it, or a method taking it as a -parameter: both hand the same instance back, so `await Assert.That(result).SomeAssertion()` and -`result.AssertNoGenerationExceptions()` are not flagged. - -## Testing attribute applications and attribute-data models - -A generator that reads attributes has two halves to test: what Roslyn gives it for an application, and what -its parsing (usually a generated attribute-data model) makes of that. `AttributeDataFactory` produces the -real `AttributeData` without running a generator; `AttributeArguments` describes it. - -```csharp -var options = new MyTestOptions { AdditionalNamespaces = ["My.Attributes"] }; - -// One application. Placed on a class, or on the first declaration its AttributeUsage allows. -AttributeData attribute = AttributeDataFactory.FromUsage("[Log(\"text\", eventId: 7, Name = \"N\")]", options); - -// Every application on a type, or on one of its members. -var onMember = AttributeDataFactory.FromSource(source, "Sample.IEvents", "Raised", options); - -var arguments = AttributeArguments.From(attribute); -arguments.TryGetConstructorArgument(0, out var byOrdinal); // #0 message: "text" -arguments.TryGetConstructorArgument("eventId", out var byName); // Form = NamedParameter -arguments.TryGetNamedArgument("Name", out var named); // Form = NamedArgument -arguments.ToString(); // [LogAttribute(#0 message: "text", #1 eventId: 7 (by name), Name = "N")] - -var model = LogAttributeData.FromAttributeData(attribute); -``` - -- References and usings come from the options: `AdditionalAssemblyTypes` for the assembly declaring the - attribute, `AdditionalNamespaces` for its namespace, or declare the attribute in `AdditionalSources`. -- A compilation error throws `InvalidOperationException` listing the errors, so a misspelt parameter name - fails the test rather than producing an application with a missing argument. -- `AttributeArgumentForm` tells `Positional`, `NamedParameter` (`message: "x"`), `Defaulted` (an optional - parameter that was not written) and `NamedArgument` (`Name = "x"`) apart, which `AttributeData` alone - cannot. -- `AttributeArgument.ValueEquals` compares numbers across types, enums by value or member name, `typeof` - by `Type`/`TypeIdentity`/name, and arrays element-wise. Names are case-sensitive, as generated models are. -- The TUnit assertions over these (`HasConstructorArgument`, `HasNamedArgument`, …) are in - `purview-sourcegenerator-tunit-tests`; what to cover for a model is in - `purview-sourcegenerator-attribute-data-models`. - -## Best practices - -- **Test attribute parsing against real `AttributeData`** (`AttributeDataFactory`), not only by asserting - on emitted parsing code: emitted code can look right and still read the wrong name. -- **Deterministic output**: `WriteAutoGeneratedHeader` is timestamp-free; assert with - `ContainsGeneratedCode`/`GeneratesCode` (whitespace-flattened) or `CodeQuery`, never with timestamps. -- **Generator references**: to use a generated type in the test project AND pass the generator type to a - runner, reference the generator project twice — once `OutputItemType="Analyzer"` and once as a normal - reference. -- **Multi-target**: build generators against the Roslyn version that supports the test matrix; the - framework is built against Roslyn 5.9 (`net10.0`/`netstandard2.0` assets keep a .NET 10–11 matrix - loading); keep `System.Collections.Immutable` version pinned to the shared one. -- **Scope validation**: keep `PurviewSourceGeneratorFrameworkValidateCodeWriterScopes` enabled; it makes - undisposed `CodeWriter` scopes fail tests. -- **Prefer `CodeQuery` over string matching** for structural assertions (members, signatures, namespaces). -- **Dispose results**: `using var result = ...`, enforced by `PSGFR42`. -- **Cap parallelism**: the harness shares one `MetadataReference` set per process, so memory is largely flat - in the degree of parallelism, but the platform's auto-detected default is both slower and heavier than an - explicit ceiling. Wall clock saturates around four concurrent tests; prefer - `--maximum-parallel-tests 8` (or a `TestingPlatformCommandLineArguments` equivalent) for a project that - multi-targets and runs several TFM executables at once. - -## Incremental cache testing (`RunIncrementalAsync`) - -To prove the pipeline caches correctly stage-by-stage, use `SourceGeneratorTestRunner.RunIncrementalAsync` -(or `GenerateIncrementalAsync` on the TUnit base). It runs a sequence of source sets over a **single shared -`GeneratorDriver`** and captures each run's `TrackedSteps`, keyed by tracking name. The canonical reference -implementation is `IncrementalPipelineCacheTests` in `SourceGeneratorShared.UnitTests`; the end-to-end -generator variant is `ServiceRegistrationCacheTests` in -`SourceGeneratorFramework.ExampleGenerator.UnitTests`. Copy the pattern into your own test project — do -not expect the source repo's files locally. - -### What is being asserted and why - -Roslyn reports one `IncrementalStepRunReason` per step output on each run: - -- `New` — the step ran for the first time. -- `Modified` — the step ran and produced a different value than the previous run. -- `Unchanged` — the step ran but produced the same value. -- `Cached` — the step was skipped and its previous result reused from the incremental cache. - -A pipeline is "caching correctly" when an unchanged input keeps every stage `Cached`/`Unchanged`, and a -targeted change marks **only** the stages whose inputs actually changed `Modified` while unrelated stages -stay `Cached`. If a generator accidentally leaks `Compilation`, `SemanticModel`, `ISymbol`, -`SyntaxNode`, or `Location` into a pipeline model, unrelated stages will report `Modified`/`New` on rerun — -these tests fail the build and catch the regression. - -### The four scenarios every cache test should cover - -1. **First run → all `New`.** Nothing can be cached on the first run; this confirms every stage is tracked - under the expected name. -2. **Identical rerun → all `Cached`/`Unchanged`.** `RunIncrementalAsync(sources, ...)` runs the same source - set twice for exactly this case. This is the strongest "it caches" proof. -3. **Source-only change → only the source/attribute stage `Modified`.** Changing an attributed class must - mark `ForAttribute_*` (and downstream output) `Modified` while property/config stages stay `Cached`. -4. **Property-only change → only the property/configuration stage `Modified`.** Toggling an MSBuild - property (via `IncrementalRunInput.AnalyzerConfig`) must mark `GetMSBuildPropertyValue_*` / - `GetGenerationConfiguration` / `GetGenerationContext_*` `Modified` while `ForAttribute_*` stays `Cached`. - -### How the runner makes this possible - -`RunIncrementalAsync` creates **one** driver, enables incremental step tracking, and **reuses the same -`Compilation` instance for identical source sets** (keyed by prepared source text). Without that reuse, -Roslyn would see a fresh compilation on the second run and report stages `Modified`/`New` even though the -sources are byte-identical — the "cached" assertion would fail. - -### Log entries per run - -`IncrementalCacheRun.LogEntries` carries the framework log entries that run wrote, in order. The sink is -registered for the whole sequence and drained between runs, so entries never accumulate. A rerun whose -output step is cached logs nothing, which makes it a second signal alongside the step reasons: - -```csharp -await Assert.That(result.Runs[0].LogEntries).IsNotEmpty(); -await Assert.That(result.Runs[1].LogEntries).IsEmpty(); -``` - -`DriverRunResult.LogEntries` (the `RunAsync` path) is likewise in write order. Both are empty when -`EnableLogging` is disabled. - -### The `StepReasons` helper - -`IncrementalCacheRun.Steps` is `ImmutableDictionary>` -keyed by tracking name. Flatten each step's `Outputs` into the reasons list so assertions read cleanly: - -```csharp -static ImmutableDictionary> StepReasons(IncrementalCacheRun run) -{ - var builder = ImmutableDictionary.CreateBuilder>(); - foreach (var pair in run.Steps) - builder[pair.Key] = [.. pair.Value.SelectMany(step => step.Outputs.Select(static output => output.Reason))]; - return builder.ToImmutable(); -} -``` - -### Framework pipeline stage names - -- `GetMSBuildPropertyValue_{Property}` — `IncrementalPipeline.PropertyValueProvider`. -- `GetGenerationConfiguration` — `IncrementalPipeline.GenerationContextValueProvider`. -- `GetGenerationContext_{Capabilities}` — e.g. `GetGenerationContext_EmptyCapabilities`. -- `ForAttribute_{AttributeType}` — `IncrementalPipeline.ForAttributeWithMetadataName`. - -The framework reference (`IncrementalPipelineCacheTests`, framework-agnostic runner) shows all four -scenarios against `TestGenerator`/`DiagnosticTestGenerator`: - -```csharp -using System.Collections.Immutable; -using Purview.SourceGeneratorFramework.TestGenerators; -using StepReason = Microsoft.CodeAnalysis.IncrementalStepRunReason; - -public class IncrementalPipelineCacheTests -{ - const string AttributedSource = """ - [TestAttribute] - public partial class MyClass { } - """; - const string ChangedAttributedSource = """ - [TestAttribute] - public partial class AnotherClass { } - """; - const string TestAttributeSource = """ - [System.AttributeUsage(System.AttributeTargets.Class)] - public sealed class TestAttribute : System.Attribute { } - """; - - static SourceGeneratorTestOptions CreateOptions() => - new SourceGeneratorTestOptions() - .WithAdditionalSources(TestAttributeSource) - .WithExcludeGeneratedSourceHintNames("TestAttribute"); - - static ImmutableDictionary> StepReasons(IncrementalCacheRun run) { /* as above */ } - - [Test] - public async Task FirstRun_AllStagesAreNew(CancellationToken cancellationToken) - { - var result = await new SourceGeneratorTestRunner().RunIncrementalAsync( - [new IncrementalRunInput([AttributedSource])], - CreateOptions(), - cancellationToken); - - var reasons = StepReasons(result.Runs[0]); - await Assert.That(reasons).IsNotEmpty(); - await Assert.That(reasons.Values.SelectMany(r => r).All(r => r == StepReason.New)).IsTrue(); - } - - [Test] - public async Task IdenticalRerun_AllStagesCached(CancellationToken cancellationToken) - { - var result = await new SourceGeneratorTestRunner() - .RunIncrementalAsync([AttributedSource], CreateOptions(), cancellationToken); - - var second = StepReasons(result.Runs[1]); - await Assert.That(second.Values.SelectMany(r => r).All(r => r is StepReason.Cached or StepReason.Unchanged)).IsTrue(); - } - - [Test] - public async Task SourceChange_MarksAttributeStageModified_PropertyStagesStayCached(CancellationToken cancellationToken) - { - var result = await new SourceGeneratorTestRunner().RunIncrementalAsync( - [new IncrementalRunInput([AttributedSource]), new IncrementalRunInput([ChangedAttributedSource])], - CreateOptions(), - cancellationToken); - - var second = StepReasons(result.Runs[1]); - await Assert.That(second["ForAttribute_TestAttribute"]).Contains(StepReason.Modified); - await Assert.That(second["GetMSBuildPropertyValue_DisableTestGenerator"].All(r => r == StepReason.Cached)).IsTrue(); - } - - [Test] - public async Task PropertyChange_MarksPropertyStageModified_AttributeStageStaysCached(CancellationToken cancellationToken) - { - var result = await new SourceGeneratorTestRunner().RunIncrementalAsync( - [ - new IncrementalRunInput([AttributedSource]), - new IncrementalRunInput([AttributedSource], [("build_property.DisableTestGenerator", "true")]), - ], - CreateOptions(), - cancellationToken); - - var second = StepReasons(result.Runs[1]); - await Assert.That(second["GetMSBuildPropertyValue_DisableTestGenerator"]).Contains(StepReason.Modified); - await Assert.That(second["ForAttribute_TestAttribute"].All(r => r == StepReason.Cached)).IsTrue(); - } -} -``` - -### End-to-end generator variant (`GenerateIncrementalAsync`) - -TUnit tests derive from the base class and call `GenerateIncrementalAsync` (which wires the -`OnBeforeRun`/`OnBeforeRunAsync` hooks and the derived options). `ServiceRegistrationCacheTests` in -`SourceGeneratorFramework.ExampleGenerator.UnitTests` is the reference: - -```csharp -public class ServiceRegistrationCacheTests - : TUnitSourceGeneratorTestBase -{ - const string Source = """ - namespace Test; - - [GenerateService] - public class MyService { } - """; - - [Test] - public async Task IdenticalRerun_AllStagesCached(CancellationToken cancellationToken) - { - var result = await GenerateIncrementalAsync([Source], cancellationToken: cancellationToken); - - var second = StepReasons(result.Runs[1]); - string[] frameworkStages = - [ - "GetMSBuildPropertyValue_EmitServiceRegistrationInfo", - "GetGenerationConfiguration", - "GetGenerationContext_EmptyCapabilities", - "ForAttribute_GenerateServiceAttribute", - ]; - await Assert.That( - frameworkStages.All(stage => - second.TryGetValue(stage, out var reasons) - && reasons.All(r => r is StepReason.Cached or StepReason.Unchanged))).IsTrue(); - } -} -``` - -**Why the example filters to `frameworkStages`:** `ServiceRegistrationGenerator` emits its own -`GenerateServiceAttribute` via post-initialization output, which is regenerated as a new `SyntaxTree` each -run. That makes Roslyn's *internal* `ForAttributeWithMetadataName` `Compilation` step legitimately report -`Modified` on an identical rerun. Asserting on the framework-named stages (which stay `Cached`/`Unchanged`) -is the meaningful check. If your generator does not depend on its own post-init output, the stricter -"every tracked step is `Cached`/`Unchanged`" assertion (as in the framework `IncrementalPipelineCacheTests`) -is correct. - -Per-run MSBuild-property changes are supplied with `new IncrementalRunInput(sources, [("build_property.X", "value")])`. - -## License - -This project is licensed under the MIT license. \ No newline at end of file diff --git a/.agents/skills/purview-sourcegenerator-testing/references/test-modernisation.md b/.agents/skills/purview-sourcegenerator-testing/references/test-modernisation.md deleted file mode 100644 index 6db47803..00000000 --- a/.agents/skills/purview-sourcegenerator-testing/references/test-modernisation.md +++ /dev/null @@ -1,63 +0,0 @@ -# Modernising a Roslyn test suite - -A playbook for moving an existing test suite onto `CodeQuery` plus the TUnit assertion extensions, -and adding a stage-by-stage incremental cache test. - -## Before you start, collect - -- The test file(s) being changed. -- The Roslyn component under test — generator, analyzer, code fix or refactor (infer it from the - base class if the task does not say). -- The component's type name. - -## Requirements - -### 1. The right base class and method - -| Component | Base class | Method | -| --- | --- | --- | -| Generator | `TUnitSourceGeneratorTestBase` | `GenerateAsync` | -| Analyzer | `TUnitDiagnosticAnalyzerTestBase` | `AnalyzeAsync` | -| Code fix | `TUnitCodeFixTestBase` | `ApplyCodeFixAsync` / `ApplyFixAllAsync` | -| Refactor | `TUnitRefactoringTestBase` | `RefactorAsync` | - -### 2. `CodeQuery` instead of string matching - -Replace `GetGeneratedTree(...)` + `string.Contains(...)` with `CodeQuery` -(`result.Generated().Get/Has/TryGet…`) and the terminal assertion extensions — -`await Assert.That(result).HasGeneratedMethod/Class/Property/Field/SyntaxTree(…)` — which return the -node so a follow-up assertion has something to work with. - -### 3. `TypeReference` instead of signature strings - -Match parameter and return types structurally. A signature string breaks on a whitespace or -nullability change that means nothing. - -### 4. Options in one place - -Derive a `SourceGeneratorTestOptions` record that seeds the required namespaces and additional -assemblies, and remove the per-test duplication it replaces. - -### 5. A stage-by-stage cache test - -Use `RunIncrementalAsync`, or `GenerateIncrementalAsync` on the TUnit base, and assert the four -scenarios. `ServiceRegistrationCacheTests` and `IncrementalPipelineCacheTests` are the reference -pattern. - -| Scenario | Expected | -| --- | --- | -| First run | every framework stage `New` | -| Identical rerun (`RunIncrementalAsync(sources, …)` runs the same source twice) | framework stages `Cached`/`Unchanged` | -| Source-only change | `ForAttribute_*` `Modified`; property/config stages stay `Cached` | -| Property-only change (`new IncrementalRunInput(sources, [("build_property.X", "value")])`) | `GetMSBuildPropertyValue_*`, `GetGenerationConfiguration`, `GetGenerationContext_*` `Modified`; `ForAttribute_*` stays `Cached` | - -Use the `StepReasons(IncrementalCacheRun)` flattening helper. If the generator depends on its own -post-init output, assert on the framework-named stages rather than on every tracked step. - -### 6. Minimal change - -Keep behaviour equivalent, and do not reformat unrelated tests. - -## Verification - -Build the test project and run its suite before finishing. diff --git a/.agents/skills/purview-sourcegenerator-tunit-tests/SKILL.md b/.agents/skills/purview-sourcegenerator-tunit-tests/SKILL.md deleted file mode 100644 index 2a3a0612..00000000 --- a/.agents/skills/purview-sourcegenerator-tunit-tests/SKILL.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -name: purview-sourcegenerator-tunit-tests -description: >- - Use when writing TUnit tests for source generators, diagnostic analyzers, code fixes or - refactorings built on Purview.SourceGeneratorFramework - choosing the correct TUnit base class and - method, customising SourceGeneratorTestOptions, using the TUnit assertion extensions (including - attribute-argument assertions for testing attribute-data models), and - modernising existing tests. -metadata: - product: Purview.SourceGeneratorFramework.Testing.TUnit - repository: purview-dev/sourcegenerator-framework ---- - -# TUnit test authoring for Roslyn components - -Use this skill whenever a task involves authoring, fixing, or modernising **TUnit** tests for Roslyn -components built with `Purview.SourceGeneratorFramework`. It tells you which base class to derive from, -which method to call, how to customise options with an easy starting point, and how to use the TUnit -assertion extensions. For the framework-agnostic runner layer and the `CodeQuery` API, also load the -`purview-sourcegenerator-testing` skill. - -## Base class → method matrix - -| Roslyn type | Base class | Method to call | -|---|---|---| -| `IIncrementalGenerator` / `ISourceGenerator` | `TUnitSourceGeneratorTestBase` | `GenerateAsync(source, options, ct)` | -| `DiagnosticAnalyzer` | `TUnitDiagnosticAnalyzerTestBase` | `AnalyzeAsync(source, options, ct)` | -| `CodeFixProvider` (single fix) | `TUnitCodeFixTestBase` | `ApplyCodeFixAsync(source, options, ct)` | -| `CodeFixProvider` (fix-all) | `TUnitCodeFixTestBase` | `ApplyFixAllAsync(sources, options, ct)` | -| `CodeRefactoringProvider` | `TUnitRefactoringTestBase` | `RefactorAsync(source, options, ct)` | - -For cache tests, `TUnitSourceGeneratorTestBase` also exposes `GenerateIncrementalAsync(...)`. - -Framework-agnostic equivalents (no TUnit): `SourceGeneratorTestRunner`, `DiagnosticAnalyzerTestRunner`, -`CodeFixTestRunner`, `RefactoringTestRunner`. - -## Easy starting point: derive your options record - -Create a test-options record that seeds the namespaces and assemblies your component needs, then pass it -to every test via `new MyTestOptions()`: - -```csharp -public sealed record MyGeneratorTestOptions : SourceGeneratorTestOptions -{ - public MyGeneratorTestOptions() - { - AdditionalNamespaces = AdditionalNamespaces.Add("My.Namespace"); - AdditionalAssemblyTypes = AdditionalAssemblyTypes.AddRange( - typeof(SomeDependencyType), - typeof(TypeIdentity) // framework Shared assembly, when needed - ); - DisableSourceGeneratorPropertyName = "DisableMyGenerator"; - } -} - -public class MyGeneratorTests : TUnitSourceGeneratorTestBase -{ - [Test] - public async Task GeneratesExpectedSource(CancellationToken ct) => - await GenerateAsync("...source...", ct); -} -``` - -Use the base hooks to customise per-run: `OnBeforeRun`/`OnBeforeRunAsync` (mutate sources/options, e.g. -`options.WithAdditionalSources(markerAttributeSource)`) and `OnAfterRun`/`OnAfterRunAsync`. Use -`options.Compile()` to opt into `CompileToAssembly` while preserving the derived options type. - -Write `using var result = await GenerateAsync(...)`: `DriverRunResult` is `IDisposable`, and `PSGFR42` -flags a result that is produced and never disposed (a `warning` once the run compiles to an assembly, -`info` otherwise). It also catches the indirect case — a helper that creates a result, projects a value out -of it and returns only the projection. Awaiting an assertion, or calling a helper that is handed the result — -an extension on it, or a method taking it as a parameter — is not a production: both hand the same instance -back, so neither is flagged. - -For code fixes/refactorings, select a specific registered action via `CodeFixTestOptions.EquivalenceKey` -or `CodeActionIndex`, and `RefactorTestOptions.Span`/`NodeSelector` (e.g. -`NodeSelector = query => query.GetMethod("M")`). - -## TUnit assertion extensions - -All assertion extensions live under `Purview.SourceGeneratorFramework.Testing.TUnit.Assertions` -(globally imported by the package's props). `Assert.That(...)` calls are terminal and **return the value** -when awaited. - -- **`CodeQueryAssertions`** — return `CodeQueryResult` (the matched node via `.Node`, plus a query - scoped to it via `.Query`): `HasGeneratedMethod` (optionally with `TypeReference[]` parameter types), - `HasGeneratedMethodReturnType`, `HasGeneratedClass` (by name or `TypeReference`/`TypeIdentity` identity), - `HasGeneratedProperty`, `HasGeneratedField`, `HasGeneratedSyntaxTree`; `HasFixedMethod` for code-fix and - refactor results. The assertions operate on a `CodeQuery` directly, so pass any query — `result.Generated()` - (generated trees), `result.Output()` (whole compilation), or `result.FixedCode()` — or use the convenience - overloads on the test result types, which query the relevant code for you. -- **Scoped member chaining** — `HasPropertyOfType(name, type)`, `HasFieldOfType(name, type)`, - `HasMethodOfType(name, TypeReference[])`, `HasConstructorOfType(TypeReference[])`, and - `HasAttributeOfType(name)` chain from a scoped `CodeQueryResult` (e.g. the result of `HasGeneratedClass`) - and return the matched member. They are named to avoid colliding with the bool `Has*` predicates in - `MemberQueryExtensions`. -- **Fluent `.And` chains** — the node-producing assertions (`HasGeneratedClass`, `HasPropertyOfType`, - `HasMethodOfType`, `HasNestedType`) move the chain onto the matched node, so further assertions can be - appended with `.And`. Node-inspection assertions — `WithAccessibility`, `WithGetterAccessibility`, - `WithSetterAccessibility`, `WithBaseType`, `WithGenericTypeParameter(s)`, `IsInNamespace`, - `IsInGlobalNamespace` — keep the node on the chain: - ```csharp - var method = await Assert.That(query) - .HasGeneratedClass("Service") - .And.HasNestedType("Builder") - .And.WithAccessibility(Accessibility.Private) - .And.HasMethodOfType("Build", []); - ``` - Generic types are matched by arity — `HasGeneratedClass(name, arity)` or a `TypeIdentity` with arity — - so `new TypeIdentity("ResourceDefinition", ns, arity: 1)` finds `ResourceDefinition` - without matching the non-generic `ResourceDefinition`. -- **Nullable expected types in tests** — use the test-only `query.MakeNullable(type)` extension (on a - `CodeQuery`). It resolves the annotation against the query's compilation and, unlike - `TypeReference.Nullable()`/`TypeIdentity.MakeNullable()`, does not trip the `PSGFR16` context-overload - suggestion, since tests have no generation context to pass. - ```csharp - CodeQueryResult method = await Assert.That(result.Generated()).HasGeneratedMethod("DoWork", [intType, nullableInt]); - CodeQueryResult cls = await Assert.That(result.Generated()).HasGeneratedClass("Service"); - await Assert.That(cls.HasProperty("Count", intType)).IsTrue(); // chained member query - await Assert.That(cls.Node.Identifier.ValueText).IsEqualTo("Service"); // direct syntax access - await Assert.That(result.FixedCode()).HasFixedMethod("DoWork"); // code-fix / refactor results - - var query = result.Generated(); - var attributeClass = await Assert.That(query).HasGeneratedClass(hostKitAttribute); - await Assert.That(attributeClass).HasPropertyOfType("Name", query.MakeNullable(TypeLibrary.System.String)); - ``` -- **`DiagnosticAssertions`** — `HasDiagnostic(descriptor|id)`, `HasDiagnostics(count)`, - `DoesNotHaveDiagnostic`, `HasNoDiagnostics`, `HasNoErrorDiagnostics` on generator/analyzer/code-fix results. -- **`AttributeDataAssertions`** — on an `AttributeData` (typically from `AttributeDataFactory`): - `HasConstructorArgument(ordinal, expected)`, `HasConstructorArgument(parameterName, expected[, form])`, - `DoesNotHaveConstructorArgument(parameterName)` (defaulted or absent), `HasNamedArgument(name, expected)`, - `DoesNotHaveNamedArgument(name)`. Each returns the matched `AttributeArgument`, and a failure lists every - argument of the application with how it was supplied. Pin the attribute side with these before asserting - on the model, so a failure says which half is wrong: - ```csharp - var attribute = AttributeDataFactory.FromUsage("[Info(\"custom {Value}\")]", options); - - await Assert.That(attribute).HasConstructorArgument("messageTemplate", "custom {Value}"); - await Assert.That(attribute).HasConstructorArgument("eventId", -1, AttributeArgumentForm.Defaulted); - await Assert.That(attribute).DoesNotHaveNamedArgument("Name"); - - await Assert.That(InfoAttributeData.FromAttributeData(attribute).Log.MessageTemplate).IsEqualTo("custom {Value}"); - ``` -- **`TypeIdentityAssertions`** — `HasSymbol(TypeIdentity)` / `HasSymbol("Namespace.Type")`. -- **`GeneratedCodeAssertionsExtensions`** — `GeneratesCode(expected)`, `ContainsGeneratedCode(expected)` - (whitespace-flattened string comparison). - -For structural assertions (members, signatures, namespaces) prefer `result.Generated()` + -`Get/Has/TryGet` from `CodeQuery` (see `purview-sourcegenerator-testing`). - -## Incremental cache tests (`GenerateIncrementalAsync`) - -`TUnitSourceGeneratorTestBase` exposes `GenerateIncrementalAsync`, which mirrors `RunIncrementalAsync` but -also wires the base class hooks (`OnBeforeRun`/`OnBeforeRunAsync`) and your derived options record. Use it to -prove the pipeline caches stage-by-stage. The reference is `ServiceRegistrationCacheTests` in -`SourceGeneratorFramework.ExampleGenerator.UnitTests`; the framework-agnostic twin with a full walkthrough is -in the `purview-sourcegenerator-testing` skill. - -Why the tests look the way they do: - -- `GenerateIncrementalAsync([Source])` runs the **same source twice** on a single shared driver. The first - run reports every stage `New`; the second must report `Cached`/`Unchanged` for unchanged stages — that is - the core "it caches" proof. -- `GenerateIncrementalAsync([new IncrementalRunInput([Source]), new IncrementalRunInput([changed])])` runs two - **different** source sets, so a source-only change must mark `ForAttribute_*` `Modified` while - property/configuration stages stay `Cached`. -- `new IncrementalRunInput([Source], [("build_property.X", "value")])` toggles an MSBuild property for one - run only, so a property-only change must mark `GetMSBuildPropertyValue_*`/`GetGenerationConfiguration`/ - `GetGenerationContext_*` `Modified` while `ForAttribute_*` stays `Cached`. -- `result.Runs[n].LogEntries` carries the framework log entries *that run* wrote, in order, so a rerun whose - output step is cached can be asserted to have logged nothing. Empty when `EnableLogging` is disabled. -- The `StepReasons(IncrementalCacheRun)` helper flattens each tracked step's `Outputs` into a - `ImmutableDictionary>` so assertions can address a stage - by name (see `purview-sourcegenerator-testing` for the helper body). -- If the generator's pipeline depends on its own post-initialization output (a self-referencing generated - attribute), Roslyn's internal `ForAttributeWithMetadataName` `Compilation` step is legitimately `Modified` - on rerun; assert on the framework-named stages (e.g. `ForAttribute_GenerateServiceAttribute`, - `GetGenerationConfiguration`, `GetGenerationContext_EmptyCapabilities`) rather than every tracked step. - -```csharp -public class ServiceRegistrationCacheTests - : TUnitSourceGeneratorTestBase -{ - const string Source = """ - namespace Test; - - [GenerateService] - public class MyService { } - """; - - [Test] - public async Task IdenticalRerun_AllStagesCached(CancellationToken cancellationToken) - { - var result = await GenerateIncrementalAsync([Source], cancellationToken: cancellationToken); - - var second = StepReasons(result.Runs[1]); - string[] frameworkStages = - [ - "GetMSBuildPropertyValue_EmitServiceRegistrationInfo", - "GetGenerationConfiguration", - "GetGenerationContext_EmptyCapabilities", - "ForAttribute_GenerateServiceAttribute", - ]; - await Assert.That( - frameworkStages.All(stage => - second.TryGetValue(stage, out var reasons) - && reasons.All(r => r is StepReason.Cached or StepReason.Unchanged))).IsTrue(); - } - - [Test] - public async Task PropertyChange_MarksPropertyStageModified_AttributeStageStaysCached(CancellationToken cancellationToken) - { - var result = await GenerateIncrementalAsync( - [ - new IncrementalRunInput([Source]), - new IncrementalRunInput([Source], [(PropertyLibrary.EmitServiceRegistrationInfo, "true")]), - ], - cancellationToken: cancellationToken); - - var second = StepReasons(result.Runs[1]); - await Assert.That(second["GetMSBuildPropertyValue_EmitServiceRegistrationInfo"]).Contains(StepReason.Modified); - await Assert.That(second["ForAttribute_GenerateServiceAttribute"].All(r => r is StepReason.Cached or StepReason.Unchanged)).IsTrue(); - } -} -``` - -Use `using StepReason = Microsoft.CodeAnalysis.IncrementalStepRunReason;` and your own stage names. - -## Modernising existing tests - -When converting legacy tests that do `result.GetGeneratedTree(...)` + `string.Contains(...)`: - -1. Replace tree-lookup + string matching with `result.Generated().GetClass/GetMethod/GetProperty(...)` and - the `Has*`/`TryGet*` family. -2. Replace signature string checks with `TypeReference` parameter/return-type matching. -3. Replace `Assert.That(text).Contains("...")` with the terminal assertion extensions that return nodes. -4. Verify options use a derived record (namespaces + assemblies) rather than repeating `AdditionalNamespaces` - per test. -5. Add a stage-by-stage cache test if the component has an incremental pipeline — first run `New`, - identical rerun `Cached`/`Unchanged`, and targeted changes mark only the affected stage `Modified`. - Use the inlined examples in this skill and in `purview-sourcegenerator-testing`'s "Incremental cache testing" - section, swapping in your own generator and stage names. - -## License - -This project is licensed under the MIT license. \ No newline at end of file diff --git a/.agents/skills/purview-telemetry/SKILL.md b/.agents/skills/purview-telemetry/SKILL.md deleted file mode 100644 index d2f42d78..00000000 --- a/.agents/skills/purview-telemetry/SKILL.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -name: purview-telemetry -description: >- - Use when adding, reviewing or scaling observability in a .NET project — logging, tracing, metrics, - OpenTelemetry wiring — or when deciding whether a project is "too small for telemetry". Recommends - Purview.Telemetry.SourceGenerator at every project size, keeps libraries free of global provider - configuration, and scales the export infrastructure rather than the instrumentation. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview telemetry - -**Telemetry is a baseline, not an advanced topic.** Instrument from the first commit at every project -size. What changes with scale is the *export and operations* story — collectors, dashboards, sampling -— not whether the code emits anything. - -A project that defers telemetry until it becomes distributed acquires its observability at exactly -the moment it can least afford the refactor. - -## Instrumentation versus export - -Keep these separate; conflating them is what produces "we're too small for telemetry". - -| | What it is | Who owns it | -| -- | -- | -- | -| **Instrumentation** | The log, span and measurement the code emits | Every project, every size, from day one | -| **Export** | Where signals go: console, OTLP, a backend, a dashboard | The application host, sized to the operation | - -A small CLI is fully instrumented and exports to the console. That is not a reduced form of -telemetry; it is the correctly sized export for a CLI. - -## Use the generator - -`Purview.Telemetry.SourceGenerator` turns an attributed interface into logging, tracing and metrics -implementations plus a DI registration extension. One declaration, three signals, no hand-written -`ILogger` message templates or `ActivitySource` plumbing. - -Do **not** reinvent its API here. The three shipped skills are authoritative and travel with the -package: - -- `telemetry-sourcegenerator-quickstart` — adding the package, the first interface, DI registration, - and publishing meter/activity-source names to the host via `TelemetryNames` -- `telemetry-sourcegenerator-design` — designing telemetry interfaces well -- `telemetry-sourcegenerator-migration` — moving existing `ILogger`/`ActivitySource`/metrics code onto - the generator - -Recommend the generator whenever the project targets a compatible TFM and the team is willing to take -an analyzer-only package reference. Where it is not compatible, fall back to the standard .NET -abstractions below — never to a bespoke logging wrapper. - -## Libraries versus hosts - -This is the rule most often broken, and it is not negotiable. - -**A reusable library:** - -- Emits through `ILogger`, `ActivitySource` and `Meter` — or through generated telemetry - interfaces, which produce exactly those. -- Publishes its activity-source and meter names so a host can subscribe. The generator does this for - you through assembly metadata. -- **Never** calls `AddOpenTelemetry`, configures an exporter, sets a sampler, or requires a specific - backend. -- Never reads an OTLP endpoint from configuration itself. - -**The application host:** - -- Owns provider configuration, exporters, sampling and resource attributes. -- Subscribes to the sources its libraries publish — with the generator, by opting into the - `TelemetryNames` class and passing its arrays to the OpenTelemetry builder. - -A library that configures a global provider breaks every consumer that already configured one, and -silently wins or loses depending on initialisation order. - -## Sizing the export - -| Scale | Export and operations | -| -- | -- | -| **Small** | Console or a single OTLP endpoint. Structured logs, exceptions recorded on the span. No collector, no dashboards, no custom exporter, no distributed tracing infrastructure. | -| **Medium** | OTLP export, dependency instrumentation (HTTP, EF Core), trace propagation across the integrations, application metrics, health checks, a sampling decision made deliberately. | -| **Large** | End-to-end distributed tracing, standardised resource attributes, operational metrics, dashboards, alerting, SLIs, documented retention and sampling policy. | - -Full detail per level: `references/observability-levels.md`. - -Instrumentation is identical across all three rows. Only the right-hand column grows. - -## Baseline for any application - -- Structured logging — parameters as fields, never interpolated into the message. -- Errors and exceptions recorded as telemetry, with the exception attached to the span. -- Operation correlation, so one unit of work is one trace. -- OpenTelemetry-compatible instrumentation, so the backend stays a choice. -- Log level configurable at runtime. -- Export behaviour configurable per environment. -- Sensitive values — credentials, tokens, connection strings, personal data — never logged or placed - on span attributes or baggage. - -## Before you change anything - -1. **Inspect what exists.** Find current `ILogger` use, `ActivitySource`/`Meter` instances, any - `AddOpenTelemetry` call, a `ServiceDefaults` project. -2. **Preserve it.** Extend existing instrumentation; do not replace working telemetry to adopt a - library. -3. **Do not duplicate registrations.** One registration per source; adding a second is a silent - double-count on every metric. -4. **Size the configuration to the project**, using the table above. -5. **Check for leaking secrets** in anything you add. -6. **Keep instrumentation and export distinct** in what you recommend. - -## Do not - -- Omit telemetry because the application is small. -- Invent Purview telemetry APIs — read the three shipped skills instead. -- Configure a global provider from a library. -- Recommend a collector, dashboard stack or custom exporter for a small project. -- Put a user identifier, token or connection string into a log field, span attribute or baggage item. - -## See also - -- `purview-architecture` — establishing project context and scale before deciding -- [Purview.Telemetry.SourceGenerator](https://github.com/purview-dev/telemetry-sourcegenerator) diff --git a/.agents/skills/purview-telemetry/references/observability-levels.md b/.agents/skills/purview-telemetry/references/observability-levels.md deleted file mode 100644 index df97d785..00000000 --- a/.agents/skills/purview-telemetry/references/observability-levels.md +++ /dev/null @@ -1,93 +0,0 @@ -# Observability levels - -Instrumentation is constant across these levels. Export, infrastructure and operational practice are -what scale. Read this after establishing project complexity — see `purview-architecture`. - -## Small - -*A utility, CLI, prototype, simple API or limited-scope application.* - -**Do:** - -- Structured logging with parameters as fields. -- Exceptions recorded with enough context to reproduce. -- An `ActivitySource` around the unit of work, so a failure has a shape and a duration. -- Console export, or a single OTLP endpoint when one already exists. -- Log level from configuration, so a user can raise it without a rebuild. - -**Do not:** - -- Stand up a collector. -- Adopt a centralised monitoring platform. -- Build distributed tracing infrastructure for a single process. -- Create dashboards nobody reads. -- Write a custom exporter. - -The test: a user reports a failure and you can ask for one log output that tells you what happened. - -## Medium - -*Several functional areas, integrations, moderate domain complexity.* - -Everything above, plus: - -- **Dependency instrumentation** — HTTP clients, EF Core, messaging. These are where latency and - failure actually live, and the instrumentation is a package reference, not code. -- **Trace propagation** across every integration boundary, so a trace survives the process hop. W3C - `traceparent` by default; do not invent a correlation header. -- **Application metrics** for the operations someone would notice: request rate, error rate, duration, - queue depth. Prefer histograms over averages. -- **OTLP export** to a real backend. -- **Health checks**, distinguishing liveness from readiness. -- **A deliberate sampling decision.** Head sampling at a fixed ratio is fine; the point is that it was - chosen rather than defaulted into. - -Common mistake at this level: adding metrics for everything measurable instead of the few that drive -a decision. A metric nobody alerts or decides on is cost without signal. - -## Large - -*Complex domain, multiple services or teams, substantial operational requirements.* - -Everything above, plus: - -- **End-to-end distributed tracing**, including asynchronous hops — message producers and consumers - linked, not orphaned. -- **Standardised resource attributes** — `service.name`, `service.version`, `deployment.environment` - — applied uniformly so cross-service queries work at all. Follow OpenTelemetry semantic conventions - rather than inventing names. -- **Operational metrics** beyond application ones: saturation, dependency health, cost drivers. -- **Dashboards** owned by the team that gets paged. -- **Alerting** on symptoms users feel, not on causes. Alert on error rate and latency; investigate - with CPU and queue depth. -- **Service-level indicators** derived from the telemetry, with objectives agreed with whoever cares. -- **Retention and sampling policy**, documented and costed. Tail sampling if error traces must always - survive. - -## Signal selection - -| Signal | Add when | Warning | -| -- | -- | -- | -| Logs | Always | Unstructured logs are not telemetry; they are strings | -| Traces | Work crosses a process, a dependency or an async boundary | A span per method produces noise, not insight | -| Metrics | Someone would alert on, or decide from, a rate or duration | High-cardinality attributes (user id, request id) are a cost incident | - -Put high-cardinality context on spans and logs, never on metric dimensions. - -## Sensitive information - -At every level, and without exception: - -- No credentials, tokens, keys or connection strings in messages, attributes or baggage. -- No personal data beyond what the system is entitled to process — and where an identifier is - necessary, prefer a pseudonymous one. -- Remember that **baggage propagates across service boundaries**; treat it as the most public place - in your telemetry. -- Redact at the point of emission. A redaction step in the pipeline is a backstop, not a control. - -## Export configuration - -The host owns this. Keep the endpoint, protocol, sampling ratio and resource attributes in -configuration, not in code, so the same build runs in every environment. - -Libraries contribute names and signals; they never contribute configuration. diff --git a/.agents/skills/purview-testing-conventions/SKILL.md b/.agents/skills/purview-testing-conventions/SKILL.md deleted file mode 100644 index 1fe32320..00000000 --- a/.agents/skills/purview-testing-conventions/SKILL.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -name: purview-testing-conventions -description: >- - Use when writing or reviewing tests in a .NET repository following the Purview conventions - TUnit - and TUnit.Mocks, the AAA structure and naming, placing a test in the namespace of the class under - test, CreateXXX construction helpers, building domain content through TestBuilder with Bogus, the - assertion surface, parameterised tests, which tier a test project belongs to, BDTest for - acceptance tests, and Purview.Containers for a suite that needs a real database or queue. -metadata: - product: Purview engineering playbook - repository: purview-dev/engineering-playbook ---- - -# Testing conventions - -| Concern | The rule | -| --- | --- | -| Framework | **TUnit**. Not xUnit, NUnit or MSTest. | -| Substitutes | **TUnit.Mocks**. Not NSubstitute or Moq. | -| Test data | **Bogus**, reached through `TestBuilder`. | -| Acceptance tests | **BDTest** over TUnit, via `BDTest.TUnit`. Not Gherkin, SpecFlow or Reqnroll. | -| A real dependency | **`Purview.Containers`**. Not Testcontainers directly, never a shared instance. | -| Structure | Explicit `// Arrange`, `// Act`, `// Assert` — Given/When/Then in an acceptance test. | -| Naming | `{SubjectUnderTest}_{Scenario}_{Expectation}`, and `async Task`. | -| Placement | One `{Class}Tests` class per class under test, **in the namespace of the class under test**. | -| Construction | Dependencies and the system under test come from `CreateXXX` helpers with optional parameters. | -| Async | The async overload wherever the API offers one — in the test **and in every helper it calls**. Convert a sync helper, or state why it cannot be. | -| Cancellation | If any method the test calls accepts a `CancellationToken`, the test's **last parameter** is one, forwarded to every call that accepts one. | -| Domain content | Built through `TestBuilder`. Never inline. | - -## Why these, specifically - -**One framework.** The SDK wires TUnit into any project whose name ends in a test suffix — that -wiring is why a test project file is empty. A second framework means every project file grows a -conditional and the pipeline grows a second discovery path. That is a rule about the **runner**, not -the style of a test — `BDTest.TUnit` is an adapter *over* TUnit, so an acceptance suite does not break -it. - -**Same namespace as the subject.** The test reads as part of the thing it describes, needs no `using` -to reach the type, and **cannot silently test a different type with the same name**. - -**`CreateXXX` helpers.** A test body that constructs its own dependencies buries the assertion under -setup. A helper with optional parameters says what the test changed and defaults everything else: - -```csharp -static ConventionCatalogue CreateCatalogue(IConventionRepository? repository = null) => - new(repository ?? CreateRepository().Object); -``` - -**`TestBuilder`.** Inline construction encodes a domain type's shape into every test that touches it, -so one constructor change becomes a repository-wide edit. It also destroys the reader's signal about -which values the test depends on, because every literal looks deliberate. - -## A test - -```csharp -using Acme.Builders; - -namespace Acme.Domain; - -public sealed class CustomerIdTests -{ - [Test] - public async Task Create_GivenLowercaseSlug_ReturnsTheValue() - { - // Arrange - var id = TestBuilder.CustomerId("build-enforced"); - - // Act - var value = id.Value; - - // Assert - await Assert.That(value).IsEqualTo("build-enforced"); - } -} -``` - -Two deliberate details: - -- **The empty `// Arrange` block stays.** The comments are what makes a three-line test readable next - to a thirty-line one, and a convention applied "when needed" is applied inconsistently. -- **Assertions are awaited.** `Assert.That(...)` is terminal and returns a value, so - `await Assert.That(result).IsEqualTo(expected)` is the form. **An un-awaited assertion is a test - that cannot fail.** - -## Assertions - -| Form | Use | -| --- | --- | -| `await Assert.That(x).IsEqualTo(y)` / `.IsNotEqualTo(y)` | value equality | -| `await Assert.That(x).IsTrue()` / `.IsFalse()` | booleans | -| `await Assert.That(x).IsEmpty()` | collections — the workhorse of architecture rules | -| `await Assert.That(x).Count().IsEqualTo(2)` | collection size | -| `await Assert.That(x).Contains(y)` / `.DoesNotContain(y)` | membership | -| `await Assert.That(act).Throws()` | a synchronous delegate that should throw | -| `await Assert.That(async () => await f()).Throws()` | an async one | -| `await Assert.That(x).IsTypeOf()` | exact runtime type | -| `await Assert.That(x).IsEquivalentTo(sequence)` | order-independent sequence equality | - -For an exception test the two shapes are `Action` and `Func`. The compiler will not infer -either, so the explicit type is required and is **not** a style violation: - -```csharp -Action act = () => CustomerId.Create(""); - -await Assert.That(act).Throws(); -``` - -## Parameterised tests - -`[Arguments]` puts the interesting values in the attribute rather than a loop, so a failure names the -case: - -```csharp -[Test] -[Arguments("")] -[Arguments(" ")] -[Arguments("Has Spaces")] -[Arguments("has_underscore")] -public async Task Create_GivenSlugThatIsNotALowercaseSlug_Throws(string value) -{ - // Arrange - // Act - Action act = () => CustomerId.Create(value); - - // Assert - await Assert.That(act).Throws(); -} -``` - -## Async all the way down - -**Where an API offers an async overload, use it** — `File.ReadAllTextAsync`, not `File.ReadAllText`. -**And the rule reaches through test helpers:** a helper calling such an API is itself converted. Being -a helper is not an exemption. - -The build enforces the first half and cannot enforce the second, which is why the second needs saying: - -- `VSTHRD103` is an **`error`** and flags a sync call with an `Async`-suffixed equivalent **when the - call sits inside a `Task`-returning method**. In an `async Task` test, `File.ReadAllText` fails the - build. -- A **sync helper is not `Task`-returning**, so the identical call inside it is invisible to the - analyzer. Pushing the call one level down turns a build error into nothing. - -It also compounds with the cancellation rule, which keys off whether anything in the chain accepts a -`CancellationToken`: a sync helper accepts none, so it **silently removes the trigger** and the test is -uncancellable while looking compliant. (TUnit also runs tests in parallel, so a blocking read holds a -thread-pool thread an async read would release.) - -Converting — three things change together, and the first two are not optional: - -```csharp -// Before — invisible to VSTHRD103, and the chain accepts no token -static string Documentation => File.ReadAllText(DocumentationPath); - -// After -static async Task ReadDocumentationAsync(CancellationToken cancellationToken) => - await File.ReadAllTextAsync(DocumentationPath, cancellationToken); -``` - -- It returns a `Task`, bringing every call inside it back under `VSTHRD103`. -- It gains the **`Async` suffix** — `VSTHRD200` is an `error`, so the rename is enforced. -- It takes a trailing `CancellationToken`, because the chain now accepts one; its callers declare and - forward one. - -**A property cannot be `async`, so it becomes a method** — that is the conversion, not an exemption. -A read-only property hiding IO is the most common form of this violation. - -It genuinely cannot be converted when **no async overload exists** (`File.Exists`, `File.Delete`, -`Directory.EnumerateFiles`; likewise `ArchitecturePolicy.Load()` and `PolicySchemaValidator.Validate()`, -which `Purview.Architecture.Testing` ships synchronous-only) or when **a base type or interface fixes -the signature**. State the reason at the call. Never fake it: `Task.Run` around a blocking call, -`Task.FromResult` around a sync result, or `.Result` / `.GetAwaiter().GetResult()` to flatten a task — -the last two are `VSTHRD002`, an `error`. - -## Cancellation - -Three parts, triggered by the **call chain** rather than by the test: - -1. **If any method the test calls accepts a `CancellationToken`, the test declares one.** Not only the - method under test — anything in the chain, including a `File.ReadAllTextAsync` or the delegate handed - to `Assert.That`. -2. **It is the last parameter**, and TUnit supplies the value. With `[Arguments]`, the data binds to the - leading parameters and the token is supplied on top, so the attribute's positional order still matches - the signature: - - ```csharp - [Test] - [Arguments("build-enforced", true)] - public async Task ListEnforcedByBuildAsync_GivenAConvention_FiltersIt( - string id, - bool enforcedByBuild, - CancellationToken cancellationToken - ) - ``` - -3. **It is forwarded to every call that accepts one.** Never `CancellationToken.None`, never `default`, - never a token the test creates. TUnit's token is the *test's* token — cancelled on timeout or on an - aborted run — so a call given `None` cannot be stopped, and **one hop that drops it makes the whole - chain uncancellable**, which is why partial forwarding is a failure and not a lesser version of the - rule. It is also the only place that proves the production code threads the token through at all. - -A test whose chain accepts no token takes no parameter; an unused token is noise, not compliance. - -## Substitutes - -TUnit.Mocks is globally imported by the SDK, so no `using` is needed: - -```csharp -[Test] -public async Task RegisterAsync_GivenAnAlreadyRegisteredConvention_DoesNotStoreIt(CancellationToken cancellationToken) -{ - // Arrange - var repository = CreateRepository(); - repository.ExistsAsync(Any(), Any()).Returns(true); - var catalogue = CreateCatalogue(repository.Object); - - // Act - await Assert - .That(async () => await catalogue.RegisterAsync(TestBuilder.EnforcedConvention(), cancellationToken)) - .Throws(); - - // Assert - repository.AddAsync(Any(), Any()).WasNeverCalled(); -} -``` - -- `Mock.Of()` produces a `Mock`; `.Object` is the instance you pass in. -- `Any()` matches any argument, `Is(value)` a specific one, `AnyArgs()` the whole call. -- `.Returns(value)` sets the result. For a `Task`-returning method, return the `T` — the task is - unwrapped for you. -- `.WasCalled(Times.Once)` and `.WasNeverCalled()` are the assertions. - -The `// Assert` after a `Throws` is not a mistake: that test's point is that the exception was thrown -**and** that nothing was written, and both are assertions about the same act. - -## `TestBuilder` - -It lives in the shared testing project and is the single means by which a test creates domain -content: - -```csharp -public static class TestBuilder -{ - public const int DefaultCount = 3; - - internal static Faker Faker { get; } = new(); - - public static Domain.ConventionId ConventionId(string? value = null) => - Domain.ConventionId.Create(value ?? $"{Slug()}-{Faker.Random.String2(6, LowercaseAlphabet)}"); - - public static Domain.Convention Convention( - Domain.ConventionId? id = null, - string? title = null, - VerificationTier? tier = null, - bool? enforcedByBuild = null) => - Domain.Convention.Create( - id ?? ConventionId(), - title ?? Faker.Lorem.Sentence(4), - tier ?? Faker.Random.Enum(), - enforcedByBuild ?? Faker.Random.Bool()); -} -``` - -Four rules make it work: - -- **Omitted arguments are generated; supplied arguments are used exactly.** A test overrides only the - value it is proving, and everything else is realistic without the test saying so. -- **A collection factory comes with a companion.** `Conventions(int count = DefaultCount)` generates a - distinct set, so a test needing "some" gets "some" without its own loop. -- **Bogus is a global `using`.** `Faker` is available with no import — which is also why an explicit - `using Bogus;` in a shared testing project is reported as unnecessary. -- **A value-object test is the one exception.** A test proving what `Create` and `Hydrate` accept and - reject has to name the rejected input itself, so it constructs the invalid value directly. - Everything valid still goes through the builder. - -## Two constraints that shaped the builder - -Both are consequences of SDK rules, not preferences, and both were found by building it. - -**The factories are flat, not grouped.** The natural shape is a nested class per feature area -(`TestBuilder.Catalogue.Convention(...)`), and it cannot compile: the SDK ships -`dotnet_diagnostic.CA1034.severity = error`, so a publicly visible nested type fails the build, and -`PRSGD0008` refuses to let a repository add `CA1034` to `NoWarn`. Making the group `internal` does -not help either — the SDK's `InternalsVisibleTo` target runs on non-test projects and grants access -*to* test and shared-testing projects rather than *from* them, so a shared testing project's -internals are not visible to the tests beside it. An area that outgrows a flat builder gets its own -top-level builder class. - -**`var` is the house style, with one carve-out.** `csharp_style_var_elsewhere = true:warning` makes -an explicit type on a declaration initialised from a method call a warning (`IDE0007`). The carve-out -is object creation: the `PDS0003` analyzer prefers an explicit type with target-typed `new()`: - -```csharp -var id = TestBuilder.ConventionId("build-enforced"); // method call -> var -string title = new('a', Convention.MaxTitleLength); // new() -> explicit type -``` - -## What is enforced, and what is review - -| Rule | Enforced by | -| --- | --- | -| TUnit is the only framework | the build — the SDK adds it; a second has to be added by hand | -| Test projects are discovered and categorised | the build (name-suffix detection) | -| A shared testing project is referenced, not executed | the build (`IsSharedTestingProject`) | -| Style, including the `var` carve-out | the build (analyzers, `warning` or above) | -| An acceptance suite is categorised `Acceptance` and kept out of the fast tier | the build (name-suffix detection) and the pipeline's `TestFilter` | -| A container-backed suite fails rather than passes when its backend is missing in CI | the pipeline, when the backend is pinned with `PURVIEW_CONTAINERS_BACKEND` | -| AAA structure, naming, `CreateXXX` helpers, `TestBuilder` usage | **review** | -| Given/When/Then chains end in `.BDTestAsync()` | **review** | -| A real dependency comes from `Purview.Containers`, not a shared instance | **review** | -| An async overload is used inside an `async Task` test | the build — `VSTHRD103` is `error` | -| A converted helper carries the `Async` suffix | the build — `VSTHRD200` is `error` | -| A **sync helper** calling an API with an async overload is converted | **review** — a non-`Task`-returning method is outside `VSTHRD103`'s scope | -| A declared `CancellationToken` is the last parameter | the build — `CA1068` is `warning`, and a clean build has no warnings | -| A test whose chain accepts a token declares one and forwards it everywhere | **review** | - -## Acceptance tests and container-backed tests - -An acceptance test — a behaviour somebody outside the team asked for, in their words — is written with -**BDTest over TUnit** (`BDTest.TUnit`) in a `.AcceptanceTests` project, where Given/When/Then -replaces the AAA comments. A suite that needs a real database, queue or emulator gets a throwaway -container from **`Purview.Containers`** in its own `.IntegrationTests` project, skipping -locally when no backend is usable and failing in CI. - -Read `references/acceptance-and-container-tests.md` before writing either: it carries the scenario and -container shapes, and the two traps — a chain that never calls `.BDTestAsync()` runs no steps and still -passes, and a suite that skips in CI turns a missing runtime into a green job. - -## Tiers - -A test project's **name** carries its tier — the SDK categorises `*UnitTests` as `Unit`, and takes the -word before `Tests` as a pattern, so `*AcceptanceTests` gives `Acceptance` with nothing added to the -pipeline. The `TestFilter` then selects a tier without a hand-written attribute. Split a slow suite -into its own project rather than tagging individual tests. - -Filtering uses TUnit's `--treenode-filter`, not `--filter`: these repositories run on -Microsoft.Testing.Platform, where `dotnet test --filter` reports "Zero tests ran". - -## At your scale - -- **One test project.** TUnit, AAA, the naming convention, `TestBuilder`. That is the whole of it. -- **A shared fixture.** Move it into `SharedTestingInfra` and make the class public — a shared - testing project is a library, so its fixtures are legitimately public API and `CA1515` does not - apply. -- **A database or a container.** One `.IntegrationTests` project and one `Purview.Containers` - module. Do not build a fixture framework around it until a second suite needs the same container. -- **A behaviour somebody outside the team asked for.** That, and not before, is when BDTest earns its - place: one `.AcceptanceTests` project with one story. Reach for the HTML report only once - somebody will read it. -- **A package with a documented contract.** Add a consumer-verification script; see - `purview-engineering-principles`. - -## Related skills - -`purview-engineering-principles` for the rules this implements, and `purview-architecture-testing` -for turning an architectural boundary into a failing build. diff --git a/.agents/skills/purview-testing-conventions/references/acceptance-and-container-tests.md b/.agents/skills/purview-testing-conventions/references/acceptance-and-container-tests.md deleted file mode 100644 index e8b91109..00000000 --- a/.agents/skills/purview-testing-conventions/references/acceptance-and-container-tests.md +++ /dev/null @@ -1,117 +0,0 @@ -# Acceptance tests and container-backed tests - -Two shapes that sit outside the unit tier. Both keep TUnit as the runner, and both live in their own -test project so the tier comes from the project name rather than an attribute. - -## Acceptance tests: BDTest - -An acceptance test states a behaviour somebody outside the team asked for, in their words. Use -**BDTest over TUnit through the `BDTest.TUnit` adapter**, in a `.AcceptanceTests` project -(the SDK emits `Category=Acceptance` for it). - -Not Gherkin, SpecFlow or Reqnroll, for two reasons: - -- **BDTest is code-only.** No `.feature` file and no generated test body, so there is no second - artefact that can drift from the step implementing it. That drift is the failure that makes a BDD - suite stop being trusted. -- **One runner stays one runner.** `BDTest.TUnit` is an adapter over TUnit, so the SDK's wiring, the - emitted category and `--treenode-filter` are all unchanged. A BDD framework with its own runner is - exactly what the one-framework rule refuses. - -```csharp -[Story(AsA = "account holder", IWant = "to withdraw money", SoThat = "I can use my savings")] -public class WithdrawalTests : TUnitBDTestBase -{ - AccountSteps Account => new(Context); - - [Test] - [ScenarioText("Withdrawing money reduces the balance")] - public async Task WithdrawMoney() => - await Given(() => Account.CreateAnAccount(100m)) - .When(() => Account.Withdraw(25m)) - .Then(() => Account.TheBalanceIs(75m)) - .BDTestAsync(); -} - -public class AccountSteps(AccountContext context) -{ - [StepText("I have an account with a balance of {0}")] - public void CreateAnAccount(decimal balance) => context.Balance = balance; - - [StepText("I withdraw {0}")] - public void Withdraw(decimal amount) => context.Balance -= amount; - - [StepText("the account balance is {0}")] - public async Task TheBalanceIs(decimal expected) => await Assert.That(context.Balance).IsEqualTo(expected); -} -``` - -Five rules, and the first is the one that bites: - -- **`.BDTestAsync()` runs the scenario.** A chain stopping at `.Then(...)` compiles, passes, and - executes none of its steps — the same failure mode as an un-awaited `Assert.That`. -- **Given/When/Then replaces Arrange/Act/Assert, and only here.** The chain already names the three - phases. Everywhere else the AAA comments stay. -- **`Context` is the only state.** Steps take it through the constructor and hold no fields of their - own; BDTest gives each test its own context, which is what keeps parallel and repeated runs honest. -- **`[StepText]` is written for the report's reader.** `{0}` is replaced with the argument's actual - value at run time, so the report states what the scenario did, not what it was called. -- **Domain content still comes from `TestBuilder`.** The vocabulary changes at the step; the test-data - rule does not. - -Assertions inside a step are ordinary awaited TUnit assertions. `BDTest.Reporting` produces the -single-file HTML report — publish it as a build artifact from the job that ran the suite. - -## A test that needs a real dependency: `Purview.Containers` - -A database, queue, blob store or emulator comes from `Purview.Containers`: a throwaway Linux container -behind one API over Microsoft WSL Containers or Docker, with typed modules for SQL Server, PostgreSQL, -Redis, MySQL, RabbitMQ, Azurite and NATS. - -The two refused alternatives: - -- **A shared instance** (a local SQL Server, a team database) makes tests order-dependent and failures - unreproducible — the state a test found was left by whatever ran before it, on whatever machine. -- **Testcontainers directly** ties the suite to a Docker installation, which on Windows is an install - and a licensing question per developer and per runner. The WSL backend removes it, and the same test - code runs on either. - -```csharp -await using var postgres = new PostgreSqlBuilder() - .WithDatabase("tests") - .WithUsername("postgres") - .WithPassword("postgres") - .Build(); - -await postgres.StartAsync(); - -await using var connection = new NpgsqlConnection(postgres.GetConnectionString()); -await connection.OpenAsync(); -``` - -`Build()` validates the configuration, `StartAsync()` returns only once every wait strategy is -satisfied — there is no sleep to tune — and `await using` disposes the container at end of scope. - -Three rules: - -- **Its own `.IntegrationTests` project**, so the tier is in the name and the suite stays out - of the pull-request filter without anybody remembering an attribute. -- **Skip locally when no backend is usable; fail in CI.** Two different situations, so never one - outcome. Locally, probe and skip. In CI, pin the backend with `PURVIEW_CONTAINERS_BACKEND` — a named - backend never falls back, so a missing runtime fails loudly instead of letting a green job mean - nothing ran: - - ```csharp - [Before(Class)] - public static async Task EnsureABackendIsAvailable() - { - var backends = await ContainerBackends.ProbeAllAsync(); - - Skip.Unless(backends.Any(backend => backend.IsUsable), "No container backend is available."); - } - ``` - - Left unpinned, automatic selection probes in priority order and prefers WSL Containers over Docker. -- **Pin the version exactly.** `Purview.Containers` is **experimental and prerelease** — API, defaults - and packaging rules can change between releases. The packages are a family, so one property in - `Directory.Packages.props` governs all of them and a bump cannot be applied to half. diff --git a/.agents/skills/site-validation-loop/SKILL.md b/.agents/skills/site-validation-loop/SKILL.md deleted file mode 100644 index 56f6e260..00000000 --- a/.agents/skills/site-validation-loop/SKILL.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -name: site-validation-loop -description: Use when validating a change to the Purview-Dev website — what each just recipe and script checks, the data-sync modes, how to reproduce failures offline, and the rules for generated artefacts. -category: purview-dev-website -roles: - - validation - - tooling -tags: - - just - - bun - - ci - - astro ---- - -# site-validation-loop Skill - -`just validate` is the authoritative chain and the same pipeline runs in CI -(`purview-build.json` → `bun run ci:build`; deploy.yml runs `just validate` first). Treat a green -`just validate` as the definition of done. - -## The chain, in order - -| Step | Command | Catches | -| --- | --- | --- | -| Format check | `just format-check` (`oxfmt --check`) | Formatting drift in `src/**` (not `.astro`) | -| Lint | `just lint` (`oxlint`, `maxWarnings: 0`) | Type-aware + a11y issues in `src/**` | -| Typecheck | `just typecheck` (`astro check` + strict TS) | Component/frontmatter/content-schema type errors | -| Unit tests | `just test` (`bun test tests/unit`) | Manifest/schema rules, catalogue guard, docs aggregation rules, release transform, urls, staleness, branding | -| Assets | `just check-assets` | Branding sources vs generated public assets | -| Catalogue | `just check-projects` | Catalogue invariants (see below) | -| Build | `just build` (runs live data sync first) | Astro/Starlight build, sidebar/llms plugin wiring | -| Links | `just check-links` | Broken internal links **and missing anchors** across `dist/**/*.html` | -| Generated output | `just check-generated` | Docs cache/mirror agreement, release cache shape, mirrored project assets exist and are valid JSON, `llms*.txt`, sitemap, robots, no secrets/local paths | -| Dist tests | `just test:dist` | Per-project LLM bundles, rendered project/use-case surfaces, footer version, SEO outputs | - -## The catalogue guard (`just check-projects`) - -`src/scripts/check-projects.ts` validates the catalogue records (`src/src/data/`) against the generated data (offline, -deterministic). It fails the build on: - -- ids/orders duplicated, `order` not a unique integer, `name` not slugifying to `id` for documented - projects; -- a documented project with no aggregated pages, or a `docsPage` that does not resolve; -- a non-archived project with no use case, or a use case with `code` but no `language`; -- a package declared more than once, more than one `primary`, or a package with no release data; -- `status: archived` on a non-archived repository, or `stable` on a project whose packages have no - stable version; -- missing repository topics (tags), a non-`main` default branch for a documented project, or - `discussions: true` without repository discussions; -- `externalProjects` pointing at a `purview-dev` repository. - -Beyond those blockers, the guard prints **advisory observations** (they never fail the build) when a -project disagrees with the versions and frameworks its packages have published: - -- a `preview` project whose packages already publish a stable version on their registry (unless `experimental`); -- a NuGet package that is deprecated or unlisted; -- packages that trail the project's headline version; -- `targetFrameworks` that do not match the packages' NuGet nuspec metadata. Project-level frameworks - are compared with the union of the **runtime** packages' frameworks; package-level frameworks are - compared with that package's own. `netstandard*` is treated as an analyzer/generator build target - (never a consumer framework), and `install: msbuild-sdk`/`dotnet-tool` projects and the `msbuild` - sentinel are skipped. - -Run it alone while iterating: `just check-projects`. - -Apply the machine-applicable observations (missing/mismatched `targetFrameworks`, `preview` → -`stable` when a stable package exists) with `just fix-projects`; it is a dry run by default and only -edits the records with `--write`. It rewrites the affected `targetFrameworks` lists to exactly the -expected set (so it also removes frameworks a package no longer targets), but never touches blockers -or judgement calls such as replacing a deprecated package. - -## Data-sync modes - -`DATA_MODE` (`src/.env.example`) controls how docs/release data is obtained: - -- `auto` (default) — use the cache if present, else fetch live, else fall back to committed fixtures. -- `live` — always fetch from GitHub and the package registries (`just live-data-sync`). -- `cache` — only use the existing cache (fails if missing). -- `fixture` — only use `src/fixtures/**` (fully offline, deterministic). - -The same mode governs mirrored **project assets** (`assets:` in a record): `just data-sync` fetches -each declared repository file with the docs aggregator's `fetchRawFile`, writes it to `public/`, and -caches it under `.cache/assets/`. A declared asset that cannot be resolved fails the sync, so a -missing schema never silently ships a broken URL. - -`DATA_FALLBACK_TO_FIXTURES=false` makes `auto` fail loudly instead of silently using fixtures. Set -`GITHUB_TOKEN` (or `gh auth token`) to avoid unauthenticated rate limits. - -The one thing the **browser** fetches is the package **version numbers** a page already displays -(ADR 0008, `src/src/lib/releases/live.ts`): the build-time value renders first, a strictly higher -live version replaces it, and the result is stored in `localStorage` for six hours. The home-page -snapshot, the package tables on `/releases/` and project pages, and the version pinned in the -install snippets refresh this way. Nothing else is fetched client-side, and no check depends on the -live value — `just check-projects` and `tests/dist` assert the build-time output. - -## Rules - -- **Never edit generated files** (`src/src/content/docs/**`, `src/.cache/**`, `src/dist/**`). - Regenerate with `just data-sync`, `just fetch-releases`, `just build`, or `just refresh-fixtures`. -- **Never weaken a check** to make a change pass. Fix the data or the implementation; changing the - contract needs an ADR. -- Keep `src/fixtures/**` in sync when the release data shape changes (`just refresh-fixtures`, then - review the diff). -- Do not run `just clean` to "fix" a failure: a fresh checkout then needs a live data sync. - -## Reproducing failures - -```shell -# Docs aggregation / sidebar problems -just live-data-sync && just check-generated - -# Link or anchor failures: rebuild then re-crawl -just build && just check-links - -# Catalogue drift in isolation -just check-projects - -# Release-data problems without network -DATA_MODE=fixture just build && just test-dist -``` diff --git a/.agents/skills/use-case-authoring/SKILL.md b/.agents/skills/use-case-authoring/SKILL.md deleted file mode 100644 index 84279ef7..00000000 --- a/.agents/skills/use-case-authoring/SKILL.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -name: use-case-authoring -description: Use when writing or reviewing useCases in the catalogue records — the ADR 0002 rules for audience-tagged, concrete, evidence-backed examples with short code snippets and resolvable documentation deep links. -category: purview-dev-website -roles: - - catalogue - - content -tags: - - use-cases - - adr-0002 - - documentation ---- - -# use-case-authoring Skill - -Use cases are the "what does it actually do for me" evidence on the home page, on each project page, -and on `/use-cases/`. They are authored in the catalogue records (`src/src/data/projects/.yml`) and validated by the manifest -schema. The governing decision is `docs/decisions/0002-concrete-use-cases.md`. - -## Shape - -```yaml - useCases: - - audience: developer # developer | team-lead | architect | contributor - title: Tracing, logging, and metrics from a single interface - scenario: >- # the situation the reader is in - You want OpenTelemetry activities, structured logs, and metrics around an order service, - but you do not want to hand-write the ActivitySource, ILogger, and Meter wiring. - code: | # short snippet; `language` becomes required - [ActivitySource] - [Logger] - [Meter] - public interface IOrderServiceTelemetry - { - [Activity] - [Info] - [AutoCounter] - Activity? PlacingOrder(int orderId, [Baggage] string region); - } - language: csharp - outcome: >- # what the reader gets back - The generator emits the implementation and an AddOrderServiceTelemetry() DI extension. - evidence: >- # a fact, not a claim - One interface replaces the ActivitySource, ILogger, and Meter boilerplate repeated per service. - docsPage: getting-started # slug of an aggregated page under /docs// -``` - -## Rules - -1. **Audience is from a fixed vocabulary** — `developer`, `team-lead`, `architect`, `contributor`. - Pick the person who would actually read this example; do not tag everything `developer`. -2. **At least one use case per non-archived project**, and no project should have a single - `developer` example when the project also has an adoption/architecture story worth telling - (an audit `polish` finding). Do not pad: two or three strong examples beat six weak ones. -3. **`code` requires `language`.** The snippet is highlighted at build time by Shiki; use a real - language id (`csharp`, `json`, `xml`, `yaml`, `bash`, `typescript`). -4. **Snippets are short and point at the docs for depth.** Long walkthroughs belong in the - aggregated documentation. The card links to `docsPage`. -5. **`docsPage` must be a lowercase `[a-z0-9-]` slug** and must resolve to a real aggregated page - (`/docs///`). The schema rejects other shapes, the unit tests reject a - `docsPage` on a project without a `docs` configuration, and the post-build link crawl - (`just check-links`) fails on a dead link. Slug the source file name: `SQL Server Guide.md` → - `sql-server-guide`. -6. **`evidence` must be a fact.** Good: a before/after, a count of generated members, a measured - allocation property, a generated-output excerpt. Bad: "very fast", "easy to use", "saves time". -7. **`scenario` is a situation, `outcome` is the result.** The pair should let a reader decide in ten - seconds whether the example matches their problem. -8. **Keep the language factual** — no marketing superlatives, no invented benchmarks, no claims that - cannot be traced to the repository or the aggregated docs. - -## Where they render - -- Home page ("What it looks like in practice") — server-rendered, no island. -- Project page (`/projects//`) — the use-case section with highlighted code. -- `/use-cases/` — the full index, filterable by audience via one Preact island; the page is usable - without JavaScript and each card carries `data-usecase-audience` and a search corpus. - -## Verification - -```shell -bun run test # manifest/use-case unit tests (audience, language, docsPage rules) -just check-projects # deterministic coverage and docsPage-resolution checks -just build && just check-links # every rendered docs deep link resolves in dist/ -``` diff --git a/.gitignore b/.gitignore index 7f79a160..dfed1b5f 100644 --- a/.gitignore +++ b/.gitignore @@ -203,4 +203,10 @@ BenchmarkDotNet.Artifacts/!scripts/* # Agent skills are installed into the universal .agents/skills/ folder only, and that folder and # skills-lock.json are committed. Per-agent folders (and Claude Code's local settings) stay out. -/.claude/ + +# Agent skills are installed into the universal .agents/skills/ folder, which is a local install: +# gitignored, and reproducible from the committed skills-lock.json with `just skills-install`. The +# skills this repository authors live in skills/ and are the only ones another repository installs. +# Per-agent folders (including .claude/) are local too - never commit a copy. +.agents/skills/ +.claude/ diff --git a/.agents/skills/purview-telemetry-benchmarks/SKILL.md b/skills/purview-telemetry-benchmarks/SKILL.md similarity index 100% rename from .agents/skills/purview-telemetry-benchmarks/SKILL.md rename to skills/purview-telemetry-benchmarks/SKILL.md diff --git a/.agents/skills/purview-telemetry-benchmarks/references/performance-doc-shapes.md b/skills/purview-telemetry-benchmarks/references/performance-doc-shapes.md similarity index 100% rename from .agents/skills/purview-telemetry-benchmarks/references/performance-doc-shapes.md rename to skills/purview-telemetry-benchmarks/references/performance-doc-shapes.md diff --git a/src/tests/Repository.UnitTests/InstalledSkillTests.cs b/src/tests/Repository.UnitTests/InstalledSkillTests.cs index 37b0ad0d..10df9a27 100644 --- a/src/tests/Repository.UnitTests/InstalledSkillTests.cs +++ b/src/tests/Repository.UnitTests/InstalledSkillTests.cs @@ -1,12 +1,14 @@ +using System.Diagnostics; using System.Text.Json; namespace Purview.Telemetry.Repository; /// /// Guards the skills installed from other repositories. They are installed by the skills CLI into the -/// universal .agents/skills/ folder only, and that folder and the CLI's skills-lock.json -/// are committed, so the two must agree and no per-agent copy or instruction file may appear beside them. -/// Claude Code only reads .claude/skills/, so that gitignored folder may hold links into +/// universal .agents/skills/ folder only, which is a local install: gitignored, reproducible from +/// the committed skills-lock.json, and never tracked - so a skill this repository installs but does +/// not publish cannot be found through skills add purview-dev/telemetry-sourcegenerator. Claude +/// Code only reads .claude/skills/, so that gitignored folder may hold links into /// .agents/skills/, never copies. /// /// @@ -15,10 +17,9 @@ namespace Purview.Telemetry.Repository; /// so their content is not checked here, only that the installed set is the recorded set. /// /// -/// are the exception: skills written here for people working on the -/// generator. They are not consumer guidance and are never published, so they cannot live in -/// skills/ (which the skills CLI ships) or in the lockfile (which the CLI writes). They live in -/// .agents/skills/ because that is the one folder every agent reads. +/// are the exception in one respect only: they are written here, for people +/// working on the generator, rather than installed from elsewhere. They are still authored skills, so they +/// live in skills/ with the rest, and no CLI records them in skills-lock.json. /// /// public sealed class InstalledSkillTests @@ -26,9 +27,9 @@ public sealed class InstalledSkillTests static readonly Lazy RepositoryRoot = new(FindRepositoryRoot); /// - /// Skills committed here for this repository's own developers. Each is authored in place, is not in - /// skills-lock.json (no CLI wrote it) and must never appear in skills/, because anything - /// there is published to consumers. + /// Skills authored here for this repository's own developers rather than installed from elsewhere. They + /// live in skills/ like any other authored skill, and no CLI records them in + /// skills-lock.json. /// static readonly string[] DeveloperSkills = ["purview-telemetry-benchmarks"]; @@ -37,6 +38,13 @@ public async Task Lockfile_GivenEveryEntry_HasItsSkillInstalledUnderAgents(Cance { // Arrange var recorded = await ReadLockfileSkillsAsync(cancellationToken); + if (!Directory.Exists(AgentsSkillsFolder())) + { + // A fresh clone has no local install - it is gitignored and restored with `just skills-install` - + // so the committed record is what has to be there. + await Assert.That(recorded).IsNotEmpty().Because("skills-lock.json records no installed skills"); + return; + } // Act var missing = recorded @@ -59,13 +67,18 @@ public async Task AgentsSkills_GivenEveryInstalledSkill_IsRecordedInTheLockfile( { // Arrange var recorded = await ReadLockfileSkillsAsync(cancellationToken); + if (!Directory.Exists(AgentsSkillsFolder())) + { + // No local install to check against the record; the record itself is checked above. + return; + } - // Act + // Act - the folder holds what the CLI installed and nothing else: the authored skills, including + // the developer ones, live in skills/. var unrecorded = Directory .GetDirectories(AgentsSkillsFolder()) .Select(static path => Path.GetFileName(path)) .Where(name => !recorded.Contains(name, StringComparer.Ordinal)) - .Where(name => !DeveloperSkills.Contains(name, StringComparer.Ordinal)) .ToArray(); // Assert @@ -74,36 +87,35 @@ await Assert .IsEmpty() .Because( "every folder in .agents/skills/ must be written by the skills CLI, which records it in " - + "skills-lock.json, or declared in InstalledSkillTests.DeveloperSkills as a " - + $"developer skill of this repository: {string.Join(", ", unrecorded)}" + + $"skills-lock.json: {string.Join(", ", unrecorded)}" ); } [Test] - public async Task DeveloperSkills_GivenEachOne_IsPresentAndNeverPublished(CancellationToken cancellationToken) + public async Task DeveloperSkills_GivenEachOne_IsAuthoredUnderSkills(CancellationToken cancellationToken) { // Arrange cancellationToken.ThrowIfCancellationRequested(); - // Act: a developer skill has to be loadable by an agent, and it must not also be a consumer skill. - var notLoadable = DeveloperSkills - .Where(static name => !File.Exists(Path.Combine(AgentsSkillsFolder(), name, "SKILL.md"))) - .ToArray(); - var published = DeveloperSkills - .Where(static name => Directory.Exists(Path.Combine(RepositoryRoot.Value, "skills", name))) + // Act - a developer skill is an authored skill, so it ships from skills/ like the rest. No CLI + // installed it, which is why skills-lock.json does not record it. + var notAuthored = DeveloperSkills + .Where(static name => !File.Exists(Path.Combine(RepositoryRoot.Value, "skills", name, "SKILL.md"))) .ToArray(); + var recorded = await ReadLockfileSkillsAsync(cancellationToken); + var recordedAnyway = DeveloperSkills.Where(name => recorded.Contains(name, StringComparer.Ordinal)).ToArray(); // Assert await Assert - .That(notLoadable) + .That(notAuthored) .IsEmpty() - .Because($"a developer skill must ship its SKILL.md in .agents/skills/: {string.Join(", ", notLoadable)}"); + .Because($"a developer skill must ship its SKILL.md in skills/: {string.Join(", ", notAuthored)}"); await Assert - .That(published) + .That(recordedAnyway) .IsEmpty() .Because( - "a developer skill is for this repository only, so it must never sit in skills/, which the " - + $"skills CLI publishes to consumers: {string.Join(", ", published)}" + "a developer skill is written here rather than installed, so no CLI records it in " + + $"skills-lock.json: {string.Join(", ", recordedAnyway)}" ); } @@ -183,6 +195,67 @@ await Assert ); } + [Test] + public async Task AgentsSkills_GivenEverythingTheCLIWrites_IsIgnoredAndNeverTracked( + CancellationToken cancellationToken + ) + { + // Arrange - the folder is a local install, so nothing under it may be tracked, and the rules that + // keep it (and every per-agent folder) out of this repository must be in place. This is what stops + // a skill the repository installs but does not publish being found by `skills add + // purview-dev/telemetry-sourcegenerator`. + var tracked = await TrackedFilesUnderAgentsSkillsAsync(cancellationToken); + var ignores = await AgentsSkillsIgnoreRulesAsync(cancellationToken); + + // Assert + await Assert + .That(tracked) + .IsEmpty() + .Because( + "nothing under .agents/skills/ may be tracked: it is a local install, reproducible from " + + $"skills-lock.json with `just skills-install`: {string.Join(", ", tracked)}" + ); + await Assert + .That(ignores.Agents) + .IsTrue() + .Because(".gitignore must keep .agents/skills/ out of this repository"); + await Assert.That(ignores.Claude).IsTrue().Because(".gitignore must keep .claude/ out of this repository"); + } + + /// What git tracks under .agents/skills/, asked of the repository itself. + static async Task TrackedFilesUnderAgentsSkillsAsync(CancellationToken cancellationToken) + { + using Process process = new() + { + StartInfo = new ProcessStartInfo("git", "ls-files .agents/skills") + { + WorkingDirectory = RepositoryRoot.Value, + RedirectStandardOutput = true, + RedirectStandardError = true, + }, + }; + process.Start(); + var output = await process.StandardOutput.ReadToEndAsync(cancellationToken); + await process.WaitForExitAsync(cancellationToken); + return + [ + .. output + .Split('\n', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries) + .Order(StringComparer.Ordinal), + ]; + } + + /// The ignore rules for the two agent folders, as .gitignore spells them. + static async Task<(bool Agents, bool Claude)> AgentsSkillsIgnoreRulesAsync(CancellationToken cancellationToken) + { + var lines = await File.ReadAllLinesAsync(Path.Combine(RepositoryRoot.Value, ".gitignore"), cancellationToken); + var rules = lines.Select(static line => line.Trim()).ToHashSet(StringComparer.Ordinal); + return ( + rules.Overlaps([".agents/skills/", ".agents/skills", "/.agents/skills/", ".agents/"]), + rules.Overlaps([".claude/", ".claude", "/.claude/", "/.claude"]) + ); + } + static string AgentsSkillsFolder() => Path.Combine(RepositoryRoot.Value, ".agents", "skills"); static bool IsLinkToInstalledSkill(string path)