markdownlint 0.36.1 → 0.37.0

package/lib/{md044.js → md044.mjs}

@@ -1,18 +1,15 @@
 // @ts-check
 
-"use strict";
-
-const { addErrorDetailIf, escapeForRegExp, hasOverlap } = require("../helpers");
-const { filterByPredicate, filterByTypes } = require("../helpers/micromark-helpers.cjs");
-const { parse } = require("../helpers/micromark-parse.cjs");
+import { addErrorDetailIf, escapeForRegExp, hasOverlap } from "../helpers/helpers.cjs";
+import { filterByPredicate, filterByTypes } from "../helpers/micromark-helpers.cjs";
+import { parse } from "./micromark-parse.mjs";
 
 const ignoredChildTypes = new Set(
   [ "codeFencedFence", "definition", "reference", "resource" ]
 );
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD044", "proper-names" ],
   "description": "Proper names should have the correct capitalization",
   "tags": [ "spelling" ],
@@ -48,7 +45,7 @@ module.exports = {
           token.children.filter((t) => !ignoredChildTypes.has(t.type))
         )
       );
-    /** @type {import("../helpers").FileRange[]} */
+    /** @type {import("../helpers/helpers.cjs").FileRange[]} */
     const exclusions = [];
     const scannedTokens = new Set();
     for (const name of names) {
@@ -64,7 +61,7 @@ module.exports = {
           const column = token.startColumn + match.index + leftMatch.length;
           const length = nameMatch.length;
           const lineNumber = token.startLine;
-          /** @type {import("../helpers").FileRange} */
+          /** @type {import("../helpers/helpers.cjs").FileRange} */
           const nameRange = {
             "startLine": lineNumber,
             "startColumn": column,
@@ -75,7 +72,7 @@ module.exports = {
             !names.includes(nameMatch) &&
             !exclusions.some((exclusion) => hasOverlap(exclusion, nameRange))
           ) {
-            /** @type {import("../helpers").FileRange[]} */
+            /** @type {import("../helpers/helpers.cjs").FileRange[]} */
             let autolinkRanges = [];
             if (!scannedTokens.has(token)) {
               autolinkRanges = filterByTypes(parse(token.text), [ "literalAutolink" ])

package/lib/{md045.js → md045.mjs}

@@ -1,16 +1,13 @@
 // @ts-check
 
-"use strict";
-
-const { addError, getHtmlAttributeRe, nextLinesRe } = require("../helpers");
-const { getHtmlTagInfo, getDescendantsByType } = require("../helpers/micromark-helpers.cjs");
-const { filterByTypesCached } = require("./cache");
+import { addError, getHtmlAttributeRe, nextLinesRe } from "../helpers/helpers.cjs";
+import { getHtmlTagInfo, getDescendantsByType } from "../helpers/micromark-helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
 const altRe = getHtmlAttributeRe("alt");
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD045", "no-alt-text" ],
   "description": "Images should have alternate text (alt text)",
   "tags": [ "accessibility", "images" ],

package/lib/{md046.js → md046.mjs}

@@ -1,18 +1,15 @@
 // @ts-check
 
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-const { filterByTypesCached } = require("./cache");
+import { addErrorDetailIf } from "../helpers/helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
 const tokenTypeToStyle = {
   "codeFenced": "fenced",
   "codeIndented": "indented"
 };
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD046", "code-block-style" ],
   "description": "Code block style",
   "tags": [ "code" ],

package/lib/{md047.js → md047.mjs}

@@ -1,12 +1,9 @@
 // @ts-check
 
-"use strict";
+import { addError, isBlankLine } from "../helpers/helpers.cjs";
 
-const { addError, isBlankLine } = require("../helpers");
-
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD047", "single-trailing-newline" ],
   "description": "Files should end with a single newline character",
   "tags": [ "blank_lines" ],

package/lib/{md048.js → md048.mjs}

@@ -1,10 +1,8 @@
 // @ts-check
 
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-const { getDescendantsByType } = require("../helpers/micromark-helpers.cjs");
-const { filterByTypesCached } = require("./cache");
+import { addErrorDetailIf } from "../helpers/helpers.cjs";
+import { getDescendantsByType } from "../helpers/micromark-helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
 /**
  * Return the string representation of a fence markup character.
@@ -21,9 +19,8 @@ function fencedCodeBlockStyleFor(markup) {
   }
 };
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD048", "code-fence-style" ],
   "description": "Code fence style",
   "tags": [ "code" ],

package/lib/{md049-md050.js → md049-md050.mjs}

@@ -1,9 +1,7 @@
 // @ts-check
 
-"use strict";
-
-const { addError } = require("../helpers");
-const { filterByPredicate, getDescendantsByType } = require("../helpers/micromark-helpers.cjs");
+import { addError } from "../helpers/helpers.cjs";
+import { filterByPredicate, getDescendantsByType } from "../helpers/micromark-helpers.cjs";
 
 const intrawordRe = /^\w$/;
 
@@ -23,10 +21,10 @@ function emphasisOrStrongStyleFor(markup) {
 };
 
 /**
- * @param {import("./markdownlint").RuleParams} params Rule parameters.
- * @param {import("./markdownlint").RuleOnError} onError Error-reporting callback.
- * @param {import("markdownlint-micromark").TokenType} type Token type.
- * @param {import("markdownlint-micromark").TokenType} typeSequence Token sequence type.
+ * @param {import("markdownlint").RuleParams} params Rule parameters.
+ * @param {import("markdownlint").RuleOnError} onError Error-reporting callback.
+ * @param {import("micromark-util-types").TokenType} type Token type.
+ * @param {import("micromark-util-types").TokenType} typeSequence Token sequence type.
  * @param {"*" | "**"} asterisk Asterisk kind.
  * @param {"_" | "__"} underline Underline kind.
  * @param {"asterisk" | "consistent" | "underscore"} style Style string.
@@ -78,9 +76,8 @@ const impl =
     }
   };
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule[] */
-module.exports = [
+/** @type {import("markdownlint").Rule[]} */
+export default [
   {
     "names": [ "MD049", "emphasis-style" ],
     "description": "Emphasis style",

package/lib/{md051.js → md051.mjs}

@@ -1,10 +1,8 @@
 // @ts-check
 
-"use strict";
-
-const { addError, getHtmlAttributeRe } = require("../helpers");
-const { filterByPredicate, filterByTypes, getHtmlTagInfo } = require("../helpers/micromark-helpers.cjs");
-const { filterByTypesCached } = require("./cache");
+import { addError, getHtmlAttributeRe } from "../helpers/helpers.cjs";
+import { filterByPredicate, filterByTypes, getHtmlTagInfo } from "../helpers/micromark-helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
 // Regular expression for identifying HTML anchor names
 const idRe = getHtmlAttributeRe("id");
@@ -22,7 +20,7 @@ const tokensInclude = new Set(
  * Converts a Markdown heading into an HTML fragment according to the rules
  * used by GitHub.
  *
- * @param {import("../helpers/micromark-helpers.cjs").Token} headingText Heading text token.
+ * @param {import("markdownlint").MicromarkToken} headingText Heading text token.
  * @returns {string} Fragment string for heading.
  */
 function convertHeadingToHTMLFragment(headingText) {
@@ -51,7 +49,7 @@ function convertHeadingToHTMLFragment(headingText) {
 /**
  * Unescapes the text of a String-type micromark Token.
  *
- * @param {import("../helpers/micromark-helpers.cjs").Token} token String-type micromark Token.
+ * @param {import("markdownlint").MicromarkToken} token String-type micromark Token.
  * @returns {string} Unescaped token text.
  */
 function unescapeStringTokenText(token) {
@@ -60,9 +58,8 @@ function unescapeStringTokenText(token) {
     .join("");
 }
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD051", "link-fragments" ],
   "description": "Link fragments should be valid",
   "tags": [ "links" ],
@@ -104,8 +101,7 @@ module.exports = {
     }
 
     // Process link and definition fragments
-    // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark-helpers.cjs").TokenType[][] */
+    /** @type {import("markdownlint").MicromarkTokenType[][]} */
     const parentChilds = [
       [ "link", "resourceDestinationString" ],
       [ "definition", "definitionDestinationString" ]

package/lib/{md052.js → md052.mjs}

@@ -1,13 +1,10 @@
 // @ts-check
 
-"use strict";
+import { addError } from "../helpers/helpers.cjs";
+import { getReferenceLinkImageData } from "./cache.mjs";
 
-const { addError } = require("../helpers");
-const { getReferenceLinkImageData } = require("./cache");
-
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD052", "reference-links-images" ],
   "description":
     "Reference links and images should use a label that is defined",

package/lib/{md053.js → md053.mjs}

@@ -1,15 +1,12 @@
 // @ts-check
 
-"use strict";
-
-const { addError, ellipsify } = require("../helpers");
-const { getReferenceLinkImageData } = require("./cache");
+import { addError, ellipsify } from "../helpers/helpers.cjs";
+import { getReferenceLinkImageData } from "./cache.mjs";
 
 const linkReferenceDefinitionRe = /^ {0,3}\[([^\]]*[^\\])\]:/;
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD053", "link-image-reference-definitions" ],
   "description": "Link and image reference definitions should be needed",
   "tags": [ "images", "links" ],

package/lib/{md054.js → md054.mjs}

@@ -1,10 +1,8 @@
 // @ts-check
 
-"use strict";
-
-const { addErrorContext, nextLinesRe } = require("../helpers");
-const { getDescendantsByType } = require("../helpers/micromark-helpers.cjs");
-const { getReferenceLinkImageData, filterByTypesCached } = require("./cache");
+import { addErrorContext, nextLinesRe } from "../helpers/helpers.cjs";
+import { getDescendantsByType } from "../helpers/micromark-helpers.cjs";
+import { getReferenceLinkImageData, filterByTypesCached } from "./cache.mjs";
 
 const backslashEscapeRe = /\\([!"#$%&'()*+,\-./:;<=>?@[\\\]^_`{|}~])/g;
 const removeBackslashEscapes = (text) => text.replace(backslashEscapeRe, "$1");
@@ -20,9 +18,8 @@ const autolinkAble = (destination) => {
   return !autolinkDisallowedRe.test(destination);
 };
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD054", "link-image-style" ],
   "description": "Link and image style",
   "tags": [ "images", "links" ],

package/lib/{md055.js → md055.mjs}

@@ -1,9 +1,7 @@
 // @ts-check
 
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-const { filterByTypesCached } = require("./cache");
+import { addErrorDetailIf } from "../helpers/helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
 const whitespaceTypes = new Set([ "linePrefix", "whitespace" ]);
 const ignoreWhitespace = (tokens) => tokens.filter(
@@ -13,9 +11,10 @@ const firstOrNothing = (items) => items[0];
 const lastOrNothing = (items) => items[items.length - 1];
 const makeRange = (start, end) => [ start, end - start + 1 ];
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @typedef {import("micromark-extension-gfm-table")} */
+
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD055", "table-pipe-style" ],
   "description": "Table pipe style",
   "tags": [ "table" ],

package/lib/{md056.js → md056.mjs}

@@ -1,16 +1,15 @@
 // @ts-check
 
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-const { getParentOfType } = require("../helpers/micromark-helpers.cjs");
-const { filterByTypesCached } = require("./cache");
+import { addErrorDetailIf } from "../helpers/helpers.cjs";
+import { getParentOfType } from "../helpers/micromark-helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
 const makeRange = (start, end) => [ start, end - start + 1 ];
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @typedef {import("micromark-extension-gfm-table")} */
+
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD056", "table-column-count" ],
   "description": "Table column count",
   "tags": [ "table" ],

package/lib/{md058.js → md058.mjs}

@@ -1,14 +1,13 @@
 // @ts-check
 
-"use strict";
+import { addErrorContext, isBlankLine } from "../helpers/helpers.cjs";
+import { getBlockQuotePrefixText } from "../helpers/micromark-helpers.cjs";
+import { filterByTypesCached } from "./cache.mjs";
 
-const { addErrorContext, isBlankLine } = require("../helpers");
-const { getBlockQuotePrefixText } = require("../helpers/micromark-helpers.cjs");
-const { filterByTypesCached } = require("./cache");
+/** @typedef {import("micromark-extension-gfm-table")} */
 
-// eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
-module.exports = {
+/** @type {import("markdownlint").Rule} */
+export default {
   "names": [ "MD058", "blanks-around-tables" ],
   "description": "Tables should be surrounded by blank lines",
   "tags": [ "table" ],

package/{helpers/micromark-parse.cjs → lib/micromark-parse.mjs}

@@ -1,18 +1,24 @@
 // @ts-check
 
-"use strict";
+import { directive } from "micromark-extension-directive";
+import { gfmAutolinkLiteral } from "micromark-extension-gfm-autolink-literal";
+import { gfmFootnote } from "micromark-extension-gfm-footnote";
+import { gfmTable } from "micromark-extension-gfm-table";
+import { math } from "micromark-extension-math";
+import { parse as micromarkParse, postprocess as micromarkPostprocess, preprocess as micromarkPreprocess } from "micromark";
+// micromark-core-commonmark is not a dependency because this instance must match what's used by micromark
+// eslint-disable-next-line n/no-extraneous-import
+import { labelEnd } from "micromark-core-commonmark";
+import { isHtmlFlowComment } from "../helpers/micromark-helpers.cjs";
+import { flatTokensSymbol, htmlFlowSymbol, newLineRe } from "../helpers/shared.cjs";
 
-const micromark = require("markdownlint-micromark");
-const { isHtmlFlowComment } = require("./micromark-helpers.cjs");
-const { flatTokensSymbol, htmlFlowSymbol, newLineRe } = require("./shared.js");
-
-/** @typedef {import("markdownlint-micromark").Construct} Construct */
-/** @typedef {import("markdownlint-micromark").Event} Event */
-/** @typedef {import("markdownlint-micromark").ParseOptions} MicromarkParseOptions */
-/** @typedef {import("markdownlint-micromark").State} State */
-/** @typedef {import("markdownlint-micromark").Token} Token */
-/** @typedef {import("markdownlint-micromark").Tokenizer} Tokenizer */
-/** @typedef {import("../lib/markdownlint.js").MicromarkToken} MicromarkToken */
+/** @typedef {import("micromark-util-types").Event} Event */
+/** @typedef {import("micromark-util-types").ParseOptions} MicromarkParseOptions */
+/** @typedef {import("micromark-util-types").State} State */
+/** @typedef {import("micromark-util-types").Token} Token */
+/** @typedef {import("micromark-util-types").Tokenizer} Tokenizer */
+/** @typedef {import("markdownlint").MicromarkToken} MicromarkToken */
+/** @typedef {import("./micromark-types.d.mts")} */
 
 /**
  * Parse options.
@@ -28,27 +34,23 @@ const { flatTokensSymbol, htmlFlowSymbol, newLineRe } = require("./shared.js");
  * @param {MicromarkParseOptions} [micromarkParseOptions] Options for micromark.
  * @returns {Event[]} Micromark events.
  */
-function getEvents(
+export function getEvents(
   markdown,
   micromarkParseOptions = {}
 ) {
   // Customize extensions list to add useful extensions
   const extensions = [
-    micromark.directive(),
-    micromark.gfmAutolinkLiteral(),
-    micromark.gfmFootnote(),
-    micromark.gfmTable(),
-    micromark.math(),
+    directive(),
+    gfmAutolinkLiteral(),
+    gfmFootnote(),
+    gfmTable(),
+    math(),
     ...(micromarkParseOptions.extensions || [])
   ];
 
   // // Shim labelEnd to identify undefined link labels
   /** @type {Event[][]} */
   const artificialEventLists = [];
-  /** @type {Construct} */
-  const labelEnd =
-    // @ts-ignore
-    micromark.labelEnd;
   const tokenizeOriginal = labelEnd.tokenize;
 
   /** @type {Tokenizer} */
@@ -162,9 +164,9 @@ function getEvents(
     // Use micromark to parse document into Events
     const encoding = undefined;
     const eol = true;
-    const parseContext = micromark.parse({ ...micromarkParseOptions, extensions });
-    const chunks = micromark.preprocess()(markdown, encoding, eol);
-    const events = micromark.postprocess(parseContext.document().write(chunks));
+    const parseContext = micromarkParse({ ...micromarkParseOptions, extensions });
+    const chunks = micromarkPreprocess()(markdown, encoding, eol);
+    const events = micromarkPostprocess(parseContext.document().write(chunks));
 
     // Append artificial events and return all events
     // eslint-disable-next-line unicorn/prefer-spread
@@ -214,8 +216,7 @@ function parseInternal(
   };
   const history = [ root ];
   let current = root;
-  // eslint-disable-next-line jsdoc/valid-types
-  /** @type MicromarkParseOptions | null */
+  /** @type {MicromarkParseOptions | null} */
   let reparseOptions = null;
   let lines = null;
   let skipHtmlFlowChildren = false;
@@ -303,11 +304,6 @@ function parseInternal(
  * @param {ParseOptions} [parseOptions] Options.
  * @returns {MicromarkToken[]} Micromark tokens.
  */
-function parse(markdown, parseOptions) {
+export function parse(markdown, parseOptions) {
   return parseInternal(markdown, parseOptions);
 }
-
-module.exports = {
-  getEvents,
-  parse
-};

package/lib/micromark-types.d.mts

@@ -0,0 +1,11 @@
+export {};
+
+// Augment TokenTypeMap with markdownlint-specific types.
+declare module "micromark-util-types" {
+  export interface TokenTypeMap {
+    undefinedReference: "undefinedReference"
+    undefinedReferenceCollapsed: "undefinedReferenceCollapsed"
+    undefinedReferenceFull: "undefinedReferenceFull"
+    undefinedReferenceShortcut: "undefinedReferenceShortcut"
+  }
+}

package/lib/rules.mjs

@@ -0,0 +1,118 @@
+// @ts-check
+
+import { homepage, version } from "./constants.mjs";
+
+import md001 from "./md001.mjs";
+import md003 from "./md003.mjs";
+import md004 from "./md004.mjs";
+import md005 from "./md005.mjs";
+import md007 from "./md007.mjs";
+import md009 from "./md009.mjs";
+import md010 from "./md010.mjs";
+import md011 from "./md011.mjs";
+import md012 from "./md012.mjs";
+import md013 from "./md013.mjs";
+import md014 from "./md014.mjs";
+import md018 from "./md018.mjs";
+import md019md021 from "./md019-md021.mjs";
+const [ md019, md021 ] = md019md021;
+import md020 from "./md020.mjs";
+import md022 from "./md022.mjs";
+import md023 from "./md023.mjs";
+import md024 from "./md024.mjs";
+import md025 from "./md025.mjs";
+import md026 from "./md026.mjs";
+import md027 from "./md027.mjs";
+import md028 from "./md028.mjs";
+import md029 from "./md029.mjs";
+import md030 from "./md030.mjs";
+import md031 from "./md031.mjs";
+import md032 from "./md032.mjs";
+import md033 from "./md033.mjs";
+import md034 from "./md034.mjs";
+import md035 from "./md035.mjs";
+import md036 from "./md036.mjs";
+import md037 from "./md037.mjs";
+import md038 from "./md038.mjs";
+import md039 from "./md039.mjs";
+import md040 from "./md040.mjs";
+import md041 from "./md041.mjs";
+import md042 from "./md042.mjs";
+import md043 from "./md043.mjs";
+import md044 from "./md044.mjs";
+import md045 from "./md045.mjs";
+import md046 from "./md046.mjs";
+import md047 from "./md047.mjs";
+import md048 from "./md048.mjs";
+import md049md050 from "./md049-md050.mjs";
+const [ md049, md050 ] = md049md050;
+import md051 from "./md051.mjs";
+import md052 from "./md052.mjs";
+import md053 from "./md053.mjs";
+import md054 from "./md054.mjs";
+import md055 from "./md055.mjs";
+import md056 from "./md056.mjs";
+import md058 from "./md058.mjs";
+
+const rules = [
+  md001,
+  // md002: Deprecated and removed
+  md003,
+  md004,
+  md005,
+  // md006: Deprecated and removed
+  md007,
+  md009,
+  md010,
+  md011,
+  md012,
+  md013,
+  md014,
+  md018,
+  md019,
+  md020,
+  md021,
+  md022,
+  md023,
+  md024,
+  md025,
+  md026,
+  md027,
+  md028,
+  md029,
+  md030,
+  md031,
+  md032,
+  md033,
+  md034,
+  md035,
+  md036,
+  md037,
+  md038,
+  md039,
+  md040,
+  md041,
+  md042,
+  md043,
+  md044,
+  md045,
+  md046,
+  md047,
+  md048,
+  md049,
+  md050,
+  md051,
+  md052,
+  md053,
+  md054,
+  md055,
+  md056,
+  // md057: See https://github.com/markdownlint/markdownlint
+  md058
+];
+for (const rule of rules) {
+  const name = rule.names[0].toLowerCase();
+  // eslint-disable-next-line dot-notation
+  rule["information"] = new URL(`${homepage}/blob/v${version}/doc/${name}.md`);
+}
+export default rules;

package/lib/types.d.mts

@@ -0,0 +1,12 @@
+declare module "markdownlint" {
+  export * from "./exports.mjs";
+}
+declare module "markdownlint/async" {
+  export * from "./exports-async.mjs";
+}
+declare module "markdownlint/promise" {
+  export * from "./exports-promise.mjs";
+}
+declare module "markdownlint/sync" {
+  export * from "./exports-sync.mjs";
+}