@electron/lint-roller 1.12.1 → 2.0.0

package/markdownlint-rules/emd003.mjs

@@ -0,0 +1,46 @@
+import { addError, filterTokens } from 'markdownlint/helpers';
+
+import { fromMarkdown } from 'mdast-util-from-markdown';
+import { visit } from 'unist-util-visit';
+
+export const names = ['EMD003', 'no-curly-braces'];
+export const description = 'No unescaped opening curly braces in text (does not play nice with MDX)';
+export const tags = ['braces'];
+
+const UNESCAPED_REGEX = /(?<!\\){/g;
+
+function EMD003(params, onError) {
+  filterTokens(params, 'inline', (token) => {
+    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
+      // the raw content to detect escaped curly braces, parse
+      // the raw content of any match a second time to avoid any
+      // false positives.
+      if (
+        childToken.type === 'text' &&
+        childToken.markup !== '&#123;' &&
+        childToken.content.includes('{') &&
+        childToken.line.match(UNESCAPED_REGEX) !== null
+      ) {
+        // The AST produced by mdast is easier to work with here
+        // since it gives position data within the line
+        const tree = fromMarkdown(childToken.line);
+
+        visit(
+          tree,
+          (node) => node.type === 'text',
+          (node) => {
+            const rawContent = childToken.line.slice(node.position.start.offset, node.position.end.offset);
+
+            if (rawContent.match(UNESCAPED_REGEX) !== null) {
+              addError(onError, token.lineNumber, 'Unescaped opening curly brace');
+            }
+          },
+        );
+      }
+    }
+  });
+};
+
+export { EMD003 as function };

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@electron/lint-roller",
-  "version": "1.12.1",
+  "version": "2.0.0",
   "description": "Markdown linting helpers for Electron org repos",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "bin": {
     "electron-markdownlint": "./dist/bin/markdownlint-cli-wrapper.js",
-    "electron-lint-markdown-links": "./dist/bin/lint-markdown-links.js",
-    "electron-lint-markdown-standard": "./dist/bin/lint-markdown-standard.js",
-    "electron-lint-markdown-ts-check": "./dist/bin/lint-markdown-ts-check.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"
   },
   "files": [
     "configs",
@@ -21,7 +21,9 @@
     "lib": "lib"
   },
   "scripts": {
-    "build": "tsc && esbuild --platform=node --target=node14 --format=cjs --bundle --outfile=markdownlint-rules/emd002.js markdownlint-rules/emd002.mjs",
+    "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",
     "prepublishOnly": "yarn run build",
     "lint:eslint": "eslint \"{bin,lib,markdownlint-rules,tests}/**/*.{js,ts}\"",
     "lint:eslint:fix": "eslint --fix \"{bin,lib,markdownlint-rules,tests}/**/*.{js,ts}\"",
@@ -50,25 +52,23 @@
     "@types/markdown-it": "^13.0.6",
     "@types/minimist": "^1.2.5",
     "@types/node": "20.1.2",
-    "@types/node-fetch": "^2.6.9",
-    "esbuild": "^0.20.1",
+    "esbuild": "^0.21.0",
     "eslint": "^8.54.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-node": "^11.1.0",
     "jest": "^29.7.0",
-    "prettier": "^3.1.0",
+    "prettier": "^3.2.5",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   },
   "dependencies": {
     "@dsanders11/vscode-markdown-languageservice": "^0.3.0",
     "balanced-match": "^2.0.0",
     "glob": "^8.1.0",
     "markdown-it": "^13.0.1",
-    "markdownlint-cli": "^0.33.0",
+    "markdownlint-cli": "^0.40.0",
     "mdast-util-from-markdown": "^1.3.0",
     "minimist": "^1.2.8",
-    "node-fetch": "^2.6.9",
     "rimraf": "^4.4.1",
     "standard": "^17.0.0",
     "unist-util-visit": "^4.1.2",
@@ -83,5 +83,8 @@
     "typescript": {
       "optional": true
     }
+  },
+  "resolutions": {
+    "jackspeak": "2.1.1"
   }
 }

package/markdownlint-rules/emd001.js

@@ -1,26 +0,0 @@
-const { addError, getLineMetadata, getReferenceLinkImageData } = require('markdownlint/helpers');
-
-// These are used by GitHub's "alert" extension to Markdown
-// https://github.com/orgs/community/discussions/16925
-const ALERT_KEYWORDS = ['!note', '!tip', '!important', '!warning', '!caution'];
-
-module.exports = {
-  names: ['EMD001', 'no-shortcut-reference-links'],
-  description: 'Disallow shortcut reference links (those with no link label)',
-  tags: ['images', 'links'],
-  function: function EMD001(params, onError) {
-    const lineMetadata = getLineMetadata(params);
-    const { shortcuts } = getReferenceLinkImageData(lineMetadata);
-    for (const [shortcut, occurrences] of shortcuts) {
-      for (const [lineNumber] of occurrences) {
-        if (!ALERT_KEYWORDS.includes(shortcut)) {
-          addError(
-            onError,
-            lineNumber + 1, // human-friendly line numbers (1-based)
-            `Disallowed shortcut reference link: "${shortcut}"`,
-          );
-        }
-      }
-    }
-  },
-};