paperlint 3.1.3 → 3.2.0

package/dist/eslint-rules/latex-language.d.ts

@@ -0,0 +1,136 @@
+import { TextSourceCodeBase, VisitNodeStep, Directive } from "@eslint/plugin-kit";
+import type { FileProblem, Language, LanguageOptions } from "@eslint/core";
+/** A position in the `.tex`, as unified-latex and mdast both spell it. */
+export interface Point {
+    readonly offset: number;
+    readonly line: number;
+    readonly column: number;
+}
+export interface Span {
+    readonly start: Point;
+    readonly end: Point;
+}
+/**
+ * A node as the projection reads it: unified-latex's shape, with every part the projection can
+ * live without made optional — a macro without `args`, an argument without `content`, an `env`
+ * given as nodes. unified-latex's own `Ast.Root` is one of these.
+ */
+export type TexNode = {
+    readonly type: "string" | "comment";
+    readonly content: string;
+    readonly position?: Span;
+} | {
+    readonly type: "macro";
+    readonly content: string;
+    readonly args?: readonly TexArg[];
+    readonly position?: Span;
+} | {
+    readonly type: "environment" | "mathenv";
+    readonly env: string | readonly TexNode[];
+    readonly content?: readonly TexNode[];
+    readonly args?: readonly TexArg[];
+    readonly position?: Span;
+} | {
+    readonly type: "verbatim" | "verb";
+    readonly env: string;
+    readonly content: string;
+    readonly position?: Span;
+} | {
+    readonly type: "group" | "inlinemath" | "displaymath" | "root";
+    readonly content: readonly TexNode[];
+    readonly position?: Span;
+} | {
+    readonly type: "whitespace" | "parbreak";
+    readonly position?: Span;
+} | TexArg;
+/** A macro's or an environment's argument. */
+export interface TexArg {
+    readonly type: "argument";
+    readonly content?: readonly TexNode[];
+    readonly openMark?: string;
+    readonly closeMark?: string;
+    readonly position?: Span;
+}
+/** What a parser hands the projection. */
+export interface TexRoot {
+    readonly content: readonly TexNode[];
+}
+/**
+ * The projection's mdast-shaped output: the node kinds the prose rules read (`root`, `heading`,
+ * `text`, `strong`, `code`, `html`), each with its span in the `.tex`.
+ */
+export type MdNode = {
+    readonly type: "root" | "strong";
+    readonly position: Span;
+    readonly children: readonly MdNode[];
+} | {
+    readonly type: "heading";
+    readonly position: Span;
+    readonly depth: number;
+    readonly title: string;
+    readonly children: readonly MdNode[];
+} | {
+    readonly type: "text" | "html";
+    readonly position: Span;
+    readonly value: string;
+} | {
+    readonly type: "code";
+    readonly position: Span;
+    readonly lang: string;
+    readonly value: string;
+};
+/** An inline-config comment: an `html` node's text and where it sits. */
+interface ConfigNode {
+    readonly value: string;
+    readonly position: Span;
+}
+export declare function texToMdast(src: string, { parse, }?: {
+    parse?: (s: string) => TexRoot;
+}): {
+    root: MdNode;
+    text: string;
+};
+declare class TexSourceCode extends TextSourceCodeBase<{
+    LangOptions: LanguageOptions;
+    RootNode: MdNode;
+    SyntaxElementWithLoc: MdNode;
+    ConfigNode: ConfigNode;
+}> {
+    #private;
+    ast: MdNode;
+    /**
+     * `raw` is the UNPROJECTED `.tex`, and it is here because the projection is lossy by design:
+     * it blanks macros, so a rule that must count `\S\ref` or `Fig.~\ref` sees spaces. Those
+     * rules are about MARKUP, not prose, and the projection exists precisely to hide markup.
+     *
+     * 🔴 Positions stay interchangeable, which is what makes this safe rather than a second
+     * coordinate system: `blank()` overwrites characters with spaces and never changes length,
+     * so an offset computed on `raw` addresses the same byte of `text`. A rule may therefore
+     * scan `raw` and report with the offset it found.
+     */
+    raw: string;
+    constructor({ text, ast, raw, }: {
+        text: string;
+        ast: MdNode;
+        raw?: string | undefined;
+    });
+    getParent(node: MdNode): MdNode | undefined;
+    getInlineConfigNodes(): ConfigNode[];
+    getDisableDirectives(): {
+        problems: FileProblem[];
+        directives: Directive[];
+    };
+    applyInlineConfig(): {
+        configs: never[];
+        problems: FileProblem[];
+    };
+    traverse(): ArrayIterator<VisitNodeStep>;
+}
+export declare const texLanguage: Language<{
+    LangOptions: LanguageOptions;
+    Code: TexSourceCode;
+    RootNode: MdNode;
+    Node: MdNode;
+}>;
+export {};
+//# sourceMappingURL=latex-language.d.ts.map

package/dist/eslint-rules/latex-language.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"latex-language.d.ts","sourceRoot":"","sources":["../../eslint-rules/latex-language.ts"],"names":[],"mappings":"AAsGA,OAAO,EACL,kBAAkB,EAClB,aAAa,EAEb,SAAS,EACV,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAGV,WAAW,EACX,QAAQ,EACR,eAAe,EAGhB,MAAM,cAAc,CAAC;AAEtB,0EAA0E;AAC1E,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AACD,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GACf;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC1B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC1B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,OAAO,EAAE,CAAC;IAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC1B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IACnC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC1B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,YAAY,GAAG,aAAa,GAAG,MAAM,CAAC;IAC/D,QAAQ,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC1B,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC;IAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;CAAE,GACtE,MAAM,CAAC;AAEX,8CAA8C;AAC9C,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;CAC1B;AAED,0CAA0C;AAC1C,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GACd;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEN,yEAAyE;AACzE,UAAU,UAAU;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAuFD,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,EACE,KAAoD,GACrD,GAAE;IAAE,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAA;CAAO,GACzC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAyWhC;AAaD,cAAM,aAAc,SAAQ,kBAAkB,CAAC;IAC7C,WAAW,EAAE,eAAe,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;;IAKS,GAAG,EAAE,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,GAAG,EAAE,MAAM,CAAC;gBACA,EACV,IAAI,EACJ,GAAG,EACH,GAAG,GACJ,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC1B;IAMQ,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAGpD,oBAAoB,IAAI,UAAU,EAAE;IAOpC,oBAAoB,IAAI;QAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;QAAC,UAAU,EAAE,SAAS,EAAE,CAAA;KAAE;IAe5E,iBAAiB,IAAI;QAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAAC,QAAQ,EAAE,WAAW,EAAE,CAAA;KAAE;IAGzD,QAAQ,IAAI,aAAa,CAAC,aAAa,CAAC;CAkBlD;AAED,eAAO,MAAM,WAAW,EAAE,QAAQ,CAAC;IACjC,WAAW,EAAE,eAAe,CAAC;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAuCA,CAAC"}