npm - @electron/lint-roller - Versions diffs - 2.1.0 → 2.3.0 - Mend

@electron/lint-roller 2.1.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/configs/markdownlint.json +1 -0
package/dist/bin/lint-markdown-api-history.d.ts +8 -0
package/dist/bin/lint-markdown-api-history.js +285 -0
package/dist/bin/lint-markdown-api-history.js.map +1 -0
package/markdownlint-rules/emd002.js +1 -1
package/markdownlint-rules/emd003.js +1 -1
package/markdownlint-rules/emd004.js +30 -0
package/markdownlint-rules/index.js +2 -1
package/package.json +10 -8

package/configs/markdownlint.json CHANGED Viewed

@@ -26,6 +26,7 @@
   "no-inline-html": false,
   "no-angle-brackets": false,
   "no-curly-braces": false,
+  "no-newline-in-links": false,
   "link-image-style": {
     "shortcut": false
   }

package/dist/bin/lint-markdown-api-history.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import type { Node } from 'unist';
+interface PossibleHistoryBlock {
+    previousNode?: Node;
+    value: string;
+}
+export declare function findPossibleApiHistoryBlocks(content: string): Promise<PossibleHistoryBlock[]>;
+export {};

package/dist/bin/lint-markdown-api-history.js ADDED Viewed

@@ -0,0 +1,285 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findPossibleApiHistoryBlocks = void 0;
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+const ajv_1 = require("ajv");
+const minimist = require("minimist");
+const vscode_uri_1 = require("vscode-uri");
+const yaml_1 = require("yaml");
+const helpers_1 = require("../lib/helpers");
+const markdown_1 = require("../lib/markdown");
+// "<any char>: <match group>"
+const possibleStringRegex = /^[ \S]+?: *?(\S[ \S]+?)$/gm;
+const nonAlphaNumericDotRegex = /[^a-zA-Z0-9.]/g;
+function isHTML(node) {
+    return node.type === 'html';
+}
+async function findPossibleApiHistoryBlocks(content) {
+    const { fromMarkdown } = (await (0, helpers_1.dynamicImport)('mdast-util-from-markdown'));
+    const { visit } = (await (0, helpers_1.dynamicImport)('unist-util-visit'));
+    const tree = fromMarkdown(content);
+    const codeBlocks = [];
+    visit(tree,
+    // Very loose check for YAML history blocks to help catch user error
+    (node) => isHTML(node) &&
+        node.value.includes('```') &&
+        node.value.toLowerCase().includes('yaml') &&
+        node.value.toLowerCase().includes('history'), (node, index) => {
+        codeBlocks.push({
+            previousNode: index !== null ? tree.children[index - 1] : undefined,
+            value: node.value,
+        });
+    });
+    return codeBlocks;
+}
+exports.findPossibleApiHistoryBlocks = findPossibleApiHistoryBlocks;
+async function main(workspaceRoot, globs, { checkPlacement, breakingChangesFile, checkStrings, schema, ignoreGlobs = [] }) {
+    var _a, _b, _c, _d, _e, _f;
+    let documentCounter = 0;
+    let historyBlockCounter = 0;
+    let errorCounter = 0;
+    let warningCounter = 0;
+    try {
+        const { fromHtml } = (await (0, helpers_1.dynamicImport)('hast-util-from-html'));
+        const { fromMarkdown } = (await (0, helpers_1.dynamicImport)('mdast-util-from-markdown'));
+        const workspace = new markdown_1.DocsWorkspace(workspaceRoot, globs, ignoreGlobs);
+        let validateAgainstSchema = null;
+        if (schema) {
+            try {
+                const ajv = new ajv_1.default();
+                const ApiHistorySchemaFile = await (0, promises_1.readFile)(schema, { encoding: 'utf-8' });
+                const ApiHistorySchema = JSON.parse(ApiHistorySchemaFile);
+                validateAgainstSchema = ajv.compile(ApiHistorySchema);
+            }
+            catch (error) {
+                throw new Error(`Error occurred while attempting to read API history schema and compile AJV validator:\n${error}\n`);
+            }
+        }
+        let breakingChangesFileHeadingIds = null;
+        if (breakingChangesFile) {
+            try {
+                const breakingChanges = await (0, promises_1.readFile)(breakingChangesFile, { encoding: 'utf-8' });
+                const markdownBreakingChanges = fromMarkdown(breakingChanges);
+                const headings = markdownBreakingChanges.children.filter((e) => e.type === 'heading' && e.depth === 3);
+                // Convert to GitHub heading ID format
+                breakingChangesFileHeadingIds = headings.map((heading) => heading.children.reduce((acc, cur) => acc +
+                    cur.value
+                        .toLowerCase()
+                        .replace(/ /g, '-')
+                        .replace(/[^a-zA-Z0-9-]/g, ''), ''));
+            }
+            catch (error) {
+                throw new Error(`Error occurred while attempting to read breaking changes file and parse the heading IDs:\n${error}\n`);
+            }
+        }
+        for (const document of await workspace.getAllMarkdownDocuments()) {
+            const uri = vscode_uri_1.URI.parse(document.uri);
+            const filepath = workspace.getWorkspaceRelativePath(uri);
+            documentCounter++;
+            const documentText = document.getText();
+            if (!documentText.includes('<!--'))
+                continue;
+            const possibleHistoryBlocks = await findPossibleApiHistoryBlocks(documentText);
+            for (const possibleHistoryBlock of possibleHistoryBlocks) {
+                historyBlockCounter++;
+                const { children: [htmlComment], } = fromHtml(possibleHistoryBlock.value);
+                if (htmlComment.type !== 'comment')
+                    continue;
+                const { children: [codeBlock], } = fromMarkdown(htmlComment.value);
+                if (codeBlock.type !== 'code' ||
+                    ((_a = codeBlock.lang) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== 'yaml' ||
+                    ((_b = codeBlock.meta) === null || _b === void 0 ? void 0 : _b.trim().toLowerCase()) !== 'history') {
+                    console.error('Error occurred while parsing Markdown document:\n\n' +
+                        `'${filepath}'\n\n` +
+                        "Couldn't extract matches from possible API history block, did you use the correct format?\n\n" +
+                        'Possible API history block:\n\n' +
+                        `${possibleHistoryBlock.value}\n`);
+                    errorCounter++;
+                    continue;
+                }
+                // Special chars in YAML strings may break the parser if not surrounded by quotes,
+                //  including just causing the parser to read a value as null instead of throwing an error
+                //  <https://stackoverflow.com/questions/19109912/yaml-do-i-need-quotes-for-strings-in-yaml>
+                if (checkStrings) {
+                    const possibleStrings = codeBlock.value.matchAll(possibleStringRegex);
+                    for (const [matchedLine, matchedGroup] of possibleStrings) {
+                        const trimmedMatchedGroup = matchedGroup.trim();
+                        const isMatchedGroupInsideQuotes = (trimmedMatchedGroup.startsWith('"') && trimmedMatchedGroup.endsWith('"')) ||
+                            (trimmedMatchedGroup.startsWith("'") && trimmedMatchedGroup.endsWith("'"));
+                        // Most special characters won't cause a problem if they're inside quotes
+                        if (isMatchedGroupInsideQuotes)
+                            continue;
+                        // I've only seen errors occur when the first or last character is a special character - @piotrpdev
+                        const isFirstCharNonAlphaNumeric = trimmedMatchedGroup[0].match(nonAlphaNumericDotRegex) !== null;
+                        const isLastCharNonAlphaNumeric = ((_c = trimmedMatchedGroup.at(-1)) === null || _c === void 0 ? void 0 : _c.match(nonAlphaNumericDotRegex)) !== null;
+                        if (isFirstCharNonAlphaNumeric || isLastCharNonAlphaNumeric) {
+                            console.warn('Warning occurred while parsing Markdown document:\n\n' +
+                                `'${filepath}'\n\n` +
+                                'Possible string value starts/ends with a non-alphanumeric character.\n\n' +
+                                'This might cause issues when parsing the YAML (might not throw an error)\n\n' +
+                                'Matched group:\n\n' +
+                                `${matchedGroup}\n\n` +
+                                'Matched line:\n\n' +
+                                `${matchedLine}\n\n` +
+                                'API history block:\n\n' +
+                                `${possibleHistoryBlock.value}\n`);
+                            // Not throwing an error because it might be a false positive or desired behavior
+                            warningCounter++;
+                        }
+                    }
+                }
+                if (checkPlacement) {
+                    if (((_d = possibleHistoryBlock.previousNode) === null || _d === void 0 ? void 0 : _d.type) !== 'heading') {
+                        console.error('Error occurred while parsing Markdown document:\n\n' +
+                            `'${filepath}'\n\n` +
+                            'API history block must be preceded by a heading\n\n' +
+                            'API history block:\n\n' +
+                            `${possibleHistoryBlock.value}\n`);
+                        errorCounter++;
+                        continue;
+                    }
+                }
+                let unsafeHistory = null;
+                try {
+                    unsafeHistory = (0, yaml_1.parse)(codeBlock.value);
+                }
+                catch (error) {
+                    console.error('Error occurred while parsing Markdown document:\n\n' +
+                        `'${filepath}'\n\n` +
+                        `(YAML) ${error}\n\n` +
+                        'API history block:\n\n' +
+                        `${possibleHistoryBlock.value}\n`);
+                    errorCounter++;
+                    continue;
+                }
+                if (!schema || validateAgainstSchema === null)
+                    continue;
+                const isValid = validateAgainstSchema(unsafeHistory);
+                if (!isValid) {
+                    console.error('Error occurred while parsing Markdown document:\n\n' +
+                        `'${filepath}'\n\n` +
+                        'Error validating YAML\n\n' +
+                        'Validation errors:\n\n' +
+                        `${JSON.stringify(validateAgainstSchema.errors, null, 4)}\n\n` +
+                        'Parsed YAML:\n\n' +
+                        `${JSON.stringify(unsafeHistory, null, 4)}\n\n` +
+                        'API history block:\n\n' +
+                        `${possibleHistoryBlock.value}\n`);
+                    errorCounter++;
+                    continue;
+                }
+                if (breakingChangesFile && breakingChangesFileHeadingIds !== null) {
+                    const safeHistory = unsafeHistory;
+                    const breakingChangeHeaders = [];
+                    const changesAndDeprecations = [
+                        ...((_e = safeHistory.changes) !== null && _e !== void 0 ? _e : []),
+                        ...((_f = safeHistory.deprecated) !== null && _f !== void 0 ? _f : []),
+                    ];
+                    for (const change of changesAndDeprecations) {
+                        if (change['breaking-changes-header']) {
+                            breakingChangeHeaders.push(change['breaking-changes-header']);
+                        }
+                    }
+                    for (const header of breakingChangeHeaders) {
+                        if (!breakingChangesFileHeadingIds.includes(header)) {
+                            console.error('Error occurred while parsing Markdown document:\n\n' +
+                                `'${filepath}'\n\n` +
+                                "Couldn't find the following breaking changes header:\n\n" +
+                                `'${header}'\n\n` +
+                                `in this breaking changes file:\n\n` +
+                                `'${breakingChangesFile}'\n\n` +
+                                'Parsed YAML:\n\n' +
+                                `${JSON.stringify(safeHistory, null, 4)}\n\n` +
+                                'API history block:\n\n' +
+                                `${possibleHistoryBlock.value}\n\n`);
+                            errorCounter++;
+                        }
+                    }
+                }
+                // ? Maybe collect all api history and export it to a single file for future use.
+            }
+            // ? Maybe replace user YAML with result of <https://eemeli.org/yaml/#tostring-options> for consistent style (but not in CI)
+        }
+    }
+    catch (error) {
+        errorCounter++;
+        console.error('Error occurred while linting:\n', error);
+    }
+    finally {
+        return { historyBlockCounter, documentCounter, errorCounter, warningCounter };
+    }
+}
+function parseCommandLine() {
+    const showUsage = (arg) => {
+        if (!arg || arg.startsWith('-')) {
+            console.log('Usage: lint-roller-markdown-api-history [--root <dir>] <globs>' +
+                ' [-h|--help]' +
+                ' [--check-placement] [--breaking-changes-file <path>] [--check-strings]' +
+                ' [--schema <path>]' +
+                ' [--ignore <globs>] [--ignore-path <path>]');
+            process.exit(1);
+        }
+        return true;
+    };
+    const opts = minimist(process.argv.slice(2), {
+        boolean: ['help', 'check-placement', 'check-strings'],
+        string: ['root', 'ignore', 'ignore-path', 'schema', 'breaking-changes-file'],
+        unknown: showUsage,
+        default: {
+            'check-placement': true,
+            'check-strings': true,
+        },
+    });
+    if (opts.help || !opts._.length)
+        showUsage();
+    return opts;
+}
+async function init() {
+    try {
+        const opts = parseCommandLine();
+        if (!opts.root) {
+            opts.root = '.';
+        }
+        if (opts.ignore) {
+            opts.ignore = Array.isArray(opts.ignore) ? opts.ignore : [opts.ignore];
+        }
+        else {
+            opts.ignore = [];
+        }
+        if (opts['ignore-path']) {
+            const ignores = await (0, promises_1.readFile)((0, node_path_1.resolve)(opts['ignore-path']), { encoding: 'utf-8' });
+            for (const ignore of ignores.split('\n')) {
+                opts.ignore.push(ignore.trimEnd());
+            }
+        }
+        if (opts.schema) {
+            opts.schema = (0, node_path_1.resolve)(process.cwd(), opts.schema);
+        }
+        if (opts['breaking-changes-file']) {
+            opts['breaking-changes-file'] = (0, node_path_1.resolve)(process.cwd(), opts['breaking-changes-file']);
+        }
+        const { historyBlockCounter, documentCounter, errorCounter, warningCounter } = await main((0, node_path_1.resolve)(process.cwd(), opts.root), opts._, {
+            checkPlacement: opts['check-placement'],
+            breakingChangesFile: opts['breaking-changes-file'],
+            checkStrings: opts['check-strings'],
+            ignoreGlobs: opts.ignore,
+            schema: opts.schema,
+        });
+        console.log(`Processed ${historyBlockCounter} API history block(s) in ${documentCounter} document(s) with ${errorCounter} error(s) and ${warningCounter} warning(s).`);
+        if (errorCounter > 0)
+            process.exit(1);
+    }
+    catch (error) {
+        console.error(`Error(s) occurred while initializing 'lint-markdown-api-history':\n${error}`);
+        process.exit(1);
+    }
+}
+if (require.main === module) {
+    init().catch((error) => {
+        console.error(error);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=lint-markdown-api-history.js.map

package/dist/bin/lint-markdown-api-history.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"lint-markdown-api-history.js","sourceRoot":"","sources":["../../bin/lint-markdown-api-history.ts"],"names":[],"mappings":";;;;AAEA,+CAA+D;AAC/D,yCAAoC;AAEpC,6BAA4C;AAI5C,qCAAqC;AAGrC,2CAAiC;AACjC,+BAA0C;AAE1C,4CAA+C;AAC/C,8CAAgD;AAEhD,8BAA8B;AAC9B,MAAM,mBAAmB,GAAG,4BAA4B,CAAC;AACzD,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;AAmCjD,SAAS,MAAM,CAAC,IAAU;IACxB,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC;AAC9B,CAAC;AAEM,KAAK,UAAU,4BAA4B,CAChD,OAAe;IAEf,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,IAAA,uBAAa,EAAC,0BAA0B,CAAC,CAExE,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,IAAA,uBAAa,EAAC,kBAAkB,CAAC,CAEzD,CAAC;IACF,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,UAAU,GAA2B,EAAE,CAAC;IAE9C,KAAK,CACH,IAAI;IACJ,oEAAoE;IACpE,CAAC,IAAI,EAAgB,EAAE,CACrB,MAAM,CAAC,IAAI,CAAC;QACZ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAC9C,CAAC,IAAU,EAAE,KAAK,EAAE,EAAE;QACpB,UAAU,CAAC,IAAI,CAAC;YACd,YAAY,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;YACnE,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AA7BD,oEA6BC;AASD,KAAK,UAAU,IAAI,CACjB,aAAqB,EACrB,KAAe,EACf,EAAE,cAAc,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,GAAG,EAAE,EAAW;;IAExF,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,mBAAmB,GAAG,CAAC,CAAC;IAC5B,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,cAAc,GAAG,CAAC,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,IAAA,uBAAa,EAAC,qBAAqB,CAAC,CAE/D,CAAC;QACF,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,IAAA,uBAAa,EAAC,0BAA0B,CAAC,CAExE,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,wBAAa,CAAC,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAEvE,IAAI,qBAAqB,GAAwC,IAAI,CAAC;QAEtE,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,aAAG,EAAE,CAAC;gBACtB,MAAM,oBAAoB,GAAG,MAAM,IAAA,mBAAQ,EAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC3E,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBAC1D,qBAAqB,GAAG,GAAG,CAAC,OAAO,CAAa,gBAAgB,CAAC,CAAC;YACpE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,0FAA0F,KAAK,IAAI,CACpG,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,6BAA6B,GAAoB,IAAI,CAAC;QAE1D,IAAI,mBAAmB,EAAE,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,eAAe,GAAG,MAAM,IAAA,mBAAQ,EAAC,mBAAmB,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;gBACnF,MAAM,uBAAuB,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;gBAC9D,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CACtD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAChC,CAAC;gBACf,sCAAsC;gBACtC,6BAA6B,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACvD,OAAO,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CACX,GAAG;oBACF,GAAuB,CAAC,KAAK;yBAC3B,WAAW,EAAE;yBACb,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;yBAClB,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,EAClC,EAAE,CACH,CACF,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,6FAA6F,KAAK,IAAI,CACvG,CAAC;YACJ,CAAC;QACH,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,MAAM,SAAS,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACjE,MAAM,GAAG,GAAG,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,QAAQ,GAAG,SAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;YAEzD,eAAe,EAAE,CAAC;YAElB,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAAE,SAAS;YAE7C,MAAM,qBAAqB,GAAG,MAAM,4BAA4B,CAAC,YAAY,CAAC,CAAC;YAE/E,KAAK,MAAM,oBAAoB,IAAI,qBAAqB,EAAE,CAAC;gBACzD,mBAAmB,EAAE,CAAC;gBAEtB,MAAM,EACJ,QAAQ,EAAE,CAAC,WAAW,CAAC,GACxB,GAAG,QAAQ,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAEzC,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS;oBAAE,SAAS;gBAE7C,MAAM,EACJ,QAAQ,EAAE,CAAC,SAAS,CAAC,GACtB,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAEpC,IACE,SAAS,CAAC,IAAI,KAAK,MAAM;oBACzB,CAAA,MAAA,SAAS,CAAC,IAAI,0CAAE,WAAW,EAAE,MAAK,MAAM;oBACxC,CAAA,MAAA,SAAS,CAAC,IAAI,0CAAE,IAAI,GAAG,WAAW,EAAE,MAAK,SAAS,EAClD,CAAC;oBACD,OAAO,CAAC,KAAK,CACX,qDAAqD;wBACnD,IAAI,QAAQ,OAAO;wBACnB,+FAA+F;wBAC/F,iCAAiC;wBACjC,GAAG,oBAAoB,CAAC,KAAK,IAAI,CACpC,CAAC;oBACF,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,kFAAkF;gBAClF,0FAA0F;gBAC1F,4FAA4F;gBAC5F,IAAI,YAAY,EAAE,CAAC;oBACjB,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;oBAEtE,KAAK,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,IAAI,eAAe,EAAE,CAAC;wBAC1D,MAAM,mBAAmB,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC;wBAChD,MAAM,0BAA0B,GAC9B,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;4BAC1E,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;wBAE7E,yEAAyE;wBACzE,IAAI,0BAA0B;4BAAE,SAAS;wBAEzC,mGAAmG;wBACnG,MAAM,0BAA0B,GAC9B,mBAAmB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,KAAK,IAAI,CAAC;wBACjE,MAAM,yBAAyB,GAC7B,CAAA,MAAA,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,uBAAuB,CAAC,MAAK,IAAI,CAAC;wBACtE,IAAI,0BAA0B,IAAI,yBAAyB,EAAE,CAAC;4BAC5D,OAAO,CAAC,IAAI,CACV,uDAAuD;gCACrD,IAAI,QAAQ,OAAO;gCACnB,0EAA0E;gCAC1E,8EAA8E;gCAC9E,oBAAoB;gCACpB,GAAG,YAAY,MAAM;gCACrB,mBAAmB;gCACnB,GAAG,WAAW,MAAM;gCACpB,wBAAwB;gCACxB,GAAG,oBAAoB,CAAC,KAAK,IAAI,CACpC,CAAC;4BACF,iFAAiF;4BACjF,cAAc,EAAE,CAAC;wBACnB,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,IAAI,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAA,MAAA,oBAAoB,CAAC,YAAY,0CAAE,IAAI,MAAK,SAAS,EAAE,CAAC;wBAC1D,OAAO,CAAC,KAAK,CACX,qDAAqD;4BACnD,IAAI,QAAQ,OAAO;4BACnB,qDAAqD;4BACrD,wBAAwB;4BACxB,GAAG,oBAAoB,CAAC,KAAK,IAAI,CACpC,CAAC;wBACF,YAAY,EAAE,CAAC;wBACf,SAAS;oBACX,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,GAAG,IAAI,CAAC;gBAEzB,IAAI,CAAC;oBACH,aAAa,GAAG,IAAA,YAAS,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC7C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CACX,qDAAqD;wBACnD,IAAI,QAAQ,OAAO;wBACnB,UAAU,KAAK,MAAM;wBACrB,wBAAwB;wBACxB,GAAG,oBAAoB,CAAC,KAAK,IAAI,CACpC,CAAC;oBACF,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,IAAI,CAAC,MAAM,IAAI,qBAAqB,KAAK,IAAI;oBAAE,SAAS;gBAExD,MAAM,OAAO,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;gBAErD,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,CAAC,KAAK,CACX,qDAAqD;wBACnD,IAAI,QAAQ,OAAO;wBACnB,2BAA2B;wBAC3B,wBAAwB;wBACxB,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM;wBAC9D,kBAAkB;wBAClB,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM;wBAC/C,wBAAwB;wBACxB,GAAG,oBAAoB,CAAC,KAAK,IAAI,CACpC,CAAC;oBACF,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,IAAI,mBAAmB,IAAI,6BAA6B,KAAK,IAAI,EAAE,CAAC;oBAClE,MAAM,WAAW,GAAG,aAA2B,CAAC;oBAEhD,MAAM,qBAAqB,GAAa,EAAE,CAAC;oBAE3C,MAAM,sBAAsB,GAAG;wBAC7B,GAAG,CAAC,MAAA,WAAW,CAAC,OAAO,mCAAI,EAAE,CAAC;wBAC9B,GAAG,CAAC,MAAA,WAAW,CAAC,UAAU,mCAAI,EAAE,CAAC;qBAClC,CAAC;oBAEF,KAAK,MAAM,MAAM,IAAI,sBAAsB,EAAE,CAAC;wBAC5C,IAAI,MAAM,CAAC,yBAAyB,CAAC,EAAE,CAAC;4BACtC,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC;wBAChE,CAAC;oBACH,CAAC;oBAED,KAAK,MAAM,MAAM,IAAI,qBAAqB,EAAE,CAAC;wBAC3C,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;4BACpD,OAAO,CAAC,KAAK,CACX,qDAAqD;gCACnD,IAAI,QAAQ,OAAO;gCACnB,0DAA0D;gCAC1D,IAAI,MAAM,OAAO;gCACjB,oCAAoC;gCACpC,IAAI,mBAAmB,OAAO;gCAC9B,kBAAkB;gCAClB,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM;gCAC7C,wBAAwB;gCACxB,GAAG,oBAAoB,CAAC,KAAK,MAAM,CACtC,CAAC;4BACF,YAAY,EAAE,CAAC;wBACjB,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,iFAAiF;YACnF,CAAC;YAED,4HAA4H;QAC9H,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;YAAS,CAAC;QACT,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;IAChF,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB;IACvB,MAAM,SAAS,GAAG,CAAC,GAAY,EAAW,EAAE;QAC1C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,CAAC,GAAG,CACT,gEAAgE;gBAC9D,cAAc;gBACd,yEAAyE;gBACzE,oBAAoB;gBACpB,4CAA4C,CAC/C,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QAC3C,OAAO,EAAE,CAAC,MAAM,EAAE,iBAAiB,EAAE,eAAe,CAAC;QACrD,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,uBAAuB,CAAC;QAC5E,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE;YACP,iBAAiB,EAAE,IAAI;YACvB,eAAe,EAAE,IAAI;SACtB;KACF,CAAC,CAAC;IAEH,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;QAAE,SAAS,EAAE,CAAC;IAE7C,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAC;QAEhC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAClB,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAA,mBAAO,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YAEpF,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,uBAAuB,CAAC,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,EAAE,mBAAmB,EAAE,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,CACvF,IAAA,mBAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,EACjC,IAAI,CAAC,CAAC,EACN;YACE,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC;YACvC,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,CAAC;YAClD,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC;YACnC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CACF,CAAC;QAEF,OAAO,CAAC,GAAG,CACT,aAAa,mBAAmB,4BAA4B,eAAe,qBAAqB,YAAY,iBAAiB,cAAc,cAAc,CAC1J,CAAC;QAEF,IAAI,YAAY,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,sEAAsE,KAAK,EAAE,CAAC,CAAC;QAC7F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/markdownlint-rules/emd002.js CHANGED Viewed

@@ -8915,7 +8915,7 @@ function decode($0, $1, $2) {
   return decodeNamedCharacterReference($2) || $0;
 }
-// node_modules/unist-util-stringify-position/lib/index.js
+// node_modules/mdast-util-from-markdown/node_modules/unist-util-stringify-position/lib/index.js
 function stringifyPosition(value) {
   if (!value || typeof value !== "object") {
     return "";

package/markdownlint-rules/emd003.js CHANGED Viewed

@@ -8915,7 +8915,7 @@ function decode($0, $1, $2) {
   return decodeNamedCharacterReference($2) || $0;
 }
-// node_modules/unist-util-stringify-position/lib/index.js
+// node_modules/mdast-util-from-markdown/node_modules/unist-util-stringify-position/lib/index.js
 function stringifyPosition(value) {
   if (!value || typeof value !== "object") {
     return "";

package/markdownlint-rules/emd004.js ADDED Viewed

@@ -0,0 +1,30 @@
+const { addError, filterTokens } = require('markdownlint/helpers');
+module.exports = {
+  names: ['EMD004', 'no-newline-in-links'],
+  description: 'Newlines inside link text',
+  tags: ['newline', 'links'],
+  parser: 'markdownit',
+  function: function EMD004(params, onError) {
+    filterTokens(params, 'inline', (token) => {
+      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) {
+            addError(onError, lineNumber);
+            break;
+          } else {
+            lineNumber++;
+          }
+        }
+      }
+    });
+  },
+};

package/markdownlint-rules/index.js CHANGED Viewed

@@ -1,4 +1,5 @@
 const EMD002 = require('./emd002.js');
 const EMD003 = require('./emd003.js');
+const EMD004 = require('./emd004.js');
-module.exports = [EMD002, EMD003];
+module.exports = [EMD002, EMD003, EMD004];

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@electron/lint-roller",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "Markdown linting helpers for Electron org repos",
   "engines": {
     "node": ">=18.0.0"
@@ -9,7 +9,8 @@
     "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"
+    "lint-roller-markdown-ts-check": "./dist/bin/lint-markdown-ts-check.js",
+    "lint-roller-markdown-api-history": "./dist/bin/lint-markdown-api-history.js"
   },
   "files": [
     "configs",
@@ -32,7 +33,7 @@
     "lint:prettier:fix": "prettier --write \"{bin,lib,markdownlint-rules,tests}/**/*.{js,mjs,ts}\"",
     "lint": "yarn run lint:prettier && yarn run lint:markdown",
     "lint:fix": "yarn run lint:eslint:fix && yarn run lint:prettier:fix",
-    "test": "yarn run build && jest"
+    "test": "yarn run build && vitest run --reporter=verbose"
   },
   "repository": {
     "type": "git",
@@ -48,7 +49,6 @@
     "@electron-internal/eslint-config": "^1.0.1",
     "@types/balanced-match": "^1.0.3",
     "@types/glob": "^8.1.0",
-    "@types/jest": "^29.5.8",
     "@types/markdown-it": "^13.0.6",
     "@types/minimist": "^1.2.5",
     "@types/node": "20.1.2",
@@ -56,15 +56,16 @@
     "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-node": "^11.1.0",
-    "jest": "^29.7.0",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.3"
   },
   "dependencies": {
     "@dsanders11/vscode-markdown-languageservice": "^0.3.0",
+    "ajv": "^8.16.0",
     "balanced-match": "^2.0.0",
     "glob": "^8.1.0",
+    "hast-util-from-html": "^2.0.1",
     "markdown-it": "^13.0.1",
     "markdownlint-cli": "^0.40.0",
     "mdast-util-from-markdown": "^1.3.0",
@@ -74,7 +75,8 @@
     "unist-util-visit": "^4.1.2",
     "vscode-languageserver": "^8.1.0",
     "vscode-languageserver-textdocument": "^1.0.8",
-    "vscode-uri": "^3.0.7"
+    "vscode-uri": "^3.0.7",
+    "yaml": "^2.4.5"
   },
   "peerDependencies": {
     "typescript": ">= 4.7.0"