markdownlint - npm Package Compare versions

Comparing version 0.14.1 to 0.14.2

.eslintrc.json

@@ -24,3 +24,3 @@ {
     "max-lines-per-function": "off",
-    "max-params": ["error", 9],
+    "max-params": ["error", 10],
     "max-statements": ["error", 33],
@@ -27,0 +27,0 @@ "multiline-comment-style": ["error", "separate-lines"],

helpers/helpers.js

@@ -79,3 +79,3 @@ // @ts-check
       j = text.length;
-      text += "\\";
+      text += "\\\n";
     }
@@ -82,0 +82,0 @@ const comment = text.slice(i + htmlCommentBegin.length, j);

helpers/package.json

 {
   "name": "markdownlint-rule-helpers",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A collection of markdownlint helper functions for custom rules",
@@ -5,0 +5,0 @@ "main": "helpers.js",

lib/markdownlint.js

@@ -304,2 +304,3 @@ // @ts-check
   frontMatter,
+  handleRuleFailures,
   noInlineConfig,
@@ -380,3 +381,14 @@ resultVersion,
     // 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)
@@ -437,2 +449,3 @@ if (errors.length) {
   frontMatter,
+  handleRuleFailures,
   noInlineConfig,
@@ -447,3 +460,3 @@ resultVersion,
     return lintContent(ruleList, file, content, md, config, frontMatter,
-      noInlineConfig, resultVersion, callback);
+      handleRuleFailures, noInlineConfig, resultVersion, callback);
   }
@@ -479,2 +492,3 @@ // Make a/synchronous call to read file
     helpers.frontMatterRe : options.frontMatter;
+  const handleRuleFailures = !!options.handleRuleFailures;
   const noInlineConfig = !!options.noInlineConfig;
@@ -512,2 +526,3 @@ const resultVersion = (options.resultVersion === undefined) ?
           frontMatter,
+          handleRuleFailures,
           noInlineConfig,
@@ -524,2 +539,3 @@ resultVersion,
           frontMatter,
+          handleRuleFailures,
           noInlineConfig,
@@ -526,0 +542,0 @@ resultVersion,

package.json

 {
   "name": "markdownlint",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
@@ -5,0 +5,0 @@ "main": "lib/markdownlint.js",

README.md

@@ -363,2 +363,17 @@ # markdownlint
 
+##### 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
@@ -703,2 +718,3 @@
 * [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))
@@ -729,3 +745,3 @@ * [webpack](https://webpack.js.org/) ([Search repository](https://github.com/webpack/webpack.js.org/search?q=markdownlint))
   * 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.
@@ -758,2 +774,3 @@ * 0.6.0 - `resultVersion` defaults to 1 (breaking change), ignore HTML comments, TOML
   * 0.14.1 - Improve MD033.
+  * 0.14.2 - Improve MD047, add `handleRuleFailures` option.
 
@@ -760,0 +777,0 @@ [npm-image]: https://img.shields.io/npm/v/markdownlint.svg

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

221152

increased by0.59%

Lines of code

4275

increased by0.38%

Number of lines in readme file

781

increased by2.23%

No dependency changes