markdownlint 0.14.1 → 0.14.2

package/.eslintrc.json

@@ -21,7 +21,7 @@
     "linebreak-style": "off",
     "max-lines": "off",
     "max-lines-per-function": "off",
-    "max-params": ["error", 9],
+    "max-params": ["error", 10],
     "max-statements": ["error", 33],
     "multiline-comment-style": ["error", "separate-lines"],
     "multiline-ternary": "off",

package/README.md

@@ -360,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`
@@ -699,6 +714,7 @@ For ideas how to integrate `markdownlint` into your workflow, refer to the follo
 * [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))
 
@@ -724,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.
@@ -752,6 +768,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
            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/helpers/helpers.js

@@ -76,7 +76,7 @@ module.exports.clearHtmlCommentText = function clearHtmlCommentText(text) {
     let j = text.indexOf(htmlCommentEnd, i);
     if (j === -1) {
       j = text.length;
-      text += "\\";
+      text += "\\\n";
     }
     const comment = text.slice(i + htmlCommentBegin.length, j);
     if ((comment.length > 0) &&

package/helpers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-rule-helpers",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A collection of markdownlint helper functions for custom rules",
   "main": "helpers.js",
   "author": "David Anson (https://dlaa.me/)",

package/lib/markdownlint.js

@@ -301,6 +301,7 @@ function lintContent(
   md,
   config,
   frontMatter,
+  handleRuleFailures,
   noInlineConfig,
   resultVersion,
   callback) {
@@ -376,7 +377,18 @@ function lintContent(
       });
     }
     // Call (possibly external) rule function
-    rule.function(params, onError);
+    if (handleRuleFailures) {
+      try {
+        rule.function(params, onError);
+      } catch (ex) {
+        onError({
+          "lineNumber": 1,
+          "detail": `This rule threw an exception: ${ex.message}`
+        });
+      }
+    } else {
+      rule.function(params, onError);
+    }
     // Record any errors (significant performance benefit from length check)
     if (errors.length) {
       errors.sort(lineNumberComparison);
@@ -432,6 +444,7 @@ function lintFile(
   md,
   config,
   frontMatter,
+  handleRuleFailures,
   noInlineConfig,
   resultVersion,
   synchronous,
@@ -441,7 +454,7 @@ function lintFile(
       return callback(err);
     }
     return lintContent(ruleList, file, content, md, config, frontMatter,
-      noInlineConfig, resultVersion, callback);
+      handleRuleFailures, noInlineConfig, resultVersion, callback);
   }
   // Make a/synchronous call to read file
   if (synchronous) {
@@ -472,6 +485,7 @@ function lintInput(options, synchronous, callback) {
   const config = options.config || { "default": true };
   const frontMatter = (options.frontMatter === undefined) ?
     helpers.frontMatterRe : options.frontMatter;
+  const handleRuleFailures = !!options.handleRuleFailures;
   const noInlineConfig = !!options.noInlineConfig;
   const resultVersion = (options.resultVersion === undefined) ?
     2 : options.resultVersion;
@@ -504,6 +518,7 @@ function lintInput(options, synchronous, callback) {
           md,
           config,
           frontMatter,
+          handleRuleFailures,
           noInlineConfig,
           resultVersion,
           lintNextItemCallback);
@@ -515,6 +530,7 @@ function lintInput(options, synchronous, callback) {
           md,
           config,
           frontMatter,
+          handleRuleFailures,
           noInlineConfig,
           resultVersion,
           synchronous,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "main": "lib/markdownlint.js",
   "author": "David Anson (https://dlaa.me/)",