@electron/lint-roller 0.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Contributors to the Electron project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @electron/lint-roller
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/electron/lint-roller/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/electron/lint-roller/tree/main)
+[![npm version](http://img.shields.io/npm/v/@electron/lint-roller.svg)](https://npmjs.org/package/@electron/lint-roller)
+
+> Markdown linting helpers for Electron org repos
+
+## Usage
+
+```bash
+yarn global add @electron/lint-roller
+
+electron-markdownlint "**/*.md"
+electron-lint-markdown-links --root docs/ "docs/**/*.md"
+```
+
+## What It Provides
+
+A base config for `markdownlint` is provided for consistent linting rules
+across repos. To use the base config, extend it in `.markdownlint.json`:
+
+```json
+{
+  "extends": "@electron/lint-roller/configs/markdownlint.json"
+}
+```
+
+`electron-markdownlint` is provided as a wrapper command which adds extra
+rules found in this package automatically.
+
+`electron-lint-markdown-links` is a command to further link links to find
+broken relative links, including URL fragments, and can also be used to
+check external links with the `--fetch-external-links` option.
+
+## License
+
+MIT

package/configs/markdownlint.json

@@ -0,0 +1,29 @@
+{
+  "commands-show-output": false,
+  "first-line-h1": false,
+  "header-increment": false,
+  "line-length": {
+    "code_blocks": false,
+    "tables": false,
+    "stern": true,
+    "line_length": -1
+  },
+  "no-bare-urls": false,
+  "no-blanks-blockquote": false,
+  "no-duplicate-header": {
+    "allow_different_nesting": true
+  },
+  "no-emphasis-as-header": false,
+  "no-hard-tabs": {
+    "code_blocks": false
+  },
+  "no-space-in-emphasis": false,
+  "no-trailing-punctuation": false,
+  "no-trailing-spaces": {
+    "br_spaces": 0
+  },
+  "single-h1": false,
+  "no-inline-html": false,
+  "emphasis-style": false,
+  "strong-style": false
+}

package/dist/bin/lint-markdown-links.d.ts

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

package/dist/bin/lint-markdown-links.js

@@ -0,0 +1,145 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("node:fs");
+const path = require("node:path");
+const vscode_markdown_languageservice_1 = require("@dsanders11/vscode-markdown-languageservice");
+const minimist = require("minimist");
+const node_fetch_1 = require("node-fetch");
+const vscode_languageserver_1 = require("vscode-languageserver");
+const vscode_uri_1 = require("vscode-uri");
+const markdown_1 = require("../lib/markdown");
+class NoOpLogger {
+    constructor() {
+        this.level = vscode_markdown_languageservice_1.LogLevel.Off;
+    }
+    log() { }
+}
+const diagnosticOptions = {
+    ignoreLinks: [],
+    validateDuplicateLinkDefinitions: vscode_markdown_languageservice_1.DiagnosticLevel.error,
+    validateFileLinks: vscode_markdown_languageservice_1.DiagnosticLevel.error,
+    validateFragmentLinks: vscode_markdown_languageservice_1.DiagnosticLevel.error,
+    validateMarkdownFileLinkFragments: vscode_markdown_languageservice_1.DiagnosticLevel.error,
+    validateReferences: vscode_markdown_languageservice_1.DiagnosticLevel.error,
+    validateUnusedLinkDefinitions: vscode_markdown_languageservice_1.DiagnosticLevel.error,
+};
+async function fetchExternalLink(link, checkRedirects = false) {
+    try {
+        const response = await (0, node_fetch_1.default)(link);
+        if (response.status !== 200) {
+            console.log('Broken link', link, response.status, response.statusText);
+        }
+        else {
+            if (checkRedirects && response.redirected) {
+                const wwwUrl = new URL(link);
+                wwwUrl.hostname = `www.${wwwUrl.hostname}`;
+                // For now cut down on noise to find meaningful redirects
+                const wwwRedirect = wwwUrl.toString() === response.url;
+                const trailingSlashRedirect = `${link}/` === response.url;
+                if (!wwwRedirect && !trailingSlashRedirect) {
+                    console.log('Link redirection', link, '->', response.url);
+                }
+            }
+            return true;
+        }
+    }
+    catch (_a) {
+        console.log('Broken link', link);
+    }
+    return false;
+}
+async function main(workspaceRoot, globs, { fetchExternalLinks = false, checkRedirects = false, ignoreGlobs = [] }) {
+    var _a;
+    const workspace = new markdown_1.DocsWorkspace(workspaceRoot, globs, ignoreGlobs);
+    const parser = new markdown_1.MarkdownParser();
+    const linkComputer = new markdown_1.MarkdownLinkComputer(workspace);
+    const languageService = (0, vscode_markdown_languageservice_1.createLanguageService)({
+        workspace,
+        parser,
+        logger: new NoOpLogger(),
+        linkComputer,
+    });
+    const cts = new vscode_languageserver_1.CancellationTokenSource();
+    let errors = false;
+    const externalLinks = new Set();
+    try {
+        // Collect diagnostics for all documents in the workspace
+        for (const document of await workspace.getAllMarkdownDocuments()) {
+            for (let link of await languageService.getDocumentLinks(document, cts.token)) {
+                if (link.target === undefined) {
+                    link = (_a = (await languageService.resolveDocumentLink(link, cts.token))) !== null && _a !== void 0 ? _a : link;
+                }
+                if (link.target &&
+                    link.target.startsWith('http') &&
+                    new URL(link.target).hostname !== 'localhost') {
+                    externalLinks.add(link.target);
+                }
+            }
+            const diagnostics = await languageService.computeDiagnostics(document, diagnosticOptions, cts.token);
+            if (diagnostics.length) {
+                console.log('File Location:', path.relative(vscode_uri_1.URI.file(workspace.root).path, vscode_uri_1.URI.parse(document.uri).path));
+            }
+            for (const diagnostic of diagnostics) {
+                console.log(`\tBroken link on line ${diagnostic.range.start.line + 1}:`, diagnostic.message);
+                errors = true;
+            }
+        }
+    }
+    finally {
+        cts.dispose();
+    }
+    if (fetchExternalLinks) {
+        const externalLinkStates = await Promise.all(Array.from(externalLinks).map((link) => fetchExternalLink(link, checkRedirects)));
+        errors = errors || !externalLinkStates.every((x) => x);
+    }
+    return errors;
+}
+function parseCommandLine() {
+    const showUsage = (arg) => {
+        if (!arg || arg.startsWith('-')) {
+            console.log('Usage: electron-lint-markdown-links --root <dir> <globs> [-h|--help] [--fetch-external-links] ' +
+                '[--check-redirects [--ignore <globs>]');
+            process.exit(1);
+        }
+        return true;
+    };
+    const opts = minimist(process.argv.slice(2), {
+        boolean: ['help', 'fetch-external-links', 'check-redirects'],
+        string: ['root', 'ignore', 'ignore-path'],
+        stopEarly: true,
+        unknown: showUsage,
+    });
+    if (opts.help || !opts.root || !opts._.length)
+        showUsage();
+    return opts;
+}
+if (require.main === module) {
+    const opts = parseCommandLine();
+    if (opts.ignore) {
+        opts.ignore = Array.isArray(opts.ignore) ? opts.ignore : [opts.ignore];
+    }
+    else {
+        opts.ignore = [];
+    }
+    if (opts['ignore-path']) {
+        const ignores = fs.readFileSync(path.resolve(opts['ignore-path']), { encoding: 'utf-8' });
+        for (const ignore of ignores.split('\n')) {
+            opts.ignore.push(ignore.trimEnd());
+        }
+    }
+    main(path.resolve(process.cwd(), opts.root), opts._, {
+        fetchExternalLinks: opts['fetch-external-links'],
+        checkRedirects: opts['check-redirects'],
+        ignoreGlobs: opts.ignore,
+    })
+        .then((errors) => {
+        if (errors)
+            process.exit(1);
+    })
+        .catch((error) => {
+        console.error(error);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=lint-markdown-links.js.map

package/dist/bin/lint-markdown-links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint-markdown-links.js","sourceRoot":"","sources":["../../bin/lint-markdown-links.ts"],"names":[],"mappings":";;;AAEA,8BAA8B;AAC9B,kCAAkC;AAElC,iGAMqD;AACrD,qCAAqC;AACrC,2CAA+B;AAC/B,iEAAgE;AAChE,2CAAiC;AAEjC,8CAAsF;AAEtF,MAAM,UAAU;IAAhB;QACW,UAAK,GAAG,0CAAQ,CAAC,GAAG,CAAC;IAGhC,CAAC;IADC,GAAG,KAAU,CAAC;CACf;AAED,MAAM,iBAAiB,GAAsB;IAC3C,WAAW,EAAE,EAAE;IACf,gCAAgC,EAAE,iDAAe,CAAC,KAAK;IACvD,iBAAiB,EAAE,iDAAe,CAAC,KAAK;IACxC,qBAAqB,EAAE,iDAAe,CAAC,KAAK;IAC5C,iCAAiC,EAAE,iDAAe,CAAC,KAAK;IACxD,kBAAkB,EAAE,iDAAe,CAAC,KAAK;IACzC,6BAA6B,EAAE,iDAAe,CAAC,KAAK;CACrD,CAAC;AAEF,KAAK,UAAU,iBAAiB,CAAC,IAAY,EAAE,cAAc,GAAG,KAAK;IACnE,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,IAAI,CAAC,CAAC;QACnC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;SACxE;aAAM;YACL,IAAI,cAAc,IAAI,QAAQ,CAAC,UAAU,EAAE;gBACzC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7B,MAAM,CAAC,QAAQ,GAAG,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAE3C,yDAAyD;gBACzD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,EAAE,KAAK,QAAQ,CAAC,GAAG,CAAC;gBACvD,MAAM,qBAAqB,GAAG,GAAG,IAAI,GAAG,KAAK,QAAQ,CAAC,GAAG,CAAC;gBAE1D,IAAI,CAAC,WAAW,IAAI,CAAC,qBAAqB,EAAE;oBAC1C,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;iBAC3D;aACF;YAED,OAAO,IAAI,CAAC;SACb;KACF;IAAC,WAAM;QACN,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;KAClC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAQD,KAAK,UAAU,IAAI,CACjB,aAAqB,EACrB,KAAe,EACf,EAAE,kBAAkB,GAAG,KAAK,EAAE,cAAc,GAAG,KAAK,EAAE,WAAW,GAAG,EAAE,EAAW;;IAEjF,MAAM,SAAS,GAAG,IAAI,wBAAa,CAAC,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IACvE,MAAM,MAAM,GAAG,IAAI,yBAAc,EAAE,CAAC;IACpC,MAAM,YAAY,GAAG,IAAI,+BAAoB,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,IAAA,uDAAqB,EAAC;QAC5C,SAAS;QACT,MAAM;QACN,MAAM,EAAE,IAAI,UAAU,EAAE;QACxB,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,IAAI,+CAAuB,EAAE,CAAC;IAC1C,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IAExC,IAAI;QACF,yDAAyD;QACzD,KAAK,MAAM,QAAQ,IAAI,MAAM,SAAS,CAAC,uBAAuB,EAAE,EAAE;YAChE,KAAK,IAAI,IAAI,IAAI,MAAM,eAAe,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE;gBAC5E,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;oBAC7B,IAAI,GAAG,MAAA,CAAC,MAAM,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,mCAAI,IAAI,CAAC;iBAC7E;gBAED,IACE,IAAI,CAAC,MAAM;oBACX,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC;oBAC9B,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,KAAK,WAAW,EAC7C;oBACA,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBAChC;aACF;YACD,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,kBAAkB,CAC1D,QAAQ,EACR,iBAAiB,EACjB,GAAG,CAAC,KAAK,CACV,CAAC;YAEF,IAAI,WAAW,CAAC,MAAM,EAAE;gBACtB,OAAO,CAAC,GAAG,CACT,gBAAgB,EAChB,IAAI,CAAC,QAAQ,CAAC,gBAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAC3E,CAAC;aACH;YAED,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;gBACpC,OAAO,CAAC,GAAG,CACT,yBAAyB,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,GAAG,EAC3D,UAAU,CAAC,OAAO,CACnB,CAAC;gBACF,MAAM,GAAG,IAAI,CAAC;aACf;SACF;KACF;YAAS;QACR,GAAG,CAAC,OAAO,EAAE,CAAC;KACf;IAED,IAAI,kBAAkB,EAAE;QACtB,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CACjF,CAAC;QAEF,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;KACxD;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB;IACvB,MAAM,SAAS,GAAG,CAAC,GAAY,EAAW,EAAE;QAC1C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,OAAO,CAAC,GAAG,CACT,gGAAgG;gBAC9F,uCAAuC,CAC1C,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;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,sBAAsB,EAAE,iBAAiB,CAAC;QAC5D,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC;QACzC,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,SAAS;KACnB,CAAC,CAAC;IAEH,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;QAAE,SAAS,EAAE,CAAC;IAE3D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAC;IAEhC,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,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;KACxE;SAAM;QACL,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;KAClB;IAED,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE;QACvB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAE1F,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;SACpC;KACF;IAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE;QACnD,kBAAkB,EAAE,IAAI,CAAC,sBAAsB,CAAC;QAChD,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC;QACvC,WAAW,EAAE,IAAI,CAAC,MAAM;KACzB,CAAC;SACC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,IAAI,MAAM;YAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACN"}

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

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

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

@@ -0,0 +1,16 @@
+#!/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'),
+        ...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

@@ -0,0 +1 @@
+{"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;IAC3B,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,0BAA0B,CAAC;QACnD,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;CAClC"}

package/dist/lib/markdown.d.ts

@@ -0,0 +1,30 @@
+import { FileStat, IMdLinkComputer, IMdParser, ITextDocument, IWorkspace, MdLink } from '@dsanders11/vscode-markdown-languageservice';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+import { URI } from 'vscode-uri';
+export declare class MarkdownParser implements IMdParser {
+    slugifier: import("@dsanders11/vscode-markdown-languageservice").ISlugifier;
+    tokenize(document: TextDocument): Promise<import("markdown-it/lib/token")[]>;
+}
+export declare class DocsWorkspace implements IWorkspace {
+    #private;
+    private readonly documentCache;
+    readonly root: string;
+    readonly globs: string[];
+    readonly ignoreGlobs: string[];
+    constructor(root: string, globs: string[], ignoreGlobs?: string[]);
+    get workspaceFolders(): URI[];
+    getAllMarkdownDocuments(): Promise<Iterable<ITextDocument>>;
+    hasMarkdownDocument(resource: URI): boolean;
+    openMarkdownDocument(resource: URI): Promise<TextDocument | undefined>;
+    stat(resource: URI): Promise<FileStat | undefined>;
+    readDirectory(): Promise<Iterable<readonly [string, FileStat]>>;
+    onDidChangeMarkdownDocument: import("vscode-languageserver").Event<ITextDocument>;
+    onDidCreateMarkdownDocument: import("vscode-languageserver").Event<ITextDocument>;
+    onDidDeleteMarkdownDocument: import("vscode-languageserver").Event<URI>;
+}
+export declare class MarkdownLinkComputer implements IMdLinkComputer {
+    #private;
+    private readonly workspace;
+    constructor(workspace: IWorkspace);
+    getAllLinks(document: ITextDocument): Promise<MdLink[]>;
+}

package/dist/lib/markdown.js

@@ -0,0 +1,234 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DocsWorkspace_onDidChangeMarkdownDocument, _DocsWorkspace_onDidCreateMarkdownDocument, _DocsWorkspace_onDidDeleteMarkdownDocument, _MarkdownLinkComputer_instances, _MarkdownLinkComputer_getInlineLinks, _MarkdownLinkComputer_getReferenceLinks, _MarkdownLinkComputer_getLinkDefinitions;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownLinkComputer = exports.DocsWorkspace = exports.MarkdownParser = void 0;
+const fs = require("node:fs");
+const path = require("node:path");
+const glob = require("glob");
+const MarkdownIt = require("markdown-it");
+const vscode_markdown_languageservice_1 = require("@dsanders11/vscode-markdown-languageservice");
+const vscode_languageserver_1 = require("vscode-languageserver");
+const vscode_languageserver_textdocument_1 = require("vscode-languageserver-textdocument");
+const vscode_uri_1 = require("vscode-uri");
+// Helper function to work around import issues with ESM modules and ts-node
+// eslint-disable-next-line no-new-func
+const dynamicImport = new Function('specifier', 'return import(specifier)');
+// Helper function from `vscode-markdown-languageservice` codebase
+function tryDecodeUri(str) {
+    try {
+        return decodeURI(str);
+    }
+    catch (_a) {
+        return str;
+    }
+}
+// Helper function from `vscode-markdown-languageservice` codebase
+function createHref(sourceDocUri, link, workspace) {
+    if (/^[a-z-][a-z-]+:/i.test(link)) {
+        // Looks like a uri
+        return { kind: vscode_markdown_languageservice_1.HrefKind.External, uri: vscode_uri_1.URI.parse(tryDecodeUri(link)) };
+    }
+    const resolved = (0, vscode_markdown_languageservice_1.resolveInternalDocumentLink)(sourceDocUri, link, workspace);
+    if (!resolved) {
+        return undefined;
+    }
+    return {
+        kind: vscode_markdown_languageservice_1.HrefKind.Internal,
+        path: resolved.resource,
+        fragment: resolved.linkFragment,
+    };
+}
+function positionToRange(position) {
+    return {
+        start: {
+            character: position.start.column - 1,
+            line: position.start.line - 1,
+        },
+        end: { character: position.end.column - 1, line: position.end.line - 1 },
+    };
+}
+const mdIt = MarkdownIt({ html: true });
+class MarkdownParser {
+    constructor() {
+        this.slugifier = vscode_markdown_languageservice_1.githubSlugifier;
+    }
+    async tokenize(document) {
+        return mdIt.parse(document.getText(), {});
+    }
+}
+exports.MarkdownParser = MarkdownParser;
+class DocsWorkspace {
+    constructor(root, globs, ignoreGlobs = []) {
+        //
+        // These events are defined to fulfill the interface, but are never emitted
+        // by this implementation since it's not meant for watching a workspace
+        //
+        _DocsWorkspace_onDidChangeMarkdownDocument.set(this, new vscode_languageserver_1.Emitter());
+        this.onDidChangeMarkdownDocument = __classPrivateFieldGet(this, _DocsWorkspace_onDidChangeMarkdownDocument, "f").event;
+        _DocsWorkspace_onDidCreateMarkdownDocument.set(this, new vscode_languageserver_1.Emitter());
+        this.onDidCreateMarkdownDocument = __classPrivateFieldGet(this, _DocsWorkspace_onDidCreateMarkdownDocument, "f").event;
+        _DocsWorkspace_onDidDeleteMarkdownDocument.set(this, new vscode_languageserver_1.Emitter());
+        this.onDidDeleteMarkdownDocument = __classPrivateFieldGet(this, _DocsWorkspace_onDidDeleteMarkdownDocument, "f").event;
+        this.documentCache = new Map();
+        this.root = root;
+        this.globs = globs;
+        this.ignoreGlobs = ignoreGlobs;
+    }
+    get workspaceFolders() {
+        return [vscode_uri_1.URI.file(this.root)];
+    }
+    async getAllMarkdownDocuments() {
+        const files = this.globs.flatMap((pattern) => glob.sync(pattern, { ignore: this.ignoreGlobs, absolute: true, cwd: this.root }));
+        for (const file of files) {
+            const document = vscode_languageserver_textdocument_1.TextDocument.create(vscode_uri_1.URI.file(file).toString(), 'markdown', 1, fs.readFileSync(file, 'utf8'));
+            this.documentCache.set(file, document);
+        }
+        return this.documentCache.values();
+    }
+    hasMarkdownDocument(resource) {
+        const relativePath = path.relative(path.resolve(this.root), resource.fsPath);
+        return (!relativePath.startsWith('..') &&
+            !path.isAbsolute(relativePath) &&
+            fs.existsSync(resource.fsPath));
+    }
+    async openMarkdownDocument(resource) {
+        if (!this.documentCache.has(resource.fsPath)) {
+            try {
+                const document = vscode_languageserver_textdocument_1.TextDocument.create(resource.toString(), 'markdown', 1, fs.readFileSync(resource.fsPath, 'utf8'));
+                this.documentCache.set(resource.fsPath, document);
+            }
+            catch (_a) {
+                return undefined;
+            }
+        }
+        return this.documentCache.get(resource.fsPath);
+    }
+    async stat(resource) {
+        if (this.hasMarkdownDocument(resource)) {
+            const stats = fs.statSync(resource.fsPath);
+            return { isDirectory: stats.isDirectory() };
+        }
+        return undefined;
+    }
+    async readDirectory() {
+        throw new Error('Not implemented');
+    }
+}
+exports.DocsWorkspace = DocsWorkspace;
+_DocsWorkspace_onDidChangeMarkdownDocument = new WeakMap(), _DocsWorkspace_onDidCreateMarkdownDocument = new WeakMap(), _DocsWorkspace_onDidDeleteMarkdownDocument = new WeakMap();
+class MarkdownLinkComputer {
+    constructor(workspace) {
+        _MarkdownLinkComputer_instances.add(this);
+        this.workspace = workspace;
+    }
+    async getAllLinks(document) {
+        const { fromMarkdown } = (await dynamicImport('mdast-util-from-markdown'));
+        const tree = fromMarkdown(document.getText());
+        const links = [
+            ...(await __classPrivateFieldGet(this, _MarkdownLinkComputer_instances, "m", _MarkdownLinkComputer_getInlineLinks).call(this, document, tree)),
+            ...(await __classPrivateFieldGet(this, _MarkdownLinkComputer_instances, "m", _MarkdownLinkComputer_getReferenceLinks).call(this, document, tree)),
+            ...(await __classPrivateFieldGet(this, _MarkdownLinkComputer_instances, "m", _MarkdownLinkComputer_getLinkDefinitions).call(this, document, tree)),
+        ];
+        return links;
+    }
+}
+exports.MarkdownLinkComputer = MarkdownLinkComputer;
+_MarkdownLinkComputer_instances = new WeakSet(), _MarkdownLinkComputer_getInlineLinks = async function _MarkdownLinkComputer_getInlineLinks(document, tree) {
+    const { visit } = (await dynamicImport('unist-util-visit'));
+    const documentUri = vscode_uri_1.URI.parse(document.uri);
+    const links = [];
+    visit(tree, (node) => node.type === 'link', (node) => {
+        const link = node;
+        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: vscode_markdown_languageservice_1.MdLinkKind.Link,
+                href,
+                source: {
+                    hrefText: link.url,
+                    resource: documentUri,
+                    range,
+                    targetRange,
+                    hrefRange,
+                    fragmentRange,
+                    pathText: link.url.split('#')[0],
+                },
+            });
+        }
+    });
+    return links;
+}, _MarkdownLinkComputer_getReferenceLinks = async function _MarkdownLinkComputer_getReferenceLinks(document, tree) {
+    const { visit } = (await dynamicImport('unist-util-visit'));
+    const links = [];
+    visit(tree, (node) => ['imageReference', 'linkReference'].includes(node.type), (node) => {
+        const link = node;
+        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: vscode_markdown_languageservice_1.MdLinkKind.Link,
+            href: {
+                kind: vscode_markdown_languageservice_1.HrefKind.Reference,
+                ref: link.label,
+            },
+            source: {
+                hrefText: link.label,
+                resource: vscode_uri_1.URI.parse(document.uri),
+                range,
+                targetRange,
+                hrefRange,
+                fragmentRange: undefined,
+                pathText: link.label,
+            },
+        });
+    });
+    return links;
+}, _MarkdownLinkComputer_getLinkDefinitions = async function _MarkdownLinkComputer_getLinkDefinitions(document, tree) {
+    const { visit } = (await dynamicImport('unist-util-visit'));
+    const documentUri = vscode_uri_1.URI.parse(document.uri);
+    const links = [];
+    visit(tree, (node) => node.type === 'definition', (node) => {
+        const definition = node;
+        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: vscode_markdown_languageservice_1.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;
+};
+//# sourceMappingURL=markdown.js.map

package/dist/lib/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../lib/markdown.ts"],"names":[],"mappings":";;;;;;;;;AAAA,8BAA8B;AAC9B,kCAAkC;AAElC,6BAA6B;AAC7B,0CAA0C;AAC1C,iGAaqD;AACrD,iEAAuD;AACvD,2FAAkE;AAClE,2CAAiC;AAOjC,4EAA4E;AAC5E,uCAAuC;AACvC,MAAM,aAAa,GAAG,IAAI,QAAQ,CAAC,WAAW,EAAE,0BAA0B,CAAC,CAAC;AAE5E,kEAAkE;AAClE,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI;QACF,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;KACvB;IAAC,WAAM;QACN,OAAO,GAAG,CAAC;KACZ;AACH,CAAC;AAED,kEAAkE;AAClE,SAAS,UAAU,CACjB,YAAiB,EACjB,IAAY,EACZ,SAAqB;IAErB,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACjC,mBAAmB;QACnB,OAAO,EAAE,IAAI,EAAE,0CAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE,gBAAG,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;KACxE;IAED,MAAM,QAAQ,GAAG,IAAA,6DAA2B,EAAC,YAAY,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5E,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,IAAI,EAAE,0CAAQ,CAAC,QAAQ;QACvB,IAAI,EAAE,QAAQ,CAAC,QAAQ;QACvB,QAAQ,EAAE,QAAQ,CAAC,YAAY;KAChC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,QAAkB;IACzC,OAAO;QACL,KAAK,EAAE;YACL,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;YACpC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC;SAC9B;QACD,GAAG,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE;KACzE,CAAC;AACJ,CAAC;AAED,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AAExC,MAAa,cAAc;IAA3B;QACE,cAAS,GAAG,iDAAe,CAAC;IAK9B,CAAC;IAHC,KAAK,CAAC,QAAQ,CAAC,QAAsB;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAND,wCAMC;AAED,MAAa,aAAa;IAMxB,YAAY,IAAY,EAAE,KAAe,EAAE,cAAwB,EAAE;QAuErE,EAAE;QACF,2EAA2E;QAC3E,uEAAuE;QACvE,EAAE;QAEF,qDAA+B,IAAI,+BAAO,EAAiB,EAAC;QAC5D,gCAA2B,GAAG,uBAAA,IAAI,kDAA6B,CAAC,KAAK,CAAC;QAEtE,qDAA+B,IAAI,+BAAO,EAAiB,EAAC;QAC5D,gCAA2B,GAAG,uBAAA,IAAI,kDAA6B,CAAC,KAAK,CAAC;QAEtE,qDAA+B,IAAI,+BAAO,EAAO,EAAC;QAClD,gCAA2B,GAAG,uBAAA,IAAI,kDAA6B,CAAC,KAAK,CAAC;QAlFpE,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,CAAC,gBAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,uBAAuB;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CACjF,CAAC;QAEF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,QAAQ,GAAG,iDAAY,CAAC,MAAM,CAClC,gBAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EACzB,UAAU,EACV,CAAC,EACD,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAC9B,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;SACxC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;IACrC,CAAC;IAED,mBAAmB,CAAC,QAAa;QAC/B,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC7E,OAAO,CACL,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC;YAC9B,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAC9B,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC/B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,QAAa;QACtC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC5C,IAAI;gBACF,MAAM,QAAQ,GAAG,iDAAY,CAAC,MAAM,CAClC,QAAQ,CAAC,QAAQ,EAAE,EACnB,UAAU,EACV,CAAC,EACD,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CACzC,CAAC;gBAEF,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aACnD;YAAC,WAAM;gBACN,OAAO,SAAS,CAAC;aAClB;SACF;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,QAAa;QACtB,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE;YACtC,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC3C,OAAO,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;SAC7C;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CAeF;AA1FD,sCA0FC;;AAED,MAAa,oBAAoB;IAG/B,YAAY,SAAqB;;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,QAAuB;QACvC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,aAAa,CAAC,0BAA0B,CAAC,CAExE,CAAC;QAEF,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QAE9C,MAAM,KAAK,GAAG;YACZ,GAAG,CAAC,MAAM,uBAAA,IAAI,6EAAgB,MAApB,IAAI,EAAiB,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC/C,GAAG,CAAC,MAAM,uBAAA,IAAI,gFAAmB,MAAvB,IAAI,EAAoB,QAAQ,EAAE,IAAI,CAAC,CAAC;YAClD,GAAG,CAAC,MAAM,uBAAA,IAAI,iFAAoB,MAAxB,IAAI,EAAqB,QAAQ,EAAE,IAAI,CAAC,CAAC;SACpD,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;CAsIF;AA3JD,oDA2JC;wFApIC,KAAK,+CAAiB,QAAuB,EAAE,IAAU;IACvD,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,aAAa,CAAC,kBAAkB,CAAC,CAEzD,CAAC;IAEF,MAAM,WAAW,GAAG,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CACH,IAAI,EACJ,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,EAC9B,CAAC,IAAU,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,IAAY,CAAC;QAC1B,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAE/D,IAAI,IAAI,EAAE;YACR,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;YAE9C,4DAA4D;YAC5D,0DAA0D;YAC1D,MAAM,WAAW,GAAG,KAAK,CAAC;YAC1B,MAAM,SAAS,GAAG,KAAK,CAAC;YACxB,MAAM,aAAa,GAAG,SAAS,CAAC;YAEhC,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI,EAAE,4CAAU,CAAC,IAAI;gBACrB,IAAI;gBACJ,MAAM,EAAE;oBACN,QAAQ,EAAE,IAAI,CAAC,GAAG;oBAClB,QAAQ,EAAE,WAAW;oBACrB,KAAK;oBACL,WAAW;oBACX,SAAS;oBACT,aAAa;oBACb,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBACjC;aACF,CAAC,CAAC;SACJ;IACH,CAAC,CACF,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC,4CAED,KAAK,kDAAoB,QAAuB,EAAE,IAAU;IAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,aAAa,CAAC,kBAAkB,CAAC,CAEzD,CAAC;IAEF,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CACH,IAAI,EACJ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EACjE,CAAC,IAAU,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,IAAsC,CAAC;QACpD,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;QAE9C,4DAA4D;QAC5D,0DAA0D;QAC1D,MAAM,WAAW,GAAG,KAAK,CAAC;QAC1B,MAAM,SAAS,GAAG,KAAK,CAAC;QAExB,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,4CAAU,CAAC,IAAI;YACrB,IAAI,EAAE;gBACJ,IAAI,EAAE,0CAAQ,CAAC,SAAS;gBACxB,GAAG,EAAE,IAAI,CAAC,KAAM;aACjB;YACD,MAAM,EAAE;gBACN,QAAQ,EAAE,IAAI,CAAC,KAAM;gBACrB,QAAQ,EAAE,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACjC,KAAK;gBACL,WAAW;gBACX,SAAS;gBACT,aAAa,EAAE,SAAS;gBACxB,QAAQ,EAAE,IAAI,CAAC,KAAM;aACtB;SACF,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC,6CAED,KAAK,mDAAqB,QAAuB,EAAE,IAAU;IAC3D,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,aAAa,CAAC,kBAAkB,CAAC,CAEzD,CAAC;IAEF,MAAM,WAAW,GAAG,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CACH,IAAI,EACJ,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY,EACpC,CAAC,IAAU,EAAE,EAAE;QACb,MAAM,UAAU,GAAG,IAAkB,CAAC;QACtC,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAErE,IAAI,IAAI,EAAE;YACR,MAAM,KAAK,GAAG,eAAe,CAAC,UAAU,CAAC,QAAS,CAAC,CAAC;YAEpD,4DAA4D;YAC5D,0DAA0D;YAC1D,MAAM,WAAW,GAAG,KAAK,CAAC;YAC1B,MAAM,SAAS,GAAG,KAAK,CAAC;YACxB,MAAM,aAAa,GAAG,SAAS,CAAC;YAEhC,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI,EAAE,4CAAU,CAAC,UAAU;gBAC3B,IAAI;gBACJ,GAAG,EAAE;oBACH,KAAK;oBACL,IAAI,EAAE,UAAU,CAAC,KAAM;iBACxB;gBACD,MAAM,EAAE;oBACN,QAAQ,EAAE,UAAU,CAAC,GAAG;oBACxB,QAAQ,EAAE,WAAW;oBACrB,KAAK;oBACL,WAAW;oBACX,SAAS;oBACT,aAAa;oBACb,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBACvC;aACF,CAAC,CAAC;SACJ;IACH,CAAC,CACF,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/markdown.ts

@@ -0,0 +1,332 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+import * as glob from 'glob';
+import * as MarkdownIt from 'markdown-it';
+import {
+  githubSlugifier,
+  resolveInternalDocumentLink,
+  ExternalHref,
+  FileStat,
+  HrefKind,
+  InternalHref,
+  IMdLinkComputer,
+  IMdParser,
+  ITextDocument,
+  IWorkspace,
+  MdLink,
+  MdLinkKind,
+} from '@dsanders11/vscode-markdown-languageservice';
+import { Emitter, Range } from 'vscode-languageserver';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+import { URI } from 'vscode-uri';
+
+import type { 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';
+
+// Helper function to work around import issues with ESM modules and ts-node
+// eslint-disable-next-line no-new-func
+const dynamicImport = new Function('specifier', 'return import(specifier)');
+
+// Helper function from `vscode-markdown-languageservice` codebase
+function tryDecodeUri(str: string): string {
+  try {
+    return decodeURI(str);
+  } catch {
+    return str;
+  }
+}
+
+// Helper function from `vscode-markdown-languageservice` codebase
+function createHref(
+  sourceDocUri: URI,
+  link: string,
+  workspace: IWorkspace,
+): ExternalHref | InternalHref | undefined {
+  if (/^[a-z-][a-z-]+:/i.test(link)) {
+    // Looks like a uri
+    return { kind: HrefKind.External, uri: URI.parse(tryDecodeUri(link)) };
+  }
+
+  const resolved = resolveInternalDocumentLink(sourceDocUri, link, workspace);
+  if (!resolved) {
+    return undefined;
+  }
+
+  return {
+    kind: HrefKind.Internal,
+    path: resolved.resource,
+    fragment: resolved.linkFragment,
+  };
+}
+
+function positionToRange(position: Position): Range {
+  return {
+    start: {
+      character: position.start.column - 1,
+      line: position.start.line - 1,
+    },
+    end: { character: position.end.column - 1, line: position.end.line - 1 },
+  };
+}
+
+const mdIt = MarkdownIt({ html: true });
+
+export class MarkdownParser implements IMdParser {
+  slugifier = githubSlugifier;
+
+  async tokenize(document: TextDocument) {
+    return mdIt.parse(document.getText(), {});
+  }
+}
+
+export class DocsWorkspace implements IWorkspace {
+  private readonly documentCache: Map<string, TextDocument>;
+  readonly root: string;
+  readonly globs: string[];
+  readonly ignoreGlobs: string[];
+
+  constructor(root: string, globs: string[], ignoreGlobs: string[] = []) {
+    this.documentCache = new Map();
+    this.root = root;
+    this.globs = globs;
+    this.ignoreGlobs = ignoreGlobs;
+  }
+
+  get workspaceFolders() {
+    return [URI.file(this.root)];
+  }
+
+  async getAllMarkdownDocuments(): Promise<Iterable<ITextDocument>> {
+    const files = this.globs.flatMap((pattern) =>
+      glob.sync(pattern, { ignore: this.ignoreGlobs, absolute: true, cwd: this.root }),
+    );
+
+    for (const file of files) {
+      const document = TextDocument.create(
+        URI.file(file).toString(),
+        'markdown',
+        1,
+        fs.readFileSync(file, 'utf8'),
+      );
+
+      this.documentCache.set(file, document);
+    }
+
+    return this.documentCache.values();
+  }
+
+  hasMarkdownDocument(resource: URI) {
+    const relativePath = path.relative(path.resolve(this.root), resource.fsPath);
+    return (
+      !relativePath.startsWith('..') &&
+      !path.isAbsolute(relativePath) &&
+      fs.existsSync(resource.fsPath)
+    );
+  }
+
+  async openMarkdownDocument(resource: URI) {
+    if (!this.documentCache.has(resource.fsPath)) {
+      try {
+        const document = TextDocument.create(
+          resource.toString(),
+          'markdown',
+          1,
+          fs.readFileSync(resource.fsPath, 'utf8'),
+        );
+
+        this.documentCache.set(resource.fsPath, document);
+      } catch {
+        return undefined;
+      }
+    }
+
+    return this.documentCache.get(resource.fsPath);
+  }
+
+  async stat(resource: URI): Promise<FileStat | undefined> {
+    if (this.hasMarkdownDocument(resource)) {
+      const stats = fs.statSync(resource.fsPath);
+      return { isDirectory: stats.isDirectory() };
+    }
+
+    return undefined;
+  }
+
+  async readDirectory(): Promise<Iterable<readonly [string, FileStat]>> {
+    throw new Error('Not implemented');
+  }
+
+  //
+  // These events are defined to fulfill the interface, but are never emitted
+  // by this implementation since it's not meant for watching a workspace
+  //
+
+  #onDidChangeMarkdownDocument = new Emitter<ITextDocument>();
+  onDidChangeMarkdownDocument = this.#onDidChangeMarkdownDocument.event;
+
+  #onDidCreateMarkdownDocument = new Emitter<ITextDocument>();
+  onDidCreateMarkdownDocument = this.#onDidCreateMarkdownDocument.event;
+
+  #onDidDeleteMarkdownDocument = new Emitter<URI>();
+  onDidDeleteMarkdownDocument = this.#onDidDeleteMarkdownDocument.event;
+}
+
+export class MarkdownLinkComputer implements IMdLinkComputer {
+  private readonly workspace: IWorkspace;
+
+  constructor(workspace: IWorkspace) {
+    this.workspace = workspace;
+  }
+
+  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 = [
+      ...(await this.#getInlineLinks(document, tree)),
+      ...(await this.#getReferenceLinks(document, tree)),
+      ...(await this.#getLinkDefinitions(document, tree)),
+    ];
+
+    return links;
+  }
+
+  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,
+      (node) => ['imageReference', 'linkReference'].includes(node.type),
+      (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 { visit } = (await dynamicImport('unist-util-visit')) as {
+      visit: typeof VisitFunction;
+    };
+
+    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],
+            },
+          });
+        }
+      },
+    );
+
+    return links;
+  }
+}

package/markdownlint-rules/emd001.js

@@ -0,0 +1,20 @@
+const { addError, getLineMetadata, getReferenceLinkImageData } = require('markdownlint/helpers');
+
+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) {
+        addError(
+          onError,
+          lineNumber + 1, // human-friendly line numbers (1-based)
+          `Disallowed shortcut reference link: "${shortcut}"`,
+        );
+      }
+    }
+  },
+};

package/package.json

@@ -1,4 +1,67 @@
 {
   "name": "@electron/lint-roller",
-  "version": "0.0.0"
+  "version": "1.0.1",
+  "description": "Markdown linting helpers for Electron org repos",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "bin": {
+    "electron-markdownlint": "./dist/bin/markdownlint-cli-wrapper.js",
+    "electron-lint-markdown-links": "./dist/bin/lint-markdown-links.js"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "yarn run build",
+    "lint:eslint": "eslint \"{bin,lib,markdownlint-rules}/**/*.{js,ts}\"",
+    "lint:eslint:fix": "eslint --fix \"{bin,lib,markdownlint-rules}/**/*.{js,ts}\"",
+    "lint:markdown": "yarn run build && node ./dist/bin/markdownlint-cli-wrapper.js \"*.md\" && node ./dist/bin/lint-markdown-links.js --root . \"*.md\"",
+    "lint:prettier": "prettier --check \"{bin,lib,markdownlint-rules}/**/*.{js,ts}\"",
+    "lint:prettier:fix": "prettier --write \"{bin,lib,markdownlint-rules}/**/*.{js,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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/electron/lint-roller.git"
+  },
+  "author": "David Sanders <dsanders11@ucsbalum.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/electron/lint-roller/issues"
+  },
+  "homepage": "https://github.com/electron/lint-roller#readme",
+  "devDependencies": {
+    "@continuous-auth/semantic-release-npm": "^3.0.0",
+    "@electron-internal/eslint-config": "^1.0.1",
+    "@types/glob": "^8.0.1",
+    "@types/jest": "^29.4.0",
+    "@types/markdown-it": "^12.2.3",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "^18.14.0",
+    "@types/node-fetch": "^2.6.2",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-node": "^11.1.0",
+    "jest": "^29.4.3",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@dsanders11/vscode-markdown-languageservice": "^0.3.0",
+    "glob": "^8.1.0",
+    "markdown-it": "^13.0.1",
+    "markdownlint-cli": "^0.33.0",
+    "mdast-util-from-markdown": "^1.3.0",
+    "minimist": "^1.2.8",
+    "node-fetch": "^2.6.9",
+    "unist-util-visit": "^4.1.2",
+    "vscode-languageserver": "^8.1.0",
+    "vscode-languageserver-textdocument": "^1.0.8",
+    "vscode-uri": "^3.0.7"
+  }
 }