lint-md-cli

library0.1.2jsnpmunverified

A command-line tool for linting Chinese markdown files based on AST. Current stable version 0.1.2. Developed by hustcc, it integrates with CI pipelines and Docker. Supports configuring rule severity and excluding files via .lintmdrc. Key differentiator: focused on Chinese writing conventions, built on lint-md package, no breaking changes reported.

testing devops

npm install lint-md-cli

github ↗package ↗

INSTALL

IMPORT

SIG · LINT-MD-CLI

lint-md-cli

testingjavascriptv0.1.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Install globally, then lint or fix markdown files with options for config and auto-fix.

npm install -g lint-md-cli # Check single file lint-md README.md # Check multiple files lint-md README.md Document.md # Fix automatically lint-md README.md --fix # Custom config lint-md README.md -c .lintmdrc

lint-md --version

Debug

Known issues

gotchaGlobal install required for CLI use; not found when installed locally.

fix

Install globally via npm i -g lint-md-cli or use npx lint-md-cli.

affects: >=0.0.0

gotchaRules configured in .lintmdrc must match lint-md package rules exactly.

fix

Refer to https://github.com/hustcc/lint-md/tree/master/packages/lint-md for valid rule names.

affects: >=0.0.0

deprecatedThe package may not be actively maintained; last update 2020.

fix

Consider alternatives like markdownlint or remark-lint for broader support.

affects: >=0.0.0

Errors

Common errors & fixes

bash: lint-md: command not found

Package not installed globally.

fix

Run npm install -g lint-md-cli

Error: Cannot find module 'lint-md'

Missing dependency lint-md, not installed automatically.

fix

Run npm install lint-md (use lint-md package) alongside lint-md-cli

Unknown option: --fix

Older version without fix support; or misspelled option.

fix

Upgrade to latest version (0.1.2) and use --fix as shown in help.

Upgrade

Version history

0.1.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/hustcc/lint-md ↗

packagehttps://www.npmjs.com/package/lint-md-cli ↗