docs: Document Next.js @ alias fallback behavior#38
Open
lightninglu10 wants to merge 1 commit intomainfrom
Open
docs: Document Next.js @ alias fallback behavior#38lightninglu10 wants to merge 1 commit intomainfrom
lightninglu10 wants to merge 1 commit intomainfrom
Conversation
Add comprehensive JSDoc comments explaining the automatic @ alias detection in the webpack plugin's getAliasMap method. The fallback behavior: - Only activates when no @ alias is found in tsconfig or webpack config - Assumes Next.js convention: @/* -> ./src/* - Requires a src directory to exist in the project root This documentation helps users understand: - When the auto-detection applies - How to override it for non-Next.js projects - The recommended approach using tsconfig.json paths 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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.
Summary
getAliasMapmethodChanges
The webpack plugin has a fallback that auto-detects the
@alias for Next.js projects. This PR adds detailed documentation explaining:When the fallback activates:
What it does:
@/*→./src/*import { Button } from "@/components/Button"How to override it:
{ "compilerOptions": { "paths": { "@/*": ["./app/*"] } } }Test Plan
🤖 Generated with Claude Code