wip

DavidAnson · Nov 30, 2024 · 9c5a877 · 9c5a877
1 parent 772eb50
commit 9c5a877
Show file tree

Hide file tree

Showing 60 changed files with 82 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -798,7 +798,7 @@ function applyFixes(input, errors) { ... }
 Invoking `applyFixes` with the results of a call to lint can be done like so:
 
 ```javascript
-import markdownlint from "../lib/markdownlint.mjs";
+import markdownlint from "markdownlint";
 
 const fixResults = markdownlint.sync({ "strings": { "content": original } });
 const fixed = markdownlint.applyFixes(original, fixResults.content);
@@ -809,7 +809,7 @@ const fixed = markdownlint.applyFixes(original, fixResults.content);
 Invoke `markdownlint` and use the `result` object's `toString` method:
 
 ```javascript
-import markdownlint from "../lib/markdownlint.mjs";
+import markdownlint from "markdownlint";
 
 const options = {
   "files": [ "good.md", "bad.md" ],

diff --git a/example/Gruntfile.cjs b/example/Gruntfile.cjs
@@ -13,7 +13,7 @@ module.exports = function wrapper(grunt) {
 
   grunt.registerMultiTask("markdownlint", function task() {
     const done = this.async();
-    import("../lib/markdownlint.mjs").then(({ "default": markdownlint }) => {
+    import("markdownlint").then(({ "default": markdownlint }) => {
       markdownlint(
         { "files": this.filesSrc },
         function callback(err, result) {

diff --git a/example/gulpfile.cjs b/example/gulpfile.cjs
@@ -9,7 +9,7 @@ const through2 = require("through2");
 gulp.task("markdownlint", function task() {
   return gulp.src("*.md", { "read": false })
     .pipe(through2.obj(function obj(file, enc, next) {
-      import("../lib/markdownlint.mjs").then(({ "default": markdownlint }) => {
+      import("markdownlint").then(({ "default": markdownlint }) => {
         markdownlint(
           { "files": [ file.relative ] },
           function callback(err, result) {

diff --git a/example/standalone.mjs b/example/standalone.mjs
@@ -1,6 +1,6 @@
 // @ts-check
 
-import markdownlint from "../lib/markdownlint.mjs";
+import markdownlint from "markdownlint";
 
 const options = {
   "files": [ "good.md", "bad.md" ],

diff --git a/lib/md001.mjs b/lib/md001.mjs
@@ -3,6 +3,7 @@
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { getHeadingLevel } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD001", "heading-increment" ],

diff --git a/lib/md003.mjs b/lib/md003.mjs
@@ -3,6 +3,7 @@
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { getHeadingLevel, getHeadingStyle } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD003", "heading-style" ],

diff --git a/lib/md004.mjs b/lib/md004.mjs
@@ -26,6 +26,7 @@ const validStyles = new Set([
   "plus",
   "sublist"
 ]);
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD004", "ul-style" ],

diff --git a/lib/md005.mjs b/lib/md005.mjs
@@ -2,6 +2,7 @@
 
 import { addError, addErrorDetailIf } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD005", "list-indent" ],

diff --git a/lib/md007.mjs b/lib/md007.mjs
@@ -3,12 +3,14 @@
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { getParentOfType } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("micromark-util-types").TokenType[]} */
 const unorderedListTypes =
   [ "blockQuotePrefix", "listItemPrefix", "listUnordered" ];
 /** @type {import("micromark-util-types").TokenType[]} */
 const unorderedParentTypes =
   [ "blockQuote", "listOrdered", "listUnordered" ];
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD007", "ul-indent" ],

diff --git a/lib/md009.mjs b/lib/md009.mjs
@@ -3,6 +3,7 @@
 import { addError } from "../helpers/helpers.cjs";
 import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD009", "no-trailing-spaces" ],

diff --git a/lib/md010.mjs b/lib/md010.mjs
@@ -5,6 +5,7 @@ import { getDescendantsByType } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 const tabRe = /\t+/g;
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD010", "no-hard-tabs" ],

diff --git a/lib/md011.mjs b/lib/md011.mjs
@@ -4,8 +4,8 @@ import { addError, hasOverlap } from "../helpers/helpers.cjs";
 import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
-const reversedLinkRe =
-  /(^|[^\\])\(([^()]+)\)\[([^\]^][^\]]*)\](?!\()/g;
+const reversedLinkRe = /(^|[^\\])\(([^()]+)\)\[([^\]^][^\]]*)\](?!\()/g;
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD011", "no-reversed-links" ],

diff --git a/lib/md012.mjs b/lib/md012.mjs
@@ -3,6 +3,7 @@
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD012", "no-multiple-blanks" ],

diff --git a/lib/md013.mjs b/lib/md013.mjs
@@ -8,6 +8,10 @@ const longLineRePrefix = "^.{";
 const longLineRePostfixRelaxed = "}.*\\s.*$";
 const longLineRePostfixStrict = "}.+$";
 const sternModeRe = /^(?:[#>\s]*\s)?\S*$/;
+
+/** @typedef {import("micromark-extension-gfm-autolink-literal")} */
+/** @typedef {import("micromark-extension-gfm-table")} */
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD013", "line-length" ],

diff --git a/lib/md014.mjs b/lib/md014.mjs
@@ -4,6 +4,7 @@ import { addErrorContext } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 const dollarCommandRe = /^(\s*)(\$\s+)/;
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD014", "commands-show-output" ],

diff --git a/lib/md018.mjs b/lib/md018.mjs
@@ -3,6 +3,7 @@
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD018", "no-missing-space-atx" ],

diff --git a/lib/md019-md021.mjs b/lib/md019-md021.mjs
@@ -44,6 +44,7 @@ function validateHeadingSpaces(onError, heading, delta) {
     );
   }
 }
+
 /** @type {import("./markdownlint.mjs").Rule[]} */
 export default [
   {

diff --git a/lib/md020.mjs b/lib/md020.mjs
@@ -3,6 +3,7 @@
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD020", "no-missing-space-closed-atx" ],

diff --git a/lib/md022.mjs b/lib/md022.mjs
@@ -18,6 +18,7 @@ const getLinesFunction = (linesParam) => {
   const lines = (linesParam === undefined) ? defaultLines : Number(linesParam);
   return () => lines;
 };
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD022", "blanks-around-headings" ],

diff --git a/lib/md023.mjs b/lib/md023.mjs
@@ -2,6 +2,7 @@
 
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD023", "heading-start-left" ],

diff --git a/lib/md024.mjs b/lib/md024.mjs
@@ -3,6 +3,7 @@
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { getHeadingLevel, getHeadingText } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD024", "no-duplicate-heading" ],

diff --git a/lib/md025.mjs b/lib/md025.mjs
@@ -3,6 +3,7 @@
 import { addErrorContext, frontMatterHasTitle } from "../helpers/helpers.cjs";
 import { getHeadingLevel, getHeadingText } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD025", "single-title", "single-h1" ],

diff --git a/lib/md026.mjs b/lib/md026.mjs
@@ -3,6 +3,7 @@
 import { addError, allPunctuationNoQuestion, endOfLineGemojiCodeRe,
   endOfLineHtmlEntityRe, escapeForRegExp } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD026", "no-trailing-punctuation" ],

diff --git a/lib/md027.mjs b/lib/md027.mjs
@@ -2,6 +2,7 @@
 
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD027", "no-multiple-space-blockquote" ],

diff --git a/lib/md028.mjs b/lib/md028.mjs
@@ -4,6 +4,7 @@ import { addError } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 const ignoreTypes = new Set([ "lineEnding", "listItemIndent", "linePrefix" ]);
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD028", "no-blanks-blockquote" ],

diff --git a/lib/md029.mjs b/lib/md029.mjs
@@ -19,6 +19,7 @@ const listStyleExamples = {
 function getOrderedListItemValue(listItemPrefix) {
   return Number(getDescendantsByType(listItemPrefix, [ "listItemValue" ])[0].text);
 }
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD029", "ol-prefix" ],

diff --git a/lib/md030.mjs b/lib/md030.mjs
@@ -2,6 +2,7 @@
 
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD030", "list-marker-space" ],

diff --git a/lib/md031.mjs b/lib/md031.mjs
@@ -37,6 +37,7 @@ function addError(onError, lines, lineNumber, top) {
     fixInfo
   );
 }
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD031", "blanks-around-fences" ],

diff --git a/lib/md032.mjs b/lib/md032.mjs
@@ -7,6 +7,7 @@ import { filterByTypesCached } from "./cache.mjs";
 const isList = (token) => (
   (token.type === "listOrdered") || (token.type === "listUnordered")
 );
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD032", "blanks-around-lists" ],

diff --git a/lib/md033.mjs b/lib/md033.mjs
@@ -3,6 +3,7 @@
 import { addError, nextLinesRe } from "../helpers/helpers.cjs";
 import { getHtmlTagInfo } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD033", "no-inline-html" ],

diff --git a/lib/md034.mjs b/lib/md034.mjs
@@ -2,6 +2,9 @@
 
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { filterByPredicate, getHtmlTagInfo, inHtmlFlow } from "../helpers/micromark-helpers.cjs";
+
+/** @typedef {import("micromark-extension-gfm-autolink-literal")} */
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD034", "no-bare-urls" ],

diff --git a/lib/md035.mjs b/lib/md035.mjs
@@ -2,6 +2,7 @@
 
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD035", "hr-style" ],

diff --git a/lib/md036.mjs b/lib/md036.mjs
@@ -10,6 +10,7 @@ const emphasisTypes = [
   [ "emphasis", "emphasisText" ],
   [ "strong", "strongText" ]
 ];
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD036", "no-emphasis-as-heading" ],

diff --git a/lib/md037.mjs b/lib/md037.mjs
@@ -2,6 +2,7 @@
 
 import { addError } from "../helpers/helpers.cjs";
 import { filterByPredicate, inHtmlFlow } from "../helpers/micromark-helpers.cjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD037", "no-space-in-emphasis" ],

diff --git a/lib/md038.mjs b/lib/md038.mjs
@@ -16,6 +16,7 @@ const trimCodeText = (text, start, end) => {
   }
   return text;
 };
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD038", "no-space-in-code" ],

diff --git a/lib/md039.mjs b/lib/md039.mjs
@@ -46,6 +46,7 @@ function addLabelSpaceError(onError, label, labelText, isStart) {
 function validLink(label, labelText, definitions) {
   return (label.parent?.children.length !== 1) || definitions.has(labelText.text.trim());
 }
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD039", "no-space-in-links" ],

diff --git a/lib/md040.mjs b/lib/md040.mjs
@@ -3,6 +3,7 @@
 import { addError, addErrorContext } from "../helpers/helpers.cjs";
 import { getDescendantsByType } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD040", "fenced-code-language" ],

diff --git a/lib/md041.mjs b/lib/md041.mjs
@@ -2,6 +2,7 @@
 
 import { addErrorContext, frontMatterHasTitle } from "../helpers/helpers.cjs";
 import { filterByTypes, getHeadingLevel, getHtmlTagInfo, isHtmlFlowComment, nonContentTokens } from "../helpers/micromark-helpers.cjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD041", "first-line-heading", "first-line-h1" ],

diff --git a/lib/md042.mjs b/lib/md042.mjs
@@ -3,6 +3,7 @@
 import { addErrorContext } from "../helpers/helpers.cjs";
 import { getDescendantsByType } from "../helpers/micromark-helpers.cjs";
 import { getReferenceLinkImageData, filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD042", "no-empty-links" ],

diff --git a/lib/md043.mjs b/lib/md043.mjs
@@ -3,6 +3,7 @@
 import { addErrorContext, addErrorDetailIf } from "../helpers/helpers.cjs";
 import { getHeadingLevel, getHeadingText } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD043", "required-headings" ],

diff --git a/lib/md044.mjs b/lib/md044.mjs
@@ -7,6 +7,7 @@ import { parse } from "../helpers/micromark-parse.mjs";
 const ignoredChildTypes = new Set(
   [ "codeFencedFence", "definition", "reference", "resource" ]
 );
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD044", "proper-names" ],

diff --git a/lib/md045.mjs b/lib/md045.mjs
@@ -5,6 +5,7 @@ import { getHtmlTagInfo, getDescendantsByType } from "../helpers/micromark-helpe
 import { filterByTypesCached } from "./cache.mjs";
 
 const altRe = getHtmlAttributeRe("alt");
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD045", "no-alt-text" ],

diff --git a/lib/md046.mjs b/lib/md046.mjs
@@ -7,6 +7,7 @@ const tokenTypeToStyle = {
   "codeFenced": "fenced",
   "codeIndented": "indented"
 };
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD046", "code-block-style" ],

diff --git a/lib/md047.mjs b/lib/md047.mjs
@@ -1,6 +1,7 @@
 // @ts-check
 
 import { addError, isBlankLine } from "../helpers/helpers.cjs";
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD047", "single-trailing-newline" ],

diff --git a/lib/md048.mjs b/lib/md048.mjs
@@ -18,6 +18,7 @@ function fencedCodeBlockStyleFor(markup) {
       return "backtick";
   }
 };
+
 /** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD048", "code-fence-style" ],

diff --git a/lib/md049-md050.mjs b/lib/md049-md050.mjs
@@ -75,6 +75,7 @@ const impl =
       }
     }
   };
+
 /** @type {import("./markdownlint.mjs").Rule[]} */
 export default [
   {