chaffjs 0.20.0 → 0.22.0

package/dist/detectors/technical-docs.js

@@ -0,0 +1,199 @@
+// Checks a README or a manual needs: code fences tagged with a language or not, shell commands written with and without
+// a prompt, a heading that names a command its section's code never shows, and a step of a numbered procedure written
+// as a statement among instructions. Pure. Shell languages and prompt marks come from the shell-fence-language and
+// shell-prompt lexicons.
+import { codeFences, codeSpans } from "./code-fences.js";
+import { quoteAt } from "./structure-tree.js";
+const patternsOf = (doc, id) => (doc.lexicons[id] ?? []).map((entry) => entry.pattern);
+/** The members of the less used of two kinds: at most limit of them, and fewer than the other kind. */
+export const minorityOf = (first, second, limit) => {
+    const [fewer, more] = first.length <= second.length ? [first, second] : [second, first];
+    return fewer.length > 0 && fewer.length < more.length && fewer.length <= limit ? fewer : [];
+};
+const finding = (doc, rule, offset, values = {}) => ({
+    rule,
+    severity: "info",
+    line: 0,
+    column: 0,
+    quote: quoteAt(doc.source, offset),
+    values: { ...values, offset },
+});
+/** Fences without a language, when they are the fewer kind: a document that mostly leaves the language out is not reported. */
+export const untaggedFewer = (fences, limit) => {
+    const untagged = fences.filter((fence) => fence.language === "");
+    const tagged = fences.filter((fence) => fence.language !== "");
+    return untagged.length > 0 && untagged.length < tagged.length && untagged.length <= limit ? untagged : [];
+};
+export const codeFenceLanguage = (doc, options) => {
+    const fences = codeFences(doc.source);
+    const tagged = fences.filter((fence) => fence.language !== "").length;
+    return untaggedFewer(fences, options.limit).map((fence) => finding(doc, "code-fence-language-mix", fence.start, { tagged, untagged: fences.length - tagged }));
+};
+/**
+ * Whether a shell block writes its commands after a prompt ($ npm install) or bare (npm install). A block that mixes
+ * prompted and unprompted lines shows a command with its output, and is neither. Comment lines (#) are skipped.
+ */
+export const promptStyleOf = (fence, prompts) => {
+    const lines = fence.lines.map((line) => line.trim()).filter((line) => line !== "" && !line.startsWith("#"));
+    if (lines.length === 0)
+        return undefined;
+    const prompted = lines.filter((line) => prompts.some((prompt) => line.startsWith(`${prompt} `))).length;
+    if (prompted === lines.length)
+        return "prompt";
+    return prompted === 0 ? "bare" : undefined;
+};
+export const shellPrompt = (doc, options) => {
+    const languages = new Set(patternsOf(doc, "shell-fence-language").map((language) => language.toLowerCase()));
+    const prompts = patternsOf(doc, "shell-prompt");
+    const shells = codeFences(doc.source).filter((fence) => languages.has(fence.language));
+    const prompted = shells.filter((fence) => promptStyleOf(fence, prompts) === "prompt");
+    const bare = shells.filter((fence) => promptStyleOf(fence, prompts) === "bare");
+    const minority = minorityOf(prompted, bare, options.limit);
+    const style = minority === prompted ? "prompt" : "bare";
+    return minority.map((fence) => finding(doc, "shell-prompt-mix", fence.start, { majority: style === "prompt" ? bare.length : prompted.length }));
+};
+/**
+ * A code span that names a command or an option: a flag (--force, -f) or a command with its arguments (npm install). A
+ * single plain word (net, init) is as often a package, an endpoint or a type as a command, and is left out.
+ */
+const COMMAND_WORD = /^[a-z][a-z0-9_-]*$/u;
+const FLAG = /^--?[A-Za-z][\w-]*$/u;
+export const isCommandName = (text) => {
+    const words = text.trim().split(/\s+/u);
+    const first = words[0] ?? "";
+    return words.length === 1 ? FLAG.test(first) : COMMAND_WORD.test(first);
+};
+/** The heading without its links' text: [`net`](/pkg/net/) names the page it links to, not a command shown below. */
+export const withoutLinks = (heading) => {
+    const pieces = [];
+    const state = { at: 0 };
+    while (state.at < heading.length) {
+        const open = heading.indexOf("[", state.at);
+        const close = open === -1 ? -1 : heading.indexOf("]", open);
+        if (close === -1)
+            break;
+        pieces.push(heading.slice(state.at, open), " ");
+        state.at = close + 1 + targetLength(heading, close + 1);
+    }
+    pieces.push(heading.slice(state.at));
+    return pieces.join("");
+};
+/** The length of a link's target right after its text: (url), [label] or [] (a reference link); 0 when there is none. */
+const targetLength = (heading, at) => {
+    const pair = { "(": ")", "[": "]" };
+    const closer = pair[heading.charAt(at)];
+    const end = closer === undefined ? -1 : heading.indexOf(closer, at);
+    return end === -1 ? 0 : end - at + 1;
+};
+/** The commands and options a heading names: its code spans that read as one, and bare flags (--force). */
+export const commandsIn = (heading) => {
+    const spans = codeSpans(withoutLinks(heading)).map((span) => span.text);
+    const flags = heading
+        .replace(/`[^`]*`/gu, " ")
+        .split(/\s+/u)
+        .filter((word) => FLAG.test(word) && word.startsWith("--"));
+    return [...new Set([...spans.filter(isCommandName), ...flags])];
+};
+const collapse = (text) => text.replace(/\s+/gu, " ");
+const OPTION_CHAR = /[A-Za-z0-9_-]/u;
+/** Whether the code holds the command as a whole word: --force is not --force-with-lease, init is not initial. */
+export const showsCommand = (code, command) => {
+    const text = collapse(code);
+    const wanted = collapse(command.trim());
+    const state = { at: text.indexOf(wanted) };
+    while (state.at !== -1) {
+        const before = text.charAt(state.at - 1);
+        const after = text.charAt(state.at + wanted.length);
+        if (!OPTION_CHAR.test(before) && !OPTION_CHAR.test(after))
+            return true;
+        state.at = text.indexOf(wanted, state.at + 1);
+    }
+    return false;
+};
+const sectionsOf = (doc) => {
+    const headings = doc.markup?.headings ?? [];
+    return headings.map((heading, index) => {
+        const next = headings.slice(index + 1).find((later) => later.depth <= heading.depth);
+        return { heading: doc.source.slice(heading.start, heading.end), start: heading.start, body: { start: heading.end, end: next?.start ?? doc.source.length } };
+    });
+};
+/** The code a section shows: its fenced blocks and its inline code spans. Empty when it shows none. */
+const codeOf = (doc, fences, body) => {
+    const inFences = fences.filter((fence) => fence.start >= body.start && fence.start < body.end);
+    const outside = inFences.reduceRight((text, fence) => `${text.slice(0, fence.start - body.start)}${text.slice(Math.min(fence.end, body.end) - body.start)}`, doc.source.slice(body.start, body.end));
+    return [...inFences.flatMap((fence) => fence.lines), ...codeSpans(outside).map((span) => span.text)].join("\n");
+};
+export const headingCommand = (doc) => {
+    const fences = codeFences(doc.source);
+    return sectionsOf(doc).flatMap((section) => {
+        const commands = commandsIn(section.heading);
+        if (commands.length === 0)
+            return [];
+        const code = codeOf(doc, fences, section.body);
+        if (code.trim() === "")
+            return [];
+        return commands.filter((command) => !showsCommand(code, command)).map((command) => finding(doc, "heading-command-missing", section.start, { command }));
+    });
+};
+const ORDERED_ITEM = /^\s*\d{1,3}[.)]\s/u;
+/** What opens a statement: an article or a pronoun (The installer asks, You click, It opens). */
+const SUBJECT_OPENER = new Set(["DET", "PRON"]);
+/** What a subject opens with when it is a name or a noun phrase (Docker builds, Each user gets). */
+const SUBJECT_HEAD = new Set(["DET", "PRON", "PROPN", "NOUN", "ADJ"]);
+/** What may stand between the opener and the verb: the rest of the subject. */
+const SUBJECT_PART = new Set(["DET", "PRON", "PROPN", "NOUN", "ADJ", "ADP"]);
+/** What opens an instruction. The tagger reads a sentence-initial imperative as a noun, an adjective or a name (Click, Open, Restart). */
+const INSTRUCTION_OPENER = new Set(["VERB", "NOUN", "ADJ", "PROPN"]);
+const PREDICATE = new Set(["VERB", "AUX"]);
+const SKIPPED = new Set(["PUNCT", "NUM", "SYM", "X", "SPACE"]);
+/** Steps shorter than this are labels (1. Setup), not instructions or statements. */
+const MIN_STEP_TOKENS = 3;
+/** A list needs this many steps to have a form to keep. */
+const MIN_STEPS = 3;
+/** A verb in a finite, inflected form (starts, built): it has a subject before it. A base form (Save) may be an imperative's object. */
+const isInflected = (token) => token.lemma !== undefined && token.lemma !== "" && token.surface.toLowerCase() !== token.lemma && token.features?.["VerbForm"] !== "Part";
+/**
+ * A step written as a statement: a subject, then its verb. The subject opens with an article or a pronoun (The installer
+ * asks, You click), or it is a name or a noun whose verb is inflected (Docker builds). A noun before a base-form verb is
+ * not enough: the tagger reads Click and Press there as nouns (Click Save).
+ */
+export const isStatement = (tokens) => {
+    const words = tokens.filter((token) => !SKIPPED.has(token.pos));
+    const [head, ...rest] = words;
+    if (head === undefined || words.length < MIN_STEP_TOKENS || !SUBJECT_HEAD.has(head.pos))
+        return false;
+    const verbAt = rest.findIndex((token) => PREDICATE.has(token.pos));
+    const verb = rest[verbAt];
+    if (verb === undefined || !rest.slice(0, verbAt).every((token) => SUBJECT_PART.has(token.pos)))
+        return false;
+    // Punctuation before the verb is no subject: a label (Guests: the users who …) or an opening phrase (On the left bar, select …).
+    const interrupted = tokens.some((token) => token.pos === "PUNCT" && token.span.start > head.span.start && token.span.start < verb.span.start);
+    return !interrupted && (SUBJECT_OPENER.has(head.pos) || isInflected(verb));
+};
+/** A step that opens with its verb: an instruction (Run the installer). */
+export const isInstruction = (tokens) => INSTRUCTION_OPENER.has(tokens.find((token) => !SKIPPED.has(token.pos))?.pos ?? "");
+const kindOf = (tokens) => {
+    if (isStatement(tokens))
+        return "statement";
+    return isInstruction(tokens) ? "instruction" : "other";
+};
+/** The steps of each numbered list: each item's first sentence, read as a statement or not. */
+const stepLists = (doc) => doc.lists
+    .filter((list) => ORDERED_ITEM.test(doc.source.slice(list.span.start, list.span.end)))
+    .map((list) => list.itemSpans.flatMap((item) => {
+    const sentence = doc.sentences.find((candidate) => candidate.span.start >= item.start && candidate.span.start < item.end);
+    // Only the sentence on the item's own line: a note paragraph under it (**NOTE:** …) is not the step.
+    const onItemLine = sentence !== undefined && !doc.source.slice(item.start, sentence.span.start).includes("\n");
+    return sentence?.tokens === undefined || !onItemLine ? [] : [{ start: sentence.span.start, kind: kindOf(sentence.tokens) }];
+}))
+    .filter((steps) => steps.length >= MIN_STEPS);
+export const stepStatement = (doc, options) => stepLists(doc).flatMap((steps) => {
+    const statements = steps.filter((step) => step.kind === "statement");
+    const instructions = steps.filter((step) => step.kind === "instruction");
+    // A procedure is a list most of whose steps are instructions; a numbered list of terms and definitions is not one.
+    const isProcedure = instructions.length * 2 > steps.length;
+    return isProcedure && statements.length > 0 && statements.length < instructions.length && statements.length <= options.limit
+        ? statements.map((step) => finding(doc, "step-statement-mix", step.start, { count: instructions.length }))
+        : [];
+});
+//# sourceMappingURL=technical-docs.js.map

package/dist/detectors/technical-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"technical-docs.js","sourceRoot":"","sources":["../../src/detectors/technical-docs.ts"],"names":[],"mappings":"AAAA,wHAAwH;AACxH,sHAAsH;AACtH,mHAAmH;AACnH,yBAAyB;AACzB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAkB,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,MAAM,UAAU,GAAG,CAAC,GAAkB,EAAE,EAAU,EAAY,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAExH,uGAAuG;AACvG,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,KAAmB,EAAE,MAAoB,EAAE,KAAa,EAAgB,EAAE;IACtG,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACxF,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC9F,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,GAAkB,EAAE,IAAY,EAAE,MAAc,EAAE,SAAoD,EAAE,EAAW,EAAE,CAAC,CAAC;IACtI,IAAI;IACJ,QAAQ,EAAE,MAAM;IAChB,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAClC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE;CAC9B,CAAC,CAAC;AAEH,+HAA+H;AAC/H,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAA4B,EAAE,KAAa,EAAwB,EAAE;IACjG,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC;IAC/D,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5G,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAa,CAAC,GAAG,EAAE,OAAO,EAAa,EAAE;IACrE,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;IACtE,OAAO,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACxD,OAAO,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CACnG,CAAC;AACJ,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAgB,EAAE,OAA0B,EAAe,EAAE;IACzF,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5G,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACxG,IAAI,QAAQ,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,QAAQ,CAAC;IAC/C,OAAO,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAa,CAAC,GAAG,EAAE,OAAO,EAAa,EAAE;IAC/D,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC7G,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IACtF,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,CAAC;IAChF,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACxD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,kBAAkB,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAClJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,YAAY,GAAG,qBAAqB,CAAC;AAC3C,MAAM,IAAI,GAAG,sBAAsB,CAAC;AAEpC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAW,EAAE;IACrD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7B,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,qHAAqH;AACrH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAe,EAAU,EAAE;IACtD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;IACxB,OAAO,KAAK,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5D,IAAI,KAAK,KAAK,CAAC,CAAC;YAAE,MAAM;QACxB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAChD,KAAK,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,yHAAyH;AACzH,MAAM,YAAY,GAAG,CAAC,OAAe,EAAE,EAAU,EAAU,EAAE;IAC3D,MAAM,IAAI,GAAqC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IACtE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IACxC,MAAM,GAAG,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACpE,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,2GAA2G;AAC3G,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAe,EAAY,EAAE;IACtD,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,OAAO;SAClB,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC;SACzB,KAAK,CAAC,MAAM,CAAC;SACb,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACtE,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAErC,kHAAkH;AAClH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,OAAe,EAAW,EAAE;IACrE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAC3C,OAAO,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACvE,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAIF,MAAM,UAAU,GAAG,CAAC,GAAkB,EAAa,EAAE;IACnD,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC;IAC5C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QACrC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;QACrF,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;IAC9J,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,MAAM,GAAG,CAAC,GAAkB,EAAE,MAA4B,EAAE,IAAU,EAAU,EAAE;IACtF,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/F,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAClC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,EACtH,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CACvC,CAAC;IACF,OAAO,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAa,CAAC,GAAG,EAAa,EAAE;IACzD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACzC,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC;QAClC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,yBAAyB,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,oBAAoB,CAAC;AAC1C,iGAAiG;AACjG,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAChD,oGAAoG;AACpG,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AACtE,+EAA+E;AAC/E,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAC7E,0IAA0I;AAC1I,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AACrE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAC3C,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/D,qFAAqF;AACrF,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,2DAA2D;AAC3D,MAAM,SAAS,GAAG,CAAC,CAAC;AAEpB,wIAAwI;AACxI,MAAM,WAAW,GAAG,CAAC,KAAY,EAAW,EAAE,CAC5C,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,KAAK,MAAM,CAAC;AAE5I;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAwB,EAAW,EAAE;IAC/D,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC;IAC9B,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,eAAe,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACtG,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7G,iIAAiI;IACjI,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9I,OAAO,CAAC,WAAW,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7E,CAAC,CAAC;AAIF,2EAA2E;AAC3E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAwB,EAAW,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAEvJ,MAAM,MAAM,GAAG,CAAC,MAAwB,EAAgB,EAAE;IACxD,IAAI,WAAW,CAAC,MAAM,CAAC;QAAE,OAAO,WAAW,CAAC;IAC5C,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;AACzD,CAAC,CAAC;AAEF,+FAA+F;AAC/F,MAAM,SAAS,GAAG,CAAC,GAAkB,EAAY,EAAE,CACjD,GAAG,CAAC,KAAK;KACN,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KACrF,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAU,EAAE;IACtC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1H,qGAAqG;IACrG,MAAM,UAAU,GAAG,QAAQ,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/G,OAAO,QAAQ,EAAE,MAAM,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAC9H,CAAC,CAAC,CACH;KACA,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;AAElD,MAAM,CAAC,MAAM,aAAa,GAAa,CAAC,GAAG,EAAE,OAAO,EAAa,EAAE,CACjE,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;IAC/B,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;IACrE,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;IACzE,mHAAmH;IACnH,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IAC3D,OAAO,WAAW,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK;QAC1H,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,oBAAoB,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1G,CAAC,CAAC,EAAE,CAAC;AACT,CAAC,CAAC,CAAC"}

package/dist/detectors/toc-heading.d.ts

@@ -0,0 +1,10 @@
+import type { Detector } from "../plugin.ts";
+/** 見出しの無い目次の項目 1 つ。entry は項目の言葉（リンクなら字の部分）。 */
+export type StrayTocEntry = {
+    readonly offset: number;
+    readonly entry: string;
+};
+/** 文書の目次の項目のうち、どの見出しとも合わないもの。 */
+export declare const strayTocEntries: (source: string, tocWords: readonly string[]) => StrayTocEntry[];
+export declare const tocHeading: Detector;
+//# sourceMappingURL=toc-heading.d.ts.map

package/dist/detectors/toc-heading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toc-heading.d.ts","sourceRoot":"","sources":["../../src/detectors/toc-heading.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAW,MAAM,cAAc,CAAC;AAOtD,+CAA+C;AAC/C,MAAM,MAAM,aAAa,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAuFhF,iCAAiC;AACjC,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,UAAU,SAAS,MAAM,EAAE,KAAG,aAAa,EAe1F,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,QAWpB,CAAC"}

package/dist/detectors/toc-heading.js

@@ -0,0 +1,99 @@
+import { headingWords } from "../structure-shape/heading-words.js";
+import { quoteAround } from "./quote-around.js";
+const HEADING = /^[ \t]{0,3}#{1,6}[ \t]/u;
+const FENCE = /^[ \t]*(?:```|~~~)/u;
+const LIST_ITEM = /^[ \t]*(?:[-*+]|\d{1,3}[.)])[ \t]/u;
+const LINK_TEXT = /^\[(?<text>[^\]]*)\]\([^)]*\)/u;
+const ATTRIBUTES = /\{#[^}]*\}/gu;
+const DIGIT = /[\d０-９]/u;
+const LEADER_DOTS = new Set([".", "…", "・"]);
+const MIN_LEADER = 2;
+/** 目次の項目のうち見出しに合わないものがこれより多ければ、目次は別の書き方の見出し（本文に無い章立て）と読んで言わない。 */
+const MAX_STRAY_SHARE = 0.5;
+const linesOf = (source) => [...source.matchAll(/^.*$/gmu)].map((match) => ({ text: match[0], offset: match.index }));
+/** コードの囲みの外の行。 */
+const outsideFences = (lines) => {
+    const fence = { open: false };
+    return lines.filter((line) => {
+        if (FENCE.test(line.text)) {
+            fence.open = !fence.open;
+            return false;
+        }
+        return !fence.open;
+    });
+};
+/** 比べるための形。全角を半角にそろえ（４ と 4）、空白・記号を消し、小文字にする。 */
+const comparable = (text) => text
+    .replace(ATTRIBUTES, "")
+    .normalize("NFKC")
+    .toLowerCase()
+    .replace(/[\s\p{P}\p{S}]/gu, "");
+/** 頭の番号（1.2、2-1、第3章）と飾りを外した、比べるための形。 */
+const withoutNumber = (text) => comparable(headingWords(text));
+/** text の終わりから、isTail に当たる字を外したもの。 */
+const trimTail = (text, isTail) => {
+    const chars = [...text];
+    return chars.slice(0, chars.findLastIndex((char) => !isTail(char)) + 1).join("");
+};
+/** 見出しの行の題（頭と終わりの # を外す）。見出しでなければ undefined。 */
+const headingTitle = (line) => {
+    if (!HEADING.test(line))
+        return undefined;
+    const withoutMarks = line.trim().replace(/^#+/u, "").trim();
+    return trimTail(withoutMarks, (char) => char === "#").trim();
+};
+/** 終わりのページ番号（「背景 ........ 3」の 3 と点線）。点線の無い数（Step 3）は題のうち。 */
+const withoutPageNumber = (text) => {
+    const before = trimTail(text, (char) => DIGIT.test(char)).trimEnd();
+    if (before === text.trimEnd())
+        return text;
+    const title = trimTail(before, (char) => LEADER_DOTS.has(char));
+    return before.length - title.length >= MIN_LEADER ? title.trim() : text;
+};
+/** 項目の言葉と、項目の行の中でそれが始まる所。リンクなら字の部分（番号の後ろのリンク「1. [概要](#…)」も）。 */
+const entryOf = (item) => {
+    const bracket = item.indexOf("[");
+    const link = bracket === -1 ? undefined : LINK_TEXT.exec(item.slice(bracket))?.groups?.["text"];
+    if (link !== undefined)
+        return { text: withoutPageNumber(link), start: bracket + 1 };
+    return { text: withoutPageNumber(item.trim()), start: item.length - item.trimStart().length };
+};
+const matchesHeading = (entry, headings) => headings.some((heading) => comparable(heading.title) === comparable(entry) || (withoutNumber(entry) !== "" && withoutNumber(heading.title) === withoutNumber(entry)));
+/** 目次の見出しの下（次の見出しまで）の箇条書きの項目。 */
+const entriesUnder = (lines, tocAt) => {
+    const after = lines.filter((line) => line.offset > tocAt);
+    const end = after.findIndex((line) => HEADING.test(line.text));
+    return (end === -1 ? after : after.slice(0, end)).flatMap((line) => {
+        const marker = LIST_ITEM.exec(line.text)?.[0];
+        if (marker === undefined)
+            return [];
+        const entry = entryOf(line.text.slice(marker.length));
+        return [{ text: entry.text, offset: line.offset + marker.length + entry.start }];
+    });
+};
+/** 文書の目次の項目のうち、どの見出しとも合わないもの。 */
+export const strayTocEntries = (source, tocWords) => {
+    const lines = outsideFences(linesOf(source));
+    const headings = lines.flatMap((line) => {
+        const title = headingTitle(line.text);
+        return title === undefined ? [] : [{ title, offset: line.offset }];
+    });
+    const tocNames = new Set(tocWords.map(comparable));
+    return headings
+        .filter((heading) => tocNames.has(comparable(heading.title)))
+        .flatMap((toc) => {
+        const entries = entriesUnder(lines, toc.offset).filter((entry) => entry.text !== "");
+        const others = headings.filter((heading) => heading !== toc);
+        const stray = entries.filter((entry) => !matchesHeading(entry.text, others));
+        return stray.length > entries.length * MAX_STRAY_SHARE ? [] : stray.map((entry) => ({ offset: entry.offset, entry: entry.text }));
+    });
+};
+export const tocHeading = (doc) => strayTocEntries(doc.source, (doc.lexicons["toc-heading"] ?? []).map((entry) => entry.pattern)).map((stray) => ({
+    rule: "",
+    severity: "warning",
+    line: 0,
+    column: 0,
+    quote: quoteAround(doc.source, stray.offset, stray.offset + stray.entry.length),
+    values: { entry: stray.entry, offset: stray.offset },
+}));
+//# sourceMappingURL=toc-heading.js.map

package/dist/detectors/toc-heading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toc-heading.js","sourceRoot":"","sources":["../../src/detectors/toc-heading.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAWhD,MAAM,OAAO,GAAG,yBAAyB,CAAC;AAC1C,MAAM,KAAK,GAAG,qBAAqB,CAAC;AACpC,MAAM,SAAS,GAAG,oCAAoC,CAAC;AACvD,MAAM,SAAS,GAAG,gCAAgC,CAAC;AACnD,MAAM,UAAU,GAAG,cAAc,CAAC;AAClC,MAAM,KAAK,GAAG,UAAU,CAAC;AACzB,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAC7C,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,kEAAkE;AAClE,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,MAAM,OAAO,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAEtI,kBAAkB;AAClB,MAAM,aAAa,GAAG,CAAC,KAAsB,EAAU,EAAE;IACvD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC9B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,KAAK,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,gDAAgD;AAChD,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CAC1C,IAAI;KACD,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;KACvB,SAAS,CAAC,MAAM,CAAC;KACjB,WAAW,EAAE;KACb,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;AAErC,wCAAwC;AACxC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/E,sCAAsC;AACtC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,MAAiC,EAAU,EAAE;IAC3E,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACxB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnF,CAAC,CAAC;AAEF,gDAAgD;AAChD,MAAM,YAAY,GAAG,CAAC,IAAY,EAAsB,EAAE;IACxD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5D,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAC/D,CAAC,CAAC;AAEF,6DAA6D;AAC7D,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAU,EAAE;IACjD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACpE,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE;QAAE,OAAO,IAAI,CAAC;IAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC,CAAC;AAEF,gEAAgE;AAChE,MAAM,OAAO,GAAG,CAAC,IAAY,EAAqD,EAAE;IAClF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IAChG,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,CAAC,EAAE,CAAC;IACrF,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC;AAChG,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,QAA4B,EAAW,EAAE,CAC9E,QAAQ,CAAC,IAAI,CACX,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,CACvJ,CAAC;AAEJ,iCAAiC;AACjC,MAAM,YAAY,GAAG,CAAC,KAAsB,EAAE,KAAa,EAAU,EAAE;IACrE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjE,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,iCAAiC;AACjC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,QAA2B,EAAmB,EAAE;IAC9F,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IACnD,OAAO,QAAQ;SACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;SAC5D,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;QACrF,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAC7E,OAAO,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACpI,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAa,CAAC,GAAG,EAAa,EAAE,CACrD,eAAe,CACb,GAAG,CAAC,MAAM,EACV,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAClE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChB,IAAI,EAAE,EAAE;IACR,QAAQ,EAAE,SAAS;IACnB,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IAC/E,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;CACrD,CAAC,CAAC,CAAC"}

package/dist/extension/pack-read.d.ts

@@ -0,0 +1,21 @@
+export declare const PACK_MANIFEST = "chaff-plugin.yaml";
+/** The name in the folder's package.json, if it has one. */
+export declare const packageNameOf: (dir: string) => string | undefined;
+/**
+ * The manifest of a pack folder: chaff-plugin.yaml, else package.json's chaff field. undefined when the folder is not
+ * a pack (a code plugin, loaded by importing it). A manifest that cannot be read is reported, not taken for "not a pack".
+ */
+export declare const packManifestOf: (dir: string) => {
+    readonly manifest: Record<string, unknown>;
+} | {
+    readonly message: string;
+} | undefined;
+type Read<T> = {
+    readonly value: T;
+} | {
+    readonly message: string;
+};
+/** The pack as a plugin's default export: its name and API version from the manifest, its rules, lexicons and styles from its folders. */
+export declare const readPack: (dir: string, manifest: Readonly<Record<string, unknown>>, expectedName: string | undefined) => Read<Record<string, unknown>>;
+export {};
+//# sourceMappingURL=pack-read.d.ts.map

package/dist/extension/pack-read.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack-read.d.ts","sourceRoot":"","sources":["../../src/extension/pack-read.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,aAAa,sBAAsB,CAAC;AAyCjD,4DAA4D;AAC5D,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,KAAG,MAAM,GAAG,SAGpD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,SAW5H,CAAC;AAEF,KAAK,IAAI,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAoCpE,0IAA0I;AAC1I,eAAO,MAAM,QAAQ,GAAI,KAAK,MAAM,EAAE,UAAU,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,cAAc,MAAM,GAAG,SAAS,KAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAgBjJ,CAAC"}

package/dist/extension/pack-read.js

@@ -0,0 +1,117 @@
+import { existsSync, readFileSync, readdirSync, realpathSync, statSync } from "node:fs";
+import { basename, join } from "node:path";
+import { parse } from "yaml";
+import { API_VERSION } from "../api.js";
+import { isInside } from "../custom/module-path.js";
+// A rule pack: a plugin written in YAML alone. Its folder holds a manifest (chaff-plugin.yaml, or a chaff field in
+// package.json), rules/*.yaml, lexicons/<language>/<list>.yaml and styles/*.yaml. Read here into the shape a code
+// plugin's default export has, so plugin-parse.ts checks a pack exactly as it checks a code plugin. Nothing is run.
+export const PACK_MANIFEST = "chaff-plugin.yaml";
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const printed = (value) => JSON.stringify(value) ?? typeof value;
+const firstLine = (error) => (error instanceof Error ? error.message : String(error)).split("\n")[0] ?? "";
+/** A YAML file, or why it cannot be read, naming it as the pack's own path (rules/no-tbd.yaml). */
+const readYaml = (dir, path) => {
+    try {
+        // A link inside the pack that points out of it would read a file the pack does not hold.
+        if (!isInside(realpathSync(dir), realpathSync(join(dir, path))))
+            return { message: `${path}: it links to a file outside the pack` };
+        return { value: parse(readFileSync(join(dir, path), "utf8")) };
+    }
+    catch (error) {
+        return { message: `${path}: ${firstLine(error)}` };
+    }
+};
+const yamlFilesIn = (dir, folder) => {
+    const full = join(dir, folder);
+    if (!existsSync(full) || !statSync(full).isDirectory())
+        return [];
+    return readdirSync(full)
+        .filter((file) => file.endsWith(".yaml") || file.endsWith(".yml"))
+        .toSorted((left, right) => left.localeCompare(right, "en"))
+        .map((file) => `${folder}/${file}`);
+};
+const foldersIn = (dir, folder) => {
+    const full = join(dir, folder);
+    if (!existsSync(full) || !statSync(full).isDirectory())
+        return [];
+    return readdirSync(full)
+        .filter((name) => statSync(join(full, name)).isDirectory())
+        .toSorted((left, right) => left.localeCompare(right, "en"));
+};
+const packageJsonOf = (dir) => {
+    const read = existsSync(join(dir, "package.json")) ? readYaml(dir, "package.json") : undefined;
+    return read !== undefined && "value" in read && isRecord(read.value) ? read.value : undefined;
+};
+/** The name in the folder's package.json, if it has one. */
+export const packageNameOf = (dir) => {
+    const name = packageJsonOf(dir)?.["name"];
+    return typeof name === "string" ? name : undefined;
+};
+/**
+ * The manifest of a pack folder: chaff-plugin.yaml, else package.json's chaff field. undefined when the folder is not
+ * a pack (a code plugin, loaded by importing it). A manifest that cannot be read is reported, not taken for "not a pack".
+ */
+export const packManifestOf = (dir) => {
+    if (existsSync(join(dir, PACK_MANIFEST))) {
+        const read = readYaml(dir, PACK_MANIFEST);
+        if ("message" in read)
+            return read;
+        // An empty manifest only marks the folder; anything else must be a map.
+        if (read.value === null || read.value === undefined)
+            return { manifest: {} };
+        return isRecord(read.value) ? { manifest: read.value } : { message: `${PACK_MANIFEST}: write a map (apiVersion: 1), not ${printed(read.value)}` };
+    }
+    const chaff = packageJsonOf(dir)?.["chaff"];
+    if (chaff === undefined)
+        return undefined;
+    return isRecord(chaff) ? { manifest: chaff } : { message: `package.json: chaff must be a map ({ "apiVersion": 1 }), not ${printed(chaff)}` };
+};
+/** Every file's value in the order of the files, or the first that cannot be read. */
+const readAll = (dir, paths) => paths.reduce((done, path) => {
+    if ("message" in done)
+        return done;
+    const read = readYaml(dir, path);
+    return "message" in read ? read : { value: [...done.value, read.value] };
+}, { value: [] });
+/** rules/*.yaml: each file holds one rule, or a list of them. */
+const rulesOf = (dir) => {
+    const read = readAll(dir, yamlFilesIn(dir, "rules"));
+    return "message" in read ? read : { value: read.value.flatMap((value) => (Array.isArray(value) ? value.map((rule) => rule) : [value])) };
+};
+/** lexicons/<language>/<list>.yaml, as a code plugin writes its lexicons: { list: { language: entries } }. */
+const lexiconsOf = (dir) => foldersIn(dir, "lexicons").reduce((done, language) => {
+    if ("message" in done)
+        return done;
+    const paths = yamlFilesIn(dir, `lexicons/${language}`);
+    const read = readAll(dir, paths);
+    if ("message" in read)
+        return read;
+    const merged = paths.reduce((acc, path, index) => {
+        const list = basename(path).replace(/\.ya?ml$/u, "");
+        return { ...acc, [list]: { ...acc[list], [language]: read.value[index] } };
+    }, done.value);
+    return { value: merged };
+}, { value: {} });
+/** The pack as a plugin's default export: its name and API version from the manifest, its rules, lexicons and styles from its folders. */
+export const readPack = (dir, manifest, expectedName) => {
+    const rules = rulesOf(dir);
+    if ("message" in rules)
+        return rules;
+    const lexicons = lexiconsOf(dir);
+    if ("message" in lexicons)
+        return lexicons;
+    const styles = readAll(dir, yamlFilesIn(dir, "styles"));
+    if ("message" in styles)
+        return styles;
+    return {
+        value: {
+            apiVersion: manifest["apiVersion"] ?? API_VERSION,
+            name: manifest["name"] ?? expectedName,
+            rules: rules.value,
+            lexicons: lexicons.value,
+            styles: styles.value,
+        },
+    };
+};
+//# sourceMappingURL=pack-read.js.map

package/dist/extension/pack-read.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack-read.js","sourceRoot":"","sources":["../../src/extension/pack-read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACxF,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,mHAAmH;AACnH,kHAAkH;AAClH,oHAAoH;AAEpH,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAEjD,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE5I,MAAM,OAAO,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC;AAElF,MAAM,SAAS,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE5H,mGAAmG;AACnG,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,IAAY,EAA8D,EAAE;IACzG,IAAI,CAAC;QACH,yFAAyF;QACzF,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,uCAAuC,EAAE,CAAC;QACpI,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;IACrD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,MAAc,EAAY,EAAE;IAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,CAAC;IAClE,OAAO,WAAW,CAAC,IAAI,CAAC;SACrB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACjE,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;SAC1D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,MAAc,EAAY,EAAE;IAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,CAAC;IAClE,OAAO,WAAW,CAAC,IAAI,CAAC;SACrB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;SAC1D,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,GAAW,EAAuC,EAAE;IACzE,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/F,OAAO,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAChG,CAAC,CAAC;AAEF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAsB,EAAE;IAC/D,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC1C,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAA6F,EAAE;IACvI,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC1C,IAAI,SAAS,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QACnC,wEAAwE;QACxE,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;YAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAC7E,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,aAAa,sCAAsC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;IACpJ,CAAC;IACD,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,gEAAgE,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;AAC/I,CAAC,CAAC;AAIF,sFAAsF;AACtF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,KAAwB,EAAmB,EAAE,CACzE,KAAK,CAAC,MAAM,CACV,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;IACb,IAAI,SAAS,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjC,OAAO,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3E,CAAC,EACD,EAAE,KAAK,EAAE,EAAE,EAAE,CACd,CAAC;AAEJ,iEAAiE;AACjE,MAAM,OAAO,GAAG,CAAC,GAAW,EAAmB,EAAE;IAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,OAAO,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AACpJ,CAAC,CAAC;AAEF,8GAA8G;AAC9G,MAAM,UAAU,GAAG,CAAC,GAAW,EAAiD,EAAE,CAChF,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,MAAM,CAC/B,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;IACjB,IAAI,SAAS,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,YAAY,QAAQ,EAAE,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,IAAI,SAAS,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAA0C,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QACxF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACrD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;IAC7E,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACf,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC,EACD,EAAE,KAAK,EAAE,EAAE,EAAE,CACd,CAAC;AAEJ,0IAA0I;AAC1I,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,QAA2C,EAAE,YAAgC,EAAiC,EAAE;IACpJ,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,IAAI,SAAS,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACrC,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,SAAS,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxD,IAAI,SAAS,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IACvC,OAAO;QACL,KAAK,EAAE;YACL,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,IAAI,WAAW;YACjD,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,YAAY;YACtC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ,EAAE,QAAQ,CAAC,KAAK;YACxB,MAAM,EAAE,MAAM,CAAC,KAAK;SACrB;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/extension/plugin-load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-load.d.ts","sourceRoot":"","sources":["../../src/extension/plugin-load.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAM7D,OAAO,EAAe,KAAK,YAAY,EAAqB,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAM1G,MAAM,MAAM,aAAa,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAA;CAAE,CAAC;AAwDvH,6EAA6E;AAC7E,eAAO,MAAM,WAAW,GAAU,QAAQ,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,KAAG,OAAO,CAAC,aAAa,CAUpG,CAAC"}
+{"version":3,"file":"plugin-load.d.ts","sourceRoot":"","sources":["../../src/extension/plugin-load.ts"],"names":[],"mappings":"AAGA,OAAO,EAAe,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAM7D,OAAO,EAAe,KAAK,YAAY,EAAqB,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAO1G,MAAM,MAAM,aAAa,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAA;CAAE,CAAC;AA8FvH,6EAA6E;AAC7E,eAAO,MAAM,WAAW,GAAU,QAAQ,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,KAAG,OAAO,CAAC,aAAa,CAUpG,CAAC"}

package/dist/extension/plugin-load.js

@@ -1,3 +1,4 @@
+import { existsSync, statSync } from "node:fs";
 import { createRequire } from "node:module";
 import { join } from "node:path";
 import { CONFIG_FILE } from "../config/load.js";
@@ -7,6 +8,7 @@ import { importDefault } from "./import-default.js";
 import { staysInside } from "./real-path.js";
 import { isPluginPath, pluginNameOfPackage } from "./plugin-name.js";
 import { parsePlugin } from "./plugin-parse.js";
+import { PACK_MANIFEST, packManifestOf, packageNameOf, readPack } from "./pack-read.js";
 const problemOf = (kind, plugin, detail = "") => ({
     problem: { kind, plugin, detail },
 });
@@ -19,27 +21,59 @@ const resolveFrom = (baseDir, specifier) => {
         return undefined;
     }
 };
+const isFolder = (path) => existsSync(path) && statSync(path).isDirectory();
+/** A folder that is a rule pack: it has a manifest. A folder that is a code plugin is imported as Node imports it. */
+const isPack = (dir) => packManifestOf(dir) !== undefined;
+/** The folder Node would find package name in from the folder chaff.yaml is in, whatever the package exports. */
+const packageFolder = (baseDir, name) => (createRequire(join(baseDir, CONFIG_FILE)).resolve.paths(name) ?? [])
+    .map((nodeModules) => join(nodeModules, name))
+    .find((dir) => existsSync(join(dir, "package.json")));
+const packAt = (written, dir, expectedName) => ({
+    origin: { written, file: join(dir, PACK_MANIFEST), expectedName },
+    pack: dir,
+});
+/** A pack of the project's own takes its name from its package.json (chaff-plugin-foo is foo) when its manifest does not give one. */
+const localPackName = (dir) => {
+    const name = packageNameOf(dir);
+    return name === undefined ? undefined : pluginNameOfPackage(name);
+};
+/** A plugin of the project's own, by its path: a pack folder, or a file (or folder) Node imports. Neither may leave the project. */
+const locatePath = (written, baseDir) => {
+    const path = modulePathOf(written, baseDir);
+    if ("refusal" in path)
+        return problemOf("outside", written);
+    if (isFolder(path.file) && isPack(path.file))
+        return staysInside(written, path.file, baseDir) ? packAt(written, path.file, localPackName(path.file)) : problemOf("outside", written);
+    const file = resolveFrom(baseDir, path.file);
+    if (file === undefined)
+        return problemOf("not-found", written);
+    return staysInside(written, file, baseDir) ? { origin: { written, file, expectedName: undefined } } : problemOf("outside", written);
+};
 const locate = (written, baseDir) => {
-    if (isPluginPath(written)) {
-        const path = modulePathOf(written, baseDir);
-        if ("refusal" in path)
-            return problemOf("outside", written);
-        const file = resolveFrom(baseDir, path.file);
-        if (file === undefined)
-            return problemOf("not-found", written);
-        return staysInside(written, file, baseDir) ? { origin: { written, file, expectedName: undefined } } : problemOf("outside", written);
-    }
+    if (isPluginPath(written))
+        return locatePath(written, baseDir);
     const expectedName = pluginNameOfPackage(written);
     if (expectedName === undefined)
         return problemOf("bad-specifier", written);
+    const folder = packageFolder(baseDir, written);
+    if (folder !== undefined && isPack(folder))
+        return packAt(written, folder, expectedName);
     const file = resolveFrom(baseDir, written);
     return file === undefined ? problemOf("not-found", written) : { origin: { written, file, expectedName } };
 };
+/** A rule pack read into what a code plugin's default export would be. Nothing in it runs. */
+const readPackAt = (dir, expectedName) => {
+    const manifest = packManifestOf(dir);
+    if (manifest !== undefined && "message" in manifest)
+        return manifest;
+    const read = readPack(dir, manifest?.manifest ?? {}, expectedName);
+    return "message" in read ? read : { exported: read.value };
+};
 const loadPlugin = async (written, baseDir, useFor) => {
     const located = locate(written, baseDir);
     if ("problem" in located)
         return { plugins: [], problems: [located.problem] };
-    const imported = await importDefault(located.origin.file);
+    const imported = located.pack === undefined ? await importDefault(located.origin.file) : readPackAt(located.pack, located.origin.expectedName);
     if ("message" in imported)
         return { plugins: [], problems: [problemOf("import-failed", written, imported.message).problem] };
     const read = parsePlugin(imported.exported, located.origin, useFor);