markdownlint 0.12.0 → 0.14.2

package/lib/md041.js

@@ -2,32 +2,30 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, frontMatterHasTitle } = require("../helpers");
 
 module.exports = {
-  "names": [ "MD041", "first-line-h1" ],
+  "names": [ "MD041", "first-line-heading", "first-line-h1" ],
   "description": "First line in file should be a top level heading",
   "tags": [ "headings", "headers" ],
   "function": function MD041(params, onError) {
     const level = params.config.level || 1;
-    const frontMatterTitle = params.config.front_matter_title;
     const tag = "h" + level;
-    const frontMatterTitleRe =
-      new RegExp(frontMatterTitle || "^\\s*title\\s*[:=]", "i");
-    params.tokens.every(function forToken(token) {
-      if (token.type === "html_block") {
-        return true;
-      } else if (token.type === "heading_open") {
-        if (token.tag !== tag) {
-          shared.addErrorContext(onError, token.lineNumber, token.line);
+    const foundFrontMatterTitle =
+      frontMatterHasTitle(
+        params.frontMatterLines,
+        params.config.front_matter_title
+      );
+    if (!foundFrontMatterTitle) {
+      params.tokens.every((token) => {
+        if (token.type === "html_block") {
+          return true;
         }
-      } else if (((frontMatterTitle !== undefined) && !frontMatterTitle) ||
-        !params.frontMatterLines.some(function forLine(line) {
-          return frontMatterTitleRe.test(line);
-        })) {
-        shared.addErrorContext(onError, token.lineNumber, token.line);
-      }
-      return false;
-    });
+        if ((token.type !== "heading_open") || (token.tag !== tag)) {
+          addErrorContext(onError, token.lineNumber, token.line);
+        }
+        return false;
+      });
+    }
   }
 };

package/lib/md042.js

@@ -2,7 +2,8 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, filterTokens, rangeFromRegExp } =
+  require("../helpers");
 
 const emptyLinkRe = /\[[^\]]*](?:\((?:#?|(?:<>))\))/;
 
@@ -11,7 +12,7 @@ module.exports = {
   "description": "No empty links",
   "tags": [ "links" ],
   "function": function MD042(params, onError) {
-    shared.filterTokens(params, "inline", function forToken(token) {
+    filterTokens(params, "inline", function forToken(token) {
       let inLink = false;
       let linkText = "";
       let emptyLink = false;
@@ -27,9 +28,9 @@ module.exports = {
         } else if (child.type === "link_close") {
           inLink = false;
           if (emptyLink) {
-            shared.addErrorContext(onError, child.lineNumber,
+            addErrorContext(onError, child.lineNumber,
               "[" + linkText + "]()", null, null,
-              shared.rangeFromRegExp(child.line, emptyLinkRe));
+              rangeFromRegExp(child.line, emptyLinkRe));
           }
         } else if (inLink) {
           linkText += child.content;

package/lib/md043.js

@@ -2,7 +2,8 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, addErrorDetailIf, forEachHeading } =
+  require("../helpers");
 
 module.exports = {
   "names": [ "MD043", "required-headings", "required-headers" ],
@@ -18,7 +19,7 @@ module.exports = {
       let i = 0;
       let optional = false;
       let errorCount = 0;
-      shared.forEachHeading(params, function forHeading(heading, content) {
+      forEachHeading(params, function forHeading(heading, content) {
         if (!errorCount) {
           const actual = levels[heading.tag] + " " + content;
           const expected = requiredHeadings[i++] || "[None]";
@@ -29,14 +30,14 @@ module.exports = {
           } else if (optional) {
             i--;
           } else {
-            shared.addErrorDetailIf(onError, heading.lineNumber,
+            addErrorDetailIf(onError, heading.lineNumber,
               expected, actual);
             errorCount++;
           }
         }
       });
       if ((i < requiredHeadings.length) && !errorCount) {
-        shared.addErrorContext(onError, params.lines.length,
+        addErrorContext(onError, params.lines.length,
           requiredHeadings[i]);
       }
     }

package/lib/md044.js

@@ -2,7 +2,8 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorDetailIf, bareUrlRe, escapeForRegExp, filterTokens,
+  forEachInlineChild, newLineRe } = require("../helpers");
 
 module.exports = {
   "names": [ "MD044", "proper-names" ],
@@ -12,35 +13,35 @@ module.exports = {
     const names = params.config.names || [];
     const codeBlocks = params.config.code_blocks;
     const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
-    names.forEach(function forName(name) {
-      const escapedName = shared.escapeForRegExp(name);
+    names.forEach((name) => {
+      const escapedName = escapeForRegExp(name);
       const namePattern = "\\S*\\b(" + escapedName + ")\\b\\S*";
       const anyNameRe = new RegExp(namePattern, "gi");
       function forToken(token) {
         const fenceOffset = (token.type === "fence") ? 1 : 0;
-        token.content.split(shared.newLineRe)
-          .forEach(function forLine(line, index) {
+        token.content.split(newLineRe)
+          .forEach((line, index) => {
             let match = null;
             while ((match = anyNameRe.exec(line)) !== null) {
               const fullMatch = match[0];
-              if (!shared.bareUrlRe.test(fullMatch)) {
+              if (!bareUrlRe.test(fullMatch)) {
                 const wordMatch = fullMatch
                   .replace(/^\W*/, "").replace(/\W*$/, "");
-                if (names.indexOf(wordMatch) === -1) {
+                if (!names.includes(wordMatch)) {
                   const lineNumber = token.lineNumber + index + fenceOffset;
                   const range = [ match.index + 1, wordMatch.length ];
-                  shared.addErrorDetailIf(onError, lineNumber,
-                    name, match[1], null, range);
+                  addErrorDetailIf(onError, lineNumber,
+                    name, match[1], null, null, range);
                 }
               }
             }
           });
       }
-      shared.forEachInlineChild(params, "text", forToken);
+      forEachInlineChild(params, "text", forToken);
       if (includeCodeBlocks) {
-        shared.forEachInlineChild(params, "code_inline", forToken);
-        shared.filterTokens(params, "code_block", forToken);
-        shared.filterTokens(params, "fence", forToken);
+        forEachInlineChild(params, "code_inline", forToken);
+        filterTokens(params, "code_block", forToken);
+        filterTokens(params, "fence", forToken);
       }
     });
   }

package/lib/md045.js

@@ -2,16 +2,16 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addError, forEachInlineChild } = require("../helpers");
 
 module.exports = {
   "names": [ "MD045", "no-alt-text" ],
   "description": "Images should have alternate text (alt text)",
   "tags": [ "accessibility", "images" ],
   "function": function MD045(params, onError) {
-    shared.forEachInlineChild(params, "image", function forToken(token) {
+    forEachInlineChild(params, "image", function forToken(token) {
       if (token.content === "") {
-        shared.addError(onError, token.lineNumber);
+        addError(onError, token.lineNumber);
       }
     });
   }

package/lib/md046.js

@@ -0,0 +1,32 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+
+const tokenTypeToStyle = {
+  "fence": "fenced",
+  "code_block": "indented"
+};
+
+module.exports = {
+  "names": [ "MD046", "code-block-style" ],
+  "description": "Code block style",
+  "tags": [ "code" ],
+  "function": function MD046(params, onError) {
+    let expectedStyle = params.config.style || "consistent";
+    params.tokens
+      .filter((token) => token.type === "code_block" || token.type === "fence")
+      .forEach((token) => {
+        const { lineNumber, type } = token;
+        if (expectedStyle === "consistent") {
+          expectedStyle = tokenTypeToStyle[type];
+        }
+        addErrorDetailIf(
+          onError,
+          lineNumber,
+          expectedStyle,
+          tokenTypeToStyle[type]);
+      });
+  }
+};

package/lib/md047.js

@@ -0,0 +1,18 @@
+// @ts-check
+
+"use strict";
+
+const { addError, isBlankLine } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD047", "single-trailing-newline" ],
+  "description": "Files should end with a single newline character",
+  "tags": [ "blank_lines" ],
+  "function": function MD047(params, onError) {
+    const lastLineNumber = params.lines.length;
+    const lastLine = params.lines[lastLineNumber - 1];
+    if (!isBlankLine(lastLine)) {
+      addError(onError, lastLineNumber);
+    }
+  }
+};

package/lib/rules.js

@@ -48,7 +48,9 @@ const rules = [
   require("./md042"),
   require("./md043"),
   require("./md044"),
-  require("./md045")
+  require("./md045"),
+  require("./md046"),
+  require("./md047")
 ];
 rules.forEach((rule) => {
   const name = rule.names[0].toLowerCase();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.12.0",
+  "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/)",
@@ -13,39 +13,40 @@
   "bugs": "https://github.com/DavidAnson/markdownlint/issues",
   "scripts": {
     "test": "nodeunit test/markdownlint-test.js",
-    "test-cover": "istanbul cover node_modules/nodeunit/bin/nodeunit test/markdownlint-test.js",
+    "test-cover": "nyc node_modules/nodeunit/bin/nodeunit test/markdownlint-test.js",
     "test-extra": "nodeunit test/markdownlint-test-extra.js",
     "debug": "node debug node_modules/nodeunit/bin/nodeunit",
-    "lint": "eslint lib test schema && eslint --env browser --global markdownit --global markdownlint --rule \"no-unused-vars: 0, no-extend-native: 0, max-statements: 0, no-console: 0, no-var: 0\" demo && eslint --rule \"no-console: 0, no-shadow: 0, object-property-newline: 0\" example",
+    "lint": "eslint lib helpers test schema && eslint --env browser --global markdownit --global markdownlint --rule \"no-unused-vars: 0, no-extend-native: 0, max-statements: 0, no-console: 0, no-var: 0\" demo && eslint --rule \"no-console: 0, no-invalid-this: 0, no-shadow: 0, object-property-newline: 0\" example",
     "build-config-schema": "node schema/build-config-schema.js",
-    "build-demo": "cpy node_modules/markdown-it/dist/markdown-it.min.js demo && cd demo && rimraf markdownlint-browser.* && cpy file-header.js . --rename=markdownlint-browser.js && tsc --allowJs --resolveJsonModule --outDir ../lib-es3 ../lib/markdownlint.js && browserify ../lib-es3/lib/markdownlint.js --standalone markdownlint >> markdownlint-browser.js && uglifyjs markdownlint-browser.js --compress --mangle --comments --output markdownlint-browser.min.js",
+    "build-demo": "cpy node_modules/markdown-it/dist/markdown-it.min.js demo && cd demo && rimraf markdownlint-browser.* && cpy file-header.js . --rename=markdownlint-browser.js && tsc --allowJs --resolveJsonModule --outDir ../lib-es3 ../lib/markdownlint.js && cpy ../helpers/package.json ../lib-es3/helpers && browserify ../lib-es3/lib/markdownlint.js --standalone markdownlint >> markdownlint-browser.js && uglifyjs markdownlint-browser.js --compress --mangle --comments --output markdownlint-browser.min.js",
     "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
     "example": "cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint"
   },
   "engines": {
-    "node": ">=6"
+    "node": ">=8"
   },
   "dependencies": {
     "markdown-it": "8.4.2"
   },
   "devDependencies": {
-    "@types/node": "~10.12.21",
+    "@types/node": "~12.0.0",
     "browserify": "~16.2.3",
     "cpy-cli": "~2.0.0",
-    "eslint": "~5.12.1",
+    "eslint": "~5.16.0",
     "glob": "~7.1.3",
-    "istanbul": "~0.4.5",
-    "js-yaml": "~3.12.1",
+    "js-yaml": "~3.13.1",
     "markdown-it-for-inline": "~0.1.1",
     "markdown-it-katex": "~2.0.3",
     "markdown-it-sub": "~1.0.0",
     "markdown-it-sup": "~1.0.0",
+    "markdownlint-rule-helpers": "~0.1.0",
     "nodeunit": "~0.11.3",
+    "nyc": "~14.1.0",
     "rimraf": "~2.6.3",
     "toml": "~3.0.0",
     "tv4": "~1.3.0",
-    "typescript": "~3.3.1",
-    "uglify-js": "~3.4.9"
+    "typescript": "~3.4.5",
+    "uglify-js": "~3.5.11"
   },
   "keywords": [
     "markdown",

package/schema/build-config-schema.js

@@ -40,7 +40,6 @@ rules.forEach(function forRule(rule) {
   let custom = true;
   switch (rule.names[0]) {
     case "MD002":
-    case "MD025":
       scheme.properties = {
         "level": {
           "description": "Heading level",
@@ -130,6 +129,11 @@ rules.forEach(function forRule(rule) {
           "type": "integer",
           "default": 80
         },
+        "heading_line_length": {
+          "description": "Number of characters for headings",
+          "type": "integer",
+          "default": 80
+        },
         "code_blocks": {
           "description": "Include code blocks",
           "type": "boolean",
@@ -152,6 +156,20 @@ rules.forEach(function forRule(rule) {
         }
       };
       break;
+    case "MD022":
+      scheme.properties = {
+        "lines_above": {
+          "description": "Blank lines above heading",
+          "type": "integer",
+          "default": 1
+        },
+        "lines_below": {
+          "description": "Blank lines below heading",
+          "type": "integer",
+          "default": 1
+        }
+      };
+      break;
     case "MD024":
       scheme.properties = {
         "allow_different_nesting": {
@@ -184,7 +202,8 @@ rules.forEach(function forRule(rule) {
           "enum": [
             "one",
             "ordered",
-            "one_or_ordered"
+            "one_or_ordered",
+            "zero"
           ],
           "default": "one_or_ordered"
         }
@@ -235,6 +254,7 @@ rules.forEach(function forRule(rule) {
         }
       };
       break;
+    case "MD025":
     case "MD041":
       scheme.properties = {
         "level": {
@@ -286,6 +306,20 @@ rules.forEach(function forRule(rule) {
         }
       };
       break;
+    case "MD046":
+      scheme.properties = {
+        "style": {
+          "description": "Block style",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "fenced",
+            "indented"
+          ],
+          "default": "consistent"
+        }
+      };
+      break;
     default:
       custom = false;
       break;