Skip to content

Restore portable compatibility alias - #23

Closed
tannerlinsley wants to merge 2 commits into
mainfrom
taren/universal-compatibility
Closed

Restore portable compatibility alias#23
tannerlinsley wants to merge 2 commits into
mainfrom
taren/universal-compatibility

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

  • restore the published @tanstack/charts/portable entry as a thin alias of @tanstack/charts/universal
  • keep the browser-oriented root and preferred /universal entry unchanged
  • verify source and packed declaration/runtime compatibility across /portable, /universal, and /types
  • carry the restoration as a patch changeset after the 0.3.1 release

Compatibility

This is additive and non-breaking. It restores the /portable surface published in 0.1.0 and absent from 0.2.0 through 0.3.1. Existing root, /universal, and /types consumers are unchanged.

Validation

  • pnpm validate — all 17 targets; 121 test files and 646 tests
  • pnpm benchmark:check
  • pnpm changeset status --since=origin/main — patch release
  • packed /universal consumer: 84.30 kB minified / 26.55 kB gzip
  • comparison bundle matrix unchanged against the 0.3.1 baseline

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The package restores /portable as an alias for /universal. Export tests and packed-consumer checks cover the entry. Documentation, release records, comparison evidence, and synchronization requirements are updated.

Changes

Portable compatibility export

Layer / File(s) Summary
Portable export and validation
packages/charts-core/package.json, packages/charts-core/src/portable.ts, packages/charts-core/src/exports.test.ts, scripts/check-packed-consumers.mjs
The package publishes /portable and maps it to a barrel that re-exports /universal. Tests and declaration checks validate the matching exports.
Compatibility documentation and release records
.changeset/portable-compatibility.md, CHANGELOG.md, docs/installation.md, packages/charts-core/docs/installation.md, docs/reference/index.md, packages/charts-core/docs/reference/index.md
Documentation identifies /portable as a compatibility alias and /universal as the preferred environment-neutral entry.
Release synchronization and comparison evidence
API-FRICTION.md, benchmarks/comparison/bundle-baseline.json, docs/comparison.md, packages/charts-core/docs/comparison.md
Release synchronization rules, packed-entry verification, workspace revision references, and bundle baseline links are updated.

Estimated code review effort: 2 (Simple) | ~10 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Consumer
  participant PackageExports
  participant portable.ts
  participant universal.ts
  Consumer->>PackageExports: Import `@tanstack/charts/portable`
  PackageExports->>portable.ts: Resolve portable entry
  portable.ts->>universal.ts: Re-export universal members
  Consumer-->>PackageExports: Receive universal-compatible exports
Loading

Possibly related PRs

  • TanStack/charts#8: This PR restores and validates the portable entry introduced there.
  • TanStack/charts#20: This PR follows the universal entry changes by restoring portable compatibility.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: restoring the portable compatibility alias.
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/universal-compatibility

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

Comment @coderabbitai help to get the list of available commands.

@tannerlinsley
tannerlinsley force-pushed the taren/universal-compatibility branch 5 times, most recently from d45afbd to 521392c Compare July 31, 2026 21:59
@tannerlinsley
tannerlinsley force-pushed the taren/universal-compatibility branch from 521392c to a0fb632 Compare July 31, 2026 22:22
@tannerlinsley

Copy link
Copy Markdown
Member Author

Closing this compatibility-only PR. The project is pre-1.0, so /universal remains the sole cross-runtime entry and /portable will not be restored. #11 is now stacked directly on main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant