Registry / devops / open-md-checker

open-md-checker

library1.2.3jsnpmunverified

Open-md-checker is an open-source, extensible markdown linting tool available as a global npm module (v1.2.3). It checks markdown files for formatting issues using configurable rules from the remark-lint ecosystem. Key differentiators include support for custom rule files, integration with .gitignore, configuration via package.json or environment variables, and optional Docker usage. It offers a flexible Config interface with patterns and options for ignoring files. The tool is stable but has limited recent updates compared to alternatives like markdownlint.

devops testing

npm install open-md-checker

package ↗

INSTALL

IMPORT

SIG · OPEN-MD-CHECKER

open-md-checker

devopsjavascriptv1.2.3

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.

CLI

✓ npx open-md-checker

✗ open-md-checker

Use npx to run without global install; the package is designed as a CLI tool, not a library.

Config

✓ import type { Config } from 'open-md-checker'

Config type is available for TypeScript users; no default export for programmatic use.

default configuration

✓ const config = require('open-md-checker/defaults');

✗ import defaults from 'open-md-checker'

No direct API export; configuration is read from files or environment, not imported.

Shows global install and usage, including environment variable for custom config.

# Install globally npm install -g open-md-checker # Create a markdown file with issues echo '## Title' > test.md # Run the linter open-md-checker # Or use configuration via environment MD_LINT_CONFIG_PATH=./open-md-checker.json open-md-checker

open-md-checker --version

Debug

Known issues

gotchaConfiguration must be placed under 'open-md-checker' key in package.json; reading from a plain config file requires MD_LINT_CONFIG_PATH environment variable.

fix

Use the correct structure: { 'open-md-checker': { patterns: ['**/*.md'], options: {} } }

affects: >=1.0.0

gotchaCustom rules via 'requires' field must be in a CommonJS module (module.exports = [...]); relative paths are resolved from cwd.

fix

Use absolute paths or ensure the file exports an array of remark-lint rules.

affects: >=1.0.0

deprecatedThe package is stable but not actively developed; newer alternatives like markdownlint-cli2 exist.

fix

Consider migrating to markdownlint-cli2 for more features and active maintenance.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Config file not found

The MD_LINT_CONFIG_PATH points to a non-existent or invalid file.

fix

Export the correct path: export MD_LINT_CONFIG_PATH=./valid-config.json

Error: Cannot find module 'remark-lint-final-newline'

Custom rules require module installed; missing in node_modules or dependencies.

fix

Install the required lint rule: npm install remark-lint-final-newline

Upgrade

Version history

1.2.3latest on npm

Audit

Dependencies

deglobrequiredFor file pattern matching and ignoring files based on .gitignore or package.json configuration.

remark-lintrequiredCore linting engine, although not explicitly listed in dependencies, is used via the default requires file.

Agent activity

2 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/open-md-checker ↗