asciidoclint 0.5.0

package/dist/parsers/asciidoctor.js

@@ -0,0 +1,444 @@
+import { spawnSync } from "node:child_process";
+import { createRequire } from "node:module";
+import fs from "node:fs";
+import path from "node:path";
+const require = createRequire(typeof __filename === "string" ? __filename : import.meta.url);
+let asciidoctor;
+export function collectAsciidoctorDiagnostics(file) {
+    if (shouldIsolateAsciidoctor()) {
+        return collectAsciidoctorDiagnosticsInChild(file);
+    }
+    const processor = getAsciidoctor();
+    const logger = processor.MemoryLogger.create();
+    processor.LoggerManager.setLogger(logger);
+    try {
+        processor.convertFile(file, {
+            safe: "unsafe",
+            to_file: false,
+            mkdirs: false,
+        });
+    }
+    catch {
+        // Diagnostics are collected below; conversion exceptions should not mask lint findings.
+    }
+    return logger.getMessages().map((message) => {
+        return toFinding(message, file);
+    });
+}
+export function collectAsciidoctorBlocks(file) {
+    if (shouldIsolateAsciidoctor()) {
+        return collectAsciidoctorBlocksInChild(file);
+    }
+    try {
+        const processor = getAsciidoctor();
+        const logger = processor.MemoryLogger.create();
+        processor.LoggerManager.setLogger(logger);
+        const document = processor.loadFile(file, {
+            safe: "unsafe",
+            sourcemap: true,
+        });
+        return blocksFromDocument(document);
+    }
+    catch {
+        return [];
+    }
+}
+export function collectAsciidoctorReferenceTargets(file) {
+    if (shouldIsolateAsciidoctor()) {
+        return collectAsciidoctorReferenceTargetsInChild(file);
+    }
+    try {
+        const processor = getAsciidoctor();
+        const logger = processor.MemoryLogger.create();
+        processor.LoggerManager.setLogger(logger);
+        const document = processor.loadFile(file, {
+            safe: "unsafe",
+            sourcemap: true,
+        });
+        return referenceTargetsFromDocument(document, file);
+    }
+    catch {
+        return [];
+    }
+}
+function shouldIsolateAsciidoctor() {
+    return process.env.ASCIIDOCLINT_ISOLATE_ASCIIDOCTOR === "1" || !!process.versions.electron;
+}
+function collectAsciidoctorDiagnosticsInChild(file) {
+    const asciidoctorEntry = require.resolve("asciidoctor");
+    const child = spawnSync(process.execPath, ["-e", isolatedAsciidoctorScript(), file, asciidoctorEntry], {
+        encoding: "utf8",
+        env: {
+            ...process.env,
+            ELECTRON_RUN_AS_NODE: "1",
+            ASCIIDOCLINT_ISOLATE_ASCIIDOCTOR: "0",
+        },
+        maxBuffer: 10 * 1024 * 1024,
+    });
+    if (child.status !== 0) {
+        return [parserFailureFinding(file, child.stderr || child.stdout || `child process exited with status ${child.status}`)];
+    }
+    try {
+        return JSON.parse(child.stdout);
+    }
+    catch (error) {
+        return [parserFailureFinding(file, `failed to parse child diagnostics output: ${error instanceof Error ? error.message : String(error)}`)];
+    }
+}
+function collectAsciidoctorBlocksInChild(file) {
+    const asciidoctorEntry = require.resolve("asciidoctor");
+    const child = spawnSync(process.execPath, ["-e", isolatedAsciidoctorBlocksScript(), file, asciidoctorEntry], {
+        encoding: "utf8",
+        env: {
+            ...process.env,
+            ELECTRON_RUN_AS_NODE: "1",
+            ASCIIDOCLINT_ISOLATE_ASCIIDOCTOR: "0",
+        },
+        maxBuffer: 10 * 1024 * 1024,
+    });
+    if (child.status !== 0) {
+        return [];
+    }
+    try {
+        return JSON.parse(child.stdout);
+    }
+    catch {
+        return [];
+    }
+}
+function collectAsciidoctorReferenceTargetsInChild(file) {
+    const asciidoctorEntry = require.resolve("asciidoctor");
+    const child = spawnSync(process.execPath, ["-e", isolatedAsciidoctorReferenceTargetsScript(), file, asciidoctorEntry], {
+        encoding: "utf8",
+        env: {
+            ...process.env,
+            ELECTRON_RUN_AS_NODE: "1",
+            ASCIIDOCLINT_ISOLATE_ASCIIDOCTOR: "0",
+        },
+        maxBuffer: 10 * 1024 * 1024,
+    });
+    if (child.status !== 0) {
+        return [];
+    }
+    try {
+        return JSON.parse(child.stdout);
+    }
+    catch {
+        return [];
+    }
+}
+function isolatedAsciidoctorScript() {
+    return `
+const path = require("node:path");
+const file = process.argv[1];
+const asciidoctorEntry = process.argv[2];
+delete globalThis.Opal;
+const asciidoctor = require(asciidoctorEntry)();
+const logger = asciidoctor.MemoryLogger.create();
+asciidoctor.LoggerManager.setLogger(logger);
+const diagramStyles = new Set(["a2s","actdiag","blockdiag","bytefield","dbml","ditaa","dot","dpic","drawio","erd","gnuplot","goat","graphviz","lilypond","matplotlib","mermaid","mmpviz","mscgen","nomnoml","nwdiag","packetdiag","penrose","pikchr","pintora","plantuml","rackdiag","seqdiag","shaape","smcat","state-machine-cat","structurizr","svgbob","symbolator","syntrax","umlet","vega","vega-lite","vegalite","wavedrom"]);
+try {
+  asciidoctor.convertFile(file, { safe: "unsafe", to_file: false, mkdirs: false });
+} catch {}
+const findings = logger.getMessages().map((message) => {
+  const location = message.getSourceLocation?.();
+  const sourceFile = location?.file ? path.resolve(String(location.file)) : path.resolve(file);
+  const line = Number(location?.lineno ?? 1);
+  const severity = String(message.getSeverity?.() ?? "WARN").toUpperCase() === "ERROR" ? "error" : "warning";
+  return {
+    ruleId: "AD000",
+    alias: "asciidoctor-diagnostic",
+    severity,
+    message: String(message.getText?.() ?? message),
+    range: { start: { file: sourceFile, line, column: 1 } },
+  };
+});
+process.stdout.write(JSON.stringify(findings));
+`;
+}
+function isolatedAsciidoctorBlocksScript() {
+    return `
+const fs = require("node:fs");
+const path = require("node:path");
+const file = process.argv[1];
+const asciidoctorEntry = process.argv[2];
+delete globalThis.Opal;
+const asciidoctor = require(asciidoctorEntry)();
+const logger = asciidoctor.MemoryLogger.create();
+asciidoctor.LoggerManager.setLogger(logger);
+function pos(file, line, column) {
+  return { file, line, column };
+}
+function findClosingDelimiter(sourceFile, startLine, delimiter) {
+  try {
+    const lines = fs.readFileSync(sourceFile, "utf8").split(/\\r?\\n/);
+    for (let index = startLine; index < lines.length; index += 1) {
+      if ((lines[index] || "").trim() === delimiter) {
+        return { line: index + 1, column: (lines[index] || "").length + 1 };
+      }
+    }
+  } catch {}
+  return undefined;
+}
+function blocksFromDocument(document) {
+  const tables = document.findBy({ context: "table" }) || [];
+  const images = document.findBy({ context: "image" }) || [];
+  const diagrams = []
+    .concat(document.findBy({ context: "listing" }) || [])
+    .concat(document.findBy({ context: "literal" }) || [])
+    .filter((block) => diagramStyles.has(String((block.getStyle && block.getStyle()) || "")));
+  return []
+    .concat(tables.map((block) => {
+    const location = block.getSourceLocation && block.getSourceLocation();
+    const sourceFile = location && location.file ? path.resolve(String(location.file)) : path.resolve(file);
+    const startLine = Number((location && (location.getLineNumber && location.getLineNumber())) || (location && location.lineno) || 1);
+    const end = findClosingDelimiter(sourceFile, startLine, "|===");
+    const attributes = block.getAttributes ? block.getAttributes() : {};
+    return {
+      kind: "block",
+      type: "table",
+      style: block.getStyle && block.getStyle() ? String(block.getStyle()) : undefined,
+      title: block.getTitle && block.getTitle() ? String(block.getTitle()) : undefined,
+      attributes: Object.fromEntries(Object.entries(attributes).filter(([, value]) => ["string", "number", "boolean"].includes(typeof value)).map(([key, value]) => [key, String(value)])),
+      table: tableInfo(block),
+      range: { start: pos(sourceFile, startLine, 1), end: end ? pos(sourceFile, end.line, end.column) : undefined },
+      contentRange: end ? { start: pos(sourceFile, startLine + 1, 1), end: pos(sourceFile, end.line - 1, 1) } : undefined,
+    };
+  }))
+    .concat(images.map((block) => blockNode(block, "image")))
+    .concat(diagrams.map((block) => blockNode(block, "diagram")));
+}
+function blockNode(block, type) {
+  const location = block.getSourceLocation && block.getSourceLocation();
+  const sourceFile = location && location.file ? path.resolve(String(location.file)) : path.resolve(file);
+  const startLine = Number((location && (location.getLineNumber && location.getLineNumber())) || (location && location.lineno) || 1);
+  const attributes = block.getAttributes ? block.getAttributes() : {};
+  return {
+    kind: "block",
+    type,
+    style: block.getStyle && block.getStyle() ? String(block.getStyle()) : undefined,
+    title: block.getTitle && block.getTitle() ? String(block.getTitle()) : undefined,
+    attributes: Object.fromEntries(Object.entries(attributes).filter(([, value]) => ["string", "number", "boolean"].includes(typeof value)).map(([key, value]) => [key, typeof value === "boolean" ? value : String(value)])),
+    range: { start: pos(sourceFile, startLine, 1) },
+  };
+}
+function primitiveNumber(value) {
+  return typeof value === "number" ? value : undefined;
+}
+function tableInfo(block) {
+  const rows = block.getRows && block.getRows();
+  const cells = []
+    .concat(rows && rows.head ? rows.head.flat() : [])
+    .concat(rows && rows.body ? rows.body.flat() : [])
+    .concat(rows && rows.foot ? rows.foot.flat() : []);
+  return {
+    columnCount: primitiveNumber(block.getColumnCount && block.getColumnCount()),
+    renderedCellCount: cells.length,
+    renderedCellSourceLines: cells
+      .map((cell) => {
+        const location = cell && cell.getSourceLocation && cell.getSourceLocation();
+        return Number((location && (location.getLineNumber && location.getLineNumber())) || (location && location.lineno) || 0);
+      })
+      .filter((line) => line > 0),
+  };
+}
+try {
+  const document = asciidoctor.loadFile(file, { safe: "unsafe", sourcemap: true });
+  process.stdout.write(JSON.stringify(blocksFromDocument(document)));
+} catch {
+  process.stdout.write("[]");
+}
+`;
+}
+function isolatedAsciidoctorReferenceTargetsScript() {
+    return `
+const path = require("node:path");
+const file = process.argv[1];
+const asciidoctorEntry = process.argv[2];
+delete globalThis.Opal;
+const asciidoctor = require(asciidoctorEntry)();
+const logger = asciidoctor.MemoryLogger.create();
+asciidoctor.LoggerManager.setLogger(logger);
+function referenceTargetsFromDocument(document) {
+  const refs = document.getCatalog && document.getCatalog().refs;
+  const map = refs && refs.$$smap ? refs.$$smap : {};
+  return Object.entries(map).flatMap(([id, node]) => {
+    const location = node && node.getSourceLocation ? node.getSourceLocation() : node && node.source_location;
+    const sourceFile = location && location.file ? path.resolve(String(location.file)) : path.resolve(file);
+    const title = node && node.title ? String(node.title) : undefined;
+    const context = node && node.context ? String(node.context) : undefined;
+    const aliases = title && context === "section" && title !== id ? [title] : [];
+    return [{ id, file: sourceFile, aliases, source: "asciidoctor" }];
+  });
+}
+try {
+  const document = asciidoctor.loadFile(file, { safe: "unsafe", sourcemap: true });
+  process.stdout.write(JSON.stringify(referenceTargetsFromDocument(document)));
+} catch {
+  process.stdout.write("[]");
+}
+`;
+}
+function blocksFromDocument(document) {
+    const tables = document.findBy?.({ context: "table" }) ?? [];
+    const images = document.findBy?.({ context: "image" }) ?? [];
+    const diagrams = [
+        ...(document.findBy?.({ context: "listing" }) ?? []),
+        ...(document.findBy?.({ context: "literal" }) ?? []),
+    ].filter((block) => diagramStyles.has(String(block.getStyle?.() ?? "")));
+    return [
+        ...tables.map((block) => {
+            const location = block.getSourceLocation?.();
+            const sourceFile = location?.file ? path.resolve(String(location.file)) : undefined;
+            if (!sourceFile) {
+                return undefined;
+            }
+            const startLine = Number(location.getLineNumber?.() ?? location.lineno ?? 1);
+            const end = findClosingDelimiter(sourceFile, startLine, "|===");
+            const attributes = primitiveAttributes(block.getAttributes?.() ?? {});
+            return {
+                kind: "block",
+                type: "table",
+                style: block.getStyle?.() ? String(block.getStyle()) : undefined,
+                title: block.getTitle?.() ? String(block.getTitle()) : undefined,
+                attributes,
+                table: tableInfo(block),
+                range: {
+                    start: { file: sourceFile, line: startLine, column: 1 },
+                    end: end ? { file: sourceFile, line: end.line, column: end.column } : undefined,
+                },
+                contentRange: end ? {
+                    start: { file: sourceFile, line: startLine + 1, column: 1 },
+                    end: { file: sourceFile, line: end.line - 1, column: 1 },
+                } : undefined,
+            };
+        }),
+        ...images.map((block) => genericBlockNode(block, "image")),
+        ...diagrams.map((block) => genericBlockNode(block, "diagram")),
+    ].filter((block) => !!block);
+}
+function referenceTargetsFromDocument(document, rootFile) {
+    const refs = document.getCatalog?.().refs;
+    const map = refs?.$$smap ?? {};
+    return Object.entries(map).map(([id, node]) => {
+        const location = node.getSourceLocation?.() ?? node.source_location;
+        const sourceFile = location?.file ? path.resolve(String(location.file)) : path.resolve(rootFile);
+        const title = node.title ? String(node.title) : undefined;
+        const context = node.context ? String(node.context) : undefined;
+        return {
+            id,
+            file: sourceFile,
+            aliases: title && context === "section" && title !== id ? [title] : [],
+            source: "asciidoctor",
+        };
+    });
+}
+const diagramStyles = new Set([
+    "a2s", "actdiag", "blockdiag", "bytefield", "dbml", "ditaa", "dot", "dpic",
+    "drawio", "erd", "gnuplot", "goat", "graphviz", "lilypond", "matplotlib",
+    "mermaid", "mmpviz", "mscgen", "nomnoml", "nwdiag", "packetdiag", "penrose",
+    "pikchr", "pintora", "plantuml", "rackdiag", "seqdiag", "shaape", "smcat",
+    "state-machine-cat", "structurizr", "svgbob", "symbolator", "syntrax",
+    "umlet", "vega", "vega-lite", "vegalite", "wavedrom",
+]);
+function genericBlockNode(block, type) {
+    const location = block.getSourceLocation?.();
+    const sourceFile = location?.file ? path.resolve(String(location.file)) : undefined;
+    if (!sourceFile) {
+        return undefined;
+    }
+    const startLine = Number(location.getLineNumber?.() ?? location.lineno ?? 1);
+    return {
+        kind: "block",
+        type,
+        style: block.getStyle?.() ? String(block.getStyle()) : undefined,
+        title: block.getTitle?.() ? String(block.getTitle()) : undefined,
+        attributes: primitiveAttributes(block.getAttributes?.() ?? {}),
+        range: {
+            start: { file: sourceFile, line: startLine, column: 1 },
+        },
+    };
+}
+function tableInfo(block) {
+    const rows = block.getRows?.();
+    const cells = [
+        ...(rows?.head ?? []).flat(),
+        ...(rows?.body ?? []).flat(),
+        ...(rows?.foot ?? []).flat(),
+    ];
+    return {
+        columnCount: primitiveNumber(block.getColumnCount?.()),
+        renderedCellCount: cells.length,
+        renderedCellSourceLines: cells
+            .map((cell) => {
+            const location = cell?.getSourceLocation?.();
+            return Number(location?.getLineNumber?.() ?? location?.lineno ?? 0);
+        })
+            .filter((line) => line > 0),
+    };
+}
+function primitiveNumber(value) {
+    return typeof value === "number" ? value : undefined;
+}
+function primitiveAttributes(attributes) {
+    return Object.fromEntries(Object.entries(attributes)
+        .filter(([, value]) => ["string", "number", "boolean"].includes(typeof value))
+        .map(([key, value]) => [key, typeof value === "boolean" ? value : String(value)]));
+}
+function findClosingDelimiter(sourceFile, startLine, delimiter) {
+    try {
+        const lines = fs.readFileSync(sourceFile, "utf8").split(/\r?\n/);
+        for (let index = startLine; index < lines.length; index += 1) {
+            if ((lines[index] ?? "").trim() === delimiter) {
+                return { line: index + 1, column: (lines[index] ?? "").length + 1 };
+            }
+        }
+    }
+    catch {
+        return undefined;
+    }
+    return undefined;
+}
+function parserFailureFinding(file, detail) {
+    return {
+        ruleId: "AD000",
+        alias: "asciidoctor-diagnostic",
+        severity: "warning",
+        message: `Asciidoctor diagnostics failed: ${detail.split("\\n")[0]}`,
+        range: {
+            start: { file: path.resolve(file), line: 1, column: 1 },
+        },
+    };
+}
+function toFinding(message, file) {
+    const location = message.getSourceLocation?.();
+    const sourceFile = location?.file ? path.resolve(String(location.file)) : path.resolve(file);
+    const line = Number(location?.lineno ?? 1);
+    const severity = String(message.getSeverity?.() ?? "WARN").toUpperCase() === "ERROR" ? "error" : "warning";
+    return {
+        ruleId: "AD000",
+        alias: "asciidoctor-diagnostic",
+        severity,
+        message: String(message.getText?.() ?? message),
+        range: {
+            start: { file: sourceFile, line, column: 1 },
+        },
+    };
+}
+function getAsciidoctor() {
+    asciidoctor ??= loadAsciidoctor();
+    return asciidoctor;
+}
+function loadAsciidoctor() {
+    const globalObject = globalThis;
+    const hadOpal = Object.prototype.hasOwnProperty.call(globalObject, "Opal");
+    if (hadOpal) {
+        Reflect.deleteProperty(globalObject, "Opal");
+    }
+    const factory = require("asciidoctor");
+    const processor = factory();
+    // Asciidoctor.js keeps using globalThis.Opal after initialization. If the
+    // editor host already had an Opal object from another extension/runtime,
+    // restoring or reusing it can recurse in Opal constant resolution.
+    return processor;
+}

package/dist/parsers/tolerant.d.ts

@@ -0,0 +1,4 @@
+import type { NormalizedDocument } from "../types.js";
+export declare function parseDocument(file: string): NormalizedDocument;
+export declare function resolveDocumentXrefs(document: NormalizedDocument): void;
+export declare function substituteAttributes(value: string, attributes: Record<string, string>): string;