@electron/lint-roller 2.4.0 → 3.1.0

package/lib/markdown.ts

@@ -2,7 +2,7 @@ import * as fs from 'node:fs';
 import * as path from 'node:path';
 
 import * as glob from 'glob';
-import * as MarkdownIt from 'markdown-it';
+import MarkdownIt from 'markdown-it';
 import {
   githubSlugifier,
   resolveInternalDocumentLink,
@@ -17,16 +17,14 @@ import {
   MdLink,
   MdLinkKind,
 } from '@dsanders11/vscode-markdown-languageservice';
+import { visit } from 'unist-util-visit';
+import { fromMarkdown } from 'mdast-util-from-markdown';
 import { Emitter, Range } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { URI } from 'vscode-uri';
 
-import { dynamicImport } from './helpers';
-
 import type { Code, Definition, ImageReference, Link, LinkReference } from 'mdast';
-import type { fromMarkdown as FromMarkdownFunction } from 'mdast-util-from-markdown';
 import type { Node, Position } from 'unist';
-import type { visit as VisitFunction } from 'unist-util-visit';
 
 export type { Code };
 
@@ -186,10 +184,6 @@ export class MarkdownLinkComputer implements IMdLinkComputer {
   }
 
   async getAllLinks(document: ITextDocument): Promise<MdLink[]> {
-    const { fromMarkdown } = (await dynamicImport('mdast-util-from-markdown')) as {
-      fromMarkdown: typeof FromMarkdownFunction;
-    };
-
     const tree = fromMarkdown(document.getText());
 
     const links = [
@@ -202,158 +196,123 @@ export class MarkdownLinkComputer implements IMdLinkComputer {
   }
 
   async #getInlineLinks(document: ITextDocument, tree: Node): Promise<MdLink[]> {
-    const { visit } = (await dynamicImport('unist-util-visit')) as {
-      visit: typeof VisitFunction;
-    };
-
     const documentUri = URI.parse(document.uri);
     const links: MdLink[] = [];
 
-    visit(
-      tree,
-      (node) => node.type === 'link',
-      (node: Node) => {
-        const link = node as Link;
-        const href = createHref(documentUri, link.url, this.workspace);
-
-        if (href) {
-          const range = positionToRange(link.position!);
-
-          // NOTE - These haven't been implemented properly, but their
-          //        values aren't used for the link linting use-case
-          const targetRange = range;
-          const hrefRange = range;
-          const fragmentRange = undefined;
-
-          links.push({
-            kind: MdLinkKind.Link,
-            href,
-            source: {
-              hrefText: link.url,
-              resource: documentUri,
-              range,
-              targetRange,
-              hrefRange,
-              fragmentRange,
-              pathText: link.url.split('#')[0],
-            },
-          });
-        }
-      },
-    );
-
-    return links;
-  }
-
-  async #getReferenceLinks(document: ITextDocument, tree: Node): Promise<MdLink[]> {
-    const { visit } = (await dynamicImport('unist-util-visit')) as {
-      visit: typeof VisitFunction;
-    };
-
-    const links: MdLink[] = [];
+    visit(tree, 'link', (node: Node) => {
+      const link = node as Link;
+      const href = createHref(documentUri, link.url, this.workspace);
 
-    visit(
-      tree,
-      (node) => ['imageReference', 'linkReference'].includes(node.type),
-      (node: Node) => {
-        const link = node as ImageReference | LinkReference;
+      if (href) {
         const range = positionToRange(link.position!);
 
         // NOTE - These haven't been implemented properly, but their
         //        values aren't used for the link linting use-case
         const targetRange = range;
         const hrefRange = range;
+        const fragmentRange = undefined;
 
         links.push({
           kind: MdLinkKind.Link,
-          href: {
-            kind: HrefKind.Reference,
-            ref: link.label!,
-          },
+          href,
           source: {
-            hrefText: link.label!,
-            resource: URI.parse(document.uri),
+            hrefText: link.url,
+            resource: documentUri,
             range,
             targetRange,
             hrefRange,
-            fragmentRange: undefined,
-            pathText: link.label!,
+            fragmentRange,
+            pathText: link.url.split('#')[0],
           },
         });
-      },
-    );
+      }
+    });
 
     return links;
   }
 
-  async #getLinkDefinitions(document: ITextDocument, tree: Node): Promise<MdLink[]> {
-    const { visit } = (await dynamicImport('unist-util-visit')) as {
-      visit: typeof VisitFunction;
-    };
+  async #getReferenceLinks(document: ITextDocument, tree: Node): Promise<MdLink[]> {
+    const links: MdLink[] = [];
 
+    visit(tree, ['imageReference', 'linkReference'], (node: Node) => {
+      const link = node as ImageReference | LinkReference;
+      const range = positionToRange(link.position!);
+
+      // NOTE - These haven't been implemented properly, but their
+      //        values aren't used for the link linting use-case
+      const targetRange = range;
+      const hrefRange = range;
+
+      links.push({
+        kind: MdLinkKind.Link,
+        href: {
+          kind: HrefKind.Reference,
+          ref: link.label!,
+        },
+        source: {
+          hrefText: link.label!,
+          resource: URI.parse(document.uri),
+          range,
+          targetRange,
+          hrefRange,
+          fragmentRange: undefined,
+          pathText: link.label!,
+        },
+      });
+    });
+
+    return links;
+  }
+
+  async #getLinkDefinitions(document: ITextDocument, tree: Node): Promise<MdLink[]> {
     const documentUri = URI.parse(document.uri);
     const links: MdLink[] = [];
 
-    visit(
-      tree,
-      (node) => node.type === 'definition',
-      (node: Node) => {
-        const definition = node as Definition;
-        const href = createHref(documentUri, definition.url, this.workspace);
-
-        if (href) {
-          const range = positionToRange(definition.position!);
-
-          // NOTE - These haven't been implemented properly, but their
-          //        values aren't used for the link linting use-case
-          const targetRange = range;
-          const hrefRange = range;
-          const fragmentRange = undefined;
-
-          links.push({
-            kind: MdLinkKind.Definition,
-            href,
-            ref: {
-              range,
-              text: definition.label!,
-            },
-            source: {
-              hrefText: definition.url,
-              resource: documentUri,
-              range,
-              targetRange,
-              hrefRange,
-              fragmentRange,
-              pathText: definition.url.split('#')[0],
-            },
-          });
-        }
-      },
-    );
+    visit(tree, 'definition', (node: Node) => {
+      const definition = node as Definition;
+      const href = createHref(documentUri, definition.url, this.workspace);
+
+      if (href) {
+        const range = positionToRange(definition.position!);
+
+        // NOTE - These haven't been implemented properly, but their
+        //        values aren't used for the link linting use-case
+        const targetRange = range;
+        const hrefRange = range;
+        const fragmentRange = undefined;
+
+        links.push({
+          kind: MdLinkKind.Definition,
+          href,
+          ref: {
+            range,
+            text: definition.label!,
+          },
+          source: {
+            hrefText: definition.url,
+            resource: documentUri,
+            range,
+            targetRange,
+            hrefRange,
+            fragmentRange,
+            pathText: definition.url.split('#')[0],
+          },
+        });
+      }
+    });
 
     return links;
   }
 }
 
 export async function getCodeBlocks(content: string): Promise<Code[]> {
-  const { fromMarkdown } = (await dynamicImport('mdast-util-from-markdown')) as {
-    fromMarkdown: typeof FromMarkdownFunction;
-  };
-  const { visit } = (await dynamicImport('unist-util-visit')) as {
-    visit: typeof VisitFunction;
-  };
-
   const tree = fromMarkdown(content);
 
   const codeBlocks: Code[] = [];
 
-  visit(
-    tree,
-    (node) => node.type === 'code',
-    (node: Node) => {
-      codeBlocks.push(node as Code);
-    },
-  );
+  visit(tree, 'code', (node: Node) => {
+    codeBlocks.push(node as Code);
+  });
 
   return codeBlocks;
 }

package/markdownlint-rules/emd002.mjs

@@ -1,5 +1,3 @@
-import { addError, filterTokens } from 'markdownlint/helpers';
-
 import { fromMarkdown } from 'mdast-util-from-markdown';
 import { visit } from 'unist-util-visit';
 
@@ -11,7 +9,9 @@ export const tags = ['brackets'];
 const UNESCAPED_REGEX = /(?<!\\)<(?!\s)/g;
 
 function EMD002(params, onError) {
-  filterTokens(params, 'inline', (token) => {
+  const tokens = params.parsers.markdownit.tokens.filter((token) => token.type === 'inline');
+
+  for (const token of tokens) {
     for (const childToken of token.children) {
       // childToken.line has the raw content, but may also contain
       // more content than just childToken.content. Since we need
@@ -41,19 +41,17 @@ function EMD002(params, onError) {
             const matches = rawContent.matchAll(UNESCAPED_REGEX);
 
             for (const match of matches) {
-              addError(
-                onError,
-                childToken.lineNumber,
-                'Unescaped opening angle bracket',
-                undefined,
-                [node.position.start.offset + 1 + match.index, 1],
-              );
+              onError({
+                lineNumber: childToken.lineNumber,
+                detail: 'Unescaped opening angle bracket',
+                range: [node.position.start.offset + 1 + match.index, 1],
+              });
             }
           },
         );
       }
     }
-  });
+  }
 }
 
 export { EMD002 as function };

package/markdownlint-rules/emd003.mjs

@@ -1,5 +1,3 @@
-import { addError, filterTokens } from 'markdownlint/helpers';
-
 import { fromMarkdown } from 'mdast-util-from-markdown';
 import { visit } from 'unist-util-visit';
 
@@ -11,7 +9,9 @@ export const tags = ['braces'];
 const UNESCAPED_REGEX = /(?<!\\){/g;
 
 function EMD003(params, onError) {
-  filterTokens(params, 'inline', (token) => {
+  const tokens = params.parsers.markdownit.tokens.filter((token) => token.type === 'inline');
+
+  for (const token of tokens) {
     for (const childToken of token.children) {
       // childToken.line has the raw content, but may also contain
       // more content than just childToken.content. Since we need
@@ -40,16 +40,17 @@ function EMD003(params, onError) {
             const matches = rawContent.matchAll(UNESCAPED_REGEX);
 
             for (const match of matches) {
-              addError(onError, childToken.lineNumber, 'Unescaped opening curly brace', undefined, [
-                node.position.start.offset + 1 + match.index,
-                1,
-              ]);
+              onError({
+                lineNumber: childToken.lineNumber,
+                detail: 'Unescaped opening curly brace',
+                range: [node.position.start.offset + 1 + match.index, 1],
+              });
             }
           },
         );
       }
     }
-  });
+  }
 }
 
 export { EMD003 as function };

package/markdownlint-rules/emd004.mjs

@@ -0,0 +1,31 @@
+export const names = ['EMD004', 'no-newline-in-links'];
+export const description = 'Newlines inside link text';
+export const tags = ['newline', 'links'];
+export const parser = 'markdownit';
+
+function EMD004(params, onError) {
+  const tokens = params.parsers.markdownit.tokens.filter((token) => token.type === 'inline');
+
+  for (const token of tokens) {
+    const { children } = token;
+    let { lineNumber } = token;
+    let inLink = false;
+    for (const child of children) {
+      const { type } = child;
+      if (type === 'link_open') {
+        inLink = true;
+      } else if (type === 'link_close') {
+        inLink = false;
+      } else if (type === 'softbreak') {
+        if (inLink) {
+          onError({ lineNumber });
+          break;
+        } else {
+          lineNumber++;
+        }
+      }
+    }
+  }
+}
+
+export { EMD004 as function };

package/markdownlint-rules/index.mjs

@@ -0,0 +1,5 @@
+import * as EMD002 from './emd002.mjs';
+import * as EMD003 from './emd003.mjs';
+import * as EMD004 from './emd004.mjs';
+
+export default [EMD002, EMD003, EMD004];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@electron/lint-roller",
-  "version": "2.4.0",
+  "version": "3.1.0",
   "description": "Markdown linting helpers for Electron org repos",
+  "type": "module",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.16.0 || >=22.4.0"
   },
   "bin": {
-    "electron-markdownlint": "./dist/bin/markdownlint-cli-wrapper.js",
     "lint-roller-markdown-links": "./dist/bin/lint-markdown-links.js",
     "lint-roller-markdown-standard": "./dist/bin/lint-markdown-standard.js",
     "lint-roller-markdown-ts-check": "./dist/bin/lint-markdown-ts-check.js",
@@ -22,13 +22,11 @@
     "lib": "lib"
   },
   "scripts": {
-    "build": "tsc && yarn run build:emd002 && yarn run build:emd003",
-    "build:emd002": "esbuild --platform=node --target=node18 --format=cjs --bundle --outfile=markdownlint-rules/emd002.js markdownlint-rules/emd002.mjs",
-    "build:emd003": "esbuild --platform=node --target=node18 --format=cjs --bundle --outfile=markdownlint-rules/emd003.js markdownlint-rules/emd003.mjs",
+    "build": "tsc",
     "prepublishOnly": "yarn run build",
     "lint:eslint": "eslint \"{bin,lib,markdownlint-rules,tests}/**/*.{js,mjs,ts}\"",
     "lint:eslint:fix": "eslint --fix \"{bin,lib,markdownlint-rules,tests}/**/*.{js,mjs,ts}\"",
-    "lint:markdown": "yarn run build && node ./dist/bin/markdownlint-cli-wrapper.js \"*.md\" && node ./dist/bin/lint-markdown-links.js \"*.md\"",
+    "lint:markdown": "yarn run build && markdownlint-cli2 \"*.md\" && node ./dist/bin/lint-markdown-links.js \"*.md\"",
     "lint:prettier": "prettier --check \"{bin,lib,markdownlint-rules,tests}/**/*.{js,mjs,ts}\"",
     "lint:prettier:fix": "prettier --write \"{bin,lib,markdownlint-rules,tests}/**/*.{js,mjs,ts}\"",
     "lint": "yarn run lint:prettier && yarn run lint:markdown",
@@ -45,37 +43,36 @@
     "url": "https://github.com/electron/lint-roller/issues"
   },
   "homepage": "https://github.com/electron/lint-roller#readme",
+  "publishConfig": {
+    "provenance": true
+  },
   "devDependencies": {
     "@electron-internal/eslint-config": "^1.0.1",
-    "@types/balanced-match": "^1.0.3",
+    "@types/balanced-match": "^3.0.2",
     "@types/glob": "^8.1.0",
-    "@types/markdown-it": "^13.0.6",
-    "@types/minimist": "^1.2.5",
-    "@types/node": "20.1.2",
-    "esbuild": "^0.21.0",
+    "@types/markdown-it": "^14.1.2",
+    "@types/node": "22.8.7",
     "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-node": "^11.1.0",
+    "markdownlint-cli2": "^0.18.0",
     "prettier": "^3.2.5",
     "typescript": "^5.4.5",
-    "vitest": "^1.5.3"
+    "vitest": "^3.0.6"
   },
   "dependencies": {
     "@dsanders11/vscode-markdown-languageservice": "^0.3.0",
     "ajv": "^8.16.0",
-    "balanced-match": "^2.0.0",
-    "glob": "^8.1.0",
+    "balanced-match": "^3.0.1",
+    "glob": "^10.4.5",
     "hast-util-from-html": "^2.0.1",
-    "markdown-it": "^13.0.1",
-    "markdownlint-cli": "^0.40.0",
-    "mdast-util-from-markdown": "^1.3.0",
-    "minimist": "^1.2.8",
-    "rimraf": "^4.4.1",
+    "markdown-it": "^14.1.0",
+    "mdast-util-from-markdown": "^2.0.2",
     "standard": "^17.0.0",
-    "unist-util-visit": "^4.1.2",
+    "unist-util-visit": "^5.0.0",
     "vscode-languageserver": "^8.1.0",
     "vscode-languageserver-textdocument": "^1.0.8",
-    "vscode-uri": "^3.0.7",
+    "vscode-uri": "^3.0.8",
     "yaml": "^2.4.5"
   },
   "peerDependencies": {
@@ -85,8 +82,5 @@
     "typescript": {
       "optional": true
     }
-  },
-  "resolutions": {
-    "jackspeak": "2.1.1"
   }
 }

package/dist/bin/markdownlint-cli-wrapper.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/bin/markdownlint-cli-wrapper.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cp = require("node:child_process");
-const path = require("node:path");
-if (require.main === module) {
-    const { status } = cp.spawnSync(process.execPath, [
-        require.resolve('markdownlint-cli'),
-        '-r',
-        path.resolve(__dirname, '../../markdownlint-rules/index.js'),
-        ...process.argv.slice(2),
-    ], { stdio: 'inherit' });
-    if (status)
-        process.exit(status);
-}
-//# sourceMappingURL=markdownlint-cli-wrapper.js.map

package/dist/bin/markdownlint-cli-wrapper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"markdownlint-cli-wrapper.js","sourceRoot":"","sources":["../../bin/markdownlint-cli-wrapper.ts"],"names":[],"mappings":";;;AAEA,yCAAyC;AACzC,kCAAkC;AAElC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,SAAS,CAC7B,OAAO,CAAC,QAAQ,EAChB;QACE,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC;QACnC,IAAI;QACJ,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,mCAAmC,CAAC;QAC5D,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;KACzB,EACD,EAAE,KAAK,EAAE,SAAS,EAAE,CACrB,CAAC;IACF,IAAI,MAAM;QAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC"}