Add rule aliases, support throughout (fixes #1).

README.md

@@ -38,45 +38,45 @@ cases come directly from that project.
 [`markdownlint` demo](http://dlaa.me/markdownlint/), an interactive, in-browser
 playground for learning and exploring.
 
-## Rules
+## Rules / Aliases
 
-* **MD001** - Header levels should only increment by one level at a time
-* **MD002** - First header should be a h1 header
-* **MD003** - Header style
-* **MD004** - Unordered list style
-* **MD005** - Inconsistent indentation for list items at the same level
-* **MD006** - Consider starting bulleted lists at the beginning of the line
-* **MD007** - Unordered list indentation
-* **MD009** - Trailing spaces
-* **MD010** - Hard tabs
-* **MD011** - Reversed link syntax
-* **MD012** - Multiple consecutive blank lines
-* **MD013** - Line length
-* **MD014** - Dollar signs used before commands without showing output
-* **MD018** - No space after hash on atx style header
-* **MD019** - Multiple spaces after hash on atx style header
-* **MD020** - No space inside hashes on closed atx style header
-* **MD021** - Multiple spaces inside hashes on closed atx style header
-* **MD022** - Headers should be surrounded by blank lines
-* **MD023** - Headers must start at the beginning of the line
-* **MD024** - Multiple headers with the same content
-* **MD025** - Multiple top level headers in the same document
-* **MD026** - Trailing punctuation in header
-* **MD027** - Multiple spaces after blockquote symbol
-* **MD028** - Blank line inside blockquote
-* **MD029** - Ordered list item prefix
-* **MD030** - Spaces after list markers
-* **MD031** - Fenced code blocks should be surrounded by blank lines
-* **MD032** - Lists should be surrounded by blank lines
-* **MD033** - Inline HTML
-* **MD034** - Bare URL used
-* **MD035** - Horizontal rule style
-* **MD036** - Emphasis used instead of a header
-* **MD037** - Spaces inside emphasis markers
-* **MD038** - Spaces inside code span elements
-* **MD039** - Spaces inside link text
-* **MD040** - Fenced code blocks should have a language specified
-* **MD041** - First line in file should be a top level header
+* **MD001** *header-increment* - Header levels should only increment by one level at a time
+* **MD002** *first-header-h1* - First header should be a h1 header
+* **MD003** *header-style* - Header style
+* **MD004** *ul-style* - Unordered list style
+* **MD005** *list-indent* - Inconsistent indentation for list items at the same level
+* **MD006** *ul-start-left* - Consider starting bulleted lists at the beginning of the line
+* **MD007** *ul-indent* - Unordered list indentation
+* **MD009** *no-trailing-spaces* - Trailing spaces
+* **MD010** *no-hard-tabs* - Hard tabs
+* **MD011** *no-reversed-links* - Reversed link syntax
+* **MD012** *no-multiple-blanks* - Multiple consecutive blank lines
+* **MD013** *line-length* - Line length
+* **MD014** *commands-show-output* - Dollar signs used before commands without showing output
+* **MD018** *no-missing-space-atx* - No space after hash on atx style header
+* **MD019** *no-multiple-space-atx* - Multiple spaces after hash on atx style header
+* **MD020** *no-missing-space-closed-atx* - No space inside hashes on closed atx style header
+* **MD021** *no-multiple-space-closed-atx* - Multiple spaces inside hashes on closed atx style header
+* **MD022** *blanks-around-headers* - Headers should be surrounded by blank lines
+* **MD023** *header-start-left* - Headers must start at the beginning of the line
+* **MD024** *no-duplicate-header* - Multiple headers with the same content
+* **MD025** *single-h1* - Multiple top level headers in the same document
+* **MD026** *no-trailing-punctuation* - Trailing punctuation in header
+* **MD027** *no-multiple-space-blockquote* - Multiple spaces after blockquote symbol
+* **MD028** *no-blanks-blockquote* - Blank line inside blockquote
+* **MD029** *ol-prefix* - Ordered list item prefix
+* **MD030** *list-marker-space* - Spaces after list markers
+* **MD031** *blanks-around-fences* - Fenced code blocks should be surrounded by blank lines
+* **MD032** *blanks-around-lists* - Lists should be surrounded by blank lines
+* **MD033** *no-inline-html* - Inline HTML
+* **MD034** *no-bare-urls* - Bare URL used
+* **MD035** *hr-style* - Horizontal rule style
+* **MD036** *no-emphasis-as-header* - Emphasis used instead of a header
+* **MD037** *no-space-in-emphasis* - Spaces inside emphasis markers
+* **MD038** *no-space-in-code* - Spaces inside code span elements
+* **MD039** *no-space-in-links* - Spaces inside link text
+* **MD040** *fenced-code-language* - Fenced code blocks should have a language specified
+* **MD041** *first-line-h1* - First line in file should be a top level header
 
 See [Rules.md](doc/Rules.md) for more details.
 
@@ -229,7 +229,7 @@ Type: `Object` mapping `String` to `Boolean | Object`
 
 Configures the rules to use.
 
-Object keys are rule names and values are the rule's configuration.
+Object keys are rule names or aliases and values are the rule's configuration.
 The value `false` disables a rule, `true` enables its default configuration,
 and passing an object customizes its settings. Setting the special `default`
 rule to `true` or `false` includes/excludes all rules by default. Enabling or
@@ -237,7 +237,7 @@ disabling a tag name (ex: `whitespace`) affects all rules having that tag.
 
 The `default` rule is applied first, then keys are processed in order from top
 to bottom with later values overriding earlier ones. Keys (including rule names,
-tags, and `default`) are not case-sensitive.
+aliases, tags, and `default`) are not case-sensitive.
 
 Example:
 
@@ -246,7 +246,7 @@ Example:
   "default": true,
   "MD003": { "style": "atx_closed" },
   "MD007": { "indent": 4 },
-  "MD009": false,
+  "no-hard-tabs": false,
   "whitespace": false
 }
 ```
@@ -276,7 +276,8 @@ Standard completion callback.
 Type: `Object`
 
 Call `result.toString()` for convenience or see below for an example of the
-structure of the `result` object.
+structure of the `result` object. Passing the value `true` to `toString()`
+uses rule aliases (ex: `no-hard-tabs`) instead of names (ex: `MD010`).
 
 ## Usage
 
@@ -300,14 +301,7 @@ markdownlint(options, function callback(err, result) {
 });
 ```
 
-Or invoke `markdownlint.sync` for a synchronous call:
-
-```js
-var result = markdownlint.sync(options);
-console.log(result.toString());
-```
-
-Output of both calls:
+Output:
 
 ```text
 bad.string: 3: MD010 Hard tabs
@@ -318,6 +312,24 @@ bad.md: 1: MD018 No space after hash on atx style header
 bad.md: 3: MD018 No space after hash on atx style header
 ```
 
+Or invoke `markdownlint.sync` for a synchronous call:
+
+```js
+var result = markdownlint.sync(options);
+console.log(result.toString(true));
+```
+
+Output:
+
+```text
+bad.string: 3: no-hard-tabs Hard tabs
+bad.string: 1: no-missing-space-atx No space after hash on atx style header
+bad.string: 3: no-missing-space-atx No space after hash on atx style header
+bad.md: 3: no-hard-tabs Hard tabs
+bad.md: 1: no-missing-space-atx No space after hash on atx style header
+bad.md: 3: no-missing-space-atx No space after hash on atx style header
+```
+
 To examine the `result` object directly:
 
 ```js
@@ -420,7 +432,7 @@ bad.md: 3: MD018 No space after hash on atx style header
 
 ## Browser
 
-`markdownlint` works in the browser.
+`markdownlint` also works in the browser.
 
 Generate normal and minified scripts with: