{"id":26193,"library":"remark-config-inspector","title":"remark-config-inspector","description":"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.","status":"active","version":"2.2.2","language":"javascript","source_language":"en","source_url":"https://github.com/Nick2bad4u/remark-config-inspector","tags":["javascript","@remark","@remark/config-inspector","config","eslint-inspector","inspector","remark","remark-config","remark-config-inspector","typescript"],"install":[{"cmd":"npm install remark-config-inspector","lang":"bash","label":"npm"},{"cmd":"yarn add remark-config-inspector","lang":"bash","label":"yarn"},{"cmd":"pnpm add remark-config-inspector","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency needed to inspect remark-lint configuration","package":"remark-lint","optional":false}],"imports":[{"note":"ESM-only since v2; requires Node >=20.19.0","wrong":"const remarkConfigInspector = require('remark-config-inspector')","symbol":"default","correct":"import remarkConfigInspector from 'remark-config-inspector'"},{"note":"Named export for static build; CJS not supported","wrong":"const { build } = require('remark-config-inspector')","symbol":"build","correct":"import { build } from 'remark-config-inspector'"},{"note":"TypeScript types are included; use import type for type-only imports","wrong":"","symbol":"types","correct":"import type { Options } from 'remark-config-inspector'"}],"quickstart":{"code":"// Start the inspector server for the current project\nimport { startInspector } from 'remark-config-inspector';\n\nawait startInspector({\n  config: '.remarkrc.yaml',\n  basePath: process.cwd(),\n  target: 'docs/guide.md'\n});\n// Ope n http://localhost:9999 to explore config","lang":"typescript","description":"Shows how to start the inspector programmatically with a custom config, base path, and target file."},"warnings":[{"fix":"Upgrade Node to >=20.19.0","message":"Node >=20.19.0 required; earlier versions will fail with syntax errors.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Use import syntax instead of require(). If needed, use dynamic import().","message":"v2 dropped CommonJS support; all exports are ESM-only.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Use REMARK_BASE_PATH or REMARK_CONFIG instead.","message":"Environment variable ESLINT_BASE_PATH is legacy and will be removed in a future version.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Always specify --target pointing to a real file in your project.","message":"If neither --file nor --target is provided, the inspector uses 'remark-inspector-target.md'. This may not reflect actual project config resolution.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Explicitly set --outDir or add to .gitignore as needed.","message":"The static build outputs to '.remark-config-inspector' by default; this directory may be git-ignored inadvertently.","severity":"gotcha","affected_versions":">=2.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Replace require() with import or use dynamic import().","cause":"Using require() on an ESM-only package.","error":"Error [ERR_REQUIRE_ESM]: require() of ES Module"},{"fix":"Use import remarkConfigInspector from 'remark-config-inspector' (default export).","cause":"Importing the default export incorrectly with CommonJS or destructuring.","error":"TypeError: remarkConfigInspector is not a function"},{"fix":"Install remark-lint: npm install remark-lint","cause":"Missing peer dependency remark-lint.","error":"Error: Cannot find module 'remark-lint'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}