Update npm package README: TypeScript-only examples and standalone dashboard by adamint · Pull Request #18220 · microsoft/aspire

adamint · 2026-06-15T19:55:19Z

Description

Updates the Aspire CLI npm package README (eng/scripts/pack-cli-npm-package.pointer.README.md) to:

Remove the C# AppHost example, keeping only TypeScript. The npm package targets JS/TS users, so the C# sample added noise.
Refresh the TypeScript example to match the official aspire-ts-starter template (Express API + Vite frontend, withHttpEndpoint/withExternalHttpEndpoints/withReference/waitFor/publishWithContainerFiles). This is the exact code shown on aspire.dev's "Build your first app" guide, so the README stays in lockstep with the docs. Added a one-line note explaining why each builder call is awaited.
Add a second example showing how to wire backing services (Postgres + Redis) with withReference/waitFor, mirroring playground/TypeScriptAppHost/apphost.mts.
Document the standalone dashboard with the one-line aspire dashboard run, including the OTLP endpoint apps point at via OTEL_EXPORTER_OTLP_ENDPOINT and the common options.

All API/CLI claims were verified against authoritative sources in this repo: the ts-starter template (src/Aspire.Cli/Templating/Templates/ts-starter/apphost.mts), the TypeScript playground apphosts, DashboardRunCommand.cs (defaults: frontend 18888, OTLP gRPC 4317, HTTP 4318), the npm engines node = '>=20' value, and the aspire.dev first-app guide.

Fixes # (n/a)

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No (docs only; existing NpmCliPackageTests renders this template and continues to pass)
Did you add public API?
- No
Does the change make any security assumptions or guarantees?
- No

…shboard Remove the C# AppHost example and keep TypeScript, aligning the sample with the official aspire-ts-starter template (Express API + Vite frontend). Add a second example showing how to wire backing services (Postgres, Redis) with references, and document starting the standalone dashboard with 'aspire dashboard run'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-06-15T19:55:32Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 18220

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 18220"

Copilot

Pull request overview

This PR updates the Aspire CLI npm package README to be TypeScript-focused, replacing the dual C#/TypeScript example with TypeScript-only content that matches the current ts-starter template, adds a backing services example, and documents the standalone dashboard feature.

Changes:

Replaced the C# + TypeScript dual example with a single TypeScript example matching src/Aspire.Cli/Templating/Templates/ts-starter/apphost.mts
Added a "backing services" section showing Postgres + Redis usage with withReference/waitFor
Added a "Standalone dashboard" section documenting aspire dashboard run and its key options

Show a summary per file

File	Description
eng/scripts/pack-cli-npm-package.pointer.README.md	Rewrites the app definition examples to TypeScript-only, adds backing services example, adds standalone dashboard documentation

Copilot's findings

Files reviewed: 1/1 changed files
Comments generated: 0

- Update NpmCliPackageTests to match the TypeScript-only README (the old __TypeScript__ heading was removed) and assert the C# example is gone and the standalone dashboard command is documented. - Standalone 'aspire dashboard run' surfaces OTLP logs/traces/metrics but not resource health checks (a resource-service/AppHost concept), so drop 'health checks' from the standalone-mode description. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-06-15T21:03:07Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

Copilot

Copilot's findings

Files reviewed: 2/2 changed files
Comments generated: 0 new

The generated TypeScript SDK only exposes integration methods (addPostgres, addRedis) when the matching packages are installed, so document the 'aspire add postgresql' / 'aspire add redis' prerequisite for the backing services example. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Code review found the install instructions were orphaned under the 'Add backing services' subsection after the C# example removal. Restore the '## Install' heading so install steps render as their own section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

github-actions · 2026-06-15T22:43:13Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

github-actions · 2026-06-15T23:05:41Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

github-actions · 2026-06-15T23:18:00Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

…tandalone dashboard (#18221) * Make npm package README TypeScript-only and document standalone dashboard Port of #18220 to release/13.4. - Remove the C# AppHost example so the npm README is TypeScript-only. - Refresh the TypeScript example to the current ts-starter template (apphost.mts importing ./.aspire/modules/aspire.mjs), fixing the stale apphost.ts / aspire.js references that no longer match the template. - Add a Postgres + Redis backing-services example with an `aspire add` note for the postgresql and redis integrations. - Add a Standalone dashboard section documenting `aspire dashboard run`. - Update NpmCliPackageTests to assert the TypeScript-only README content. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore Install heading dropped from npm README Code review found the install instructions were orphaned under the 'Add backing services' subsection after the C# example removal. Restore the '## Install' heading so install steps render as their own section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Move the standalone dashboard section earlier in the npm README and link to the standalone dashboard documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings June 15, 2026 19:55

Copilot started reviewing on behalf of adamint June 15, 2026 19:56 View session

Copilot AI reviewed Jun 15, 2026

View reviewed changes

adamint marked this pull request as ready for review June 15, 2026 21:26

Copilot AI review requested due to automatic review settings June 15, 2026 21:26

Copilot started reviewing on behalf of adamint June 15, 2026 21:27 View session

Copilot AI reviewed Jun 15, 2026

View reviewed changes

adamint mentioned this pull request Jun 15, 2026

[release/13.4] Make npm package README TypeScript-only and document standalone dashboard #18221

Merged

Copilot AI review requested due to automatic review settings June 15, 2026 21:45

Copilot AI reviewed Jun 15, 2026

JamesNK approved these changes Jun 16, 2026

View reviewed changes

Comment thread eng/scripts/pack-cli-npm-package.pointer.README.md

adamint enabled auto-merge (squash) June 16, 2026 14:43

github-actions Bot mentioned this pull request Jun 16, 2026

[repo-pulse] 📊 Repo Pulse — Daily Activity Dashboard #16404

Open

davidfowl reviewed Jun 17, 2026

View reviewed changes

Comment thread eng/scripts/pack-cli-npm-package.pointer.README.md Outdated

Address npm README review feedback

95a9533

Move the standalone dashboard section earlier in the npm README and link to the standalone dashboard documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

adamint merged commit 18710ef into microsoft:main Jun 19, 2026
673 of 677 checks passed

github-actions Bot added this to the 13.5 milestone Jun 19, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update npm package README: TypeScript-only examples and standalone dashboard#18220

Update npm package README: TypeScript-only examples and standalone dashboard#18220
adamint merged 5 commits into
microsoft:mainfrom
adamint:adamint/npm-readme-ts-dashboard

adamint commented Jun 15, 2026

Uh oh!

github-actions Bot commented Jun 15, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

adamint commented Jun 15, 2026

Description

Checklist

Uh oh!

github-actions Bot commented Jun 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

github-actions Bot commented Jun 15, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Jun 15, 2026 •

edited

Loading