Skip to content
Source
Sign inSign up
TanStack/cli

docs(create): correct Nitro server output instructions #555

Mergedtannerlinsleymerged 1 commit intomain fromrefs/pull/555/headmerged by tannerlinsley

tannerlinsleycommented

The generated Nitro README points to dist/server/index.mjs, but the build emits .output/server/index.mjs. Correct the server command and deployment directory for React and Solid.

AI review notes: Fresh React and Solid Nitro apps outside the monorepo passed production build, types, Vite preview and direct Node server requests with an imported route value present in the server-rendered HTML. The old README command failed with MODULE_NOT_FOUND; the entry in .output/nitro.json served HTTP 200. The newly compiled CLI generated both corrected READMEs. No deployment provider was contacted. Package installation used an empty npm config with scripts disabled, followed by a frozen-lockfile check. The unchanged normal hook passed 10 builds, 550 unit tests and all eight Chrome e2e tests. Nx reused the two prerequisite build outputs during the e2e target; the e2e command itself ran and passed. Only two README fragments and an @tanstack/create patch changeset change. No dependencies, runtime code, workflows or budgets change. Release remains held by the staged core artifact in #551.

Summary by CodeRabbit

  • Documentation
    • Corrected Nitro deployment instructions for React and Solid projects to use the .output/ directory and its server entry point.
    1. 🦋 Changeset detected

      Latest commit: 417a526758944dd30415d6bbe5c0c74b24f124df

      The changes in this PR will be included in the next version bump.

      This PR includes changesets to release 7 packages
      NameType
      @tanstack/createPatch
      create-start-appPatch
      create-tanstack-appPatch
      create-tanstackPatch
      create-tsrouter-appPatch
      @tanstack/create-startPatch
      @tanstack/cliPatch

      Not sure what this means? Click here to learn what changesets are.

      Click here if you're a maintainer who wants to add another changeset to this PR

    2. Review in Change Stack →

      No actionable comments were generated in the recent review.

      Walkthrough

      The React and Solid Nitro deployment instructions now use .output/server/index.mjs as the server command and .output/ as the deployment directory. A patch changeset records the correction.

      Changes: Nitro deployment instructions

      Layer / File(s)Summary
      Update Nitro output paths
      packages/create/src/frameworks/react/hosts/nitro/README.md, packages/create/src/frameworks/solid/hosts/nitro/README.md, .changeset/nitro-server-entry.md
      The React and Solid instructions use .output/server/index.mjs and .output/ instead of the previous dist paths. The changeset records the correction.

      Estimated code review effort: 1 (Trivial) | ~4 minutes

      Change: Bug fix

      Merge Risk: Minimal · up to 417a5

      The corrected Nitro deployment instructions are consistent with the generated application layout, with no merge-blocking risk identified.

      Pre-merge checks: Passed 5
      Check nameStatusExplanation
      Description CheckPassedCheck skipped - CodeRabbit’s high-level summary is enabled.
      Title checkPassedThe title clearly and concisely describes the main change: correcting Nitro server output instructions for the create package.
      Docstring CoveragePassedNo eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
      Linked Issues checkPassedCheck skipped because no linked issues were found for this pull request.
      Out of Scope Changes checkPassedCheck skipped because no linked issues were found for this pull request.
      Full details: Docstring Coverage

      Explanation

      No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

      Finishing Touches
      Generate unit tests (beta)
      • Commit to this branch
      • Create a new PR
      • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

      Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

      Share

      CodeRabbit Verify

      • Run CodeRabbit Verify to test the changes in this pull request.
      Recent review info
      Run configuration
      • Source mode: Auto
      • Repository: Unavailable
      • Branch: Unavailable
      • File: No configuration file from this repository applied
      • Commit: Unavailable
      • Layers: defaults
      • Review profile: CHILL
      • Plan: Advanced
      • Run ID: f28d1d98-30bb-46d8-b23b-3370fbf9f278
      Commits

      Reviewing files that changed from the base of the PR and between fac419e75086fe64418ed432181b1c387d5c3221 and 417a526758944dd30415d6bbe5c0c74b24f124df.

      Files selected for processing: 3
      • .changeset/nitro-server-entry.md
      • packages/create/src/frameworks/react/hosts/nitro/README.md
      • packages/create/src/frameworks/solid/hosts/nitro/README.md

      Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

    3. tannerlinsley merged thisf63f296

    4. tannerlinsley closed this

Sign in to join this conversation.