@plurnk/plurnk-plurnkdown 1.0.6

package/README.md

@@ -0,0 +1,13 @@
+# @plurnk/plurnk-plurnkdown
+
+Plurnkdown — the [plurnk-service](https://github.com/plurnk/plurnk-service) packet house style: GFM + Mermaid + fenced Plurnk ops.
+
+`PACKET.md` is the standard every outbound packet is built against. The linter enforces it:
+
+- `op-fence` — a bare Plurnk op in prose belongs in a ```plurnk fence.
+- `op-syntax` — fenced ops parse statement-level via `@plurnk/plurnk-grammar`.
+- `run-on` — soft-warn on multi-compound run-ons; prose stays atomic (split, don't weld).
+
+## license
+
+MIT © PossumTech Laboratories, LLC

package/dist/Plurnkdown.d.ts

@@ -0,0 +1,6 @@
+import type { Diagnostic } from "./types.ts";
+export default class Plurnkdown {
+    #private;
+    lint(source: string): Diagnostic[];
+}
+//# sourceMappingURL=Plurnkdown.d.ts.map

package/dist/Plurnkdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plurnkdown.d.ts","sourceRoot":"","sources":["../src/Plurnkdown.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAQ7C,MAAM,CAAC,OAAO,OAAO,UAAU;;IAC3B,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,CAajC;CAyEJ"}

package/dist/Plurnkdown.js

@@ -0,0 +1,100 @@
+import { Lexer } from "marked";
+import { PlurnkParser } from "@plurnk/plurnk-grammar";
+const RUNON_LIMIT = 180; // a long run-on regardless of structure
+const WELD_LIMIT = 120; // a semicolon welding clauses in a non-trivial sentence
+// plurnkdown linter. Structural blocks are exempt by not being prose. Ops written bare
+// in prose are flagged for fencing; ops inside a ```plurnk fence are delegated to
+// plurnk-grammar for statement-level validation; prose sentences stay atomic.
+export default class Plurnkdown {
+    lint(source) {
+        const diagnostics = [];
+        let line = 1;
+        for (const token of Lexer.lex(source)) {
+            if (token.type === "paragraph") {
+                this.#checkBareOps(token, line, diagnostics);
+                this.#checkRunOns(token, line, diagnostics);
+            }
+            else if (token.type === "code" && token.lang === "plurnk") {
+                this.#checkFencedOps(token.text, line, diagnostics);
+            }
+            line += this.#newlines(token.raw);
+        }
+        return diagnostics;
+    }
+    // A Plurnk op sigil (`<<`) opening a prose line is a bare op; ops must live in a
+    // ```plurnk fence (validated below) or an inline-code span.
+    #checkBareOps(token, line, diagnostics) {
+        token.raw.split("\n").forEach((text, index) => {
+            if (!/^\s*<</.test(text))
+                return;
+            diagnostics.push({
+                rule: "op-fence",
+                severity: "error",
+                message: "Bare Plurnk op in prose; wrap it in a ```plurnk fence.",
+                line: line + index,
+                column: 1,
+            });
+        });
+    }
+    // Soft-warn (#453): the floor model reads short atomic sentences better than dense
+    // compounds. Flag a long run-on (>= RUNON_LIMIT) or a semicolon-welded clause pair
+    // (>= WELD_LIMIT with a `;`). A `;` is not treated as a sentence split — the weld
+    // IS the anti-pattern. Warning, not error: it's a heuristic for human review.
+    #checkRunOns(token, line, diagnostics) {
+        const text = this.#visibleText(token.tokens ?? []);
+        // Per line, then per sentence — a soft line break is a unit boundary in this
+        // one-idea-per-line style, so a multi-line paragraph isn't read as one run-on.
+        for (const lineText of text.split("\n")) {
+            for (const raw of lineText.split(/(?<=\.)\s+/)) {
+                const sentence = raw.trim();
+                if (sentence === "")
+                    continue;
+                const welded = sentence.length >= WELD_LIMIT && sentence.includes(";");
+                if (sentence.length < RUNON_LIMIT && !welded)
+                    continue;
+                diagnostics.push({
+                    rule: "run-on",
+                    severity: "warning",
+                    message: `Prose sentence is ${sentence.length} chars${welded ? " and semicolon-welded" : ""}; keep it atomic — split, don't weld.`,
+                    line,
+                    column: 1,
+                });
+            }
+        }
+    }
+    // Delegate a ```plurnk fence's ops to plurnk-grammar; surface each syntax error at
+    // its absolute line. Fence content line 1 sits one line below the opening fence.
+    #checkFencedOps(text, line, diagnostics) {
+        for (const item of PlurnkParser.parseStatements(text).items) {
+            if (item.kind !== "error")
+                continue;
+            const error = item.error;
+            diagnostics.push({
+                rule: "op-syntax",
+                severity: error.severity === "warning" ? "warning" : "error",
+                message: error.message.replace(/^Plurnk \w+ error at line \d+:\d+ - /, ""),
+                line: line + error.line,
+                column: error.column,
+            });
+        }
+    }
+    #visibleText(tokens) {
+        let out = "";
+        for (const token of tokens) {
+            if (token.type === "br")
+                continue;
+            const children = token.tokens;
+            if (children && children.length > 0) {
+                out += this.#visibleText(children);
+                continue;
+            }
+            const leaf = token;
+            out += leaf.text ?? leaf.raw ?? "";
+        }
+        return out;
+    }
+    #newlines(raw) {
+        return raw.split("\n").length - 1;
+    }
+}
+//# sourceMappingURL=Plurnkdown.js.map

package/dist/Plurnkdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plurnkdown.js","sourceRoot":"","sources":["../src/Plurnkdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA2B,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAGtD,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,wCAAwC;AACjE,MAAM,UAAU,GAAG,GAAG,CAAC,CAAE,wDAAwD;AAEjF,uFAAuF;AACvF,kFAAkF;AAClF,8EAA8E;AAC9E,MAAM,CAAC,OAAO,OAAO,UAAU;IAC3B,IAAI,CAAC,MAAc;QACf,MAAM,WAAW,GAAiB,EAAE,CAAC;QACrC,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC7B,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;gBAC7C,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;YAChD,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAK,KAAqB,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC3E,IAAI,CAAC,eAAe,CAAE,KAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;YACzE,CAAC;YACD,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,iFAAiF;IACjF,4DAA4D;IAC5D,aAAa,CAAC,KAAY,EAAE,IAAY,EAAE,WAAyB;QAC/D,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;gBAAE,OAAO;YACjC,WAAW,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,wDAAwD;gBACjE,IAAI,EAAE,IAAI,GAAG,KAAK;gBAClB,MAAM,EAAE,CAAC;aACZ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,mFAAmF;IACnF,mFAAmF;IACnF,kFAAkF;IAClF,8EAA8E;IAC9E,YAAY,CAAC,KAAY,EAAE,IAAY,EAAE,WAAyB;QAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAE,KAA0B,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACzE,6EAA6E;QAC7E,+EAA+E;QAC/E,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC7C,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC5B,IAAI,QAAQ,KAAK,EAAE;oBAAE,SAAS;gBAC9B,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,UAAU,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACvE,IAAI,QAAQ,CAAC,MAAM,GAAG,WAAW,IAAI,CAAC,MAAM;oBAAE,SAAS;gBACvD,WAAW,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,qBAAqB,QAAQ,CAAC,MAAM,SAAS,MAAM,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,uCAAuC;oBAClI,IAAI;oBACJ,MAAM,EAAE,CAAC;iBACZ,CAAC,CAAC;YACP,CAAC;QACL,CAAC;IACL,CAAC;IAED,mFAAmF;IACnF,iFAAiF;IACjF,eAAe,CAAC,IAAY,EAAE,IAAY,EAAE,WAAyB;QACjE,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;YAC1D,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;gBAAE,SAAS;YACpC,MAAM,KAAK,GAAI,IAAuF,CAAC,KAAK,CAAC;YAC7G,WAAW,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;gBAC5D,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,sCAAsC,EAAE,EAAE,CAAC;gBAC1E,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,IAAI;gBACvB,MAAM,EAAE,KAAK,CAAC,MAAM;aACvB,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,YAAY,CAAC,MAAe;QACxB,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;gBAAE,SAAS;YAClC,MAAM,QAAQ,GAAI,KAA8B,CAAC,MAAM,CAAC;YACxD,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAAC,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YACtF,MAAM,IAAI,GAAG,KAAwC,CAAC;YACtD,GAAG,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;QACvC,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAED,SAAS,CAAC,GAAW;QACjB,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export declare const name = "@plurnk/plurnk-plurnkdown";
+export { default as Plurnkdown } from "./Plurnkdown.ts";
+export type { Diagnostic, Severity } from "./types.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,8BAA8B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export const name = "@plurnk/plurnk-plurnkdown";
+export { default as Plurnkdown } from "./Plurnkdown.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,2BAA2B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,9 @@
+export type Severity = "error" | "warning";
+export interface Diagnostic {
+    rule: string;
+    severity: Severity;
+    message: string;
+    line: number;
+    column: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE3C,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "@plurnk/plurnk-plurnkdown",
+    "version": "1.0.6",
+    "description": "Plurnkdown — the plurnk packet house style (GFM + Mermaid + fenced Plurnk ops) and its linter.",
+    "keywords": [
+        "plurnk",
+        "plurnkdown",
+        "markdown",
+        "gfm",
+        "mermaid",
+        "linter"
+    ],
+    "engines": {
+        "node": ">=26"
+    },
+    "dependencies": {
+        "@plurnk/plurnk-grammar": "1.0.6",
+        "marked": "^18.0.5"
+    },
+    "license": "MIT",
+    "author": "@wikitopian",
+    "type": "module",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/plurnk/plurnk-service.git",
+        "directory": "plurnk-plurnkdown"
+    },
+    "exports": {
+        ".": {
+            "plurnk-dev": "./src/index.ts",
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist/**/*",
+        "README.md"
+    ],
+    "scripts": {
+        "test:lint": "tsc --noEmit",
+        "test:unit": "node --conditions=plurnk-dev --test src/**/*.test.ts",
+        "test": "npm run test:lint && npm run test:unit",
+        "build:dist": "tsc -p tsconfig.build.json",
+        "build": "npm run build:dist",
+        "prepack": "npm run build"
+    }
+}