A visual tool for inspecting and understanding your remark / remark-lint configuration.
It helps you understand:
- which config items are active,
- where rule states come from,
- how overrides and file globs affect resolution,
- and how final rule behavior is composed.
From a project that contains a remark config (.remarkrc* or
package.json#remarkConfig):
npx remark-config-inspector@latestThen open http://localhost:9999/ (If it does not open automatically) to explore your config.
Use a specific target file when you want context-sensitive resolution:
npx remark-config-inspector --target docs/guide.mdIf neither --file nor --target is supplied, the inspector uses a synthetic
target file: remark-inspector-target.md.
remark-config-inspector [options]
remark-config-inspector build [options]--config <configFile>: explicit config file path--basePath <basePath>: root path used for glob resolution--file <filePath>: alias of--target--target <filePath>: file used for effective config resolution--files: include matched file metadata in payload (enabled by default)
To generate a static inspector snapshot:
npx remark-config-inspector buildThis emits a single-page app in .remark-config-inspector.
--base <baseURL>: deployment base URL--outDir <dir>: output directory (default:.remark-config-inspector)
Primary variables:
REMARK_CONFIG(or legacyESLINT_BASE_PATH)REMARK_BASE_PATH(or legacyESLINT_BASE_PATH)REMARK_TARGET(or legacyESLINT_TARGET)
Run npx remark-config-inspector --help for all options.
Thanks goes to these wonderful people (emoji key):
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4?s=80)
![github-actions[bot]](https://avatars.githubusercontent.com/github-actions%5Bbot%5D?v=4?s=80)
![renovate[bot]](https://avatars.githubusercontent.com/renovate%5Bbot%5D?v=4?s=80)
