Skip to content

Drop the hosted TanStack add-on once TanStack/cli ships arkenv #2004

Open

Description

@yamcodes

Summary

packages/tanstack-addon and the built-in catalog entry are two copies of the same scaffold. After TanStack/cli#516 is in a published @tanstack/cli, delete the ArkEnv copy and point the docs at the short name.

Context

--add-ons arkenv only works once that pull request is released. Until then the hosted URL is the command that works.

Blocking precondition

blocked until a published @tanstack/cli includes the arkenv add-on from TanStack/cli#516. A merge on that pull request is not enough.

Acceptance criteria

  • Confirm npx @tanstack/cli create my-app --add-ons arkenv works against the published CLI, not a local checkout.
  • Remove packages/tanstack-addon so the catalog copy is the only scaffold.
  • Update apps/www/content/docs/frameworks/tanstack-start.mdx to use npx @tanstack/cli create my-app --add-ons arkenv.
  • Leave the hosted URL in place until that published CLI exists. Older CLIs never learn the short name.

Out of scope

Activity

  1. added
    docsAdds or changes documentation, or acts as documentation in and of itself
    enhancementNew feature or improvement
    wwwImprovements or additions to arkenv.js.org
    on Sep 25, 2026
  2. pullfrog commented on Sep 25, 2026

    @pullfrog
    Contributor

    Evaluation: still blocked — plan is ready, but must not be executed yet

    Blocking precondition is not met

    The issue's gate is "a published @tanstack/cli includes the arkenv add-on". I verified against the published registry and upstream today:

    • TanStack/cli#516 is state: open, merged: false (mergeable_state: unstable).
    • npm latest is @tanstack/cli@0.71.0, which depends on @tanstack/create@0.70.0.
    • @tanstack/create@0.70.0 is the current npm latest — it predates the PR and cannot contain add-ons/arkenv.
    • The catalog add-on lives in @tanstack/create's tree (auto-discovered from packages/create/src/frameworks/react/add-ons/arkenv), so a @tanstack/cli release alone is insufficient; @tanstack/create must be rebuilt and published with the merged PR.

    So --add-ons arkenv still fails for users. The issue's own instruction applies: leave the hosted URL in place until that published CLI exists. No code changes now.

    Unblock check (run before starting any work)

    1. Confirm Version Packages #516 is merged into TanStack/cli and a release cut.
    2. npm view @tanstack/create@latest version — confirm it is newer than 0.70.0, and that the tarball actually contains the add-on (packages/create/.../add-ons/arkenv). A version bump without the add-on is not enough.
    3. In a temp dir, run npx @tanstack/cli@latest create my-app --add-ons arkenv against the published CLI (not a local checkout) and confirm it writes src/env.ts, registers arkenv() in vite.config.ts, emits .env.example, and offers the /demo/arkenv route.

    Only after step 3 passes does this issue become actionable.

    Plan once unblocked

    Docs (do this first, independent of the deletion)

    • apps/www/content/docs/frameworks/tanstack-start.mdx: switch both commands to the short name — line 33 → --add-ons arkenv, line 56 → npx @tanstack/cli add arkenv — and delete the "No catalog id yet" callout (lines 36–39).
    • apps/www/content/blog/arkenv-tanstack-start.mdx (still draft: true): update the "What's available" bullet (lines 27–29) to the short name.
    • Keep the docs Rsbuild callout as-is; that path is still upstream-blocked by feat(create): add Rsbuild as a bundler option TanStack/cli#505 and is explicitly out of scope.

    Delete the mirror

    • Remove packages/tanstack-addon/ in full (package, scripts/build.ts, tests/, .add-on/, README.md, CHANGELOG.md, tsconfig.json, vitest.config.ts). Nothing in the repo consumes it as a workspace dependency — grep -r tanstack-addon finds only self-references plus the bookkeeping below.
    • Drop the workspace entry in .vscode/arkenv.code-workspace (lines 93–96).
    • Delete pending changesets that reference the package or changeset/release will fail on an unknown package: .changeset/tanstack-addon-rc-ranges.md and .changeset/pre/tanstack-addon.md; edit the @arkenv/tanstack-addon entry out of .changeset/pre/enter-rc-channel.md.
    • Regenerate nub.lock with nub install (do not hand-edit).

    Keep the hosted URL working (acceptance criterion)

    • Do not delete apps/www/public/tanstack/**. Those are committed compiled artifacts; once the package is gone they become a frozen snapshot and stop being regenerated, which is exactly what keeps https://arkenv.js.org/tanstack/info.json alive for older CLIs that never learn the short name. Note this in the design doc so the frozen snapshot is not mistaken for drift.

    Bookkeeping

    Verify

    • nub install → nub run check → nub run typecheck → nub run test -- --run (mirror tests go away with the package; confirm the workspace still validates and no tsconfig/turbo/knip/CI reference dangles).
    • Sanity-build www if the MDX edits go beyond the command fences.
    • Single PR against v1. Because this removes a package from the publish set rather than changing published code, confirm whether a changeset is warranted or whether the removal is documentation-only.

    Out of scope (unchanged): editing TanStack/cli#516 and Rsbuild add-on support (TanStack/cli#505 still open).

    Duplicate scan was attempted but the similarity lookup returned a 500; nothing suggests this duplicates a tracked issue, and I left labels as-is (blocked remains correct).

    Pullfrog  | Implement plan ➔ | View workflow run | via Pullfrog | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

  3. added
    blockedWork cannot proceed; waiting on something else
    ready for agentFully specified, ready for immediate implementation
    on Sep 25, 2026
  4. removed
    ready for agentFully specified, ready for immediate implementation
    on Oct 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    blockedWork cannot proceed; waiting on something elsedocsAdds or changes documentation, or acts as documentation in and of itselfenhancementNew feature or improvementwwwImprovements or additions to arkenv.js.org

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions