markdownlint 0.12.0 → 0.14.2

package/.eslintrc.json

@@ -1,277 +1,54 @@
 {
-    "parser": "espree",
-    "parserOptions": {
-        "ecmaVersion": 6
-    },
-    "env": {
-        "node": true,
-        "es6": true
-    },
-    "rules": {
-        "accessor-pairs": "error",
-        "array-bracket-newline": "error",
-        "array-bracket-spacing": ["error", "always"],
-        "array-callback-return": "error",
-        "array-element-newline": "off",
-        "arrow-body-style": "error",
-        "arrow-parens": "error",
-        "arrow-spacing": "error",
-        "block-scoped-var": "error",
-        "block-spacing": "error",
-        "brace-style": "error",
-        "callback-return": "off",
-        "camelcase": "error",
-        "capitalized-comments": "off",
-        "class-methods-use-this": "error",
-        "comma-dangle": "error",
-        "comma-spacing": "error",
-        "comma-style": "error",
-        "complexity": "error",
-        "computed-property-spacing": "error",
-        "consistent-return": "off",
-        "consistent-this": "error",
-        "constructor-super": "error",
-        "curly": "error",
-        "default-case": "error",
-        "dot-location": ["error", "property"],
-        "dot-notation": "error",
-        "eol-last": "error",
-        "eqeqeq": "error",
-        "for-direction": "error",
-        "func-call-spacing": "error",
-        "func-name-matching": "off",
-        "func-names": "error",
-        "func-style": ["error", "declaration"],
-        "function-paren-newline": "off",
-        "generator-star-spacing": "error",
-        "getter-return": "error",
-        "global-require": "off",
-        "guard-for-in": "error",
-        "handle-callback-err": "error",
-        "id-blacklist": "error",
-        "id-length": "off",
-        "id-match": "error",
-        "implicit-arrow-linebreak": "error",
-        "indent": ["error", 2, { "SwitchCase": 1 }],
-        "indent-legacy": "off",
-        "init-declarations": "error",
-        "jsx-quotes": "error",
-        "key-spacing": "error",
-        "keyword-spacing": "error",
-        "line-comment-position": "error",
-        "linebreak-style": "off",
-        "lines-around-comment": "off",
-        "lines-around-directive": "error",
-        "lines-between-class-members": "error",
-        "max-classes-per-file": "error",
-        "max-depth": "error",
-        "max-len": "error",
-        "max-lines": "off",
-        "max-lines-per-function": "off",
-        "max-nested-callbacks": "error",
-        "max-params": ["error", 9],
-        "max-statements": ["error", 33],
-        "max-statements-per-line": "error",
-        "multiline-comment-style": ["error", "separate-lines"],
-        "multiline-ternary": "off",
-        "new-cap": "error",
-        "new-parens": "error",
-        "newline-after-var": "off",
-        "newline-before-return": "off",
-        "newline-per-chained-call": "off",
-        "no-alert": "error",
-        "no-array-constructor": "error",
-        "no-async-promise-executor": "error",
-        "no-await-in-loop": "error",
-        "no-bitwise": "off",
-        "no-buffer-constructor": "error",
-        "no-caller": "error",
-        "no-case-declarations": "error",
-        "no-catch-shadow": "error",
-        "no-class-assign": "error",
-        "no-compare-neg-zero": "error",
-        "no-cond-assign": "error",
-        "no-confusing-arrow": "error",
-        "no-console": "error",
-        "no-const-assign": "error",
-        "no-constant-condition": "error",
-        "no-continue": "error",
-        "no-control-regex": "error",
-        "no-debugger": "error",
-        "no-delete-var": "error",
-        "no-div-regex": "error",
-        "no-dupe-args": "error",
-        "no-dupe-class-members": "error",
-        "no-dupe-keys": "error",
-        "no-duplicate-case": "error",
-        "no-duplicate-imports": "error",
-        "no-else-return": "error",
-        "no-empty": "error",
-        "no-empty-character-class": "error",
-        "no-empty-function": "off",
-        "no-empty-pattern": "error",
-        "no-eq-null": "error",
-        "no-eval": "error",
-        "no-ex-assign": "error",
-        "no-extend-native": "error",
-        "no-extra-bind": "error",
-        "no-extra-boolean-cast": "error",
-        "no-extra-label": "error",
-        "no-extra-parens": "off",
-        "no-extra-semi": "error",
-        "no-fallthrough": "error",
-        "no-floating-decimal": "error",
-        "no-func-assign": "error",
-        "no-global-assign": "error",
-        "no-implicit-coercion": "off",
-        "no-implicit-globals": "error",
-        "no-implied-eval": "error",
-        "no-inline-comments": "error",
-        "no-inner-declarations": "error",
-        "no-invalid-regexp": "error",
-        "no-invalid-this": "off",
-        "no-irregular-whitespace": "error",
-        "no-iterator": "error",
-        "no-label-var": "error",
-        "no-labels": "error",
-        "no-lone-blocks": "error",
-        "no-lonely-if": "error",
-        "no-loop-func": "error",
-        "no-magic-numbers": "off",
-        "no-misleading-character-class": "error",
-        "no-mixed-operators": "error",
-        "no-mixed-requires": "error",
-        "no-mixed-spaces-and-tabs": "error",
-        "no-multi-assign": "off",
-        "no-multi-spaces": "error",
-        "no-multi-str": "error",
-        "no-multiple-empty-lines": "error",
-        "no-native-reassign": "error",
-        "no-negated-condition": "error",
-        "no-negated-in-lhs": "error",
-        "no-nested-ternary": "off",
-        "no-new": "error",
-        "no-new-func": "error",
-        "no-new-object": "error",
-        "no-new-require": "error",
-        "no-new-symbol": "error",
-        "no-new-wrappers": "error",
-        "no-obj-calls": "error",
-        "no-octal": "error",
-        "no-octal-escape": "error",
-        "no-param-reassign": "off",
-        "no-path-concat": "error",
-        "no-plusplus": "off",
-        "no-process-env": "error",
-        "no-process-exit": "error",
-        "no-proto": "error",
-        "no-prototype-builtins": "error",
-        "no-redeclare": "error",
-        "no-regex-spaces": "error",
-        "no-restricted-globals": "error",
-        "no-restricted-imports": "error",
-        "no-restricted-modules": "error",
-        "no-restricted-properties": "error",
-        "no-restricted-syntax": "error",
-        "no-return-assign": "error",
-        "no-return-await": "error",
-        "no-script-url": "error",
-        "no-self-assign": "error",
-        "no-self-compare": "error",
-        "no-sequences": "error",
-        "no-shadow": "error",
-        "no-shadow-restricted-names": "error",
-        "no-spaced-func": "error",
-        "no-sparse-arrays": "error",
-        "no-sync": "off",
-        "no-tabs": "error",
-        "no-template-curly-in-string": "error",
-        "no-ternary": "off",
-        "no-this-before-super": "error",
-        "no-throw-literal": "error",
-        "no-trailing-spaces": "error",
-        "no-undef": "error",
-        "no-undef-init": "error",
-        "no-undefined": "off",
-        "no-underscore-dangle": "error",
-        "no-unexpected-multiline": "error",
-        "no-unmodified-loop-condition": "error",
-        "no-unneeded-ternary": "error",
-        "no-unreachable": "error",
-        "no-unsafe-finally": "error",
-        "no-unsafe-negation": "error",
-        "no-unused-expressions": "error",
-        "no-unused-labels": "error",
-        "no-unused-vars": "error",
-        "no-use-before-define": "error",
-        "no-useless-call": "error",
-        "no-useless-catch": "error",
-        "no-useless-computed-key": "error",
-        "no-useless-concat": "error",
-        "no-useless-constructor": "error",
-        "no-useless-escape": "error",
-        "no-useless-rename": "error",
-        "no-useless-return": "error",
-        "no-var": "error",
-        "no-void": "error",
-        "no-warning-comments": "error",
-        "no-whitespace-before-property": "error",
-        "no-with": "error",
-        "nonblock-statement-body-position": "error",
-        "object-curly-newline": "off",
-        "object-curly-spacing": ["error", "always"],
-        "object-property-newline": "error",
-        "object-shorthand": "off",
-        "one-var": "off",
-        "one-var-declaration-per-line": "error",
-        "operator-assignment": "error",
-        "operator-linebreak": ["error", "after"],
-        "padded-blocks": "off",
-        "padding-line-between-statements": "off",
-        "prefer-arrow-callback": "off",
-        "prefer-const": "error",
-        "prefer-destructuring": "off",
-        "prefer-numeric-literals": "error",
-        "prefer-object-spread": "error",
-        "prefer-promise-reject-errors": "error",
-        "prefer-reflect": "off",
-        "prefer-rest-params": "error",
-        "prefer-spread": "error",
-        "prefer-template": "off",
-        "quote-props": "error",
-        "quotes": "error",
-        "radix": "error",
-        "require-atomic-updates": "error",
-        "require-await": "error",
-        "require-jsdoc": "off",
-        "require-unicode-regexp": "off",
-        "require-yield": "error",
-        "rest-spread-spacing": "error",
-        "semi": "error",
-        "semi-spacing": "error",
-        "semi-style": "error",
-        "sort-imports": "error",
-        "sort-keys": "off",
-        "sort-vars": "error",
-        "space-before-blocks": "error",
-        "space-before-function-paren": ["error", "never"],
-        "space-in-parens": "error",
-        "space-infix-ops": "error",
-        "space-unary-ops": "error",
-        "spaced-comment": "error",
-        "strict": "error",
-        "switch-colon-spacing": "error",
-        "symbol-description": "error",
-        "template-curly-spacing": "error",
-        "template-tag-spacing": "error",
-        "unicode-bom": "error",
-        "use-isnan": "error",
-        "valid-jsdoc": "error",
-        "valid-typeof": "error",
-        "vars-on-top": "off",
-        "wrap-iife": "error",
-        "wrap-regex": "off",
-        "yield-star-spacing": "error",
-        "yoda": "error"
-    }
+  "parser": "espree",
+  "parserOptions": {
+    "ecmaVersion": 2018
+  },
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "extends": "eslint:all",
+  "rules": {
+    "array-bracket-spacing": ["error", "always"],
+    "array-element-newline": "off",
+    "capitalized-comments": "off",
+    "dot-location": ["error", "property"],
+    "func-style": ["error", "declaration"],
+    "function-paren-newline": "off",
+    "global-require": "off",
+    "id-length": "off",
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "linebreak-style": "off",
+    "max-lines": "off",
+    "max-lines-per-function": "off",
+    "max-params": ["error", 10],
+    "max-statements": ["error", 33],
+    "multiline-comment-style": ["error", "separate-lines"],
+    "multiline-ternary": "off",
+    "newline-per-chained-call": "off",
+    "no-empty-function": "off",
+    "no-extra-parens": "off",
+    "no-implicit-coercion": "off",
+    "no-magic-numbers": "off",
+    "no-nested-ternary": "off",
+    "no-param-reassign": "off",
+    "no-plusplus": "off",
+    "no-sync": "off",
+    "no-ternary": "off",
+    "no-undefined": "off",
+    "object-curly-spacing": ["error", "always"],
+    "object-shorthand": "off",
+    "one-var": "off",
+    "operator-linebreak": ["error", "after"],
+    "padded-blocks": "off",
+    "prefer-arrow-callback": "off",
+    "prefer-destructuring": "off",
+    "prefer-named-capture-group": "off",
+    "prefer-template": "off",
+    "require-unicode-regexp": "off",
+    "sort-keys": "off",
+    "space-before-function-paren": ["error", "never"],
+    "vars-on-top": "off",
+    "wrap-regex": "off"
+  }
 }

package/.travis.yml

@@ -1,12 +1,12 @@
 language: node_js
 node_js:
-  - "6"
   - "8"
   - "10"
+  - "12"
 os:
   - windows
   - linux
   - osx
 cache: npm
 script: "npm run-script test-cover"
-after_script: "npm install coveralls && cat ./coverage/lcov.info | coveralls"
+after_script: "npm install coveralls && nyc report --reporter=text-lcov | coveralls"

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2018 David Anson
+Copyright (c) 2015-2019 David Anson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -19,16 +19,17 @@ The [Markdown](https://en.wikipedia.org/wiki/Markdown) markup language is
 designed to be easy to read, write, and understand. It succeeds - and its
 flexibility is both a benefit and a drawback. Many styles are possible, so
 formatting can be inconsistent. Some constructs don't work well in all
-parsers and should be avoided. The [CommonMark](http://commonmark.org/)
+parsers and should be avoided. The [CommonMark](https://commonmark.org/)
 specification standardizes parsers - but not authors.
 
-`markdownlint` is a [static analysis](https://en.wikipedia.org/wiki/Static_program_analysis)
-tool for [Node.js](https://nodejs.org/) and [io.js](https://iojs.org/) with a
-library of rules to enforce standards and consistency for Markdown files. It
-was inspired by - and heavily influenced by - Mark Harrison's
+`markdownlint` is a
+[static analysis](https://en.wikipedia.org/wiki/Static_program_analysis)
+tool for [Node.js](https://nodejs.org/) with a library of rules
+to enforce standards and consistency for Markdown files. It was
+inspired by - and heavily influenced by - Mark Harrison's
 [markdownlint](https://github.com/markdownlint/markdownlint) for
-[Ruby](https://www.ruby-lang.org/). The initial rules, rule documentation, and
-test cases came directly from that project.
+[Ruby](https://www.ruby-lang.org/). The initial rules, rule documentation,
+and test cases came directly from that project.
 
 ### Related
 
@@ -66,7 +67,7 @@ playground for learning and exploring.
 * **[MD022](doc/Rules.md#md022)** *blanks-around-headings/blanks-around-headers* - Headings should be surrounded by blank lines
 * **[MD023](doc/Rules.md#md023)** *heading-start-left/header-start-left* - Headings must start at the beginning of the line
 * **[MD024](doc/Rules.md#md024)** *no-duplicate-heading/no-duplicate-header* - Multiple headings with the same content
-* **[MD025](doc/Rules.md#md025)** *single-h1* - Multiple top level headings in the same document
+* **[MD025](doc/Rules.md#md025)** *single-title/single-h1* - Multiple top level headings in the same document
 * **[MD026](doc/Rules.md#md026)** *no-trailing-punctuation* - Trailing punctuation in heading
 * **[MD027](doc/Rules.md#md027)** *no-multiple-space-blockquote* - Multiple spaces after blockquote symbol
 * **[MD028](doc/Rules.md#md028)** *no-blanks-blockquote* - Blank line inside blockquote
@@ -82,11 +83,13 @@ playground for learning and exploring.
 * **[MD038](doc/Rules.md#md038)** *no-space-in-code* - Spaces inside code span elements
 * **[MD039](doc/Rules.md#md039)** *no-space-in-links* - Spaces inside link text
 * **[MD040](doc/Rules.md#md040)** *fenced-code-language* - Fenced code blocks should have a language specified
-* **[MD041](doc/Rules.md#md041)** *first-line-h1* - First line in file should be a top level heading
+* **[MD041](doc/Rules.md#md041)** *first-line-heading/first-line-h1* - First line in file should be a top level heading
 * **[MD042](doc/Rules.md#md042)** *no-empty-links* - No empty links
 * **[MD043](doc/Rules.md#md043)** *required-headings/required-headers* - Required heading structure
 * **[MD044](doc/Rules.md#md044)** *proper-names* - Proper names should have the correct capitalization
 * **[MD045](doc/Rules.md#md045)** *no-alt-text* - Images should have alternate text (alt text)
+* **[MD046](doc/Rules.md#md046)** *code-block-style* - Code block style
+* **[MD047](doc/Rules.md#md047)** *single-trailing-newline* - Files should end with a single newline character
 
 See [Rules.md](doc/Rules.md) for more details.
 
@@ -101,10 +104,10 @@ Tags group related rules and can be used to enable/disable multiple rules at onc
 * **accessibility** - MD045
 * **atx** - MD018, MD019
 * **atx_closed** - MD020, MD021
-* **blank_lines** - MD012, MD022, MD031, MD032
+* **blank_lines** - MD012, MD022, MD031, MD032, MD047
 * **blockquote** - MD027, MD028
 * **bullet** - MD004, MD005, MD006, MD007, MD032
-* **code** - MD014, MD031, MD038, MD040
+* **code** - MD014, MD031, MD038, MD040, MD046
 * **emphasis** - MD036, MD037
 * **hard_tab** - MD010
 * **headers** - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023,
@@ -287,7 +290,7 @@ const options = {
 See the [style](style) directory for more samples.
 
 See [markdownlint-config-schema.json](schema/markdownlint-config-schema.json)
-for the [JSON Schema](http://json-schema.org/) of the `options.config` object.
+for the [JSON Schema](https://json-schema.org/) of the `options.config` object.
 
 For more advanced scenarios, styles can reference and extend other styles. The
 `readConfig` and `readConfigSync` functions can be used to read such styles.
@@ -342,7 +345,7 @@ ignores common forms of "front matter". To match differently, specify a custom
 The default value:
 
 ```js
-/^(---|\+\+\+)$[^]*?^\1$(\r\n|\r|\n)/m
+/((^---$[^]*?^---$)|(^\+\+\+$[^]*?^(\+\+\+|\.\.\.)$))(\r\n|\r|\n|$)/m
 ```
 
 Ignores [YAML](https://en.wikipedia.org/wiki/YAML) and
@@ -357,6 +360,21 @@ title: Title
 
 Note: Matches must occur at the start of the file.
 
+##### options.handleRuleFailures
+
+Type: `Boolean`
+
+Catches exceptions thrown during rule processing and reports the problem as a
+rule violation.
+
+By default, exceptions thrown by rules (or the library itself) are unhandled
+and bubble up the stack to the caller in the conventional manner. By setting
+`handleRuleFailures` to `true`, exceptions thrown by failing rules will be
+handled by the library and the exception message logged as a rule violation.
+This setting can be useful in the presence of (custom) rules that encounter
+unexpected syntax and fail. By enabling this option, the linting process is
+allowed to continue and report any violations that were found.
+
 ##### options.noInlineConfig
 
 Type: `Boolean`
@@ -518,12 +536,12 @@ Output:
 ```text
 bad.string: 3: MD010/no-hard-tabs Hard tabs [Column: 19]
 bad.string: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.string"]
-bad.string: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This string fails some rules."]
-bad.string: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.string"]
+bad.string: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This string fails        some rules."]
+bad.string: 1: MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "#bad.string"]
 bad.md: 3: MD010/no-hard-tabs Hard tabs [Column: 17]
 bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.md"]
-bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails       some rules."]
-bad.md: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
+bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails      some rules."]
+bad.md: 1: MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
 ```
 
 Or invoke `markdownlint.sync` for a synchronous call:
@@ -553,9 +571,9 @@ Output:
       "ruleNames": [ "MD010", "no-hard-tabs" ],
       "ruleDescription": "Hard tabs",
       "ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md010",
-      "errorDetail": "Column: 19",
+      "errorDetail": "Column: 17",
       "errorContext": null,
-      "errorRange": [ 19, 1 ] },
+      "errorRange": [ 17, 1 ] },
     { "lineNumber": 1,
       "ruleNames": [ "MD018", "no-missing-space-atx" ],
       "ruleDescription": "No space after hash on atx style heading",
@@ -571,7 +589,7 @@ Output:
       "errorContext": "#This file fails\tsome rules.",
       "errorRange": [ 1, 2 ] },
     { "lineNumber": 1,
-      "ruleNames": [ "MD041", "first-line-h1" ],
+      "ruleNames": [ "MD041", "first-line-heading", "first-line-h1" ],
       "ruleDescription": "First line in file should be a top level heading",
       "ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md041",
       "errorDetail": null,
@@ -581,7 +599,7 @@ Output:
 }
 ```
 
-Integration with the [gulp](http://gulpjs.com/) build system is straightforward:
+Integration with the [gulp](https://gulpjs.com/) build system is straightforward:
 
 ```js
 const gulp = require("gulp");
@@ -610,12 +628,12 @@ Output:
 [00:00:00] Starting 'markdownlint'...
 bad.md: 3: MD010/no-hard-tabs Hard tabs [Column: 17]
 bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.md"]
-bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails       some rules."]
-bad.md: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
+bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails      some rules."]
+bad.md: 1: MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
 [00:00:00] Finished 'markdownlint' after 10 ms
 ```
 
-Integration with the [Grunt](http://gruntjs.com/) build system is similar:
+Integration with the [Grunt](https://gruntjs.com/) build system is similar:
 
 ```js
 const markdownlint = require("markdownlint");
@@ -651,8 +669,8 @@ Running "markdownlint:example" (markdownlint) task
 Warning:
 bad.md: 3: MD010/no-hard-tabs Hard tabs [Column: 17]
 bad.md: 1: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#bad.md"]
-bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails       some rules."]
-bad.md: 1: MD041/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
+bad.md: 3: MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#This file fails      some rules."]
+bad.md: 1: MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "#bad.md"]
  Use --force to continue.
 ```
 
@@ -690,11 +708,13 @@ For ideas how to integrate `markdownlint` into your workflow, refer to the follo
 
 * [ally.js](https://allyjs.io/) ([Search repository](https://github.com/medialize/ally.js/search?q=markdownlint))
 * [ESLint](https://eslint.org/) ([Search repository](https://github.com/eslint/eslint/search?q=markdownlint))
+* [Garden React Components](https://garden.zendesk.com/react-components/)  ([Search repository](https://github.com/zendeskgarden/react-components/search?q=markdownlint))
 * [Mocha](https://mochajs.org/) ([Search repository](https://github.com/mochajs/mocha/search?q=markdownlint))
 * [Reactable](https://glittershark.github.io/reactable/) ([Search repository](https://github.com/glittershark/reactable/search?q=markdownlint))
 * [Sinon.JS](https://sinonjs.org/) ([Search repository](https://github.com/sinonjs/sinon/search?q=markdownlint))
 * [TestCafe](https://devexpress.github.io/testcafe/) ([Search repository](https://github.com/DevExpress/testcafe/search?q=markdownlint))
 * [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html) ([Search repository](https://github.com/Microsoft/TypeScript-Handbook/search?q=markdownlint))
+* [V8](https://v8.dev/) ([Search repository](https://github.com/v8/v8.dev/search?q=markdownlint))
 * [webhint](https://webhint.io/) ([Search repository](https://github.com/webhintio/hint/search?q=markdownlint))
 * [webpack](https://webpack.js.org/) ([Search repository](https://github.com/webpack/webpack.js.org/search?q=markdownlint))
 
@@ -720,7 +740,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
   * 0.3.1 - Fix regressions in MD032/MD038, update dependencies.
 * 0.4.0 - Add MD044, enhance MD013/MD032/MD041/MD042/MD043, fix for MD038, dependencies.
   * 0.4.1 - Fixes for MD038/front matter, improvements to MD044, update dependencies.
-* 0.5.0 - Add shareable configuration, noInlineConfig option, README links, fix MD030,
+* 0.5.0 - Add shareable configuration, `noInlineConfig` option, README links, fix MD030,
           improve MD009/MD041, update dependencies.
 * 0.6.0 - `resultVersion` defaults to 1 (breaking change), ignore HTML comments, TOML
           front matter, fixes for MD044, update dependencies.
@@ -742,6 +762,13 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
            update dependencies.
 * 0.12.0 - Add `information` link for custom rules, `markdownItPlugins` for extensibility,
            improve MD023/MD032/MD038, update dependencies.
+* 0.13.0 - Improve MD013/MD022/MD025/MD029/MD031/MD032/MD037/MD041/, deprecate MD002,
+           improve pandoc YAML support, update dependencies.
+* 0.14.0 - Remove support for end-of-life Node version 6, introduce `markdownlint-rule-helpers`,
+           add MD046/MD047, improve MD033/MD034/MD039, improve custom rule validation and
+           in-browser demo, update dependencies.
+  * 0.14.1 - Improve MD033.
+  * 0.14.2 - Improve MD047, add `handleRuleFailures` option.
 
 [npm-image]: https://img.shields.io/npm/v/markdownlint.svg
 [npm-url]: https://www.npmjs.com/package/markdownlint

package/doc/CustomRules.md

@@ -53,16 +53,21 @@ A rule is implemented as an `Object` with four required properties:
     - `context` is an optional `String` with relevant text surrounding the error location.
     - `range` is an optional `Array` with two `Number` values identifying the 1-based column and length of the error.
 
+The collection of helper functions shared by the built-in rules is available for use by custom rules in the [markdownlint-rule-helpers package](https://www.npmjs.com/package/markdownlint-rule-helpers).
+
 ## Examples
 
 - [Simple rules used by the project's test cases](../test/rules)
 - [Code for all `markdownlint` built-in rules](../lib)
 - [Package configuration for publishing to npm](../test/rules/npm)
-  - Each package should export a single rule object
+  - Packages should export a single rule object or an `Array` of rule objects
+- [Custom rules from the Microsoft/vscode-docs-authoring repository](https://github.com/Microsoft/vscode-docs-authoring/tree/master/docs-markdown/markdownlint-custom-rules)
+- [Custom rules from the axibase/docs-util repository](https://github.com/axibase/docs-util/tree/master/linting-rules)
+- [Custom rules from the webhintio/hint repository](https://github.com/webhintio/hint/blob/master/scripts/lint-markdown.js)
 
 ## References
 
-- [CommonMark documentation and specification](http://commonmark.org/)
+- [CommonMark documentation and specification](https://commonmark.org/)
 - [`markdown-it` Markdown parser project page](https://github.com/markdown-it/markdown-it)
 
 ## Params