root-at-skic
7a2b661afe
A folder with main.archify at its top is a model, a set of diagrams that belong together. Opening main.archify shows the model page: the model's name and description, its own overview diagram when the file has one, the diagrams grouped by folder (click to open), and the registry with where each element is used. The page is built by traversing the folder tree and refreshes when files change. *.archify-registry files define shared elements once; diagrams draw them with `ref: <id>` plus position and may override label, sublabel and tag. References are resolved before Archify runs, so Archify is unchanged. Hover, go-to-definition and completion on ref; unknown names, forbidden overrides, duplicate ids and broken registries in Problems; registry edits re-render open diagrams. `diagram:` links on elements and components open the linked diagram on double-click. New command Archify | Open Model, a Model template for New Diagram…, editor schemas for the new keys and for registries, docs/model.md and examples/online-shop. Single diagrams behave exactly as before.
72 lines
3.6 KiB
TypeScript
72 lines
3.6 KiB
TypeScript
import { isMap, parseDocument } from 'yaml';
|
|
import { DiagramType } from '../sources/detect';
|
|
|
|
export interface DiagramTemplate {
|
|
/** File name under templates/. */
|
|
file: string;
|
|
type: DiagramType;
|
|
label: string;
|
|
description: string;
|
|
/** Suggested name for the new file, without .archify. */
|
|
defaultName: string;
|
|
/** Reserved file name; the user is not asked for one. */
|
|
fixedName?: string;
|
|
}
|
|
|
|
export const TEMPLATES: readonly DiagramTemplate[] = [
|
|
{ file: 'architecture.archify', type: 'architecture', label: 'Architecture', description: 'Parts of a system and how they connect', defaultName: 'architecture' },
|
|
{ file: 'workflow.archify', type: 'workflow', label: 'Workflow', description: 'Steps of a process, in lanes', defaultName: 'workflow' },
|
|
{ file: 'sequence.archify', type: 'sequence', label: 'Sequence', description: 'Who calls whom, in order', defaultName: 'sequence' },
|
|
{ file: 'dataflow.archify', type: 'dataflow', label: 'Data Flow', description: 'Where data comes from and where it goes', defaultName: 'dataflow' },
|
|
{ file: 'lifecycle.archify', type: 'lifecycle', label: 'Lifecycle', description: 'States something moves through', defaultName: 'lifecycle' },
|
|
{ file: 'everyday-plan.archify', type: 'workflow', label: 'Everyday Plan', description: 'A plan or process from daily life', defaultName: 'plan' },
|
|
{ file: 'model.archify', type: 'architecture', label: 'Model (main.archify)', description: 'Entry point of a folder of diagrams that belong together', defaultName: 'main', fixedName: 'main.archify' },
|
|
];
|
|
|
|
/** Strips a typed .archify suffix and surrounding spaces. */
|
|
export function diagramName(input: string): string {
|
|
return input.trim().replace(/\.archify$/i, '').trim();
|
|
}
|
|
|
|
/** Why a name cannot be used as a file name, or undefined when it can. */
|
|
export function invalidNameReason(input: string): string | undefined {
|
|
const name = diagramName(input);
|
|
if (!name) return 'Enter a name.';
|
|
if (/[\\/:*?"<>|\u0000-\u001f]/.test(name)) return 'A name cannot contain \\ / : * ? " < > | or control characters.';
|
|
if (/^\.+$/.test(name)) return 'Enter a name.';
|
|
return undefined;
|
|
}
|
|
|
|
/** "sales-report_v2" → "Sales report v2". */
|
|
export function titleFromName(name: string): string {
|
|
const words = name.replace(/[-_.]+/g, ' ').replace(/\s+/g, ' ').trim();
|
|
return words ? words.charAt(0).toUpperCase() + words.slice(1) : name;
|
|
}
|
|
|
|
/** "online-shop" → "online-shop"; "My Shop 2" → "my-shop-2": a model id from a folder name. */
|
|
export function modelIdFromName(name: string): string {
|
|
const id = name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
|
|
return /^[a-z]/.test(id) ? id : `m-${id || 'model'}`;
|
|
}
|
|
|
|
/** The model template with id, name and overview title taken from the folder name. */
|
|
export function modelFromTemplate(templateText: string, folderName: string): string {
|
|
const doc = parseDocument(templateText);
|
|
doc.setIn(['model', 'id'], modelIdFromName(folderName));
|
|
doc.setIn(['model', 'name'], titleFromName(folderName));
|
|
doc.setIn(['meta', 'title'], `${titleFromName(folderName)} overview`);
|
|
return doc.toString({ lineWidth: 0, flowCollectionPadding: false });
|
|
}
|
|
|
|
/**
|
|
* Template YAML with meta.title and meta.output set for the new file.
|
|
* Works on the YAML document so the template's comments and layout stay.
|
|
*/
|
|
export function diagramFromTemplate(templateText: string, name: string): string {
|
|
const doc = parseDocument(templateText);
|
|
if (!isMap(doc.get('meta'))) doc.set('meta', doc.createNode({}));
|
|
doc.setIn(['meta', 'title'], titleFromName(name));
|
|
doc.setIn(['meta', 'output'], `${name}.html`);
|
|
return doc.toString({ lineWidth: 0, flowCollectionPadding: false });
|
|
}
|