remark-lint/doc/rules.md

Rules

This document describes how to configure rules and lists all available official rules. Each rule is a separate package. See their readme’s for more information.

Table of Contents

• Configuration
• List of Rules

Configuration

false turns rules off — the code no longer runs:

remark()
  .use(require('remark-lint-final-newline'), false)
  // ...

true turns a rule on again:

remark()
  .use(require('remark-lint-final-newline'), true)
  // ...

Rules can be configured with a severity too. The following is ignores all messages from the plugin:

remark()
  .use(require('remark-lint-final-newline'), [0])
  // ...

...and passing [1] explicitly sets the normal behaviour (warn for problems). To trigger an error instead of a warning, pass 2:

remark()
  .use(require('remark-lint-final-newline'), [2])
  // ...

It’s also possible to pass both a severity and configuration:

remark()
  .use(require('remark-lint-maximum-line-length'), [2, 70])
  // ...

Lastly, strings can also be passed, instead of numbers: off instead of 0, warn or on instead of 1, and error instead of 2.

remark()
  .use(require('remark-lint-maximum-line-length'), ['error', 70])
  // ...

List of Rules

This lists contains all “official” rules, developed in this repository. For rules developed outside of this repo, view the List of External Rules.

• blockquote-indentation — warn when blockquotes are either indented too much or too little
• checkbox-character-style — warn when list item checkboxes violate a given style
• checkbox-content-indent — warn when list item checkboxes are followed by too much white-space
• code-block-style — warn when code-blocks do not adhere to a given style
• definition-case — warn when definition labels are not lower-case
• definition-spacing — warn when consecutive white space is used in a definition
• emphasis-marker — warn when emphasis markers violate the given style
• fenced-code-flag — warn when fenced code blocks occur without language flag
• fenced-code-marker — warn when fenced code markers violate the given style
• file-extension — warn when the file’s extension violates the given style
• final-definition — warn when definitions are not placed at the end of the file
• final-newline — warn when a newline at the end of a file is missing
• first-heading-level — warn when the first heading has a level other than a specified value
• hard-break-spaces — warn when too many spaces are used to create a hard break
• heading-increment — warn when headings increment with more than 1 level at a time
• heading-style — warn when heading style violates the given style
• link-title-style — warn when link and definition titles occur with incorrect quotes
• list-item-bullet-indent — warn when list item bullets are indented
• list-item-content-indent — warn when the content of a list item has mixed indentation
• list-item-indent — warn when the spacing between a list item’s bullet and its content violates a given style
• list-item-spacing — warn when list looseness is incorrect
• maximum-heading-length — warn when headings are too long
• maximum-line-length — warn when lines are too long
• no-auto-link-without-protocol — warn for angle-bracketed links without protocol
• no-blockquote-without-caret — warn when blank lines without carets are found in a blockquote
• no-consecutive-blank-lines — warn for too many consecutive blank lines
• no-duplicate-definitions — warn on duplicate definitions
• no-duplicate-headings — warn on duplicate headings
• no-duplicate-headings-in-section — warn on duplicate headings in a section
• no-emphasis-as-heading — warn when emphasis or importance is used instead of a heading
• no-empty-url — warn on empty URLs in links and images
• no-file-name-articles — warn when file name start with an article
• no-file-name-consecutive-dashes — warn when file names contain consecutive dashes
• no-file-name-irregular-characters — warn when file names contain irregular characters
• no-file-name-mixed-case — warn when file names use mixed case
• no-file-name-outer-dashes — warn when file names contain initial or final dashes
• no-heading-content-indent — warn when heading content is indented
• no-heading-indent — warn when headings are indented
• no-heading-like-paragraph — for too many hashes (h7+ “headings”)
• no-heading-punctuation — warn when headings end in illegal characters
• no-html — warn when HTML nodes are used
• no-inline-padding — warn when inline nodes are padded with spaces
• no-literal-urls — warn when URLs without angle-brackets are used
• no-missing-blank-lines — warn when missing blank lines
• no-multiple-toplevel-headings — warn when multiple top-level headings are used
• no-reference-like-url — warn when URLs are also defined identifiers
• no-shell-dollars — warn when shell code is prefixed by dollars
• no-shortcut-reference-image — warn when shortcut reference images are used
• no-shortcut-reference-link — warn when shortcut reference links are used
• no-table-indentation — warn when tables are indented
• no-tabs — warn when hard tabs are used instead of spaces
• no-undefined-references — warn when references to undefined definitions are found
• no-unused-definitions — warn when unused definitions are found
• ordered-list-marker-style — warn when the markers of ordered lists violate a given style
• ordered-list-marker-value — warn when the marker value of ordered lists violates a given style
• rule-style — warn when horizontal rules violate a given style
• strong-marker — warn when importance (strong) markers violate the given style
• table-cell-padding — warn when table cells are incorrectly padded
• table-pipe-alignment — warn when table pipes are not aligned
• table-pipes — warn when table rows are not fenced with pipes
• unordered-list-marker-style — warn when markers of unordered lists violate a given style