docs: describe every option, and migrating from fork-ts-checker - #339
Merged
Merged
Conversation
`checks` is the one option the plugin requires and the only one with no entry of its own, so it has one — what an entry may be, and that naming a tool twice runs it twice. A table above them lists every option there is, which layer it belongs to and what it decides. The typescript check covers what `fork-ts-checker-webpack-plugin` does, so migrating from it is written out option by option, the four it has no answer for included: a forked process's `memoryLimit` and `profile`, switching a kind of diagnostic off, and an issue predicate of your own. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GzZci4NQeiqwdrVfd7dGXy
This was referenced Sep 13, 2026
This was referenced Sep 13, 2026
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
1 participant
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
Read every schema against the README: of the 23 options the plugin takes, one had no entry of its own —
checks, the only one it requires. It has one now, saying what an entry may be (a name, or an object withuse), that naming a tool twice runs it twice, and thatusealso takes an adapter.Above them, an Every option table: each option, the layer it belongs to (plugin, shared, per check) and what it decides, so the whole surface reads in one screen. Every in-page link in the README was checked against the anchors GitHub generates — none are broken, and none rely on a numbered anchor that a later section would shift.
And a third migration section, From
fork-ts-checker-webpack-plugin, written option by option against its 9.1.0 types rather than from memory — including the four it has no answer for here:memoryLimitandprofile(this check is not a forked process — the program is kept between rebuilds instead), a switch per kind of diagnostic (ignoreDiagnosticsdrops by code), and an issue predicate of your own.What kind of change does this PR introduce?
docs
Did you add tests for your changes?
n/a — documentation only.
lintcovers it: Prettier and cspell read every Markdown file.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 is the documentation; the webpack.js.org page wants the same after release.
Use of AI
Claude Code compared the schemas with the README, read
fork-ts-checker-webpack-plugin@9.1.0's own type declarations for the migration table, checked every anchor, and wrote this description; I reviewed all of it.🤖 Generated with Claude Code
https://claude.ai/code/session_01GzZci4NQeiqwdrVfd7dGXy
Generated by Claude Code