docs: Document tsconfig parsing limitations in webpack plugin #40
Conversation
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
Add comprehensive JSDoc comments to the getAliasMap method explaining: - Why regex parsing is used instead of JSON.parse (TypeScript allows JSON5 syntax with comments and trailing commas) - Known limitations including multi-line paths, extends support, JSON5 edge cases, and complex path patterns - Fallback behavior when parsing fails (Next.js convention of @ -> src) The regex-based approach is necessary to handle tsconfig.json files with comments, but has limitations that developers should be aware of when debugging alias resolution. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
❇️ CodePress Review Summary
👋 Hey team,
Overall the changes look great! No specific issues found.
Here's the quick rundown:
✅ Decision: APPROVE
Changes are documentation-only and improve clarity without impacting runtime behavior; no blocking issues identified.
Contributor
Author
|
Closing in favor of a better approach - using tsconfig-paths library instead of documenting limitations |
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.
Summary
Adds comprehensive documentation to the
getAliasMapmethod insrc/webpack-plugin.tsexplaining the limitations of the regex-based tsconfig.json parsing approach.Changes
Added detailed JSDoc comments to
getAliasMapmethod explaining:extendsfield to resolve inherited path mappings"@/*": ["./src/*"]@->src) if parsing failsAdded inline comment clarifying regex assumptions about single-line path objects
Why This Matters
The regex-based parsing is necessary but has trade-offs. This documentation helps developers:
Test Plan
🤖 Generated with Claude Code