[codex] Document compatibility matrix#68
Conversation
Add a concise compatibility section to the README and package exports documentation covering Bun usage, the Effect peer dependency range, TypeScript support, package entrypoints, and runtime validation assumptions. Include a patch changeset for the documentation update.
Greptile SummaryThis PR adds a compatibility matrix to
Confidence Score: 5/5Pure documentation change with no code modifications; all stated values are consistent with package.json. The change adds two compatibility tables and a changeset file. Every factual claim in the tables (peer dependency range ^3.21.0, TypeScript 5, ESM/CJS exports, Bun-based tooling) is verified by package.json. There are no code paths touched. No files require special attention.
|
| Filename | Overview |
|---|---|
| .changeset/soft-ravens-dance.md | Patch changeset for the compatibility documentation additions. |
| README.md | Adds a Compatibility section with a six-row table covering package manager, Effect peer dependency, TypeScript, module formats, native Effect export, and runtime assumptions; all values match package.json. |
| docs/package-exports.md | Adds a matching Compatibility Matrix section; row wording is slightly more precise than the README equivalent (e.g. 'Root export' instead of 'Module formats') and consistent with the surrounding doc context. |
Reviews (2): Last reviewed commit: "docs: clarify README package manager sup..." | Re-trigger Greptile
Align the README compatibility matrix with the package exports documentation so Bun is scoped to repository development tooling rather than implied as a consumer runtime requirement.
Summary
Documents the package compatibility and runtime support expectations requested by Issue #57.
effectpeer dependency range, TypeScript support, ESM/CJS declarations, thefluent-effect/effectpassthrough export, and Bun-based runtime validation assumptions.docs/package-exports.md, where entrypoint and import guarantees are already documented.Impact
Consumers no longer need to infer package manager, peer dependency, module format, or entrypoint support from
package.json,tsconfig.json, and package smoke tests.Closes #57.
Validation
bun fmtbun lint:fixbun testbun typecheck