Template README + template.json generation tool#4570
Open
bradleyshep wants to merge 13 commits intomasterfrom
Open
Template README + template.json generation tool#4570bradleyshep wants to merge 13 commits intomasterfrom
bradleyshep wants to merge 13 commits intomasterfrom
Conversation
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
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.
Description of Changes
Adds
tools/templates/scripts to derive template metadata from manifests and generate READMEs from quickstart docs. Replaces slug-basedbuiltWithwith manifest-derived data and hardcoded quickstart mappings with discovery from docs.Manifest-based
builtWith(update-template-jsons.ts)package.json,Cargo.toml, and.csprojto populatebuiltWithin.template.json.@angular/core→angular). Excludes@types/*. Addsnodejsonly for nodejs-ts when@types/nodeis present.reactbeforespacetimedbin react-ts). Dependencies reordered in package.json where needed.Dynamic quickstart discovery (
generate-template-readmes.ts)--template Xfrom files indocs/docs/00100-intro/00200-quickstarts/.quickstartoverride in.template.json; must resolve under quickstarts dir.New:
tools/templates/(update-template-jsons.ts, generate-template-readmes.ts, README, package.json, pnpm-lock). Modified: alltemplates/*/.template.json(addedbuiltWith), new/generatedtemplates/*/README.md.API and ABI breaking changes
None.
Expected complexity level and risk
1 – Dev tooling only. No runtime or API changes. Scripts are isolated; failures only affect generated metadata and READMEs.
Testing
cd tools/templates && pnpm run generatecompletes without errorsbuiltWithand generated READMEs for a few templates