The README should include a best practices section clarifying how effect-tsgo relates to the official tsgo and whether they should be used in parallel or one over the other.
Suggested content
- Relationship:
effect-tsgo is a superset of tsgo — it embeds a pinned version with a small patch set and adds the Effect language service on top
- Usage guidance: Use
effect-tsgo instead of tsgo, not alongside it. Running both produces duplicate diagnostics and degrades editor performance
- Version pinning: Each release is built against a specific upstream
tsgo commit (recorded in flake.nix). No need to track upstream releases separately
- Upgrade guidance: Upgrade
effect-tsgo when a new release includes upstream fixes or new Effect diagnostics you need
🤖 Created by Claude on behalf of @schickling
The README should include a best practices section clarifying how
effect-tsgorelates to the officialtsgoand whether they should be used in parallel or one over the other.Suggested content
effect-tsgois a superset oftsgo— it embeds a pinned version with a small patch set and adds the Effect language service on topeffect-tsgoinstead oftsgo, not alongside it. Running both produces duplicate diagnostics and degrades editor performancetsgocommit (recorded inflake.nix). No need to track upstream releases separatelyeffect-tsgowhen a new release includes upstream fixes or new Effect diagnostics you need