Registry / devops / remark-config-inspector

remark-config-inspector

library2.2.2jsnpmunverified

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.

devops testing

npm install remark-config-inspector

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · REMARK-CONFIG-INSP

remark-config-inspector

devopsjavascriptv2.2.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import remarkConfigInspector from 'remark-config-inspector'

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

ESM-only since v2; requires Node >=20.19.0

build

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

✗ const { build } = require('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

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

Debug

Known issues

breakingNode >=20.19.0 required; earlier versions will fail with syntax errors.

fix

Upgrade Node to >=20.19.0

affects: >=2.0.0

breakingv2 dropped CommonJS support; all exports are ESM-only.

fix

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

affects: >=2.0.0

deprecatedEnvironment variable ESLINT_BASE_PATH is legacy and will be removed in a future version.

fix

Use REMARK_BASE_PATH or REMARK_CONFIG instead.

affects: >=2.0.0

gotchaIf 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.

affects: >=1.0.0

gotchaThe 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.

affects: >=2.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module

Using require() on an ESM-only package.

fix

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

TypeError: remarkConfigInspector is not a function

Importing the default export incorrectly with CommonJS or destructuring.

fix

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

Error: Cannot find module 'remark-lint'

Missing peer dependency remark-lint.

fix

Install remark-lint: npm install remark-lint

Upgrade

Version history

2.2.2latest on npm

Audit

Dependencies

remark-lintrequiredpeer dependency needed to inspect remark-lint configuration

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/Nick2bad4u/remark-config-inspector ↗

packagehttps://www.npmjs.com/package/remark-config-inspector ↗

homepagehttps://unified.plus ↗