docs: use defaults table for mode-specific configuration options#8175
Closed
shivxmsharma wants to merge 1 commit intowebpack:mainfrom
Closed
docs: use defaults table for mode-specific configuration options#8175shivxmsharma wants to merge 1 commit intowebpack:mainfrom
shivxmsharma wants to merge 1 commit intowebpack:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
@alexander-akait Can you give a feedback here? |
Member
|
@shivxmsharma #6356 (comment), we need to replace these things everywhere, not only in one place |
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 #6356
Summary
The documentation currently describes mode-specific configuration defaults using inconsistent inline text (e.g., "enabled in
productionmode and disabled elsewise"). This makes it hard to quickly compare what the default is for each mode.This PR introduces a standardized "defaults table" pattern across all configuration options that have different defaults depending on the
modesetting. It also documents this pattern in the Writer's Guide so future contributors can follow the same format.What kind of change does this PR introduce?
docs
Did you add tests for your changes?
No — this is a documentation-only change with no code changes.
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?
The following options now use a defaults table instead of inline text:
checkWasmTypes,concatenateModules,emitOnErrors,avoidEntryIife,flagIncludedChunks,innerGraph,mangleExports,minimize,nodeEnv,realContentHash,sideEffects,usedExportspathinfocachehintsAll default values were verified against
webpack/lib/config/defaults.js.The Writer's Guide has been updated to document the new pattern so future contributors know to use it.
Use of AI
I used Claude assistant to help research the correct default values from the webpack source code (
webpack/lib/config/defaults.js) and to plan which pages needed updates. All changes were reviewed and applied manually by me.