@rse/specbook 0.9.6 → 0.9.7

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.
Files changed (40) hide show
  1. package/README.md +60 -10
  2. package/dst/specbook-api.js +19 -18
  3. package/dst/specbook-cli.js +9 -6
  4. package/dst/specbook-cmd-describe.js +1 -3
  5. package/dst/specbook-cmd-export.js +19 -16
  6. package/dst/specbook-cmd-init.d.ts +1 -1
  7. package/dst/specbook-cmd-init.js +5 -4
  8. package/dst/specbook-cmd-lint.d.ts +0 -1
  9. package/dst/specbook-cmd-lint.js +29 -5
  10. package/dst/specbook-config.d.ts +1 -1
  11. package/dst/specbook-config.js +80 -71
  12. package/dst/specbook-diagnostic.js +4 -1
  13. package/dst/specbook-diagram.d.ts +3 -2
  14. package/dst/specbook-diagram.js +75 -91
  15. package/dst/specbook-export-ast.d.ts +1 -1
  16. package/dst/specbook-export-ast.js +1 -1
  17. package/dst/specbook-export-common.d.ts +2 -1
  18. package/dst/specbook-export-common.js +12 -14
  19. package/dst/specbook-export-html-search.js +10 -14
  20. package/dst/specbook-export-html.css +24 -29
  21. package/dst/specbook-export-html.js +100 -83
  22. package/dst/specbook-export-md.d.ts +1 -1
  23. package/dst/specbook-export-md.js +50 -24
  24. package/dst/specbook-export-pdf.d.ts +4 -2
  25. package/dst/specbook-export-pdf.js +48 -38
  26. package/dst/specbook-format-schema.js +6 -3
  27. package/dst/specbook-format.md +34 -18
  28. package/dst/specbook-link.d.ts +1 -0
  29. package/dst/specbook-link.js +7 -4
  30. package/dst/specbook-mcp.js +17 -10
  31. package/dst/specbook-parse-common.d.ts +1 -1
  32. package/dst/specbook-parse-semantic.d.ts +4 -2
  33. package/dst/specbook-parse-semantic.js +95 -42
  34. package/dst/specbook-parse-syntax.js +163 -136
  35. package/dst/specbook-parse-value.d.ts +1 -1
  36. package/dst/specbook-parse-value.js +6 -3
  37. package/dst/specbook-parse.d.ts +2 -5
  38. package/dst/specbook-parse.js +27 -34
  39. package/dst/specbook-verbose.js +2 -1
  40. package/package.json +1 -1
@@ -7,9 +7,11 @@ import * as fs from "node:fs";
7
7
  import * as path from "node:path";
8
8
  import { marked } from "marked";
9
9
  import { embeddingRegex, embeddingMimeType, embeddingVariants } from "./specbook-parse-common.js";
10
+ /* the marker separating a statement from its rationale */
11
+ const becauseRegex = /,\s*(?:\*\*BECAUSE\*\*|BECAUSE)\s+/;
10
12
  /* split a description text into statement and optional rationale */
11
13
  const splitDescription = (text) => {
12
- const m = text.match(/,\s*(?:\*\*BECAUSE\*\*|BECAUSE)\s+/);
14
+ const m = text.match(becauseRegex);
13
15
  if (m === null || m.index === undefined)
14
16
  return { description: text };
15
17
  return {
@@ -17,33 +19,19 @@ const splitDescription = (text) => {
17
19
  rationale: text.slice(m.index + m[0].length)
18
20
  };
19
21
  };
20
- /* parse a heading text of the form "<KIND>: <name> [(<token>)] [<a id="..."></a>]" */
21
- const parseHeadingText = (raw) => {
22
- let text = raw.trim();
23
- let id;
24
- const am = text.match(/<a\s+id="([^"]+)"\s*>\s*<\/a>\s*$/);
25
- if (am !== null && am.index !== undefined) {
26
- id = am[1];
27
- text = text.slice(0, am.index).trim();
28
- }
29
- /* detect a malformed trailing anchor fragment, still salvaging its id */
30
- let malformed;
31
- const fm = text.match(/<a\b[^>]*>?\s*(?:<\/a>)?\s*$/);
32
- if (fm !== null && fm.index !== undefined) {
33
- malformed = fm[0].trim();
34
- id ??= malformed.match(/id="([^"]+)"/)?.[1];
35
- text = text.slice(0, fm.index).trim();
36
- }
37
- /* detect the trailing explicit Wiki-style anchor ("{{xxx}}"), the
38
- primary marker ("(*)"), and/or the implicit parenthesized anchor
39
- token ("(xxx)"), in any order */
22
+ /* strip the trailing explicit Wiki-style anchor ("{{xxx}}"), the
23
+ primary marker ("(*)"), and/or the implicit parenthesized anchor
24
+ token ("(xxx)") off a name, in any order */
25
+ const parseMarkers = (raw) => {
26
+ let text = raw;
27
+ let anchor;
40
28
  let paren;
41
29
  let primary = false;
42
30
  for (;;) {
43
- const wm = text.match(/\{\{([^{}]+)\}\}\s*$/);
44
- if (wm !== null && wm.index !== undefined) {
45
- id ??= wm[1].trim();
46
- text = text.slice(0, wm.index).trim();
31
+ const am = text.match(/\{\{([^{}]+)\}\}\s*$/);
32
+ if (am !== null && am.index !== undefined) {
33
+ anchor ??= am[1].trim();
34
+ text = text.slice(0, am.index).trim();
47
35
  continue;
48
36
  }
49
37
  const sm = text.match(/\(\*\)\s*$/);
@@ -60,20 +48,49 @@ const parseHeadingText = (raw) => {
60
48
  }
61
49
  break;
62
50
  }
63
- const km = text.match(/^([^:]+):\s*(.*)$/);
51
+ return { text, anchor, paren, primary };
52
+ };
53
+ /* parse a heading text of the form "<KIND>: <name> [(<token>)] [<a id="..."></a>]" */
54
+ const parseHeadingText = (raw) => {
55
+ let text = raw.trim();
56
+ let id;
57
+ const am = text.match(/<a\s+id="([^"]+)"\s*>\s*<\/a>\s*$/);
58
+ if (am !== null && am.index !== undefined) {
59
+ id = am[1];
60
+ text = text.slice(0, am.index).trim();
61
+ }
62
+ /* detect a malformed trailing anchor fragment, still salvaging its id */
63
+ let malformed;
64
+ const fm = text.match(/<a\b[^>]*>?\s*(?:<\/a>)?\s*$/);
65
+ if (fm !== null && fm.index !== undefined) {
66
+ malformed = fm[0].trim();
67
+ id ??= malformed.match(/id="([^"]+)"/)?.[1];
68
+ text = text.slice(0, fm.index).trim();
69
+ }
70
+ /* detect the trailing markers (an HTML anchor id takes
71
+ precedence over the explicit Wiki-style anchor) */
72
+ const markers = parseMarkers(text);
73
+ const km = markers.text.match(/^([^:]+):\s*(.*)$/);
64
74
  return {
65
- kind: km !== null ? km[1].trim() : text,
75
+ kind: km !== null ? km[1].trim() : markers.text,
66
76
  name: km !== null ? km[2].trim() : "",
67
- id, paren, primary, malformed
77
+ id: id ?? markers.anchor,
78
+ paren: markers.paren,
79
+ primary: markers.primary,
80
+ malformed
68
81
  };
69
82
  };
70
83
  /* derive a stable slug identifier from an object name */
71
84
  const slugify = (text) => text.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
72
- /* extract the plain text lines of a Markdown list item
73
- (excluding any nested lists) */
85
+ /* extract the plain text lines of a Markdown list item (excluding any
86
+ nested lists), whose body is a "text" token in a tight list, but a
87
+ "paragraph" token in a loose list (and never "item.text", as this
88
+ still contains the source of the nested lists) */
74
89
  const itemLines = (item) => {
75
- const body = item.tokens.find((token) => token.type === "text");
76
- const text = body !== undefined ? body.text : item.text;
90
+ const text = item.tokens
91
+ .filter((token) => token.type === "text" || token.type === "paragraph")
92
+ .map((token) => token.text)
93
+ .join("\n");
77
94
  return text.split("\n").map((line) => line.trim());
78
95
  };
79
96
  /* parse the optional Markdown frontmatter with Created/Modified timestamps */
@@ -96,14 +113,15 @@ const parseFrontmatter = (text) => {
96
113
  created: grab("Created"),
97
114
  modified: grab("Modified"),
98
115
  body: text.slice(m[0].length),
99
- offset: m[0].split("\n").length - 1
116
+ offset: (m[0].match(/\n/g) ?? []).length
100
117
  };
101
118
  };
102
119
  /* recursively load the image files embedded via "![alt](file)" into the
103
120
  description and the property values of an object (SVG as-is, PNG/JPEG
104
121
  as base64 data: URLs), resolving the references relative to the source
105
122
  file and expanding a "{theme}" reference into its theme variants,
106
- which are loaded into consecutive embedding entries */
123
+ which are loaded into consecutive embedding entries (an unreadable
124
+ file leaves an empty entry, keeping the positions aligned) */
107
125
  const embed = (ctx, object, file) => {
108
126
  const load = (target, text, line) => {
109
127
  for (const m of text.matchAll(embeddingRegex)) {
@@ -112,13 +130,14 @@ const embed = (ctx, object, file) => {
112
130
  if (type === undefined)
113
131
  continue;
114
132
  for (const variant of embeddingVariants(reference)) {
133
+ target.embedding ??= [];
115
134
  try {
116
135
  const data = fs.readFileSync(path.resolve(path.dirname(file), variant));
117
- target.embedding ??= [];
118
136
  target.embedding.push(type === "image/svg+xml" ?
119
137
  data.toString("utf8") : `data:${type};base64,${data.toString("base64")}`);
120
138
  }
121
139
  catch (err) {
140
+ target.embedding.push("");
122
141
  ctx.diagnose(file, line, `unreadable embedding file "${variant}": ` +
123
142
  (err instanceof Error ? err.message : String(err)));
124
143
  }
@@ -152,6 +171,8 @@ const parseList = (ctx, list, object, file, line) => {
152
171
  const property = { key: km[1].trim(), value };
153
172
  ctx.propMeta.set(property, { line });
154
173
  object.properties.push(property);
174
+ if (item.tokens.some((sub) => sub.type === "list"))
175
+ ctx.diagnose(file, line, `nested list below property "${property.key}" ignored`);
155
176
  }
156
177
  else
157
178
  ctx.diagnose(file, line, `unrecognized list item "${first}"`);
@@ -174,7 +195,7 @@ const parseGrouped = (ctx, list, group, file, line) => {
174
195
  omits the leading "<kind>: " and receives its kind from the group */
175
196
  const parseConcise = (ctx, item, parent, file, line, group) => {
176
197
  const text = itemLines(item).join(" ").trim();
177
- const segments = text.split(/;\s*/).filter((segment) => segment !== "");
198
+ const segments = text.split(/\s*;\s*/).filter((segment) => segment !== "");
178
199
  const head = segments.shift() ?? "";
179
200
  let kind;
180
201
  let name;
@@ -196,30 +217,10 @@ const parseConcise = (ctx, item, parent, file, line, group) => {
196
217
  kind = km[1].trim();
197
218
  name = km[2].trim();
198
219
  }
199
- let anchor;
200
- let paren;
201
- let primary = false;
202
- for (;;) {
203
- const am = name.match(/\{\{([^{}]+)\}\}\s*$/);
204
- if (am !== null && am.index !== undefined) {
205
- anchor ??= am[1].trim();
206
- name = name.slice(0, am.index).trim();
207
- continue;
208
- }
209
- const sm = name.match(/\(\*\)\s*$/);
210
- if (sm !== null && sm.index !== undefined) {
211
- primary = true;
212
- name = name.slice(0, sm.index).trim();
213
- continue;
214
- }
215
- const pm = name.match(/\(([^()]+)\)\s*$/);
216
- if (pm !== null && pm.index !== undefined && paren === undefined) {
217
- paren = pm[1].trim();
218
- name = name.slice(0, pm.index).trim();
219
- continue;
220
- }
221
- break;
222
- }
220
+ /* detect the trailing markers of the name */
221
+ const { text: plain, anchor, paren, primary } = parseMarkers(name);
222
+ name = plain;
223
+ /* create the object with its markers, registering its source location */
223
224
  const object = {
224
225
  kind,
225
226
  id: anchor ?? slugify(name),
@@ -234,11 +235,16 @@ const parseConcise = (ctx, item, parent, file, line, group) => {
234
235
  if (primary)
235
236
  object.primary = true;
236
237
  ctx.objectMeta.set(object, { file, line });
238
+ /* split the remaining segments into properties (with a possibly
239
+ empty value) and statements, where the last segment of a "."-
240
+ terminated item is always a statement, as only this lets a
241
+ "<key>: <value>"-shaped description round-trip on export */
237
242
  const statements = new Array();
238
- for (const segment of segments) {
239
- const km = segment.match(/^([^:;]+):\s+(.+)$/);
240
- if (km !== null && !(/\s(?:\*\*BECAUSE\*\*|BECAUSE)\s/.test(segment))) {
241
- const property = { key: km[1].trim(), value: km[2].trim() };
243
+ const last = text.endsWith(".") ? segments.length - 1 : -1;
244
+ for (const [i, segment] of segments.entries()) {
245
+ const km = segment.match(/^([^:;]+):(?:\s+(.+))?$/);
246
+ if (km !== null && !becauseRegex.test(segment) && i !== last) {
247
+ const property = { key: km[1].trim(), value: (km[2] ?? "").trim() };
242
248
  ctx.propMeta.set(property, { line });
243
249
  object.properties.push(property);
244
250
  }
@@ -247,12 +253,67 @@ const parseConcise = (ctx, item, parent, file, line, group) => {
247
253
  }
248
254
  if (statements.length > 0)
249
255
  object.description = splitDescription(statements.join("; ").replace(/\.\s*$/, ""));
250
- /* recurse into nested concise-format child objects */
251
- for (const sub of item.tokens)
256
+ /* recurse into nested concise-format child objects, tracking the
257
+ source line of the nested list within the item (an ordered
258
+ nested list is not supported, so it is reported, not lost) */
259
+ let subLine = line;
260
+ for (const sub of item.tokens) {
252
261
  if (sub.type === "list" && !sub.ordered)
253
- parseList(ctx, sub, object, file, line);
262
+ parseList(ctx, sub, object, file, subLine);
263
+ else if (sub.type === "list")
264
+ ctx.diagnose(file, subLine, `nested ordered list below ${kind} "${name}" ignored`);
265
+ subLine += (sub.raw.match(/\n/g) ?? []).length;
266
+ }
254
267
  parent.childs.push(object);
255
268
  };
269
+ /* parse a heading token into either a grouping container (e.g. "### STATE",
270
+ collecting objects of its kind below the parent object) or a new object
271
+ (an artifact on level 1, a child of the enclosing object below) */
272
+ const parseHeading = (ctx, token, state, stamps, file, line) => {
273
+ const { depth, text } = token;
274
+ const heading = parseHeadingText(text);
275
+ state.group = null;
276
+ if (heading.malformed !== undefined)
277
+ ctx.diagnose(file, line, `malformed anchor "${heading.malformed}" in heading`);
278
+ if (heading.name === "" && depth > 1) {
279
+ const parent = state.stack[depth - 2];
280
+ if (parent === undefined)
281
+ ctx.diagnose(file, line, `heading level ${depth} without parent object`);
282
+ else {
283
+ state.group = { parent, kind: heading.kind };
284
+ state.current = parent;
285
+ state.stack.length = depth - 1;
286
+ }
287
+ return;
288
+ }
289
+ const object = {
290
+ kind: heading.kind,
291
+ id: heading.id ?? (depth === 1 ? heading.paren : undefined) ?? slugify(heading.name),
292
+ name: heading.name,
293
+ properties: [],
294
+ childs: []
295
+ };
296
+ if (heading.id !== undefined)
297
+ object.anchor = heading.id;
298
+ if (heading.paren !== undefined)
299
+ object.paren = heading.paren;
300
+ if (heading.primary)
301
+ object.primary = true;
302
+ ctx.objectMeta.set(object, { file, line });
303
+ if (depth === 1)
304
+ state.artifacts.push({ ...stamps, objects: [object] });
305
+ else {
306
+ const parent = state.stack[depth - 2];
307
+ if (parent === undefined) {
308
+ ctx.diagnose(file, line, `heading level ${depth} without parent object`);
309
+ return;
310
+ }
311
+ parent.childs.push(object);
312
+ }
313
+ state.stack.length = depth - 1;
314
+ state.stack[depth - 1] = object;
315
+ state.current = object;
316
+ };
256
317
  /* parse a single source file into its artifacts */
257
318
  export const parseFile = (ctx, source) => {
258
319
  const { present, created, modified, body, offset } = parseFrontmatter(source.text);
@@ -265,15 +326,30 @@ export const parseFile = (ctx, source) => {
265
326
  `missing "${key}:" frontmatter key` :
266
327
  `invalid "${key}:" frontmatter timestamp "${info.value}"`);
267
328
  /* the state tracked while walking the Markdown tokens */
268
- const artifacts = new Array();
269
- const stack = new Array();
270
- let current = null;
271
- let group = null;
329
+ const state = { artifacts: [], stack: [], current: null, group: null };
330
+ const stamps = {
331
+ created: created.date ?? new Date(),
332
+ modified: modified.date ?? new Date()
333
+ };
272
334
  let parts = new Array();
273
- /* flush the accumulated description parts into the current object */
335
+ let partsLine = 1;
336
+ /* collect a description part, remembering the line of the first one */
337
+ const collect = (raw, line) => {
338
+ if (parts.length === 0)
339
+ partsLine = line;
340
+ parts.push(raw.trim());
341
+ };
342
+ /* flush the accumulated description parts into the current object
343
+ (a grouping container re-targets the parent, whose description
344
+ is already flushed, so further content is reported, not lost) */
274
345
  const flush = () => {
275
- if (current !== null && parts.length > 0 && current.description === undefined)
276
- current.description = splitDescription(parts.join("\n\n").trim());
346
+ const current = state.current;
347
+ if (current !== null && parts.length > 0) {
348
+ if (current.description === undefined)
349
+ current.description = splitDescription(parts.join("\n\n").trim());
350
+ else
351
+ ctx.diagnose(source.file, partsLine, `content ignored, as ${current.kind} "${current.name}" already carries a description`);
352
+ }
277
353
  parts = [];
278
354
  };
279
355
  /* walk the top-level Markdown tokens, tracking source lines */
@@ -281,88 +357,39 @@ export const parseFile = (ctx, source) => {
281
357
  for (const token of marked.lexer(body)) {
282
358
  if (token.type === "heading") {
283
359
  flush();
284
- group = null;
285
- const { depth, text } = token;
286
- const heading = parseHeadingText(text);
287
- if (heading.malformed !== undefined)
288
- ctx.diagnose(source.file, line, `malformed anchor "${heading.malformed}" in heading`);
289
- if (heading.name === "" && depth > 1) {
290
- /* a grouping container heading (e.g. "### STATE") collects
291
- objects of its kind below the parent object */
292
- const parent = stack[depth - 2];
293
- if (parent === undefined)
294
- ctx.diagnose(source.file, line, `heading level ${depth} without parent object`);
295
- else {
296
- group = { parent, kind: heading.kind };
297
- current = parent;
298
- }
299
- }
300
- else {
301
- const object = {
302
- kind: heading.kind,
303
- id: heading.id ?? (depth === 1 ? heading.paren : undefined) ?? slugify(heading.name),
304
- name: heading.name,
305
- properties: [],
306
- childs: []
307
- };
308
- if (heading.id !== undefined)
309
- object.anchor = heading.id;
310
- if (heading.paren !== undefined)
311
- object.paren = heading.paren;
312
- if (heading.primary)
313
- object.primary = true;
314
- ctx.objectMeta.set(object, { file: source.file, line });
315
- if (depth === 1) {
316
- artifacts.push({
317
- created: created.date ?? new Date(),
318
- modified: modified.date ?? new Date(),
319
- objects: [object]
320
- });
321
- stack.length = 0;
322
- }
323
- else {
324
- const parent = stack[depth - 2];
325
- if (parent === undefined) {
326
- ctx.diagnose(source.file, line, `heading level ${depth} without parent object`);
327
- line += (token.raw.match(/\n/g) ?? []).length;
328
- continue;
329
- }
330
- parent.childs.push(object);
331
- }
332
- stack.length = depth - 1;
333
- stack[depth - 1] = object;
334
- current = object;
335
- }
360
+ parseHeading(ctx, token, state, stamps, source.file, line);
336
361
  }
337
362
  else if (token.type === "list") {
338
363
  const list = token;
339
- if (current === null)
364
+ if (state.current === null)
340
365
  ctx.diagnose(source.file, line, "content outside of any object");
341
- else if (!list.ordered && group !== null)
342
- parseGrouped(ctx, list, group, source.file, line);
366
+ else if (!list.ordered && state.group !== null)
367
+ parseGrouped(ctx, list, state.group, source.file, line);
343
368
  else if (!list.ordered)
344
- parseList(ctx, list, current, source.file, line);
369
+ parseList(ctx, list, state.current, source.file, line);
345
370
  else
346
- parts.push(token.raw.trim());
371
+ collect(token.raw, line);
347
372
  }
348
373
  else if (token.type === "paragraph" || token.type === "blockquote"
349
374
  || (token.type === "code" && token.lang !== "gradia")) {
350
375
  /* notice: a "gradia" code block is skipped entirely, as it is
351
376
  the derived diagram of the Markdown renderer and hence must
352
377
  not become authored content on a re-parse of exported files */
353
- if (current === null)
378
+ if (state.current === null)
354
379
  ctx.diagnose(source.file, line, "content outside of any object");
355
380
  else
356
- parts.push(token.raw.trim());
381
+ collect(token.raw, line);
357
382
  }
383
+ else if (token.type === "table")
384
+ ctx.diagnose(source.file, line, "unsupported table content ignored");
358
385
  line += (token.raw.match(/\n/g) ?? []).length;
359
386
  }
360
387
  flush();
361
388
  /* load the embedded image files of all fully parsed objects */
362
- for (const artifact of artifacts)
389
+ for (const artifact of state.artifacts)
363
390
  for (const object of artifact.objects)
364
391
  embed(ctx, object, source.file);
365
- if (artifacts.length === 0)
392
+ if (state.artifacts.length === 0)
366
393
  ctx.diagnose(source.file, 1, "no artifact (level 1 heading) found");
367
- return artifacts;
394
+ return state.artifacts;
368
395
  };
@@ -1,7 +1,6 @@
1
1
  export type ValueExpr = {
2
2
  kind: "regex";
3
3
  regex: RegExp;
4
- source: string;
5
4
  } | {
6
5
  kind: "reference";
7
6
  pattern: string;
@@ -15,5 +14,6 @@ export type ValueExpr = {
15
14
  kind: "list";
16
15
  alternatives: ValueExpr[];
17
16
  };
17
+ export declare const anchored: (pattern: string) => RegExp;
18
18
  export declare const compileValueExpr: (source: string) => ValueExpr;
19
19
  export declare const splitItems: (text: string) => string[];
@@ -33,13 +33,16 @@ lexer.rule(/\s+/, (ctx) => {
33
33
  });
34
34
  /* describe a token for error messages */
35
35
  const tokenName = (token) => token.type === "EOF" ? "end of expression" : `"${token.text}"`;
36
+ /* compile a configured pattern (object name or value regex) into an
37
+ anchored regular expression, so it has to match a text as a whole */
38
+ export const anchored = (pattern) => new RegExp(`^(?:${pattern})$`);
36
39
  /* parse a single expression from the token stream */
37
40
  const parseValueExpr = (tokens, pos, nested) => {
38
41
  const token = tokens[pos.i++];
39
42
  if (token.type === "regex") {
40
43
  const source = String(token.value);
41
44
  try {
42
- return { kind: "regex", regex: new RegExp(source), source };
45
+ return { kind: "regex", regex: anchored(source) };
43
46
  }
44
47
  catch (err) {
45
48
  throw new Error(`invalid regular expression "/${source}/": ` +
@@ -85,7 +88,7 @@ const cache = new Map();
85
88
  export const compileValueExpr = (source) => {
86
89
  let expr = cache.get(source);
87
90
  if (expr === undefined) {
88
- const tokens = lexer.reset().input(source).tokens();
91
+ const tokens = lexer.input(source).tokens();
89
92
  const pos = { i: 0 };
90
93
  expr = parseValueExpr(tokens, pos, false);
91
94
  if (tokens[pos.i].type !== "EOF")
@@ -102,7 +105,7 @@ export const splitItems = (text) => {
102
105
  let bracketed = false;
103
106
  for (let i = 0; i < text.length; i++) {
104
107
  const char = text[i];
105
- if (char === "\"")
108
+ if (char === "\"" && text[i - 1] !== "\\")
106
109
  quoted = !quoted;
107
110
  if (!quoted && !bracketed && char === "[" && text[i + 1] === "[") {
108
111
  parts[parts.length - 1] += "[[";
@@ -1,8 +1,5 @@
1
1
  import { type Schema } from "./specbook-format-schema.js";
2
2
  import { type SourceFile, type ParseResult } from "./specbook-parse-common.js";
3
- export { type SourceFile, type ParseResult, embeddingRegex, embeddingMimeType, embeddingThemes, embeddingVariants } from "./specbook-parse-common.js";
4
- export declare class Parser {
5
- private ctx;
6
- parse(sources: SourceFile[], config?: Schema): ParseResult;
7
- }
3
+ export { type SourceFile, type ParseResult } from "./specbook-parse-common.js";
4
+ export { resolveArtifact } from "./specbook-parse-semantic.js";
8
5
  export declare const parseSpecification: (sources: SourceFile[], config?: Schema) => ParseResult;
@@ -10,38 +10,31 @@ import { ParseContext } from "./specbook-parse-common.js";
10
10
  import { parseFile } from "./specbook-parse-syntax.js";
11
11
  import { validate, validateReferences } from "./specbook-parse-semantic.js";
12
12
  import { validateDiagrams } from "./specbook-diagram.js";
13
- /* re-export the public parsing types and embedding helpers */
14
- export { embeddingRegex, embeddingMimeType, embeddingThemes, embeddingVariants } from "./specbook-parse-common.js";
15
- /* parser for a set of specification Markdown files */
16
- export class Parser {
17
- ctx = new ParseContext();
18
- /* parse all source files into the specification AST and
19
- optionally validate the result against a configuration */
20
- parse(sources, config) {
21
- /* reset the parsing context to allow a reuse of the parser */
22
- this.ctx = new ParseContext();
23
- /* parse all source files into their artifacts */
24
- const artifacts = new Array();
25
- for (const source of sources)
26
- artifacts.push(...parseFile(this.ctx, source));
27
- const specification = { artifacts };
28
- /* validate the resulting specification AST */
29
- if (artifacts.length > 0) {
30
- this.ctx.linkIndex = buildLinkIndex(specification);
31
- if (config !== undefined)
32
- validate(this.ctx, specification, config);
33
- validateReferences(this.ctx, specification);
34
- if (config !== undefined)
35
- validateDiagrams(this.ctx, specification, config);
36
- const result = v.safeParse(Spec, specification);
37
- if (!result.success)
38
- for (const issue of result.issues) {
39
- const path = (issue.path ?? []).map((item) => String(item.key)).join(".");
40
- this.ctx.diagnose(sources[0]?.file ?? "", 1, `internal AST invalid at "${path}": ${issue.message}`);
41
- }
42
- }
43
- return { specification, diagnostics: this.ctx.diagnostics };
13
+ export { resolveArtifact } from "./specbook-parse-semantic.js";
14
+ /* parse a set of specification Markdown files into the specification
15
+ AST and optionally validate the result against a configuration */
16
+ export const parseSpecification = (sources, config) => {
17
+ /* create a fresh parsing context for this parsing run */
18
+ const ctx = new ParseContext();
19
+ /* parse all source files into their artifacts */
20
+ const artifacts = new Array();
21
+ for (const source of sources)
22
+ artifacts.push(...parseFile(ctx, source));
23
+ const specification = { artifacts };
24
+ /* validate the resulting specification AST */
25
+ if (artifacts.length > 0) {
26
+ ctx.linkIndex = buildLinkIndex(specification);
27
+ if (config !== undefined)
28
+ validate(ctx, specification, config);
29
+ validateReferences(ctx, specification);
30
+ if (config !== undefined)
31
+ validateDiagrams(ctx, specification, config);
32
+ const result = v.safeParse(Spec, specification);
33
+ if (!result.success)
34
+ for (const issue of result.issues) {
35
+ const path = v.getDotPath(issue) ?? "";
36
+ ctx.diagnose(sources[0]?.file ?? "", 1, `internal AST invalid at "${path}": ${issue.message}`);
37
+ }
44
38
  }
45
- }
46
- /* convenience wrapper for one-shot parsing */
47
- export const parseSpecification = (sources, config) => new Parser().parse(sources, config);
39
+ return { specification, diagnostics: ctx.diagnostics };
40
+ };
@@ -8,9 +8,10 @@
8
8
  regular content of a verbose message */
9
9
  const begin = "\uE000";
10
10
  const end = "\uE001";
11
+ const marker = new RegExp(`${begin}([^${end}]*)${end}`, "g");
11
12
  /* mark a literal value (path, number, format, ...) inside a verbose
12
13
  message, so the output sink can style it without having to guess */
13
14
  export const literal = (value) => `${begin}${value}${end}`;
14
15
  /* render a verbose message by either styling its marked literal values
15
16
  with the given styler or just stripping their markers away */
16
- export const renderVerbose = (msg, style) => msg.replace(/\uE000([^\uE001]*)\uE001/g, (_, value) => style !== undefined ? style(value) : value);
17
+ export const renderVerbose = (msg, style) => msg.replace(marker, (_, value) => style !== undefined ? style(value) : value);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rse/specbook",
3
- "version": "0.9.6",
3
+ "version": "0.9.7",
4
4
  "publishConfig": { "access": "public" },
5
5
  "description": "Markdown-based Specification Format (API, CLI and MCP service)",
6
6
  "license": "Apache-2.0",