[docs] Document TypeScript brownfield workspace subdirectory init and script preservation#1080
Open
aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
…script preservation Documents the behavior introduced in microsoft/aspire#17510: - Workspace subdirectory layout when running aspire init from a subdirectory - Root package.json delegate scripts (aspire:start, aspire:build, aspire:dev) - Script preservation: existing aspire:-prefixed scripts are not overwritten - Package-manager isolation between the AppHost and guest packages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Documents TypeScript brownfield init behavior added in microsoft/aspire#17510: workspace subdirectory layout, root delegate scripts, preservation of existing aspire:-prefixed scripts, and package-manager isolation between the AppHost and the parent workspace.
Changes:
- Adds a "Workspace subdirectory layout" section with a
cd apps/my-app && aspire init --language typescript --non-interactiveexample and FileTree. - Documents
aspire:start/aspire:build/aspire:devroot delegate scripts and shows apnpm --dir aspire-apphostexample. - Adds notes about preserving existing
aspire:-prefixed scripts and package-manager precedence at the AppHost directory.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
sebastienros
approved these changes
May 27, 2026
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.
Documents changes from microsoft/aspire#17510
Authored by
@sebastienros.Targeting
release/13.4based on the source PR milestone13.4.Why this PR is needed
PR microsoft/aspire#17510 expanded TypeScript brownfield workspace validation in the Aspire CLI. Users running
aspire init --language typescriptfrom a workspace subdirectory now get a predictableaspire-apphost/layout, root delegate scripts (aspire:start,aspire:build,aspire:dev) that point into the AppHost subdirectory, preservation of any existingaspire:-prefixed scripts (with a warning), and correct package-manager isolation between the AppHost and guest packages.None of this behavior was previously described in the docs.
What was changed
Updated
src/frontend/src/content/docs/get-started/add-aspire-existing-app.mdxto add, under the TypeScript brownfield init section:aspire-apphost/directory structure whenaspire initis run from inside a workspace subdirectory, with an example using--non-interactive.aspire:start,aspire:build, andaspire:dev, what each does, and a concretepackage.jsonsnippet showing the generated delegate commands.aspire:-prefixed scripts are left unchanged and a warning is printed, with guidance on how to regenerate them.packageManagerfield or lockfile takes precedence over the parent workspace's package manager for AppHost operations.Files modified
src/frontend/src/content/docs/get-started/add-aspire-existing-app.mdx(updated)