wip

demo/markdownlint-browser.js

@@ -1571,7 +1571,7 @@ function annotateAndFreezeTokens(tokens, lines) {
  * @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins.
  * @param {string} content Markdown content.
  * @param {string[]} lines Lines of Markdown content.
- * @returns {import("../lib/markdownlint").MarkdownItToken} Array of markdown-it tokens.
+ * @returns {import("../lib/markdownlint.mjs").MarkdownItToken} Array of markdown-it tokens.
  */
 function getMarkdownItTokens(markdownItPlugins, content, lines) {
   const markdownit = __webpack_require__(/*! markdown-it */ "markdown-it");

doc/CustomRules.md

@@ -36,7 +36,7 @@ A simple rule implementation using the `micromark` parser to report a violation
 for any use of blockquotes might look like:
 
 ```javascript
-/** @type import("markdownlint").Rule */
+/** @type {import("markdownlint").Rule} */
 module.exports = {
   "names": [ "any-blockquote-micromark" ],
   "description": "Rule that reports an error for any blockquote",
@@ -61,7 +61,7 @@ module.exports = {
 That same rule implemented using the `markdown-it` parser might look like:
 
 ```javascript
-/** @type import("markdownlint").Rule */
+/** @type {import("markdownlint").Rule} */
 module.exports = {
   "names": [ "any-blockquote-markdown-it" ],
   "description": "Rule that reports an error for any blockquote",

helpers/helpers.cjs

@@ -9,8 +9,8 @@ const { newLineRe, nextLinesRe } = require("./shared.cjs");
 module.exports.newLineRe = newLineRe;
 module.exports.nextLinesRe = nextLinesRe;
 
-/** @typedef {import("../lib/markdownlint.js").RuleOnError} RuleOnError */
-/** @typedef {import("../lib/markdownlint.js").RuleOnErrorFixInfo} RuleOnErrorFixInfo */
+/** @typedef {import("../lib/markdownlint.mjs").RuleOnError} RuleOnError */
+/** @typedef {import("../lib/markdownlint.mjs").RuleOnErrorFixInfo} RuleOnErrorFixInfo */
 
 // Regular expression for matching common front matter (YAML and TOML)
 module.exports.frontMatterRe =
@@ -336,8 +336,8 @@ const positionLessThanOrEqual = (lineA, columnA, lineB, columnB) => (
 /**
  * Returns whether two ranges (or MicromarkTokens) overlap anywhere.
  *
- * @param {FileRange|import("../lib/markdownlint.js").MicromarkToken} rangeA Range A.
- * @param {FileRange|import("../lib/markdownlint.js").MicromarkToken} rangeB Range B.
+ * @param {FileRange|import("../lib/markdownlint.mjs").MicromarkToken} rangeA Range A.
+ * @param {FileRange|import("../lib/markdownlint.mjs").MicromarkToken} rangeB Range B.
  * @returns {boolean} True iff the two ranges overlap.
  */
 module.exports.hasOverlap = function hasOverlap(rangeA, rangeB) {

helpers/micromark-helpers.cjs

@@ -4,8 +4,8 @@
 
 const { flatTokensSymbol, htmlFlowSymbol } = require("./shared.cjs");
 
-/** @typedef {import("markdownlint-micromark").TokenType} TokenType */
-/** @typedef {import("../lib/markdownlint.js").MicromarkToken} Token */
+/** @typedef {import("micromark-util-types").TokenType} TokenType */
+/** @typedef {import("../lib/markdownlint.mjs").MicromarkToken} Token */
 
 /**
  * Determines if a Micromark token is within an htmlFlow type.

helpers/micromark-parse.mjs

@@ -12,19 +12,14 @@ import { labelEnd } from "micromark-core-commonmark";
 import { isHtmlFlowComment } from "./micromark-helpers.cjs";
 import { flatTokensSymbol, htmlFlowSymbol, newLineRe } from "./shared.cjs";
 
+/** @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("./micromark-types").PlaceholderForImporting} */
 /** @typedef {import("../lib/markdownlint.mjs").MicromarkToken} MicromarkToken */
 
-// export declare interface TokenTypeMap {
-//   undefinedReference: 'undefinedReference'
-//   undefinedReferenceCollapsed: 'undefinedReferenceCollapsed'
-//   undefinedReferenceFull: 'undefinedReferenceFull'
-//   undefinedReferenceShortcut: 'undefinedReferenceShortcut'
-// }
-
 /**
  * Parse options.
  *

helpers/micromark-types.d.ts

@@ -0,0 +1,12 @@
+// Augment TokenTypeMap with markdownlint-specific types.
+export declare module "micromark-util-types" {
+  interface TokenTypeMap {
+    undefinedReference: "undefinedReference"
+    undefinedReferenceCollapsed: "undefinedReferenceCollapsed"
+    undefinedReferenceFull: "undefinedReferenceFull"
+    undefinedReferenceShortcut: "undefinedReferenceShortcut"
+  }
+}
+
+// Placeholder to use when importing.
+declare type PlaceholderForImporting = never;

lib/cache.mjs

@@ -1,6 +1,6 @@
 // @ts-check
 
-import helpers from "../helpers/helpers.cjs";
+import { getReferenceLinkImageData as helpersGetReferenceLinkImageData } from "../helpers/helpers.cjs";
 import { filterByTypes } from "../helpers/micromark-helpers.cjs";
 
 /** @type {Map<string, object>} */
@@ -10,7 +10,7 @@ let params = undefined;
 /**
  * Initializes (resets) the cache.
  *
- * @param {import("./markdownlint").RuleParams} [p] Rule parameters object.
+ * @param {import("./markdownlint.mjs").RuleParams} [p] Rule parameters object.
  * @returns {void}
  */
 export function initialize(p) {
@@ -37,9 +37,9 @@ function getCached(name, getValue) {
 /**
  * Filters a list of Micromark tokens by type and caches the result.
  *
- * @param {import("./markdownlint").MicromarkTokenType[]} types Types to allow.
+ * @param {import("./markdownlint.mjs").MicromarkTokenType[]} types Types to allow.
  * @param {boolean} [htmlFlow] Whether to include htmlFlow content.
- * @returns {import("./markdownlint").MicromarkToken[]} Filtered tokens.
+ * @returns {import("./markdownlint.mjs").MicromarkToken[]} Filtered tokens.
  */
 export function filterByTypesCached(types, htmlFlow) {
   return getCached(
@@ -57,6 +57,6 @@ export function filterByTypesCached(types, htmlFlow) {
 export function getReferenceLinkImageData() {
   return getCached(
     getReferenceLinkImageData.name,
-    () => helpers.getReferenceLinkImageData(params.parsers.micromark.tokens)
+    () => helpersGetReferenceLinkImageData(params.parsers.micromark.tokens)
   );
 }

lib/markdownit.cjs

@@ -67,7 +67,7 @@ function forEachInlineCodeSpan(input, handler) {
 /**
  * Freeze all freeze-able members of a token and its children.
  *
- * @param {import("./markdownlint").MarkdownItToken} token A markdown-it token.
+ * @param {import("./markdownlint.mjs").MarkdownItToken} token A markdown-it token.
  * @returns {void}
  */
 function freezeToken(token) {
@@ -99,7 +99,7 @@ function freezeToken(token) {
 function annotateAndFreezeTokens(tokens, lines) {
   let trMap = null;
   // eslint-disable-next-line jsdoc/valid-types
-  /** @type import("./markdownlint").MarkdownItToken[] */
+  /** @type {import("./markdownlint.mjs").MarkdownItToken[]} */
   // @ts-ignore
   const markdownItTokens = tokens;
   for (const token of markdownItTokens) {
@@ -148,10 +148,10 @@ function annotateAndFreezeTokens(tokens, lines) {
 /**
  * Gets an array of markdown-it tokens for the input.
  *
- * @param {import("./markdownlint").Plugin[]} markdownItPlugins Additional plugins.
+ * @param {import("./markdownlint.mjs").Plugin[]} markdownItPlugins Additional plugins.
  * @param {string} content Markdown content.
  * @param {string[]} lines Lines of Markdown content.
- * @returns {import("../lib/markdownlint").MarkdownItToken} Array of markdown-it tokens.
+ * @returns {import("../lib/markdownlint.mjs").MarkdownItToken} Array of markdown-it tokens.
  */
 function getMarkdownItTokens(markdownItPlugins, content, lines) {
   const markdownit = require("markdown-it");

lib/markdownlint.mjs

@@ -1,16 +1,16 @@
 // @ts-check
 
-import nodeFs from "node:fs";
+import * as nodeFs from "node:fs";
 import { createRequire } from "node:module";
 const dynamicRequire = createRequire(import.meta.url);
-import os from "node:os";
+import * as os from "node:os";
 import path from "node:path";
 import { promisify } from "node:util";
 import { getMarkdownItTokens } from "./markdownit.cjs";
 import { parse as micromarkParse } from "../helpers/micromark-parse.mjs";
 import { version } from "./constants.mjs";
 import rules from "./rules.mjs";
-import helpers from "../helpers/helpers.cjs";
+import * as helpers from "../helpers/helpers.cjs";
 import { initialize as cacheInitialize } from "./cache.mjs";
 
 /**
@@ -1411,7 +1411,7 @@ export default markdownlint;
  * @property {string} line Line content.
  */
 
-/** @typedef {import("markdownlint-micromark").TokenType} MicromarkTokenType */
+/** @typedef {import("micromark-util-types").TokenType} MicromarkTokenType */
 
 /**
  * micromark token.

lib/md001.mjs

@@ -5,7 +5,7 @@ import { getHeadingLevel } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD001", "heading-increment" ],
   "description": "Heading levels should only increment by one level at a time",

lib/md003.mjs

@@ -5,7 +5,7 @@ import { getHeadingLevel, getHeadingStyle } from "../helpers/micromark-helpers.c
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD003", "heading-style" ],
   "description": "Heading style",

lib/md004.mjs

@@ -28,7 +28,7 @@ const validStyles = new Set([
 ]);
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD004", "ul-style" ],
   "description": "Unordered list style",

lib/md005.mjs

@@ -4,7 +4,7 @@ import { addError, addErrorDetailIf } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD005", "list-indent" ],
   "description": "Inconsistent indentation for list items at the same level",

lib/md007.mjs

@@ -5,16 +5,16 @@ import { getParentOfType } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("markdownlint-micromark").TokenType[] */
+/** @type {import("micromark-util-types").TokenType[]} */
 const unorderedListTypes =
   [ "blockQuotePrefix", "listItemPrefix", "listUnordered" ];
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("markdownlint-micromark").TokenType[] */
+/** @type {import("micromark-util-types").TokenType[]} */
 const unorderedParentTypes =
   [ "blockQuote", "listOrdered", "listUnordered" ];
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD007", "ul-indent" ],
   "description": "Unordered list indentation",

lib/md009.mjs

@@ -5,7 +5,7 @@ import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD009", "no-trailing-spaces" ],
   "description": "Trailing spaces",

lib/md010.mjs

@@ -7,7 +7,7 @@ import { filterByTypesCached } from "./cache.mjs";
 const tabRe = /\t+/g;
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD010", "no-hard-tabs" ],
   "description": "Hard tabs",
@@ -25,7 +25,7 @@ export default {
       1 :
       Math.max(0, Number(spacesPerTab));
     // eslint-disable-next-line jsdoc/valid-types
-    /** @type import("../helpers/micromark-helpers.cjs").TokenType[] */
+    /** @type {import("../helpers/micromark-helpers.cjs").TokenType[]} */
     const exclusionTypes = [];
     if (includeCode) {
       if (ignoreCodeLanguages.size > 0) {
@@ -58,7 +58,7 @@ export default {
         const lineNumber = lineIndex + 1;
         const column = match.index + 1;
         const length = match[0].length;
-        /** @type {import("../helpers").FileRange} */
+        /** @type {import("../helpers/helpers.cjs").FileRange} */
         const range = { "startLine": lineNumber, "startColumn": column, "endLine": lineNumber, "endColumn": column + length - 1 };
         if (!codeRanges.some((codeRange) => hasOverlap(codeRange, range))) {
           addError(

lib/md011.mjs

@@ -8,7 +8,7 @@ const reversedLinkRe =
   /(^|[^\\])\(([^()]+)\)\[([^\]^][^\]]*)\](?!\()/g;
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD011", "no-reversed-links" ],
   "description": "Reversed link syntax",
@@ -32,7 +32,7 @@ export default {
           ) {
             const column = match.index + preChar.length + 1;
             const length = match[0].length - preChar.length;
-            /** @type {import("../helpers").FileRange} */
+            /** @type {import("../helpers/helpers.cjs").FileRange} */
             const range = { "startLine": lineNumber, "startColumn": column, "endLine": lineNumber, "endColumn": column + length - 1 };
             if (!codeTexts.some((codeText) => hasOverlap(codeText, range))) {
               addError(

lib/md012.mjs

@@ -5,7 +5,7 @@ import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD012", "no-multiple-blanks" ],
   "description": "Multiple consecutive blank lines",

lib/md013.mjs

@@ -10,7 +10,7 @@ const longLineRePostfixStrict = "}.+$";
 const sternModeRe = /^(?:[#>\s]*\s)?\S*$/;
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD013", "line-length" ],
   "description": "Line length",

lib/md014.mjs

@@ -6,7 +6,7 @@ import { filterByTypesCached } from "./cache.mjs";
 const dollarCommandRe = /^(\s*)(\$\s+)/;
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD014", "commands-show-output" ],
   "description": "Dollar signs used before commands without showing output",

lib/md018.mjs

@@ -5,7 +5,7 @@ import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD018", "no-missing-space-atx" ],
   "description": "No space after hash on atx style heading",

lib/md019-md021.mjs

@@ -7,8 +7,8 @@ import { filterByTypesCached } from "./cache.mjs";
 /**
  * Validate heading sequence and whitespace length at start or end.
  *
- * @param {import("./markdownlint").RuleOnError} onError Error-reporting callback.
- * @param {import("./markdownlint").MicromarkToken} heading ATX heading token.
+ * @param {import("./markdownlint.mjs").RuleOnError} onError Error-reporting callback.
+ * @param {import("./markdownlint.mjs").MicromarkToken} heading ATX heading token.
  * @param {number} delta Direction to scan.
  * @returns {void}
  */
@@ -46,7 +46,7 @@ function validateHeadingSpaces(onError, heading, delta) {
 }
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule[] */
+/** @type {import("./markdownlint.mjs").Rule[]} */
 export default [
   {
     "names": [ "MD019", "no-multiple-space-atx" ],

lib/md020.mjs

@@ -5,7 +5,7 @@ import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD020", "no-missing-space-closed-atx" ],
   "description": "No space inside hashes on closed atx style heading",

lib/md022.mjs

@@ -20,7 +20,7 @@ const getLinesFunction = (linesParam) => {
 };
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD022", "blanks-around-headings" ],
   "description": "Headings should be surrounded by blank lines",

lib/md023.mjs

@@ -4,7 +4,7 @@ import { addErrorContext } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD023", "heading-start-left" ],
   "description": "Headings must start at the beginning of the line",

lib/md024.mjs

@@ -5,7 +5,7 @@ import { getHeadingLevel, getHeadingText } from "../helpers/micromark-helpers.cj
 import { filterByTypesCached } from "./cache.mjs";
 
 // eslint-disable-next-line jsdoc/valid-types
-/** @type import("./markdownlint").Rule */
+/** @type {import("./markdownlint.mjs").Rule} */
 export default {
   "names": [ "MD024", "no-duplicate-heading" ],
   "description": "Multiple headings with the same content",