pasika 0.3.2 → 0.3.4

package/dist/eslint/pasika/rules/md/guide-step-single-link.js

@@ -1,48 +0,0 @@
-import { getFilename } from "./helpers.js";
-/** Count document links in a subtree. */
-function countDocLinks(node) {
-    if (node.type === "link" && node.url.endsWith(".md"))
-        return 1;
-    if ("children" in node) {
-        return node.children.reduce((sum, child) => sum + countDocLinks(child), 0);
-    }
-    return 0;
-}
-/** Visit every ordered-list item and run a check. */
-function visitSteps(node, check) {
-    if (node.type === "list" && node.ordered) {
-        for (const child of node.children)
-            check(child);
-    }
-    if ("children" in node) {
-        for (const child of node.children)
-            visitSteps(child, check);
-    }
-}
-export const guideStepSingleLinkRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Each guide step must link at most one document total.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            root(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith("-guide.md"))
-                    return;
-                visitSteps(node, (item) => {
-                    const links = countDocLinks(item);
-                    if (links > 1) {
-                        context.report({
-                            node: item,
-                            message: `step links ${String(links)} documents`,
-                        });
-                    }
-                });
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/guide-step-single-sentence.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview Each guide step must be concise and use one sentence.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const guideStepSingleSentenceRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/guide-step-single-sentence.js

@@ -1,42 +0,0 @@
-import { getFilename, getTextContent } from "./helpers.js";
-function countSentences(text) {
-    return text.split(/[.!?](?:\s+|$)/).filter((part) => part.trim() !== "").length;
-}
-export const guideStepSingleSentenceRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Each guide step must be concise and use one sentence.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        // Walked list context, tracked via enter/exit so listItem can see its
-        // enclosing list without relying on a second visitor argument.
-        const listsOnPath = [];
-        return {
-            list(node) {
-                listsOnPath.push(node);
-            },
-            "list:exit"() {
-                listsOnPath.pop();
-            },
-            listItem(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith("-guide.md"))
-                    return;
-                // Steps are ordered list items.
-                if (!listsOnPath.at(-1)?.ordered)
-                    return;
-                const text = getTextContent(node).trim();
-                const sentenceCount = countSentences(text);
-                if (sentenceCount > 1) {
-                    context.report({
-                        node,
-                        message: `step uses ${String(sentenceCount)} sentences`,
-                    });
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/helpers.d.ts

@@ -1,25 +0,0 @@
-/**
- * Helpers for markdown ESLint rules operating on @eslint/markdown's AST.
- */
-import type { Nodes } from "mdast";
-/**
- * Check if text contains RFC 2119 vocabulary.
- * Returns the first keyword found, or null.
- */
-export declare function containsRfcKeyword(text: string): string | null;
-/**
- * Get the file path being linted.
- *
- * Accepts the rule context structurally so any language plugin can pass it.
- */
-export declare function getFilename(context: {
-    filename: string;
-}): string;
-/**
- * Get the text content of an mdast node.
- */
-export declare function getTextContent(node: Nodes): string;
-/**
- * Get the line number from a node's position.
- */
-export declare function getLine(node: Nodes): number;

package/dist/eslint/pasika/rules/md/helpers.js

@@ -1,37 +0,0 @@
-/**
- * RFC 2119 keywords matched by word-boundary regex, longest first.
- */
-const RFC_PATTERN = /\b(?<keyword>MUST NOT|MUST|SHALL NOT|SHALL|SHOULD NOT|SHOULD|MAY|RECOMMENDED|NOT RECOMMENDED|OPTIONAL|REQUIRED)\b/;
-/**
- * Check if text contains RFC 2119 vocabulary.
- * Returns the first keyword found, or null.
- */
-export function containsRfcKeyword(text) {
-    const match = RFC_PATTERN.exec(text);
-    return match?.groups?.keyword ?? null;
-}
-/**
- * Get the file path being linted.
- *
- * Accepts the rule context structurally so any language plugin can pass it.
- */
-export function getFilename(context) {
-    return context.filename;
-}
-/**
- * Get the text content of an mdast node.
- */
-export function getTextContent(node) {
-    if ("value" in node && typeof node.value === "string")
-        return node.value;
-    if ("children" in node) {
-        return node.children.map(getTextContent).join("");
-    }
-    return "";
-}
-/**
- * Get the line number from a node's position.
- */
-export function getLine(node) {
-    return node.position?.start.line ?? 0;
-}

package/dist/eslint/pasika/rules/md/index.d.ts

@@ -1,27 +0,0 @@
-export declare const mdRules: {
-    "doc-kind-suffix": import("@eslint/markdown").MarkdownRuleDefinition;
-    "title-matches-file-name": import("@eslint/markdown").MarkdownRuleDefinition;
-    "overview-present": import("@eslint/markdown").MarkdownRuleDefinition;
-    "overview-length": import("@eslint/markdown").MarkdownRuleDefinition;
-    "guide-overview-no-links": import("@eslint/markdown").MarkdownRuleDefinition;
-    "guide-step-single-sentence": import("@eslint/markdown").MarkdownRuleDefinition;
-    "guide-step-single-link": import("@eslint/markdown").MarkdownRuleDefinition;
-    "guide-states-no-requirement": import("@eslint/markdown").MarkdownRuleDefinition;
-    "requirement-present": import("@eslint/markdown").MarkdownRuleDefinition;
-    "rule-paired-examples": import("@eslint/markdown").MarkdownRuleDefinition;
-    "example-heading-description": import("@eslint/markdown").MarkdownRuleDefinition;
-    "policy-no-examples": import("@eslint/markdown").MarkdownRuleDefinition;
-    "policy-single-document": import("@eslint/markdown").MarkdownRuleDefinition;
-    "no-cross-document-link": import("@eslint/markdown").MarkdownRuleDefinition;
-    "reference-no-rfc-vocabulary": import("@eslint/markdown").MarkdownRuleDefinition;
-    "reference-block-headings": import("@eslint/markdown").MarkdownRuleDefinition;
-    "support-document-placement": import("@eslint/markdown").MarkdownRuleDefinition;
-    "no-template-prompt": import("@eslint/markdown").MarkdownRuleDefinition;
-    "guide-folder-entry-point": import("@eslint/markdown").MarkdownRuleDefinition;
-    "rfc-only-in-bullets": import("@eslint/markdown").MarkdownRuleDefinition;
-    "policy-subject-headings": import("@eslint/markdown").MarkdownRuleDefinition;
-    "guide-link-anchors": import("@eslint/markdown").MarkdownRuleDefinition;
-    "no-nested-how-to": import("@eslint/markdown").MarkdownRuleDefinition;
-    "glossary-term-linking": import("@eslint/markdown").MarkdownRuleDefinition;
-};
-export type MdRuleName = keyof typeof mdRules;

package/dist/eslint/pasika/rules/md/index.js

@@ -1,53 +0,0 @@
-/**
- * @fileoverview All markdown ESLint rules for documentation checks.
- */
-import { docKindSuffixRule } from "./doc-kind-suffix.js";
-import { titleMatchesFileNameRule } from "./title-matches-file-name.js";
-import { overviewPresentRule } from "./overview-present.js";
-import { overviewLengthRule } from "./overview-length.js";
-import { guideOverviewNoLinksRule } from "./guide-overview-no-links.js";
-import { guideStepSingleSentenceRule } from "./guide-step-single-sentence.js";
-import { guideStepSingleLinkRule } from "./guide-step-single-link.js";
-import { guideStatesNoRequirementRule } from "./guide-states-no-requirement.js";
-import { requirementPresentRule } from "./requirement-present.js";
-import { rulePairedExamplesRule } from "./rule-paired-examples.js";
-import { exampleHeadingDescriptionRule } from "./example-heading-description.js";
-import { policyNoExamplesRule } from "./policy-no-examples.js";
-import { policySingleDocumentRule } from "./policy-single-document.js";
-import { noCrossDocumentLinkRule } from "./no-cross-document-link.js";
-import { referenceNoRfcVocabularyRule } from "./reference-no-rfc-vocabulary.js";
-import { referenceBlockHeadingsRule } from "./reference-block-headings.js";
-import { supportDocumentPlacementRule } from "./support-document-placement.js";
-import { noTemplatePromptRule } from "./no-template-prompt.js";
-import { guideFolderEntryPointRule } from "./guide-folder-entry-point.js";
-import { rfcOnlyInBulletsRule } from "./rfc-only-in-bullets.js";
-import { policySubjectHeadingsRule } from "./policy-subject-headings.js";
-import { guideLinkAnchorsRule } from "./guide-link-anchors.js";
-import { noNestedHowToRule } from "./no-nested-how-to.js";
-import { glossaryTermLinkingRule } from "./glossary-term-linking.js";
-export const mdRules = {
-    "doc-kind-suffix": docKindSuffixRule,
-    "title-matches-file-name": titleMatchesFileNameRule,
-    "overview-present": overviewPresentRule,
-    "overview-length": overviewLengthRule,
-    "guide-overview-no-links": guideOverviewNoLinksRule,
-    "guide-step-single-sentence": guideStepSingleSentenceRule,
-    "guide-step-single-link": guideStepSingleLinkRule,
-    "guide-states-no-requirement": guideStatesNoRequirementRule,
-    "requirement-present": requirementPresentRule,
-    "rule-paired-examples": rulePairedExamplesRule,
-    "example-heading-description": exampleHeadingDescriptionRule,
-    "policy-no-examples": policyNoExamplesRule,
-    "policy-single-document": policySingleDocumentRule,
-    "no-cross-document-link": noCrossDocumentLinkRule,
-    "reference-no-rfc-vocabulary": referenceNoRfcVocabularyRule,
-    "reference-block-headings": referenceBlockHeadingsRule,
-    "support-document-placement": supportDocumentPlacementRule,
-    "no-template-prompt": noTemplatePromptRule,
-    "guide-folder-entry-point": guideFolderEntryPointRule,
-    "rfc-only-in-bullets": rfcOnlyInBulletsRule,
-    "policy-subject-headings": policySubjectHeadingsRule,
-    "guide-link-anchors": guideLinkAnchorsRule,
-    "no-nested-how-to": noNestedHowToRule,
-    "glossary-term-linking": glossaryTermLinkingRule,
-};

package/dist/eslint/pasika/rules/md/no-cross-document-link.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview Rules, references, and policy must not link to other documents.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const noCrossDocumentLinkRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/no-cross-document-link.js

@@ -1,36 +0,0 @@
-import { getFilename } from "./helpers.js";
-/** The document kind for a filename, when the no-link rule applies to it. */
-function linkedKind(filename) {
-    if (filename.endsWith("-rule.md"))
-        return "rule";
-    if (filename.endsWith("-reference.md"))
-        return "reference";
-    if (filename.endsWith("-policy.md"))
-        return "policy";
-    return undefined;
-}
-export const noCrossDocumentLinkRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Rules, references, and policy must not link to other documents.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            link(node) {
-                const filename = getFilename(context);
-                const kind = linkedKind(filename);
-                if (!kind)
-                    return;
-                if (node.url.endsWith(".md")) {
-                    context.report({
-                        node,
-                        message: `${kind} links another document: ${node.url}`,
-                    });
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/no-nested-how-to.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview How To sections must not nest inside other How To sections.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const noNestedHowToRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/no-nested-how-to.js

@@ -1,39 +0,0 @@
-import { getFilename, getLine, getTextContent } from "./helpers.js";
-export const noNestedHowToRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "How To sections must not nest inside other How To sections.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            root(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith("-guide.md"))
-                    return;
-                const howToHeadings = [];
-                for (const child of node.children) {
-                    if (child.type !== "heading")
-                        continue;
-                    const text = getTextContent(child).trim();
-                    if (!/^How To\b/.test(text))
-                        continue;
-                    howToHeadings.push({ line: getLine(child), depth: child.depth, text });
-                }
-                // A How To heading at greater depth than the previous How To heading nests inside it.
-                for (let i = 1; i < howToHeadings.length; i++) {
-                    const prev = howToHeadings[i - 1];
-                    const current = howToHeadings[i];
-                    if (prev && current && current.depth > prev.depth) {
-                        context.report({
-                            node,
-                            message: `How To section "${current.text}" nests inside another How To section`,
-                        });
-                    }
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/no-template-prompt.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview No leftover bracketed template prompts.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const noTemplatePromptRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/no-template-prompt.js

@@ -1,22 +0,0 @@
-const TEMPLATE_PROMPT = /^\s*\[[A-Z0-9].*\]\s*$/;
-export const noTemplatePromptRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "No leftover bracketed template prompts.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            text(node) {
-                if (TEMPLATE_PROMPT.test(node.value)) {
-                    context.report({
-                        node,
-                        message: "leftover bracketed template prompt",
-                    });
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/overview-length.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview Overview must contain at most two sentences.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const overviewLengthRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/overview-length.js

@@ -1,47 +0,0 @@
-import { getFilename, getLine, getTextContent } from "./helpers.js";
-function countSentences(text) {
-    return text.split(/[.!?](?:\s+|$)/).filter((part) => part.trim() !== "").length;
-}
-export const overviewLengthRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Overview must contain at most two sentences.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            root(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith(".md"))
-                    return;
-                let titleLine = 0;
-                for (const child of node.children) {
-                    if (child.type === "heading" && child.depth === 1) {
-                        titleLine = getLine(child);
-                        break;
-                    }
-                }
-                if (!titleLine)
-                    return;
-                // Check only the first content paragraph after the title (the overview).
-                for (const child of node.children) {
-                    if (child.type !== "paragraph" || getLine(child) <= titleLine)
-                        continue;
-                    const text = getTextContent(child).trim();
-                    if (!text || text.startsWith("#"))
-                        continue;
-                    const sentenceCount = countSentences(text);
-                    if (sentenceCount > 2) {
-                        context.report({
-                            node: child,
-                            message: `overview uses ${String(sentenceCount)} sentences, at most two are allowed`,
-                        });
-                    }
-                    break;
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/overview-present.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview Overview must follow the title in a documentation file.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const overviewPresentRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/overview-present.js

@@ -1,41 +0,0 @@
-import { getFilename, getLine, getTextContent } from "./helpers.js";
-export const overviewPresentRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Overview must follow the title in a documentation file.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            root(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith(".md"))
-                    return;
-                let titleLine = 0;
-                for (const child of node.children) {
-                    if (child.type === "heading" && child.depth === 1) {
-                        titleLine = getLine(child);
-                        break;
-                    }
-                }
-                if (!titleLine)
-                    return;
-                let hasOverview = false;
-                for (const child of node.children) {
-                    if (child.type === "paragraph" && getLine(child) > titleLine && getTextContent(child).trim()) {
-                        hasOverview = true;
-                        break;
-                    }
-                }
-                if (!hasOverview) {
-                    context.report({
-                        node,
-                        message: "no overview follows the title",
-                    });
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/policy-no-examples.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview Policy document must not contain Incorrect/Correct examples.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const policyNoExamplesRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/policy-no-examples.js

@@ -1,28 +0,0 @@
-import { getFilename, getTextContent } from "./helpers.js";
-export const policyNoExamplesRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Policy document must not contain Incorrect/Correct examples.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            heading(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith("-policy.md"))
-                    return;
-                if (node.depth !== 2)
-                    return;
-                const text = getTextContent(node).trim();
-                if (/^(?:Incorrect|Correct)\b/.test(text)) {
-                    context.report({
-                        node,
-                        message: `policy document contains an example: ${text}`,
-                    });
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/policy-single-document.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview A repository must not have more than one Policy document.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const policySingleDocumentRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/policy-single-document.js

@@ -1,34 +0,0 @@
-import { getFilename } from "./helpers.js";
-import { findDocsRoot, getProjectDocs } from "./project-index.js";
-export const policySingleDocumentRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "A repository must not have more than one Policy document.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            root(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith("-policy.md"))
-                    return;
-                const docsRoot = findDocsRoot(filename);
-                if (!docsRoot)
-                    return;
-                const docs = getProjectDocs(docsRoot);
-                const policyDocs = docs.filter((d) => d.kind === "policy");
-                if (policyDocs.length > 1) {
-                    // Only report on the first policy doc, so the issue is reported once.
-                    if (policyDocs[0]?.filePath === filename) {
-                        context.report({
-                            node,
-                            message: `${String(policyDocs.length)} policy documents exist`,
-                        });
-                    }
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/policy-subject-headings.d.ts

@@ -1,5 +0,0 @@
-/**
- * @fileoverview Policy document must group its bullets under a heading per subject.
- */
-import type { MarkdownRuleDefinition } from "@eslint/markdown";
-export declare const policySubjectHeadingsRule: MarkdownRuleDefinition;

package/dist/eslint/pasika/rules/md/policy-subject-headings.js

@@ -1,58 +0,0 @@
-import { getFilename, getLine } from "./helpers.js";
-export const policySubjectHeadingsRule = {
-    meta: {
-        type: "problem",
-        docs: {
-            description: "Policy document must group its bullets under a heading per subject.",
-            recommended: true,
-        },
-    },
-    create(context) {
-        return {
-            root(node) {
-                const filename = getFilename(context);
-                if (!filename.endsWith("-policy.md"))
-                    return;
-                // Collect headings and list items with their line numbers, in document order.
-                let titleLine = 0;
-                let firstSubjectLine = 0;
-                let overviewLine = 0;
-                let foundTitle = false;
-                let foundOverview = false;
-                for (const child of node.children) {
-                    const line = getLine(child);
-                    if (!foundTitle && child.type === "heading" && child.depth === 1) {
-                        titleLine = line;
-                        foundTitle = true;
-                        continue;
-                    }
-                    if (!foundTitle)
-                        continue;
-                    if (!foundOverview && child.type === "paragraph" && line > titleLine) {
-                        overviewLine = line;
-                        foundOverview = true;
-                        continue;
-                    }
-                    if (!firstSubjectLine && child.type === "heading" && child.depth === 2 && line > titleLine) {
-                        firstSubjectLine = line;
-                    }
-                }
-                if (!titleLine || !firstSubjectLine)
-                    return;
-                // Any bullet before the first subject heading (and after the overview) is ungrouped.
-                const hasUngroupedBullet = node.children.some((child) => {
-                    if (child.type !== "list")
-                        return false;
-                    const line = getLine(child);
-                    return line > overviewLine && line < firstSubjectLine;
-                });
-                if (hasUngroupedBullet) {
-                    context.report({
-                        node,
-                        message: "policy bullet appears before the first subject heading",
-                    });
-                }
-            },
-        };
-    },
-};

package/dist/eslint/pasika/rules/md/project-index.d.ts

@@ -1,17 +0,0 @@
-export interface DocMeta {
-    /** Absolute path on disk. */
-    filePath: string;
-    /** Path relative to docs root. */
-    doc: string;
-    fileName: string;
-    kind?: "guide" | "rule" | "reference" | "policy";
-    title: string;
-}
-/**
- * Get all documents in the docs folder. Results are cached per docsRoot.
- */
-export declare function getProjectDocs(docsRoot: string): DocMeta[];
-/**
- * Try to find the docsRoot from a file path by walking up to find the docs/ directory.
- */
-export declare function findDocsRoot(filePath: string): string | undefined;