remark-config-inspector

2.2.2 verified Fri May 01 auth: no javascript

A visual tool for inspecting and understanding remark and remark-lint configurations. v2.2.2 is the latest stable release as of April 2026, with active development and monthly releases. It helps developers see which config items are active, where rule states come from, how overrides and file globs affect resolution, and how final rule behavior is composed. Unlike manual debugging, it provides an interactive web UI and static build output for CI. Requires remark-lint ^10.0.0 || ^11.0.0 and Node >=20.19.0.

Common errors

error Error [ERR_REQUIRE_ESM]: require() of ES Module ↓

cause Using require() on an ESM-only package.

fix

Replace require() with import or use dynamic import().

error TypeError: remarkConfigInspector is not a function ↓

cause Importing the default export incorrectly with CommonJS or destructuring.

fix

Use import remarkConfigInspector from 'remark-config-inspector' (default export).

error Error: Cannot find module 'remark-lint' ↓

cause Missing peer dependency remark-lint.

fix

Install remark-lint: npm install remark-lint

Warnings

breaking Node >=20.19.0 required; earlier versions will fail with syntax errors. ↓

fix Upgrade Node to >=20.19.0

breaking v2 dropped CommonJS support; all exports are ESM-only. ↓

fix Use import syntax instead of require(). If needed, use dynamic import().

deprecated Environment variable ESLINT_BASE_PATH is legacy and will be removed in a future version. ↓

fix Use REMARK_BASE_PATH or REMARK_CONFIG instead.

gotcha If neither --file nor --target is provided, the inspector uses 'remark-inspector-target.md'. This may not reflect actual project config resolution. ↓

fix Always specify --target pointing to a real file in your project.

gotcha The static build outputs to '.remark-config-inspector' by default; this directory may be git-ignored inadvertently. ↓

fix Explicitly set --outDir or add to .gitignore as needed.

Install

npm install remark-config-inspector

yarn add remark-config-inspector

pnpm add remark-config-inspector

Imports

default

wrong

const remarkConfigInspector = require('remark-config-inspector')

correct

import remarkConfigInspector from 'remark-config-inspector'

ESM-only since v2; requires Node >=20.19.0

build

wrong

const { build } = require('remark-config-inspector')

correct

import { build } from 'remark-config-inspector'

Named export for static build; CJS not supported

types
```
import type { Options } from 'remark-config-inspector'
```
TypeScript types are included; use import type for type-only imports

Quickstart

Shows how to start the inspector programmatically with a custom config, base path, and target file.

// Start the inspector server for the current project
import { startInspector } from 'remark-config-inspector';

await startInspector({
  config: '.remarkrc.yaml',
  basePath: process.cwd(),
  target: 'docs/guide.md'
});
// Ope n http://localhost:9999 to explore config