Remark Config Inspector

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.

Screenshot

Usage

From a project that contains a remark config (.remarkrc* or package.json#remarkConfig):

npx remark-config-inspector@latest

Then open http://localhost:9999/ (If it does not open automatically) to explore your config.

Resolve for a target file

Use a specific target file when you want context-sensitive resolution:

npx remark-config-inspector --target docs/guide.md

If neither --file nor --target is supplied, the inspector uses a synthetic target file: remark-inspector-target.md.

CLI

remark-config-inspector [options]
remark-config-inspector build [options]

Core 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)

Static build

To generate a static inspector snapshot:

npx remark-config-inspector build

This emits a single-page app in .remark-config-inspector.

Static build options

• --base <baseURL>: deployment base URL
• --outDir <dir>: output directory (default: .remark-config-inspector)

Environment variables

Primary variables:

• REMARK_CONFIG (or legacy ESLINT_BASE_PATH)
• REMARK_BASE_PATH (or legacy ESLINT_BASE_PATH)
• REMARK_TARGET (or legacy ESLINT_TARGET)

Run npx remark-config-inspector --help for all options.

License

Apache-2.0

Contributors ✨

Thanks goes to these wonderful people (emoji key):