Repository navigation
feat: bundle versioned AI guidance with WebUI - #522
Merged
Mohamed Mansour (mohamedmansour) merged 2 commits intoSep 9, 2026
Merged
Mohamed Mansour (mohamedmansour) merged 2 commits into
Mohamed Mansour (mohamedmansour) merged 2 commits into
Conversation
Ship the canonical AI reference in the npm package and replace the installed snapshot with a minimal loader. Refresh the reference during build and packing, document one-time migration, and remove FAST-specific guidance from the AI reference. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 45307125-be11-46be-b3fe-b77df2bd3bcf
Keep ordinary dependency builds free of AI reference writes so parallel example builds cannot collide on Windows. Preserve prepack generation and add a regression guard for build lifecycle hooks. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 45307125-be11-46be-b3fe-b77df2bd3bcf
Mohamed Mansour (mohamedmansour)
requested review from
Bang Lee (Qusic),
atul (atulkatti) and
mcritzjam
September 9, 2026 00:59
Bang Lee (Qusic)
approved these changes
Sep 9, 2026
Mohamed Mansour (mohamedmansour)
deleted the
mohamedmansour-skills-documentation-setup
branch
September 9, 2026 01:08
Mohamed Mansour (mohamedmansour)
added a commit
that referenced
this pull request
Sep 18, 2026
## Release Bumps WebUI to `0.0.29`. Previous release tag: `v0.0.28` ## Changes since `v0.0.28` Features: - Ship version-matched AI authoring guidance with `@microsoft/webui`, using a lightweight skill that reads the installed package's reference (feat: bundle versioned AI guidance with WebUI #522 by @mohamedmansour). - Add plugin-aware component discovery, with filename-based HTML components and manifest-driven FAST components (feat: add plugin-aware component discovery #524 by @mohamedmansour). - Add WebUI Press `--show=all|content` for shell-free documentation views that preserve SSR, hydration, authored examples, and accessible theme behavior (feat: add WebUI Press content mode #525 by @mohamedmansour). - Automatically support Trusted Types for compiled templates and generated CSS import maps without promoting arbitrary state HTML to trusted content (feat: use Trusted Types automatically in the framework #536 by @mohamedmansour). - Keep explicit streaming imports lightweight so applications can load streaming support early and application code later (feat: keep explicit streaming imports lightweight #539 by @mohamedmansour). - Render tree-shaped state with file-scoped named `<for id="...">` bodies, including forward references and recursive reuse without extra client runtime code. Use unbraced `each="item in items"`; the legacy `template` spelling and FAST component references produce actionable diagnostics (feat: add file-scoped recursive for loops #547 by @mohamedmansour). Fixes: - Preserve table-rooted hydration ownership and correctly compile whitespace-bearing, nested directives, preventing duplicate controls after reactive updates. Rebuild templates to receive the compiler fix (fix: preserve table-rooted hydration paths #512 by @mohamedmansour; fix: align client directive parsing with the HTML scanner #531 by @mohamedmansour). - Emit reachable stylesheets and templates in deterministic traversal order. External plugin implementations must adapt the affected `HandlerPlugin` and bootstrap component collection interfaces from hash sets to slices (fix: render reachable-component ordering deterministically #519 by @janechu). - Resolve bare CEM module specifiers through their owning packages, respecting export maps, package boundaries, and cache invalidation when nearer dependencies appear (fix: resolve bare CEM module specifiers #528 by @janechu). - Prevent spurious dev-server rebuilds from read-only filesystem activity and recursive traversal of linked workspace dependencies (Improve benchmark telemetry and dev-server watching #521 by @mohamedmansour). - Update rustls to address TLS 1.3 handshake encryption-level validation advisory RUSTSEC-2026-0285 (fix: update rustls to address RUSTSEC-2026-0285 #533 by @mohamedmansour). - Forward bare boolean and ARIA component inputs into SSR state while preserving empty literal attributes and existing conditional boolean bindings (fix: forward HTML component inputs during SSR #540 by @mohamedmansour). - Preserve sibling route declaration order across SSR and client routing so equally specific routes select the correct pending and error boundaries (fix: preserve route order for pending and error boundaries #541 by @mohamedmansour). - Handle skipped or superseded router view transitions without unhandled animation rejections, while preserving route-commit errors and responsive subsequent navigation (fix: handle router view transition rejections #543 by @mohamedmansour). - Wait for active dev-server rebuilds and their bundler subprocesses before graceful shutdown, preventing output writes after the server exits (fix: wait for dev-server rebuilds during shutdown #546 by @mohamedmansour). - Preserve global theme defaults when custom properties are overridden only by scoped selectors or conditional rules, so unmatched component instances retain their intended colors (fix: preserve theme defaults under scoped CSS overrides #548 by @mohamedmansour). Docs: - Add a data-driven Benchmark Explorer, centralize performance guidance, distinguish independent SSR/browser metrics, and publish resource telemetry with accessible methodology details (docs: centralize performance guidance and benchmark data #486 by @mohamedmansour; Improve benchmark telemetry and dev-server watching #521 by @mohamedmansour). - Update AI reference installation and migration guidance while retaining `/ai`, and clarify plugin-specific discovery and FAST converted-template requirements (feat: bundle versioned AI guidance with WebUI #522 by @mohamedmansour; feat: add plugin-aware component discovery #524 by @mohamedmansour). - Document owned Rust partial rendering, streaming state ownership, and watcher hashing benchmarks, including measurement scope and tradeoffs (perf: reduce partial response allocations #510 by @mohamedmansour; perf: move streaming command processing off async workers #529 by @mohamedmansour; perf: bound watcher hashing memory with reusable scratch #530 by @mohamedmansour). - Document automatic Trusted Types support, CSP enforcement, and first-declared precedence for equally specific routes and their pending/error boundaries (feat: use Trusted Types automatically in the framework #536 by @mohamedmansour; fix: preserve route order for pending and error boundaries #541 by @mohamedmansour). - Explain named recursive loops and their compatibility limits, scoped CSS token defaults, and router view-transition error handling (feat: add file-scoped recursive for loops #547 by @mohamedmansour; fix: preserve theme defaults under scoped CSS overrides #548 by @mohamedmansour; fix: handle router view transition rejections #543 by @mohamedmansour). Maintenance: - Reduce partial-response and per-render allocations through owned state projection, borrowed graph traversal, scalar formatting, and borrowed nested route trees. Rust callers use ownership-taking `Protocol::render_partial(Value, ...)`; JSON boundaries retain `render_partial_json` (perf: reduce partial response allocations #510 by @mohamedmansour; perf: cut per-render handler allocations #511 by @mohamedmansour; perf: avoid cloning nested route trees #513 by @mohamedmansour). - Move streaming command deserialization, validation, and default preparation onto the existing blocking renderer, transferring owned records and state rather than cloning retained projections (perf: move streaming command processing off async workers #529 by @mohamedmansour). - Bound watcher hashing content storage to one reusable 8 KiB buffer instead of repeated file-sized allocations while preserving invalidation behavior (perf: bound watcher hashing memory with reusable scratch #530 by @mohamedmansour). - Parallelize release WASM builds and artifact staging, and consolidate dependency scanning before release jobs (chore: parallelize release pipeline work #509 by @mohamedmansour). - Refresh compatible Rust and JavaScript dependencies and migrate repository tooling and CI to pnpm 12.3.4 while preserving existing audit constraints (chore: update dependencies to latest compatible versions #534 by @mohamedmansour). ## Validation - `cargo xtask check` - `pnpm --dir crates/webui-press test` (16 passed). - `pnpm --dir packages/webui-framework exec playwright test recursive-repeat --workers=2 --reporter=line` (6 passed). - `pnpm --dir packages/webui-router exec playwright test --grep "view transition rejection ownership" --workers=2 --reporter=line` (4 passed). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Installing the full AI reference as a skill creates a separate snapshot that developers must refresh whenever WebUI changes. Bundle the reference with the npm package instead so guidance follows the application's installed version.
Approach
docs/ai.mdas the canonical reference and preserve the/aidocumentation URL.@microsoft/webuiduring prepack, include it in the tarball, and expose the./ai.mdsubpath. The generated copy is not tracked in Git. Ordinary dependency builds do not write it, avoiding the Windows file-lock race caused by parallel example builds.node_modules/@microsoft/webui/ai.md, reread after upgrades, and report missing guidance. No Node.js or package-manager loading commands are prescribed.Migration
Existing users run
npx skills add microsoft/webui --skill webui-referenceonce more to replace their snapshot with the loader. Future reference updates arrive with package upgrades. Installing the published package does not regenerate documentation or modify agent configuration; an active agent session still needs to reread after an upgrade.Validation
cargo xtask checkpassed, including the parallel example builds and documentation build.pnpm --dir packages/webui test: 72 tests passed, including a build-hook regression guard, reference refresh, missing-source failure, and app-local/hoisted resolution coverage.EBUSYdestination-lock simulation. Native Windows confirmation is delegated to the CI rerun.pnpm packand offlinenpm installcommands to verify byte-for-byte reference inclusion, then installed a synthetic newer package and confirmed the reference changed while the installed loader's SHA-256 remained identical. Rechecked tarball contents after making generation prepack-only. No package was published.