@plurnk/plurnk-plurnkdown 1.14.2 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/SPEC.md +5 -5
- package/dist/PacketLint.d.ts +2 -1
- package/dist/PacketLint.d.ts.map +1 -1
- package/dist/Plurnkdown.js +3 -3
- package/dist/Plurnkdown.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Plurnkdown — the [plurnk-service](https://github.com/plurnk/plurnk-service) pa
|
|
|
5
5
|
[`SPEC.md`](./SPEC.md) is the tagged Markdown contract for outbound packets. The linter enforces
|
|
6
6
|
its three diagnostic rules:
|
|
7
7
|
|
|
8
|
-
- `op-fence` — a bare Plurnk op in prose belongs in
|
|
8
|
+
- `op-fence` — a bare Plurnk op in prose belongs in an `example` fence.
|
|
9
9
|
- `op-syntax` — fenced ops parse statement-level via `@plurnk/plurnk-contracts`.
|
|
10
10
|
- `run-on` — soft-warn on multi-compound run-ons; prose stays atomic (split, don't weld).
|
|
11
11
|
|
package/SPEC.md
CHANGED
|
@@ -52,7 +52,7 @@ flowchart LR
|
|
|
52
52
|
| `definition` | system | Bare `plurnk.md`; no wrapper heading | {§definition-table-projection} |
|
|
53
53
|
| `system-policy` | system | Authored Markdown | {§policy-sections} |
|
|
54
54
|
| `project-policy` | system | Authored Markdown | {§policy-sections} |
|
|
55
|
-
| `schemes` | system | `
|
|
55
|
+
| `schemes` | system | `example` fence | {§schemes-directory} |
|
|
56
56
|
| `inject` | system | Authored Markdown | {§packet-inject} |
|
|
57
57
|
| `log` | user | Dynamic `jsonplurnk` fence | {§jsonplurnk} |
|
|
58
58
|
| `child-streams` | user | `* <status> <path>` pointers | {§child-orientation} |
|
|
@@ -81,8 +81,8 @@ Plurnkdown preserves the semantic evidence supplied by section owners.
|
|
|
81
81
|
|
|
82
82
|
## §packet-operation-fences PLURNK operation fences
|
|
83
83
|
|
|
84
|
-
Model-facing operation examples use fenced blocks with the `
|
|
85
|
-
PLURNK operation heading outside such a fence is an `op-fence` error. Each `
|
|
84
|
+
Model-facing operation examples use fenced blocks with the `example` info string. A structural
|
|
85
|
+
PLURNK operation heading outside such a fence is an `op-fence` error. Each `example` fence is parsed statement-by-statement by
|
|
86
86
|
`@plurnk/plurnk-contracts`; bounded diagnostics and {§unparsed-tail-boundary} surface as
|
|
87
87
|
`op-syntax` diagnostics under {§parse-diagnostics}.
|
|
88
88
|
|
|
@@ -117,8 +117,8 @@ document-size limit.
|
|
|
117
117
|
|
|
118
118
|
| Rule | Severity | Trigger |
|
|
119
119
|
| ----------- | ---------------- | -------------------------------------------------------------------------- |
|
|
120
|
-
| `op-fence` | error | A PLURNK operation heading occurs outside
|
|
121
|
-
| `op-syntax` | error or warning |
|
|
120
|
+
| `op-fence` | error | A PLURNK operation heading occurs outside an `example` fence. |
|
|
121
|
+
| `op-syntax` | error or warning | An `example` fence contains a parser diagnostic, advisory, or unparsed tail.|
|
|
122
122
|
| `run-on` | warning | Paragraph prose crosses an atomic-prose threshold. |
|
|
123
123
|
|
|
124
124
|
`PacketLint.lintDir` evaluates byte-exact digest files named
|
package/dist/PacketLint.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Diagnostic } from "./types.ts";
|
|
2
|
-
|
|
2
|
+
interface PacketFinding extends Diagnostic {
|
|
3
3
|
file: string;
|
|
4
4
|
}
|
|
5
5
|
export interface PacketLintResult {
|
|
@@ -9,4 +9,5 @@ export interface PacketLintResult {
|
|
|
9
9
|
export default class PacketLint {
|
|
10
10
|
static lintDir(dir: string): PacketLintResult;
|
|
11
11
|
}
|
|
12
|
+
export {};
|
|
12
13
|
//# sourceMappingURL=PacketLint.d.ts.map
|
package/dist/PacketLint.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PacketLint.d.ts","sourceRoot":"","sources":["../src/PacketLint.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,
|
|
1
|
+
{"version":3,"file":"PacketLint.d.ts","sourceRoot":"","sources":["../src/PacketLint.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,UAAU,aAAc,SAAQ,UAAU;IACtC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC7B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC7B;AAGD,MAAM,CAAC,OAAO,OAAO,UAAU;IAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAQ5C;CACJ"}
|
package/dist/Plurnkdown.js
CHANGED
|
@@ -11,7 +11,7 @@ export default class Plurnkdown {
|
|
|
11
11
|
const diagnostics = [];
|
|
12
12
|
let line = 1;
|
|
13
13
|
for (const token of Lexer.lex(source)) {
|
|
14
|
-
if (token.type === "code" && token.lang === "
|
|
14
|
+
if (token.type === "code" && token.lang === "example") {
|
|
15
15
|
this.#checkFencedOps(token.text, line, diagnostics);
|
|
16
16
|
}
|
|
17
17
|
else {
|
|
@@ -40,7 +40,7 @@ export default class Plurnkdown {
|
|
|
40
40
|
diagnostics.push({
|
|
41
41
|
rule: "op-fence",
|
|
42
42
|
severity: "error",
|
|
43
|
-
message: "Bare Plurnk op in prose; wrap it in
|
|
43
|
+
message: "Bare Plurnk op in prose; wrap it in an ```example fence.",
|
|
44
44
|
line: line + index,
|
|
45
45
|
column: 1,
|
|
46
46
|
});
|
|
@@ -70,7 +70,7 @@ export default class Plurnkdown {
|
|
|
70
70
|
}
|
|
71
71
|
}
|
|
72
72
|
}
|
|
73
|
-
// Delegate
|
|
73
|
+
// Delegate an ```example fence's ops to the contracts grammar; surface every diagnostic and
|
|
74
74
|
// tail at its absolute point. Fence line 1 sits below the opener. {§packet-operation-fences}
|
|
75
75
|
#checkFencedOps(text, line, diagnostics) {
|
|
76
76
|
const parsed = PlurnkParser.parseStatements(text);
|
package/dist/Plurnkdown.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Plurnkdown.js","sourceRoot":"","sources":["../src/Plurnkdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA2B,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGpE,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,wCAAwC;AACjE,MAAM,UAAU,GAAG,GAAG,CAAC,CAAE,wDAAwD;AACjF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAS,UAAU,CAAC,CAAC;AACjD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7C,6EAA6E;AAC7E,6FAA6F;AAC7F,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,MAAM,IAAK,KAAqB,CAAC,IAAI,KAAK,
|
|
1
|
+
{"version":3,"file":"Plurnkdown.js","sourceRoot":"","sources":["../src/Plurnkdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA2B,MAAM,QAAQ,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGpE,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,wCAAwC;AACjE,MAAM,UAAU,GAAG,GAAG,CAAC,CAAE,wDAAwD;AACjF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAS,UAAU,CAAC,CAAC;AACjD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7C,6EAA6E;AAC7E,6FAA6F;AAC7F,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,MAAM,IAAK,KAAqB,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACrE,IAAI,CAAC,eAAe,CAAE,KAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;YACzE,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;gBAC7C,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;oBAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,+EAA+E;IAC/E,6EAA6E;IAC7E,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,MAAM,KAAK,GAAG,4CAA4C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtE,IAAI,KAAK,KAAK,IAAI;gBAAE,OAAO;YAC3B,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC;YAC5B,MAAM,iBAAiB,GAAG,EAAE,KAAK,MAAM;gBACnC,CAAC,CAAC,KAAK,KAAK,GAAG;gBACf,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC7C,MAAM,eAAe,GAAG,KAAK,KAAK,IAAI,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,iBAAiB,IAAI,CAAC,eAAe;gBAAE,OAAO;YACnD,WAAW,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,0DAA0D;gBACnE,IAAI,EAAE,IAAI,GAAG,KAAK;gBAClB,MAAM,EAAE,CAAC;aACZ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,+EAA+E;IAC/E,yBAAyB;IACzB,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,4FAA4F;IAC5F,6FAA6F;IAC7F,eAAe,CAAC,IAAY,EAAE,IAAY,EAAE,WAAyB;QACjE,MAAM,MAAM,GAAG,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAClD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;gBAAE,SAAS;YACpC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;YACvB,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;gBACtB,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,IAAI;gBACvB,MAAM,EAAE,KAAK,CAAC,MAAM;aACvB,CAAC,CAAC;QACP,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACpC,WAAW,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC,MAAM;gBACnC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI;gBAC1C,MAAM,EAAE,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM;aAC1C,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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@plurnk/plurnk-plurnkdown",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.15.0",
|
|
4
4
|
"description": "Plurnkdown — the plurnk packet house style (GFM + Mermaid + fenced Plurnk ops) and its linter.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"plurnk",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"node": ">=26"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@plurnk/plurnk-contracts": "1.
|
|
17
|
+
"@plurnk/plurnk-contracts": "1.15.0",
|
|
18
18
|
"marked": "^18.0.5"
|
|
19
19
|
},
|
|
20
20
|
"license": "MIT",
|