markdownlint 0.20.3 → 0.20.4

package/CONTRIBUTING.md

@@ -43,5 +43,5 @@ Open pull requests against the `next` branch.
 That's where the latest changes are staged for the next release.
 Include the text "(fixes #??)" at the end of the commit message so the pull request will be associated with the relevant issue.
 Once accepted, the tag `fixed in next` will be added to the issue.
-When the commit is merged to `master` branch during the release process, the issue will be closed automatically.
+When the commit is merged to the main branch during the release process, the issue will be closed automatically.
 (See [Closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/) for details.)

package/README.md

@@ -32,14 +32,21 @@ and test cases came directly from that project.
 
 ### Related
 
-* [markdownlint-cli command-line interface for Node.js](https://github.com/igorshubovych/markdownlint-cli)
-* [grunt-markdownlint for the Grunt task runner](https://github.com/sagiegurari/grunt-markdownlint)
-* [vscode-markdownlint extension for VS Code](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint)
-* [Sublime Text markdownlint for Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint)
-* [linter-node-markdownlint extension for Atom](https://atom.io/packages/linter-node-markdownlint)
-* [coc-markdownlint extension for Vim/Neovim](https://github.com/fannheyward/coc-markdownlint)
-* [markdownlint/mdl gem for Ruby](https://rubygems.org/gems/mdl)
-* [Cake.Markdownlint addin for Cake build automation system](https://github.com/cake-contrib/Cake.Markdownlint)
+* CLI
+  * [markdownlint-cli command-line interface for Node.js](https://github.com/igorshubovych/markdownlint-cli)
+* GitHub
+  * [GitHub Super-Linter Action](https://github.com/github/super-linter)
+  * [GitHub Actions problem matcher for markdownlint-cli](https://github.com/xt0rted/markdownlint-problem-matcher)
+* Editor
+  * [vscode-markdownlint extension for VS Code](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint)
+  * [Sublime Text markdownlint for Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint)
+  * [linter-node-markdownlint extension for Atom](https://atom.io/packages/linter-node-markdownlint)
+  * [coc-markdownlint extension for Vim/Neovim](https://github.com/fannheyward/coc-markdownlint)
+* Tooling
+  * [grunt-markdownlint for the Grunt task runner](https://github.com/sagiegurari/grunt-markdownlint)
+  * [Cake.Markdownlint addin for Cake build automation system](https://github.com/cake-contrib/Cake.Markdownlint)
+* Ruby
+  * [markdownlint/mdl gem for Ruby](https://rubygems.org/gems/mdl)
 
 ## Demonstration
 
@@ -199,7 +206,7 @@ This can be used to "hide" `markdownlint` comments at the bottom of a file.
 In cases where it is desirable to change the configuration of one or more rules
 for a file, the following more advanced syntax is supported:
 
-* Confiure: `<!-- markdownlint-configure-file { options.config JSON } -->`
+* Configure: `<!-- markdownlint-configure-file { options.config JSON } -->`
 
 For example:
 
@@ -864,6 +871,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
   * 0.20.1 - Fix regression in MD037.
   * 0.20.2 - Fix regression in MD037, improve MD038.
   * 0.20.3 - Fix regression in MD037, improve MD044, add automatic regression testing.
+  * 0.20.4 - Fix regression in MD037, improve MD034/MD044, improve documentation.
 
 [npm-image]: https://img.shields.io/npm/v/markdownlint.svg
 [npm-url]: https://www.npmjs.com/package/markdownlint

package/demo/markdownlint-browser.js

@@ -33,7 +33,7 @@ var inlineCommentRe =
 /<!--\s*markdownlint-(?:(?:(disable|enable|capture|restore|disable-file|enable-file)((?:\s+[a-z0-9_-]+)*))|(?:(configure-file)\s+([\s\S]*?)))\s*-->/ig;
 module.exports.inlineCommentRe = inlineCommentRe;
 // Regular expressions for range matching
-module.exports.bareUrlRe = /(?:http|ftp)s?:\/\/[^\s\]"']*/ig;
+module.exports.bareUrlRe = /(?:http|ftp)s?:\/\/[^\s\]"']*(?:\/|[^\s\]"'\W])/ig;
 module.exports.listItemMarkerRe = /^([\s>]*)(?:[*+-]|\d+[.)])\s+/;
 module.exports.orderedListItemMarkerRe = /^[\s>]*0*(\d+)[.)]/;
 // Regular expression for all instances of emphasis markers
@@ -2879,7 +2879,9 @@ module.exports = {
                     }
                     // Back up one character so RegExp has a chance to match the
                     // next marker (ex: "**star**_underscore_")
-                    emphasisRe.lastIndex--;
+                    if (emphasisRe.lastIndex > 1) {
+                        emphasisRe.lastIndex--;
+                    }
                 }
                 else if (emphasisRe.lastIndex > 1) {
                     // Back up one character so RegExp has a chance to match the
@@ -3138,6 +3140,8 @@ module.exports = {
 // @ts-check
 "use strict";
 var _a = require("../helpers"), addErrorDetailIf = _a.addErrorDetailIf, bareUrlRe = _a.bareUrlRe, escapeForRegExp = _a.escapeForRegExp, filterTokens = _a.filterTokens, forEachInlineChild = _a.forEachInlineChild, newLineRe = _a.newLineRe;
+var startNonWordRe = /^\W/;
+var endNonWordRe = /\W$/;
 module.exports = {
     "names": ["MD044", "proper-names"],
     "description": "Proper names should have the correct capitalization",
@@ -3149,7 +3153,9 @@ module.exports = {
         var includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
         names.forEach(function (name) {
             var escapedName = escapeForRegExp(name);
-            var namePattern = "\\S*\\b(" + escapedName + ")\\b\\S*";
+            var startNamePattern = startNonWordRe.test(name) ? "" : "\\S*\\b";
+            var endNamePattern = endNonWordRe.test(name) ? "" : "\\b\\S*";
+            var namePattern = "(" + startNamePattern + ")(" + escapedName + ")(" + endNamePattern + ")";
             var anyNameRe = new RegExp(namePattern, "gi");
             // eslint-disable-next-line jsdoc/require-jsdoc
             function forToken(token) {
@@ -3158,29 +3164,27 @@ module.exports = {
                     .forEach(function (line, index) {
                     var match = null;
                     while ((match = anyNameRe.exec(line)) !== null) {
-                        var fullMatch = match[0];
+                        var fullMatch = match[0], leftMatch = match[1], nameMatch = match[2], rightMatch = match[3];
                         if (fullMatch.search(bareUrlRe) === -1) {
                             var wordMatch = fullMatch
-                                .replace(/^\W*/, "").replace(/\W*$/, "");
+                                .replace(new RegExp("^\\W{0," + leftMatch.length + "}"), "")
+                                .replace(new RegExp("\\W{0," + rightMatch.length + "}$"), "");
                             if (!names.includes(wordMatch)) {
                                 var lineNumber = token.lineNumber + index + fenceOffset;
                                 var fullLine = params.lines[lineNumber - 1];
-                                var matchIndex = match.index;
                                 var matchLength = wordMatch.length;
-                                var fullLineWord = fullLine.slice(matchIndex, matchIndex + matchLength);
-                                if (fullLineWord !== wordMatch) {
-                                    // Attempt to fix bad offset due to inline content
-                                    matchIndex = fullLine.indexOf(wordMatch);
-                                }
+                                var matchIndex = fullLine.indexOf(wordMatch);
                                 var range = (matchIndex === -1) ?
                                     null :
                                     [matchIndex + 1, matchLength];
-                                var fixInfo = (matchIndex === -1) ? null : {
-                                    "editColumn": matchIndex + 1,
-                                    "deleteCount": matchLength,
-                                    "insertText": name
-                                };
-                                addErrorDetailIf(onError, lineNumber, name, match[1], null, null, range, fixInfo);
+                                var fixInfo = (matchIndex === -1) ?
+                                    null :
+                                    {
+                                        "editColumn": matchIndex + 1,
+                                        "deleteCount": matchLength,
+                                        "insertText": name
+                                    };
+                                addErrorDetailIf(onError, lineNumber, name, nameMatch, null, null, range, fixInfo);
                             }
                         }
                     }
@@ -3345,7 +3349,7 @@ module.exports = rules;
 },{"../package.json":50,"./md001":5,"./md002":6,"./md003":7,"./md004":8,"./md005":9,"./md006":10,"./md007":11,"./md009":12,"./md010":13,"./md011":14,"./md012":15,"./md013":16,"./md014":17,"./md018":18,"./md019":19,"./md020":20,"./md021":21,"./md022":22,"./md023":23,"./md024":24,"./md025":25,"./md026":26,"./md027":27,"./md028":28,"./md029":29,"./md030":30,"./md031":31,"./md032":32,"./md033":33,"./md034":34,"./md035":35,"./md036":36,"./md037":37,"./md038":38,"./md039":39,"./md040":40,"./md041":41,"./md042":42,"./md043":43,"./md044":44,"./md045":45,"./md046":46,"./md047":47,"./md048":48,"url":59}],50:[function(require,module,exports){
 module.exports={
     "name": "markdownlint",
-    "version": "0.20.3",
+    "version": "0.20.4",
     "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
     "main": "lib/markdownlint.js",
     "types": "lib/markdownlint.d.ts",

package/doc/Rules.md

@@ -186,6 +186,8 @@ Tags: bullet, ul, indentation
 
 Aliases: list-indent
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when list items are parsed as being at the same level,
 but don't have the same indentation:
 
@@ -240,6 +242,8 @@ Tags: bullet, ul, indentation
 
 Aliases: ul-start-left
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when top level lists don't start at the beginning of a
 line:
 
@@ -287,6 +291,8 @@ Aliases: ul-indent
 
 Parameters: indent, start_indented (number; default 2, boolean; default false)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when list items are not indented by the configured
 number of spaces (default: 2).
 
@@ -330,6 +336,8 @@ Aliases: no-trailing-spaces
 
 Parameters: br_spaces, list_item_empty_lines, strict (number; default 2, boolean; default false, boolean; default false)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered on any lines that end with unexpected whitespace. To fix this,
 remove the trailing space from the end of the line.
 
@@ -372,6 +380,8 @@ Aliases: no-hard-tabs
 
 Parameters: code_blocks (boolean; default true)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered by any lines that contain hard tab characters instead
 of using spaces for indentation. To fix this, replace any hard tab characters
 with spaces instead.
@@ -407,6 +417,8 @@ Tags: links
 
 Aliases: no-reversed-links
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when text that appears to be a link is encountered, but
 where the syntax appears to have been reversed (the `[]` and `()` are
 reversed):
@@ -439,6 +451,8 @@ Aliases: no-multiple-blanks
 
 Parameters: maximum (number; default 1)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when there are multiple consecutive blank lines in the
 document:
 
@@ -521,6 +535,8 @@ Tags: code
 
 Aliases: commands-show-output
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when there are code blocks showing shell commands to be
 typed, and *all* of the shell commands are preceded by dollar signs ($):
 
@@ -572,6 +588,8 @@ Tags: headings, headers, atx, spaces
 
 Aliases: no-missing-space-atx
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when spaces are missing after the hash characters
 in an atx style heading:
 
@@ -600,6 +618,8 @@ Tags: headings, headers, atx, spaces
 
 Aliases: no-multiple-space-atx
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when more than one space is used to separate the
 heading text from the hash characters in an atx style heading:
 
@@ -629,6 +649,8 @@ Tags: headings, headers, atx_closed, spaces
 
 Aliases: no-missing-space-closed-atx
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when spaces are missing inside the hash characters
 in a closed atx style heading:
 
@@ -659,6 +681,8 @@ Tags: headings, headers, atx_closed, spaces
 
 Aliases: no-multiple-space-closed-atx
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when more than one space is used to separate the
 heading text from the hash characters in a closed atx style heading:
 
@@ -693,6 +717,8 @@ Aliases: blanks-around-headings, blanks-around-headers
 
 Parameters: lines_above, lines_below (number; default 1)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when headings (any style) are either not preceded or not
 followed by at least one blank line:
 
@@ -735,6 +761,8 @@ Tags: headings, headers, spaces
 
 Aliases: heading-start-left, header-start-left
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when a heading is indented by one or more spaces:
 
 ```markdown
@@ -857,6 +885,8 @@ Aliases: no-trailing-punctuation
 
 Parameters: punctuation (string; default ".,;:!?。，；：！？")
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered on any heading that has one of the specified normal or
 full-width punctuation characters as the last character in the line:
 
@@ -887,6 +917,8 @@ Tags: blockquote, whitespace, indentation
 
 Aliases: no-multiple-space-blockquote
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when blockquotes have more than one space after the
 blockquote (`>`) symbol:
 
@@ -912,6 +944,8 @@ Tags: blockquote, whitespace
 
 Aliases: no-blanks-blockquote
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when two blockquote blocks are separated by nothing
 except for a blank line:
 
@@ -1048,6 +1082,8 @@ Aliases: list-marker-space
 
 Parameters: ul_single, ol_single, ul_multi, ol_multi (number; default 1)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule checks for the number of spaces between a list marker (e.g. '`-`',
 '`*`', '`+`' or '`1.`') and the text of the list item.
 
@@ -1121,6 +1157,8 @@ Aliases: blanks-around-fences
 
 Parameters: list_items (boolean; default true)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when fenced code blocks are either not preceded or not
 followed by a blank line:
 
@@ -1168,6 +1206,8 @@ Tags: bullet, ul, ol, blank_lines
 
 Aliases: blanks-around-lists
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when lists (of any kind) are either not preceded or not
 followed by a blank line:
 
@@ -1235,6 +1275,8 @@ Tags: links, url
 
 Aliases: no-bare-urls
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered whenever a URL is given that isn't surrounded by angle
 brackets:
 
@@ -1370,6 +1412,8 @@ Tags: whitespace, emphasis
 
 Aliases: no-space-in-emphasis
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when emphasis markers (bold, italic) are used, but they
 have spaces between the markers and the text:
 
@@ -1408,6 +1452,8 @@ Tags: whitespace, code
 
 Aliases: no-space-in-code
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered for code span elements that have spaces adjacent to the
 backticks:
 
@@ -1447,6 +1493,8 @@ Tags: whitespace, links
 
 Aliases: no-space-in-links
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered on links that have spaces surrounding the link text:
 
 ```markdown
@@ -1639,6 +1687,8 @@ Aliases: proper-names
 
 Parameters: names, code_blocks (string array; default `null`, boolean; default `true`)
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when any of the strings in the `names` array do not have
 the specified capitalization. It can be used to enforce a standard letter case
 for the names of projects and products.
@@ -1732,6 +1782,8 @@ Tags: blank_lines
 
 Aliases: single-trailing-newline
 
+Fixable: Most violations can be fixed by tooling
+
 This rule is triggered when there is not a single newline character at the end of a file.
 
 Example that triggers the rule:

package/helpers/helpers.js

@@ -21,7 +21,7 @@ const inlineCommentRe =
 module.exports.inlineCommentRe = inlineCommentRe;
 
 // Regular expressions for range matching
-module.exports.bareUrlRe = /(?:http|ftp)s?:\/\/[^\s\]"']*/ig;
+module.exports.bareUrlRe = /(?:http|ftp)s?:\/\/[^\s\]"']*(?:\/|[^\s\]"'\W])/ig;
 module.exports.listItemMarkerRe = /^([\s>]*)(?:[*+-]|\d+[.)])\s+/;
 module.exports.orderedListItemMarkerRe = /^[\s>]*0*(\d+)[.)]/;
 

package/helpers/package.json

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

package/lib/md037.js

@@ -128,7 +128,9 @@ module.exports = {
             }
             // Back up one character so RegExp has a chance to match the
             // next marker (ex: "**star**_underscore_")
-            emphasisRe.lastIndex--;
+            if (emphasisRe.lastIndex > 1) {
+              emphasisRe.lastIndex--;
+            }
           } else if (emphasisRe.lastIndex > 1) {
             // Back up one character so RegExp has a chance to match the
             // mis-matched marker (ex: "*text_*")

package/lib/md044.js

@@ -5,6 +5,9 @@
 const { addErrorDetailIf, bareUrlRe, escapeForRegExp, filterTokens,
   forEachInlineChild, newLineRe } = require("../helpers");
 
+const startNonWordRe = /^\W/;
+const endNonWordRe = /\W$/;
+
 module.exports = {
   "names": [ "MD044", "proper-names" ],
   "description": "Proper names should have the correct capitalization",
@@ -16,7 +19,10 @@ module.exports = {
     const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
     names.forEach((name) => {
       const escapedName = escapeForRegExp(name);
-      const namePattern = "\\S*\\b(" + escapedName + ")\\b\\S*";
+      const startNamePattern = startNonWordRe.test(name) ? "" : "\\S*\\b";
+      const endNamePattern = endNonWordRe.test(name) ? "" : "\\b\\S*";
+      const namePattern =
+        `(${startNamePattern})(${escapedName})(${endNamePattern})`;
       const anyNameRe = new RegExp(namePattern, "gi");
       // eslint-disable-next-line jsdoc/require-jsdoc
       function forToken(token) {
@@ -25,34 +31,31 @@ module.exports = {
           .forEach((line, index) => {
             let match = null;
             while ((match = anyNameRe.exec(line)) !== null) {
-              const fullMatch = match[0];
+              const [ fullMatch, leftMatch, nameMatch, rightMatch ] = match;
               if (fullMatch.search(bareUrlRe) === -1) {
                 const wordMatch = fullMatch
-                  .replace(/^\W*/, "").replace(/\W*$/, "");
+                  .replace(new RegExp(`^\\W{0,${leftMatch.length}}`), "")
+                  .replace(new RegExp(`\\W{0,${rightMatch.length}}$`), "");
                 if (!names.includes(wordMatch)) {
                   const lineNumber = token.lineNumber + index + fenceOffset;
                   const fullLine = params.lines[lineNumber - 1];
-                  let matchIndex = match.index;
                   const matchLength = wordMatch.length;
-                  const fullLineWord =
-                    fullLine.slice(matchIndex, matchIndex + matchLength);
-                  if (fullLineWord !== wordMatch) {
-                    // Attempt to fix bad offset due to inline content
-                    matchIndex = fullLine.indexOf(wordMatch);
-                  }
+                  const matchIndex = fullLine.indexOf(wordMatch);
                   const range = (matchIndex === -1) ?
                     null :
                     [ matchIndex + 1, matchLength ];
-                  const fixInfo = (matchIndex === -1) ? null : {
-                    "editColumn": matchIndex + 1,
-                    "deleteCount": matchLength,
-                    "insertText": name
-                  };
+                  const fixInfo = (matchIndex === -1) ?
+                    null :
+                    {
+                      "editColumn": matchIndex + 1,
+                      "deleteCount": matchLength,
+                      "insertText": name
+                    };
                   addErrorDetailIf(
                     onError,
                     lineNumber,
                     name,
-                    match[1],
+                    nameMatch,
                     null,
                     null,
                     range,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.20.3",
+  "version": "0.20.4",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "main": "lib/markdownlint.js",
   "types": "lib/markdownlint.d.ts",