yarramate 0.11.0 → 0.12.0

package/dist/adapters/likec4-cli.js

@@ -712,6 +712,9 @@ export function runLikeC4Cli(args, cwd = process.cwd()) {
                 ? [
                     {
                         ...(view.id === undefined ? {} : { id: view.id }),
+                        ...(view.folder === undefined
+                            ? {}
+                            : { folder: view.folder }),
                         prepared,
                         ...(view.compare === undefined
                             ? {}

package/dist/adapters/likec4-project.d.ts

@@ -11,6 +11,7 @@ export interface LikeC4ProjectDefinition {
     readonly views: ReadonlyArray<{
         readonly id?: string;
         readonly projection: string;
+        readonly folder?: string;
         readonly compare?: {
             readonly from: string;
             readonly to: string;
@@ -40,6 +41,7 @@ export interface LikeC4Deployment {
 export declare const loadLikeC4ProjectDefinition: (source: WorkspaceSource) => import("../source-document.js").SourceDocumentResult<LikeC4ProjectDefinition>;
 export interface PreparedLikeC4ProjectView {
     readonly id?: string;
+    readonly folder?: string;
     readonly prepared: Extract<LikeC4PreparationResult, {
         readonly ok: true;
     }>;

package/dist/adapters/likec4-project.js

@@ -8,6 +8,15 @@ const Ajv2020 = Ajv2020Module.default;
 const validateLikeC4Project = new Ajv2020({ allErrors: true }).compile(likeC4ProjectSchema);
 export const loadLikeC4ProjectDefinition = (source) => loadSourceDocument(source, validateLikeC4Project, 'LikeC4 project');
 const quote = (value) => `'${value.replaceAll('\\', '\\\\').replaceAll("'", "\\'").replaceAll('\n', '\\n')}'`;
+// A folder files the view in LikeC4's sidebar tree: the title becomes a
+// path ('Folder / Title') whose last segment is the displayed title (ADR
+// 0067). A view without a declared title still needs a title line to
+// carry the path, so the view id stands in as the leaf.
+const titleLines = (folder, title, viewId) => folder === undefined
+    ? title === undefined
+        ? []
+        : [`    title ${quote(title)}`]
+    : [`    title ${quote(`${folder} / ${title ?? viewId}`)}`];
 const unionProjection = (project, views) => ({
     format: 'yarramate/projection-result/v1',
     projection: `${project.id}@${project.version}`,
@@ -28,7 +37,7 @@ const unionProjection = (project, views) => ({
         ...new Map(views.flatMap(({ prepared }) => prepared.projection.claims.map((claim) => [claim.id, claim]))).values(),
     ].sort((left, right) => left.id.localeCompare(right.id)),
 });
-const viewBody = ({ id, prepared, dynamic, deployment, }, gitChange) => {
+const viewBody = ({ id, folder, prepared, dynamic, deployment, }, gitChange) => {
     const source = prepared.source;
     const startToken = '\nviews {\n';
     const start = source.indexOf(startToken);
@@ -58,9 +67,7 @@ const viewBody = ({ id, prepared, dynamic, deployment, }, gitChange) => {
         const viewId = id ?? prepared.projection.projection.split('@')[0];
         return [
             `  deployment view ${viewId} {`,
-            ...(prepared.projection.presentation?.title === undefined
-                ? []
-                : [`    title ${quote(prepared.projection.presentation.title)}`]),
+            ...titleLines(folder, prepared.projection.presentation?.title, viewId),
             ...(prepared.projection.presentation?.description === undefined
                 ? []
                 : [
@@ -105,9 +112,7 @@ const viewBody = ({ id, prepared, dynamic, deployment, }, gitChange) => {
         const viewId = id ?? prepared.projection.projection.split('@')[0];
         return [
             `  dynamic view ${viewId} {`,
-            ...(prepared.projection.presentation?.title === undefined
-                ? []
-                : [`    title ${quote(prepared.projection.presentation.title)}`]),
+            ...titleLines(folder, prepared.projection.presentation?.title, viewId),
             ...(prepared.projection.presentation?.description === undefined
                 ? []
                 : [
@@ -140,10 +145,17 @@ const viewBody = ({ id, prepared, dynamic, deployment, }, gitChange) => {
         ...relationshipRules,
         ...overlayRules,
     ].join('\n');
-    return source
+    const viewId = id ?? prepared.projection.projection.split('@')[0];
+    const body = source
         .slice(start + startToken.length, end)
-        .replace(/^  view [A-Za-z_][A-Za-z0-9_-]* \{/, `  view ${id ?? prepared.projection.projection.split('@')[0]} {`)
+        .replace(/^  view [A-Za-z_][A-Za-z0-9_-]* \{/, `  view ${viewId} {`)
         .replace('    include *', membershipRules);
+    if (folder === undefined)
+        return body;
+    const title = prepared.projection.presentation?.title;
+    return title === undefined
+        ? body.replace(`  view ${viewId} {`, `  view ${viewId} {\n${titleLines(folder, undefined, viewId).join('\n')}`)
+        : body.replace(`    title ${quote(title)}`, titleLines(folder, title, viewId).join('\n'));
 };
 const deploymentBody = ({ deployment, prepared, }) => {
     if (deployment === undefined)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yarramate",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Tool-neutral semantic architecture engine and guided methodology",
   "license": "MIT",
   "repository": {

package/schema/yarramate-likec4-project.schema.json

@@ -72,6 +72,11 @@
         "projection": {
           "$ref": "#/$defs/path"
         },
+        "folder": {
+          "type": "string",
+          "description": "Sidebar folder for the rendered view, emitted as a LikeC4 title path ('Folder / Title'). Nest with '/' separators; folders appear in the order their first view appears in the views list.",
+          "pattern": "^[^/]+(?:/[^/]+)*$"
+        },
         "compare": {
           "$ref": "#/$defs/comparison"
         },