@rse/specbook 1.2.3 → 1.2.4

package/dst/specbook-format.yaml

@@ -232,7 +232,7 @@
             size-node-width-max: 440
             size-node-height-scale: 1.75
             grid-columns-max: 5
-    childs:
+    children:
         -   kind: PREMISE
             desc: >
                 A single premise, named with a short (3-8 word) summary phrased as the fact taken
@@ -307,7 +307,7 @@
         config:
             size-node-width-max: 440
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: TERM
             name: "[A-Z][A-Za-z0-9-]*( [A-Z][A-Za-z0-9-]*)*"
             desc: >
@@ -399,7 +399,7 @@
         config:
             size-node-width-max: 440
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: PERSONA
             desc: >
                 An archetypal user profile, named with a per-artifact unique first name of the
@@ -490,7 +490,7 @@
         nodes: "[[JOURNEY:*]]"
         properties:
             -   ACTORS
-    childs:
+    children:
         -   kind: JOURNEY
             desc: >
                 The end-to-end journey of a single persona (or of multiple personas sharing the same
@@ -501,7 +501,7 @@
                         Comma-separated references to the User Personas objects experiencing the
                         journey.
                     value: list([[PERSONA:*]])
-            childs:
+            children:
                 -   kind: STEP
                     desc: >
                         A single step of the journey, named with a 5-10 word summary of the step at
@@ -569,7 +569,7 @@
         config:
             size-node-width-max: 440
             grid-columns-max: 5
-    childs:
+    children:
         -   kind: REQUIREMENT
             desc: >
                 A single functional requirement, named with a short (3-8 word) summary and described
@@ -628,7 +628,7 @@
         config:
             size-node-width-max: 440
             grid-columns-max: 5
-    childs:
+    children:
         -   kind: REQUIREMENT
             desc: >
                 A single non-functional requirement, named with a short (3-8 word) summary and
@@ -703,7 +703,7 @@
         config:
             size-node-width-max: 440
             grid-columns-max: 5
-    childs:
+    children:
         -   kind: RULE
             desc: >
                 A single domain rule, named with a short (3-8 word) summary and described in a
@@ -806,7 +806,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: WORKFLOW
             desc: >
                 A single workflow, named with a short (2-5 word) summary phrased as the outcome
@@ -881,7 +881,7 @@
                         checked at a single handoff is referenced from the handoff instead.
                     value: list([[RULE:*]])
                     optional: true
-            childs:
+            children:
                 -   kind: ACTIVITY
                     desc: >
                         A single unit of work within the workflow, performed by one party without a
@@ -974,7 +974,7 @@
         config:
             size-node-height-scale: 4
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: USE-CASE
             desc: >
                 A discrete goal a user pursues with the solution, named with a short (3-8 word)
@@ -1056,7 +1056,7 @@
                     desc: >
                         The condition that holds after the use case completes successfully.
                     optional: true
-            childs:
+            children:
                 -   kind: SCENARIO
                     desc: >
                         A concrete step-by-step flow of the use case, named with a short (3-8 word)
@@ -1122,7 +1122,7 @@
         type: graph
         nodes: "[[DM.ENTITY:*]]"
         edges: "[[RELATION:*]]"
-    childs:
+    children:
         -   kind: ENTITY
             name: "[A-Z][a-zA-Z0-9]*"
             desc: >
@@ -1151,7 +1151,7 @@
                         is anchored in the ubiquitous language and every term shows its data.
                     value: list([[TERM:*]])
                     optional: true
-            childs:
+            children:
                 -   kind: ATTRIBUTE
                     name: "[a-z][a-zA-Z0-9]*"
                     desc: >
@@ -1264,7 +1264,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 5
-    childs:
+    children:
         -   kind: LIFECYCLE
             desc: >
                 The lifecycle of a single entity, named with the short (1-3 word) name of the
@@ -1297,7 +1297,7 @@
                         lifecycle per entity (an entity without a lifecycle has a trivial one).
                     value: "[[DM.ENTITY:*]]"
                     unique: true
-            childs:
+            children:
                 -   kind: STATE
                     name: "[A-Z][a-zA-Z0-9]*"
                     desc: >
@@ -1415,7 +1415,7 @@
         config:
             size-node-width-max: 440
             graph-channel-width-max: 340
-    childs:
+    children:
         -   kind: ROLE
             desc: >
                 A single role, named with the canonical name of the domain role it grants (e.g.
@@ -1461,7 +1461,7 @@
                     value: list([[ROLE:*]])
                     optional: true
                     acyclic: true
-            childs:
+            children:
                 -   kind: PERMISSION
                     desc: >
                         A single right of the role on a single entity, named with a short (2-5
@@ -1544,7 +1544,7 @@
         properties:
             -   KIND
             -   DIRECTION
-    childs:
+    children:
         -   kind: INTERFACE
             desc: >
                 A single interface, named with a short (2-5 word) summary (e.g. `Public REST API`,
@@ -1629,7 +1629,7 @@
         qualified: true
         config:
             size-node-width-max: 440
-    childs:
+    children:
         -   kind: TYPE
             name: "[A-Z][A-Za-z0-9_]*"
             desc: >
@@ -1691,7 +1691,7 @@
                         entities), tracing the interface into the data model.
                     value: list([[DM.ENTITY:*]])
                     optional: true
-            childs:
+            children:
                 -   kind: FIELD
                     name: "[A-Za-z_][A-Za-z0-9_-]*"
                     desc: >
@@ -1792,7 +1792,7 @@
         qualified: true
         config:
             size-node-width-max: 440
-    childs:
+    children:
         -   kind: ENDPOINT
             name: "[A-Za-z_][A-Za-z0-9_-]*"
             desc: >
@@ -1872,7 +1872,7 @@
                         realizes, tracing the requirements into the interface.
                     value: list([[USE-CASE:*]])
                     optional: true
-            childs:
+            children:
                 -   kind: OPTION
                     name: "-{0,2}[A-Za-z_][A-Za-z0-9_-]*"
                     desc: >
@@ -2034,7 +2034,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: PRINCIPLE
             desc: >
                 A single interaction principle, named with a short (2-5 word) summary (e.g.
@@ -2115,7 +2115,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: CONVENTION
             desc: >
                 A single language convention, named with a short (2-5 word) summary (e.g. `Neutral
@@ -2186,7 +2186,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: PATTERN
             desc: >
                 A single reusable dialog pattern, named with a short (2-5 word) summary (e.g.
@@ -2280,7 +2280,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: STORYBOARD
             desc: >
                 A single depicted dialog flow, named with a short (3-8 word) summary of the flow and
@@ -2312,7 +2312,7 @@
                         interface, omitted for a storyboard of a flow no scenario covers.
                     value: "[[SCENARIO:*]]"
                     optional: true
-            childs:
+            children:
                 -   kind: FRAME
                     desc: >
                         A single frame of the storyboard, named with a short (2-5 word) label for
@@ -2385,7 +2385,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: ELEMENT
             desc: >
                 A single visual design element, named with a short (2-5 word) summary (e.g. `Brand
@@ -2515,7 +2515,7 @@
         qualified: true
         properties:
             -   KIND
-    childs:
+    children:
         -   kind: ENTITY
             desc: >
                 A single external entity the solution interacts with, named with a short (2-5 word)
@@ -2614,7 +2614,7 @@
         labeled: true
         properties:
             -   KIND
-    childs:
+    children:
         -   kind: COMPONENT
             desc: >
                 A single functional component, named with a short (2-5 word) summary (e.g.
@@ -2718,7 +2718,7 @@
     diagram:
         type: grid
         nodes: "[[TS.TIER:*]]"
-    childs:
+    children:
         -   kind: TIER
             desc: |
                 The architectural tier grouping the technology components belonging to it, named
@@ -2742,7 +2742,7 @@
                 config:
                     size-node-width-max: 440
                     size-node-height-scale: 1.75
-            childs:
+            children:
                 -   kind: COMPONENT
                     desc: >
                         A single technology component, named with a short (2-5 word) summary (e.g.
@@ -3070,7 +3070,7 @@
         nodes: "[[ASPECT:*]]"
         properties:
             -   CATEGORY
-    childs:
+    children:
         -   kind: ASPECT
             desc: >
                 A single development aspect, named with a short (2-5 word) summary (e.g. `Module
@@ -3118,7 +3118,7 @@
         labeled: true
         properties:
             -   KIND
-    childs:
+    children:
         -   kind: UNIT
             desc: >
                 A single concurrency unit, named with a short (2-5 word) summary (e.g. `Web Worker
@@ -3214,7 +3214,7 @@
             -   PLATFORM
         config:
             size-node-width-max: 350
-    childs:
+    children:
         -   kind: TIER
             desc: >
                 A single deployment tier, named with a short (1-3 word) summary (e.g. `Client`,
@@ -3455,7 +3455,7 @@
         nodes: "[[CONCERN:*]]"
         properties:
             -   CATEGORY
-    childs:
+    children:
         -   kind: CONCERN
             desc: >
                 A single operational concern, named with a short (2-5 word) summary (e.g. `Rolling
@@ -3567,7 +3567,7 @@
         nodes: "[[TACTIC:*]]"
         properties:
             -   QUALITY
-    childs:
+    children:
         -   kind: TACTIC
             desc: >
                 A single quality tactic, one architectural tactic applied to one quality attribute
@@ -3691,7 +3691,7 @@
         config:
             size-node-width-max: 440
             grid-columns-max: 5
-    childs:
+    children:
         -   kind: DECISION
             desc: |
                 A single architecture decision, named with a short summary of the decision, not
@@ -3931,7 +3931,7 @@
             size-node-width-max: 440
             size-node-height-scale: 2
             grid-columns-max: 4
-    childs:
+    children:
         -   kind: TEST-CASE
             desc: >
                 A single verifiable test case, named with a short (3-8 word) summary and defined by

package/dst/specbook-link.js

@@ -55,7 +55,7 @@ export const buildLinkIndex = (specification) => {
     const walk = (object, parent) => {
         const node = { object, parent, pos: index.length, name: plainText(object.name) };
         index.push(node);
-        for (const child of object.childs)
+        for (const child of object.children)
             walk(child, node);
     };
     for (const artifact of specification.artifacts)
@@ -173,7 +173,7 @@ export const resolveUnique = (index, reference, from) => {
 };
 /*  derive the fully-qualified anchor path of every object: the
     "<kind>-<id>" segments (whitespace in kinds dashed) of the ancestor
-    chain joined with "." (the index lists parents before childs)  */
+    chain joined with "." (the index lists parents before children)  */
 export const anchorPaths = (index) => {
     const paths = new Map();
     for (const node of index) {

package/dst/specbook-parse-semantic.js

@@ -129,11 +129,11 @@ const parenProp = (object, props) => {
     values matching the regexp or enum expression of the flag), where
     a kind without any sibling fails a present flag, too, but only for
     an optional kind, as the missing-kind check reports a required one  */
-const checkSiblingFlags = (ctx, object, childs, meta) => {
+const checkSiblingFlags = (ctx, object, children, meta) => {
     const marker = (flag) => flag === undefined || flag === false ? undefined :
         { filter: typeof flag === "string" ? compileValueExpr(flag) : undefined };
-    for (const child of childs) {
-        const siblings = object.childs.filter((c) => c.kind === child.kind);
+    for (const child of children) {
+        const siblings = object.children.filter((c) => c.kind === child.kind);
         for (const prop of child.props ?? []) {
             const unique = marker(prop.unique);
             const present = marker(prop.present);
@@ -165,7 +165,7 @@ const checkSiblingFlags = (ctx, object, childs, meta) => {
         }
     }
 };
-/*  validate a single object (and recursively its childs) against its schema  */
+/*  validate a single object (and recursively its children) against its schema  */
 const validateObject = (ctx, object, schema, level) => {
     const meta = ctx.metaOf(object);
     const props = schema.props ?? [];
@@ -199,10 +199,10 @@ const validateObject = (ctx, object, schema, level) => {
         if (!props.some((p) => p.name === property.key))
             ctx.diagnose(meta.file, ctx.propMeta.get(property)?.line ?? meta.line, `unknown property "${property.key}" on ${object.kind} "${object.name}"`);
     /*  check the configured child objects  */
-    const childs = schema.childs ?? [];
-    for (const child of object.childs) {
+    const children = schema.children ?? [];
+    for (const child of object.children) {
         const childMeta = ctx.metaOf(child);
-        const childSchema = childs.find((c) => c.kind === child.kind);
+        const childSchema = children.find((c) => c.kind === child.kind);
         if (childSchema === undefined) {
             ctx.diagnose(childMeta.file, childMeta.line, `unknown object kind "${child.kind}" below ${object.kind} "${object.name}"`);
             continue;
@@ -210,20 +210,20 @@ const validateObject = (ctx, object, schema, level) => {
         validateObject(ctx, child, childSchema, level + 1);
     }
     /*  check the sibling-scoped property flags of the child kinds  */
-    checkSiblingFlags(ctx, object, childs, meta);
+    checkSiblingFlags(ctx, object, children, meta);
     /*  report the configured child object kinds which are missing  */
-    for (const child of childs)
+    for (const child of children)
         if (child.optional !== true
-            && !object.childs.some((c) => c.kind === child.kind))
+            && !object.children.some((c) => c.kind === child.kind))
             ctx.diagnose(meta.file, meta.line, `required object kind "${child.kind}" missing below ${object.kind} "${object.name}"`);
-    /*  order the childs and properties exactly along the schema
+    /*  order the children and properties exactly along the schema
         definition (the sort is stable, so objects of the same kind
         and unknown items keep their document order)  */
     const kindPos = (kind) => {
-        const i = childs.findIndex((c) => c.kind === kind);
-        return i >= 0 ? i : childs.length;
+        const i = children.findIndex((c) => c.kind === kind);
+        return i >= 0 ? i : children.length;
     };
-    object.childs.sort((a, b) => kindPos(a.kind) - kindPos(b.kind));
+    object.children.sort((a, b) => kindPos(a.kind) - kindPos(b.kind));
     const propPos = (key) => {
         const i = props.findIndex((p) => p.name === key);
         return i >= 0 ? i : props.length;
@@ -242,8 +242,8 @@ export const collectSchemas = (specification, config) => {
     const schemas = new Map();
     const walk = (object, schema) => {
         schemas.set(object, schema);
-        for (const child of object.childs) {
-            const childSchema = (schema.childs ?? []).find((c) => c.kind === child.kind);
+        for (const child of object.children) {
+            const childSchema = (schema.children ?? []).find((c) => c.kind === child.kind);
             if (childSchema !== undefined)
                 walk(child, childSchema);
         }
@@ -284,7 +284,7 @@ const checkIds = (ctx, objects) => {
             const meta = ctx.metaOf(object);
             ctx.diagnose(meta.file, meta.line, `id "${object.id}" of ${object.kind} "${object.name}" collides with preceding ${object.kind} "${first.name}"`);
         }
-        checkIds(ctx, object.childs);
+        checkIds(ctx, object.children);
     }
 };
 /*  the objects a property of an object references (resolved and
@@ -317,7 +317,7 @@ const checkAutomata = (ctx, schemas) => {
         const automaton = schema.automaton;
         if (automaton === undefined)
             continue;
-        const nodes = object.childs.filter((child) => child.kind === automaton.nodes);
+        const nodes = object.children.filter((child) => child.kind === automaton.nodes);
         const nodeSet = new Set(nodes);
         const flagged = (node, name) => {
             const property = findProp(ctx, node, name);
@@ -329,7 +329,7 @@ const checkAutomata = (ctx, schemas) => {
             the node set is skipped, as the property checks report it)  */
         const succs = new Map(nodes.map((node) => [node, new Set()]));
         const preds = new Map(nodes.map((node) => [node, new Set()]));
-        for (const edge of object.childs.filter((child) => child.kind === automaton.edges)) {
+        for (const edge of object.children.filter((child) => child.kind === automaton.edges)) {
             const source = referencedObjects(ctx, edge, automaton.source)[0];
             const target = referencedObjects(ctx, edge, automaton.target)[0];
             if (source !== undefined && target !== undefined && nodeSet.has(source) && nodeSet.has(target)) {
@@ -446,7 +446,7 @@ const checkReferenced = (ctx, specification, schemas) => {
                 if (target !== undefined && !chain.includes(target))
                     referrers.set(target, (referrers.get(target) ?? new Set()).add(object));
             }
-        object.childs.forEach(walk);
+        object.children.forEach(walk);
     };
     for (const artifact of specification.artifacts)
         artifact.objects.forEach(walk);
@@ -494,7 +494,7 @@ export const validate = (ctx, specification, config) => {
             references all over the corpus  */
         if (object.paren !== undefined && object.anchor === undefined && !ctx.parenProps.has(object))
             assignId(ctx.linkIndex, object, object.paren);
-        object.childs.forEach(promote);
+        object.children.forEach(promote);
     };
     for (const artifact of specification.artifacts)
         artifact.objects.forEach(promote);
@@ -554,7 +554,7 @@ export const validateReferences = (ctx, specification) => {
             if (object.description.rationale !== undefined)
                 check(object, object.description.rationale, meta.file, meta.line);
         }
-        object.childs.forEach(walk);
+        object.children.forEach(walk);
     };
     for (const artifact of specification.artifacts)
         artifact.objects.forEach(walk);

package/dst/specbook-parse-syntax.js

@@ -150,7 +150,7 @@ const embed = (ctx, object, file) => {
         load(object.description, object.description.description, line);
     for (const property of object.properties)
         load(property, property.value, ctx.propMeta.get(property)?.line ?? line);
-    for (const child of object.childs)
+    for (const child of object.children)
         embed(ctx, child, file);
 };
 /*  parse an unordered list of key-values and/or concise-format objects  */
@@ -229,7 +229,7 @@ const parseConcise = (ctx, item, parent, file, line, group) => {
         id: anchor ?? slugify(name),
         name,
         properties: [],
-        childs: []
+        children: []
     };
     if (anchor !== undefined)
         object.anchor = anchor;
@@ -267,7 +267,7 @@ const parseConcise = (ctx, item, parent, file, line, group) => {
             ctx.diagnose(file, subLine, `nested ordered list below ${kind} "${name}" ignored`);
         subLine += (sub.raw.match(/\n/g) ?? []).length;
     }
-    parent.childs.push(object);
+    parent.children.push(object);
 };
 /*  parse a heading token into either a grouping container (e.g. "### STATE",
     collecting objects of its kind below the parent object) or a new object
@@ -298,7 +298,7 @@ const parseHeading = (ctx, token, state, stamps, file, line) => {
         id: heading.id ?? (depth === 1 ? heading.paren : undefined) ?? slugify(heading.name),
         name: heading.name,
         properties: [],
-        childs: []
+        children: []
     };
     if (heading.id !== undefined)
         object.anchor = heading.id;
@@ -310,7 +310,7 @@ const parseHeading = (ctx, token, state, stamps, file, line) => {
     if (parent === undefined)
         state.artifacts.push({ ...stamps, objects: [object] });
     else
-        parent.childs.push(object);
+        parent.children.push(object);
     state.stack.length = depth - 1;
     state.stack[depth - 1] = object;
     state.current = object;

package/dst/specbook-parse.js

@@ -51,7 +51,7 @@ export const specStatistics = (specification) => {
             texts.push(object.description.description, object.description.rationale ?? "");
         for (const text of texts)
             links += (plainText(text).match(referenceRegex) ?? []).length;
-        object.childs.forEach(walk);
+        object.children.forEach(walk);
     };
     for (const artifact of specification.artifacts)
         artifact.objects.forEach(walk);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name":                                "@rse/specbook",
-    "version":                             "1.2.3",
+    "version":                             "1.2.4",
     "publishConfig":                       { "access": "public" },
     "description":                         "Markdown-based Specification Format (API, CLI and MCP service)",
     "license":                             "Apache-2.0",
@@ -36,7 +36,7 @@
         "source-code-error":               "1.2.0",
         "commander":                       "15.0.0",
         "chalk":                           "6.0.0",
-        "chokidar":                        "5.0.0",
+        "chokidar5":                       "npm:chokidar@5.0.0",
         "glob":                            "13.0.6",
         "es-toolkit":                      "1.52.0",
         "fastify":                         "5.12.3",