Skip to content

[docs] Support alternative TypeScript AppHost toolchains (Bun, Yarn, pnpm)#746

Merged
IEvangelist merged 3 commits intorelease/13.3from
docs/ts-apphost-toolchains-16162-d31a9b286b43a679
Apr 23, 2026
Merged

[docs] Support alternative TypeScript AppHost toolchains (Bun, Yarn, pnpm)#746
IEvangelist merged 3 commits intorelease/13.3from
docs/ts-apphost-toolchains-16162-d31a9b286b43a679

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16162 by @sebastienros.

Targeting mainrelease/13.3 does not yet exist on microsoft/aspire.dev, so falling back to main (resolved from PR milestone "13.3").

Why this PR is needed

PR microsoft/aspire#16162 added support for non-npm JavaScript toolchains in TypeScript AppHosts. The CLI now auto-detects Bun, Yarn, and pnpm from package.json packageManager metadata and common lockfiles, and substitutes the matching install, run, and watch commands. A new aspire doctor environment check was also added for the detected toolchain. The existing docs only mentioned npm (and occasionally pnpm) — users on Bun or Yarn had no guidance.

What was changed

Files modified

  • src/frontend/src/content/docs/app-host/typescript-apphost.mdx — Added a new "Package manager toolchain" section documenting:

    • Supported toolchains (npm, pnpm, Yarn, Bun)
    • Toolchain detection order: packageManager field in package.json, then lockfiles, then parent directory walk (up to 8 levels)
    • Tabbed examples showing how to declare each toolchain via package.json
    • Install and run command substitution table per toolchain
    • Mention of the new aspire doctor check
    • Cross-reference to the aspire doctor command page
    • Updated package.json description to mention the toolchain-aware dev script
  • src/frontend/src/content/docs/get-started/prerequisites.mdx — Updated the TypeScript AppHost prerequisite description to list all supported package managers (npm, pnpm, Yarn, Bun) with links to their install pages.

  • src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx — Updated the environment checks bullet to mention JavaScript toolchain validation.

Generated by PR Documentation Check for issue #16162 · ● 2M ·

…pnpm)

- Add toolchain detection and declaration section to typescript-apphost.mdx
- Update prerequisites.mdx to list all supported package managers
- Update aspire-doctor.mdx to mention JavaScript toolchain environment check

Documents changes from microsoft/aspire#16162.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Apr 22, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from sebastienros April 22, 2026 17:47
@sebastienros
Copy link
Copy Markdown
Contributor

This should target 13.3 though

@sebastienros sebastienros changed the base branch from main to release/13.3 April 22, 2026 18:18
@sebastienros
Copy link
Copy Markdown
Contributor

I updated the target branch

@sebastienros sebastienros changed the base branch from release/13.3 to main April 22, 2026 23:10
@IEvangelist IEvangelist marked this pull request as ready for review April 23, 2026 01:58
@IEvangelist IEvangelist self-requested a review as a code owner April 23, 2026 01:58
Copilot AI review requested due to automatic review settings April 23, 2026 01:58
@IEvangelist IEvangelist requested a review from mitchdenny as a code owner April 23, 2026 01:58
Comment thread src/frontend/src/content/docs/app-host/typescript-apphost.mdx
Comment thread src/frontend/src/content/docs/app-host/typescript-apphost.mdx Outdated
Comment thread src/frontend/src/content/docs/app-host/typescript-apphost.mdx Outdated
Comment thread src/frontend/src/content/docs/app-host/typescript-apphost.mdx Outdated
Comment thread src/frontend/src/content/docs/app-host/typescript-apphost.mdx Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Aspire docs to reflect new TypeScript AppHost support for alternative Node package-manager toolchains (Bun, Yarn, pnpm) in addition to npm, including detection behavior and aspire doctor validation.

Changes:

  • Expanded TypeScript AppHost documentation with a “Package manager toolchain” section (detection, configuration examples, and command mapping).
  • Updated prerequisites to list supported package managers and link to install guides.
  • Updated aspire doctor docs to mention JavaScript toolchain validation for TypeScript AppHosts.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/frontend/src/content/docs/app-host/typescript-apphost.mdx Adds toolchain detection/configuration details and a command substitution table; links to aspire doctor.
src/frontend/src/content/docs/get-started/prerequisites.mdx Updates TypeScript prerequisites to include npm/pnpm/Yarn/Bun and installation links.
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx Notes that environment checks include JavaScript toolchain validation for TypeScript AppHosts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/frontend/src/content/docs/app-host/typescript-apphost.mdx Outdated
Comment thread src/frontend/src/content/docs/get-started/prerequisites.mdx Outdated
IEvangelist and others added 2 commits April 22, 2026 21:01
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@IEvangelist
Copy link
Copy Markdown
Member

Hey @sebastienros - is this supposed to target release/13.3?

image

@IEvangelist IEvangelist changed the base branch from main to release/13.3 April 23, 2026 12:55
@IEvangelist IEvangelist merged commit bccaac0 into release/13.3 Apr 23, 2026
5 checks passed
@IEvangelist IEvangelist deleted the docs/ts-apphost-toolchains-16162-d31a9b286b43a679 branch April 23, 2026 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants