Repository navigation
docs: document specNamespaceObject, resolve.resolver and resolve.fileSystem - #8395
Merged
Merged
Conversation
…System A second pass over schemas/WebpackOptions.json, asking whether each option is documented rather than merely mentioned, left three real gaps once the false positives were checked by hand. module.parser.javascript.specNamespaceObject is new in 5.111.0 and was undocumented. resolve.resolver and resolve.fileSystem are the last two ResolveOptions with no entry; webpack overwrites the latter with the compiler's input filesystem, so the section says so rather than implying it is configurable.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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
A second pass over
schemas/WebpackOptions.json, following #8394 — this time asking whether each option is documented rather than merely mentioned somewhere. Of 978 option paths, 14 had no entry in any form; hand-checking collapsed them to three real gaps (the rest were documented as a shorter-prefix heading, inside a TS type signature, or enumerated in prose).module.parser.javascript.specNamespaceObject— new in 5.111.0, documented nowhere.resolve.resolver— the lastResolveOptionsentry with no section.resolve.fileSystem— likewise, and the section says plainly that webpack overwrites it with the compiler's input filesystem, so configuring it does nothing.Each claim comes from a build rather than from reading the schema: the namespace object differs from the default only in
Object.getPrototypeOf(ns)andObject.isExtensible(ns)(both objects throw on writing to or deleting an export), it takes effect on the imported module and not the importer, aresolve.fileSystemwith no methods still builds cleanly, and a customresolverserves every read whileresolve.aliaskeeps applying through it.What kind of change does this PR introduce?
docs
Did you add tests for your changes?
No — documentation only; prettier, markdownlint, eslint and the jest suite (25 suites / 99 tests / 23 snapshots) all pass.
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?
n/a — this is the documentation. One finding belongs in webpack itself:
WebpackOptionsApplyassignscompiler.inputFileSystemoverresolve.fileSystemfor all three resolvers, so the schema advertises an option that cannot take effect. I am raising that separately.Use of AI
Claude Code was used to write the schema-vs-docs audit and the documentation. Every behavioural statement was checked against a real build — including two of my own drafts that the builds disproved and that were rewritten before this PR.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Cb4AP4BntRzji5vSqhzYWT
Generated by Claude Code