fix: ship Octane Table source - #6480
Conversation
📝 WalkthroughWalkthroughOctane-table now publishes authored TypeScript/TSRX with source-based exports and declarations. Octane guidance and API links reference authored sources. Examples and workspace release-age exclusions use octane-store 0.12.1. ChangesOctane authored-source distribution
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
|
View your CI Pipeline Execution ↗ for commit d4b704d
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
_artifacts/domain_map.yaml (1)
109-115: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winAlign the generic discovery rule with the Octane exception.
The generic rule still requires
distdeclarations, whileoctane_entrypointcorrectly points to publishedsrc/index.d.ts. Since Octane intentionally distributes authored source withoutdist, update the rule to allow published source for packages with that contract.Proposed wording
- rule: 'For exact exports, option types, state shapes, and instance APIs, inspect dist declarations (.d.ts) in the installed package before inventing an API or relying on memory.' + rule: 'For exact exports, option types, state shapes, and instance APIs, inspect installed declarations (.d.ts), or published authored source when the package intentionally distributes source, before inventing an API or relying on memory.'🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@_artifacts/domain_map.yaml` around lines 109 - 115, Update the generic discovery rule in the rule entry to allow published authored source declarations for packages that intentionally distribute them, while retaining the existing dist-declaration requirement for other packages. Keep the octane_entrypoint value pointing to `@tanstack/octane-table/src/index.d.ts` and align the wording with this exception.
🧹 Nitpick comments (1)
packages/octane-table/package.json (1)
49-49: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winCover authored
.tsrxfiles in lint validation.
test:eslintpasses--ext .ts, so it does not select publishedsrc/*.tsrxfiles. If no repository-level ESLint configuration covers these files, add.tsrxwith the supported parser configuration or add a dedicated lint command.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/octane-table/package.json` at line 49, Update the test:eslint script in package.json to lint authored .tsrx files as well as .ts files, using the repository’s supported ESLint parser/configuration for that extension; if ESLint cannot include both directly, add a dedicated .tsrx lint command to the validation flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@_artifacts/domain_map.yaml`:
- Around line 109-115: Update the generic discovery rule in the rule entry to
allow published authored source declarations for packages that intentionally
distribute them, while retaining the existing dist-declaration requirement for
other packages. Keep the octane_entrypoint value pointing to
`@tanstack/octane-table/src/index.d.ts` and align the wording with this exception.
---
Nitpick comments:
In `@packages/octane-table/package.json`:
- Line 49: Update the test:eslint script in package.json to lint authored .tsrx
files as well as .ts files, using the repository’s supported ESLint
parser/configuration for that extension; if ESLint cannot include both directly,
add a dedicated .tsrx lint command to the validation flow.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: aabc6206-17d7-4d75-b39e-5a084dee7486
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (25)
_artifacts/domain_map.yaml_artifacts/skill_spec.mddocs/framework/octane/quick-start.mddocs/framework/octane/reference/functions/createTableHook.mddocs/framework/octane/reference/functions/useTable.mddocs/framework/octane/reference/variables/Subscribe.mddocs/installation.mdexamples/octane/aggregation/package.jsonexamples/octane/basic-external-atoms/package.jsonexamples/octane/basic-subscribe/package.jsonexamples/octane/composable-tables/package.jsonexamples/octane/pagination/package.jsonexamples/octane/row-selection/package.jsonknip.jsonpackages/octane-table/package.jsonpackages/octane-table/scripts/finalize-types.mjspackages/octane-table/skills/getting-started/SKILL.mdpackages/octane-table/src/Subscribe.tsrx.d.tspackages/octane-table/src/createTableHook.tsrx.d.tspackages/octane-table/src/index.d.tspackages/octane-table/src/useTable.tsrx.d.tspackages/octane-table/tsconfig.build.jsonpackages/octane-table/tsdown.config.tspnpm-workspace.yamlscripts/generateDocs.js
💤 Files with no reviewable changes (4)
- knip.json
- packages/octane-table/tsconfig.build.json
- packages/octane-table/scripts/finalize-types.mjs
- packages/octane-table/tsdown.config.ts
What changed
@tanstack/octane-tablefrom its authored TypeScript and TSRX sourcedistentrypoints,tsdown, and compiled type-finalization plumbingWhy
The Octane compiler is tightly coupled to its runtime and produces target-specific development and production output. Shipping authored TSRX lets each consuming application compile the adapter for its own Octane runtime and client or server target instead of coupling consumers to precompiled adapter output.
Validation
pnpm testacross 393 workspace projectsdistor source mapsSummary by CodeRabbit
New Features
Documentation
Examples