refactor(compiler): introduce TemplateSource abstraction for tsp init#11303
Merged
Conversation
Replace getExecutionRoot()-based template loading in `tsp init` with a first-class TemplateSource abstraction (filesystem, in-memory, and remote implementations). This decouples template resolution from the CompilerHost filesystem contract and enables offline/embedded template sources. Extracted from #11299 as an independent, self-contained refactor.
microsoft-github-policy-service
Bot
added
compiler:core
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
|
You can try these changes here
|
timotheeguerin
marked this pull request as ready for review
July 20, 2026 16:13
timotheeguerin
requested review from
RodgeFu,
bterlson,
catalinaperalta,
iscai-msft,
lirenhe,
markcowl and
witemple-msft
as code owners
July 20, 2026 16:13
iscai-msft
approved these changes
Jul 20, 2026
timotheeguerin
pushed a commit
to Azure/typespec-azure
that referenced
this pull request
Jul 21, 2026
The core bump replaces ScaffoldingConfig.baseUri with source?: TemplateSource (microsoft/typespec#11303). Build a UriTemplateSource from the azure scaffolding index and pass it as source (mirrors #4965).
msyyc
pushed a commit
to msyyc/typespec-azure
that referenced
this pull request
Jul 21, 2026
…Azure#4968) Bumps the `core` submodule to latest main, which pulls in tspd's per-rule reference page generation (microsoft/typespec#11221). Left as-is, that would orphan Azure's rich hand-written rule pages by emitting barebones pages at a new location. Instead, this migrates each rule to the tspd `docs` field and keeps the generated pages at their existing URLs (net-zero URL change). ## Changes - **core**: bump submodule to latest main — includes the merged tspd `--rules-dir` change (microsoft/typespec#11316) - **86 rules**: add `docs: fileRef.fromPackageRoot("src/rules/<name>.md")`; rich content now lives in `packages/*/src/rules/*.md` - **3 `package.json`** regen-docs scripts: pass `--rules-dir ../rules` so generated pages stay at `libraries/<lib>/rules/<name>` - **astro.config**: 5 redirects for rules whose historical slug differs from the rule name (e.g. `prevent-format` → `no-format`) - **.gitignore**: ignore the generated `libraries/*/rules/` pages (regenerated during `build:web`) - **pnpm-lock**: add `@typespec/events` / `@typespec/sse` workspace links (new `http-specs` peer deps from the bump) - **eng/feeds e2e**: adapt `init-templates.e2e.ts` to the compiler's new `TemplateSource` scaffold API — `ScaffoldingConfig.baseUri` was replaced by `source?: TemplateSource` (microsoft/typespec#11303). Supersedes Azure#4965. - Contributing guide, `create-linter-rule` skill + scaffolder updated to the `docs`-field workflow ## Validation - `typespec-azure-core`, `typespec-azure-resource-manager`, `typespec-client-generator-core` tests pass - `oxlint` clean - `pnpm install --frozen-lockfile` passes - `pnpm regen-docs` clean (no drift) - init-templates e2e: scaffolding tests pass via the new `TemplateSource` path (the 2 `validate` tests that `npm install` an unpublished `@azure-tools/typespec-autorest` version fail only on registry resolution, unrelated to this change) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@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.
Extracts the self-contained
tsp inittemplate-loading refactor out of #11299 into its own PR.What
Replaces
getExecutionRoot()-based template resolution intsp initwith a first-classTemplateSourceabstraction, with three implementations behind one interface:FileSystemTemplateSource— the default (installed/node) path; readstemplates/from the compiler package root. NogetExecutionRoot()dependency.InMemoryTemplateSource— serves the index and every template file from an in-memory map (used by the standalone single-executable to serve templates offline).RemoteTemplateSource—--templates-url; keeps the untrusted-source confirmation and relative-file resolution.Why
Template loading previously went through the
CompilerHostfilesystem contract anchored atgetExecutionRoot(), which also serves the stdlib. Serving templates from an embedded/offline source required masquerading an in-memory map as a real filesystem and overloadinggetExecutionRoot(). This refactor decouples template resolution from the host FS contract so each context supplies its own source, and leavesgetExecutionRoot()solely for the stdlib.Notes
initdefaults toFileSystemTemplateSource.getTypeSpecCoreTemplates/scaffoldNewProject) and the VS Code extension keep working; the extension threads aTemplateSourcethroughcreate-tsp-project.serverlib.ts/server/types.tsare unchanged.