chore: drop comments from tsconfig.json, moving their substance to CONTRIBUTING - #18
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes explanatory comments from packages/entity/tsconfig.json (keeping it plain JSON) and relocates the durable rationale into CONTRIBUTING.md, aligning with how tsconfig.consumer.json is treated and making the reasoning easier to discover and maintain.
Changes:
- Dropped now-unneeded comments from
packages/entity/tsconfig.json, leaving a clean JSON-only config. - Added/expanded CONTRIBUTING documentation for the “consumer pass”, publishing-related TS settings, and why
*.test-d.tsis excluded from the maintscpass. - Added a patch changeset documenting this documentation-only move (and explicitly noting the stale TS4020 block was intentionally not relocated).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/entity/tsconfig.json | Removes embedded rationale comments while preserving the effective compiler settings. |
| CONTRIBUTING.md | Documents the consumer-typecheck fixture and publishing/typecheck rationale previously kept in tsconfig comments. |
| .changeset/tsconfig-comments.md | Adds a patch changeset describing the documentation-only migration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Matches the treatment
tsconfig.consumer.jsongot — plain JSON, with thereasoning kept where it can be read.
One block was stale, not relocated
The largest comment described a consumer-side hazard that no longer exists:
#13 replaced
CtorKeywith the exportedConstructionKey, so consumers nolonger get TS4020 — there is a fixture in CI that fails if they ever do again.
CtorKeydoes not exist, and thetypes.tscomment it complains about wasrewritten in the same PR. Dropped rather than moved.
The rest moved to CONTRIBUTING
Two new subsections under "The gate":
tsconfig.consumer.jsonis for, and why both ofits overrides are load-bearing. This is where the TS4020 story lives now:
as a description of the guard rather than a warning about a live bug.
declarationMapis off (files: ["dist"]excludes
src/, so published maps would be dead-ends), and the non-obviouspart:
tsdownreads that tsconfig for its--dtsemit, so those settingsshape the published types while the plain
tscpass isnoEmit.The
excludenote about*.test-d.tsjoins the existing "Type-level tests"section, which also loses a reference to
add— renamedcomputedin #10.Gate
format --check,lint,typecheck(three passes),test(120, 11 files),knip,build— all green.