docs: Correct dependency type and externals explanation in Authoring Libraries guide#8131
Closed
Abhishekgupta1215 wants to merge 1 commit intowebpack:mainfrom
Closed
docs: Correct dependency type and externals explanation in Authoring Libraries guide#8131Abhishekgupta1215 wants to merge 1 commit intowebpack:mainfrom
Abhishekgupta1215 wants to merge 1 commit intowebpack:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Member
|
Duplicate of #8094 |
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
2 participants
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.
Closes #6896
Motivation
This PR fixes incorrect guidance in the Authoring Libraries guide around dependency classification for lodash.
The guide previously suggested installing lodash as a dev dependency and described it as a peer dependency when externalized. Since lodash is directly imported by library source code, it should be documented as a regular dependency. The externals configuration should be explained as a bundling strategy, not a dependency-type rule.
What changed
Updated install instructions to:
keep webpack and webpack-cli in devDependencies
install lodash as a regular dependency
Replaced wording that implied lodash should be a peer dependency
Clarified externals behavior:
lodash is not bundled into library output
consumer bundlers can deduplicate lodash
script-tag consumers must provide lodash separately
What kind of change does this PR introduce?
docs
Did you add tests for your changes?
No. This is a documentation-only change and does not modify runtime behavior.
Does this PR introduce a breaking change?
No.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
This PR itself updates the relevant documentation in the Authoring Libraries guide, so no additional follow-up docs are required.
Use of AI
Yes. I used AI assistance to help draft and refine documentation wording and structure. I reviewed all generated text, checked its technical correctness, and made final decisions manually.