markdownlint-cli2

What is markdownlint-cli2?

markdownlint-cli2 is a command-line interface for the markdownlint library, which is used to lint Markdown files. It helps ensure that Markdown files adhere to a consistent style and are free of common errors.

What are markdownlint-cli2's main functionalities?

Linting Markdown Files

This command lints all Markdown files in the current directory and its subdirectories. It checks for common issues and style inconsistencies in Markdown files.

npx markdownlint-cli2 '**/*.md'

Using a Configuration File

This command uses a configuration file (.markdownlint.json) to specify custom linting rules. This allows for more granular control over the linting process.

npx markdownlint-cli2 '**/*.md' --config .markdownlint.json

Fixing Issues Automatically

This command not only lints the Markdown files but also attempts to fix any issues it finds automatically. This can save time by correcting common mistakes without manual intervention.

npx markdownlint-cli2-fix '**/*.md'

Ignoring Files

This command lints all Markdown files but ignores those in the node_modules directory. This is useful for excluding third-party files from the linting process.

npx markdownlint-cli2 '**/*.md' --ignore node_modules

Other packages similar to markdownlint-cli2

remark-cli

remark-cli is a command-line interface for the remark library, which is used to process Markdown files. It offers similar functionality to markdownlint-cli2, including linting and formatting, but is part of the larger unified ecosystem, which provides a wide range of plugins for additional processing tasks.

markdownlint

markdownlint is the core library that markdownlint-cli2 is based on. It provides the underlying linting functionality and can be used programmatically within Node.js applications. While it does not offer a command-line interface out of the box, it can be integrated into custom scripts and build processes.

mdlint

mdlint is another Markdown linter that focuses on simplicity and ease of use. It provides a basic set of linting rules and can be used as a command-line tool. While it may not be as feature-rich as markdownlint-cli2, it is a good option for users who need a straightforward linting solution.

README

markdownlint-cli2

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library

Install

npm install markdownlint-cli2 --save-dev

Overview

Note: markdownlint-cli2 is under development and is not yet as capable as markdownlint-cli.

• markdownlint is a library for linting Markdown/ CommonMark files on Node.js.
• markdownlint-cli is a traditional command-line interface for markdownlint.
• markdownlint-cli2 is a slightly unconventional command-line interface for markdownlint.
• markdownlint-cli2 is configuration-based and prioritizes both speed and simplicity.
• markdownlint-cli2 is mostly compatible with the features of markdownlint-cli.
• vscode-markdownlint is a markdownlint extension for the Visual Studio Code editor.
• markdownlint-cli2 is meant to work well in conjunction with vscode-markdownlint.

Use

markdownlint-cli2 version X.Y.Z by David Anson (https://dlaa.me/)
https://github.com/DavidAnson/markdownlint-cli2

Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN]

Glob expressions (from the globby library):
- * matches any number of characters, but not /
- ? matches a single character, but not /
- ** matches any number of characters, including / (when it's the only thing in a path part)
- {} allows for a comma-separated list of "or" expressions
- ! or # at the beginning of a pattern negate the match

Configuration:
- Via .markdownlint-cli2.jsonc, .markdownlint.jsonc, .markdownlint.json, .markdownlint.yaml, or .markdownlint.yml

Cross-platform compatibility:
- UNIX and Windows shells expand globs according to different rules, so quoting glob arguments is recommended
- Shells that expand globs do not support negated patterns (!node_modules), so quoting negated globs is required
- Some Windows shells do not handle single-quoted (') arguments correctly, so double-quotes (") are recommended
- Some UNIX shells handle exclamation (!) in double-quotes specially, so hashtag (#) is recommended for negated globs
- Some shells use backslash (\) to escape special characters, so forward slash (/) is the recommended path separator

Therefore, the most compatible syntax for cross-platform support:
markdownlint-cli2 "**/*.md" "#node_modules"

Exit Codes

• 0: Linting was successful and there were no errors
• 1: Linting was successful and there were errors
• 2: Linting was not completed due to a runtime issue

Rule List

• See the Rules / Aliases and [Tags][markdownlint-tags] sections of the markdownlint documentation.

Glob expressions

• Globbing is performed by the globby library; refer to that documentation for more information and examples.

Configuration

• See the Configuration section of the markdownlint documentation for information about the inline comment syntax.

.markdownlintignore

• The format of this file is similar to .npmignore and consists of one glob pattern per line.
• These glob patterns are negated (by adding a leading !) and appended to the end of the command-line arguments.
• Blank lines and lines that begin with the # character are ignored.

.markdownlint-cli2.jsonc

• The format of this file type is a JSONC object similar to the markdownlint options object.
• Valid properties are:
  • config: The markdownlint config object
    • If a jsonc/json/yaml/yml file (see below) is present in the same directory, it overrides this value.
• Settings in this file apply to the directory it is in and all subdirectories
• Settings merge with those applied by any copies of this file in a parent directory.

.markdownlint.jsonc / .markdownlint.json

• The format of this file type is a JSON or JSONC object matching the markdownlint config object.
• Settings in this file apply to the directory it is in and all subdirectories
• Settings override those applied by any copies of this file in a parent directory.
• If both files are present in the same directory, the jsonc version takes precedence.
• To merge the settings of these files or share configuration, use the extends property (documented above).
• Both extensions support comments in JSON.

.markdownlint.yaml / .markdownlint.yml

• The format of this file type is a YAML object representing markdownlint's config object.
• Other details are the same as for jsonc/json files described above.
• If both files are present in the same directory, the yaml version takes precedence.
• If a jsonc or json file is present, it takes precedence according the rules above.

Compatibility

markdownlint-cli

• The glob implementation and handling of patterns is different.
• The treatment of .markdownlintignore patterns is different.
• Configuration files are supported in each directory (vs. one globally).
• The INI config format and .markdownlintrc are not supported.

vscode-markdownlint

• The treatment of .markdownlintignore patterns is different.
• .markdownlintrc is not supported as a configuration file.

History

• 0.0.2 - Initial release