remark-lint
This linter has been temporary disabled in this version
remark-lint documentation
- Version in MegaLinter: 14.0.2
- Visit Official Web Site
- See How to configure remark-lint rules
- If custom
.remarkrc
config file is not found, .remarkrc will be used
- If custom
- See How to disable remark-lint rules in files
- See Index of problems detected by remark-lint
Configuration in MegaLinter
- Enable remark-lint by adding
MARKDOWN_REMARK_LINT
in ENABLE_LINTERS variable - Disable remark-lint by adding
MARKDOWN_REMARK_LINT
in DISABLE_LINTERS variable
- Enable auto-fixes by adding
MARKDOWN_REMARK_LINT
in APPLY_FIXES variable
Variable | Description | Default value |
---|---|---|
MARKDOWN_DEFAULT_STYLE | For remark-lint to be active, MARKDOWN_DEFAULT_STYLE must be remark-lint |
markdownlint |
MARKDOWN_REMARK_LINT_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src\|lib) |
Include every file |
MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test\|examples) |
Exclude no file |
MARKDOWN_REMARK_LINT_CLI_LINT_MODE | Override default CLI lint mode - file : Calls the linter for each file- list_of_files : Call the linter with the list of files as argument- project : Call the linter from the root of the project |
file |
MARKDOWN_REMARK_LINT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".md"] |
MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"] |
Include every file |
MARKDOWN_REMARK_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None |
MARKDOWN_REMARK_LINT_POST_COMMANDS | List of bash commands to run after the linter | None |
MARKDOWN_REMARK_LINT_CONFIG_FILE | remark-lint configuration file nameUse LINTER_DEFAULT to let the linter find it |
.remarkrc |
MARKDOWN_REMARK_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
MARKDOWN_REMARK_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | true |
MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | 0 |
IDE Integration
Use remark-lint in your favorite IDE to catch errors before MegaLinter !
IDE | Extension Name | Install | |
---|---|---|---|
Atom | linter-remark | Visit Web Site | |
Sublime Text | SublimeLinter-contrib-remark-lint | Visit Web Site | |
vim | ale | Visit Web Site | |
Visual Studio Code | vscode-remark-lint | Visit Web Site |
MegaLinter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
all | Default MegaLinter Flavor | 101 |
Behind the scenes
How are identified applicable files
- File extensions:
.md
How the linting is performed
- remark-lint is called one time by identified file
Example calls
remark --frail myfile.md
remark --frail --rc-path .remarkrc myfile.md
remark --frail -o --rc-path .remarkrc myfile.md
Help content
Usage: remark [options] [path | glob ...]
Command line interface to inspect and change markdown files with remark
Options:
-h --help output usage information
-v --version output version number
-o --output [path] specify output location
-r --rc-path <path> specify configuration file
-i --ignore-path <path> specify ignore file
-s --setting <settings> specify settings
-e --ext <extensions> specify extensions
-u --use <plugins> use plugins
-w --watch watch for changes and reprocess
-q --quiet output only warnings and errors
-S --silent output only errors
-f --frail exit with 1 on warnings
-t --tree specify input and output as syntax tree
--report <reporter> specify reporter
--file-path <path> specify path to process as
--ignore-path-resolve-from dir|cwd resolve patterns in `ignore-path` from its directory or cwd
--ignore-pattern <globs> specify ignore patterns
--silently-ignore do not fail when given ignored files
--tree-in specify input as syntax tree
--tree-out output syntax tree
--inspect output formatted syntax tree
--[no-]stdout specify writing to stdout (on by default)
--[no-]color specify color in report (on by default)
--[no-]config search for configuration files (on by default)
--[no-]ignore search for ignore files (on by default)
Examples:
# Process `input.md`
$ remark input.md -o output.md
# Pipe
$ remark < input.md > output.md
# Rewrite all applicable files
$ remark . -o
Installation on mega-linter Docker image
- NPM packages (node.js):