This repository was archived by the owner on Mar 9, 2026. It is now read-only.
refactor: TypeScript config improvements and code quality fixes#63
Merged
refactor: TypeScript config improvements and code quality fixes#63
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add explicit `: ReadonlySet<string>` annotation (required by isolatedDeclarations) - Upgrade from Set<string> to ReadonlySet<string> to prevent accidental mutation - Remove redundant `<string>` generic and `as const satisfies readonly string[]` Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The removeComments option was redundant — minifiers (terser, esbuild, oxc) strip comments from JS output regardless of this flag. Removing it lets bundlers preserve JSDoc in generated .d.ts files, improving IDE hover experience for library consumers. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The comment was an internal note pointing to AGENTS.md without a link, which leaked into dist/index.d.ts and was meaningless to library consumers. The parse() function already carries a proper @see link to AGENTS.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Move `import type { ParseResult }` to the top of the file per convention.
Simplify `export type { ParseResult } from "..."` to `export type { ParseResult }`
since the import already declares the source.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #63 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 23 23
Branches 5 5
=========================================
Hits 23 23 🚀 New features to boost your workflow:
|
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Tooling and TypeScript configuration improvements identified during bundler experiments on this branch.
No changes to runtime behavior or public API.
Type of Change
Boundary Checklist
📘 AGENTS.md
Security & API Stability
parse,ParseResult,ParseIssue,IssueCode)Changes
TypeScript Config
isolatedDeclarations: trueenabled — prep for Oxc-based.d.tsgenerationisolatedDeclarations: falseoverride added totsconfig.examples.json(examples don't emit.d.ts)removeCommentsremoved — redundant since minifiers handle it; JSDoc now preserved in.d.tsPackage Config
sideEffects: falseadded for reliable tree-shakingCode Quality
FORBIDDEN_KEYS: changed toReadonlySet<string>— stronger immutability, prevents.add()/.delete()/.clear()at the type levelsrc/index.ts: removed internal JSDoc comment that leaked into.d.tsas a meaningless note to consumerssrc/index.ts: movedimportto top per convention; simplified re-export fromfrom "..."formTesting
bun run check:type:sourcepassesbun run testpassesbun run buildpasses🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com