archimaid 0.0.0-stage → 0.1.1
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/CHANGELOG.md +39 -0
- package/FOUNDATION.md +108 -0
- package/LICENSE +21 -0
- package/README.md +271 -2
- package/dist/archimate/catalogue.d.ts +106 -0
- package/dist/archimate/catalogue.js +219 -0
- package/dist/archimate/catalogue.js.map +1 -0
- package/dist/archimate/diagnostics.d.ts +48 -0
- package/dist/archimate/diagnostics.js +64 -0
- package/dist/archimate/diagnostics.js.map +1 -0
- package/dist/archimate/frontmatter.d.ts +13 -0
- package/dist/archimate/frontmatter.js +62 -0
- package/dist/archimate/frontmatter.js.map +1 -0
- package/dist/archimate/grammar.d.ts +60 -0
- package/dist/archimate/grammar.js +273 -0
- package/dist/archimate/grammar.js.map +1 -0
- package/dist/archimate/lexer.d.ts +91 -0
- package/dist/archimate/lexer.js +215 -0
- package/dist/archimate/lexer.js.map +1 -0
- package/dist/archimate/model.d.ts +46 -0
- package/dist/archimate/model.js +2 -0
- package/dist/archimate/model.js.map +1 -0
- package/dist/archimate/nesting.d.ts +14 -0
- package/dist/archimate/nesting.js +84 -0
- package/dist/archimate/nesting.js.map +1 -0
- package/dist/archimate/parser.d.ts +14 -0
- package/dist/archimate/parser.js +53 -0
- package/dist/archimate/parser.js.map +1 -0
- package/dist/archimate/suggestions.d.ts +1 -0
- package/dist/archimate/suggestions.js +44 -0
- package/dist/archimate/suggestions.js.map +1 -0
- package/dist/archimate/validate.d.ts +4 -0
- package/dist/archimate/validate.js +402 -0
- package/dist/archimate/validate.js.map +1 -0
- package/dist/bundle/archimaid.esm.min.mjs +1 -0
- package/dist/bundle/chunks/archimateDiagram-WUCF6KHR.mjs +132 -0
- package/dist/bundle/chunks/chunk-QBMRZFD3.mjs +1 -0
- package/dist/bundle/chunks/elk.bundled-2VSLVJGB.mjs +26 -0
- package/dist/cli/render.d.ts +10 -0
- package/dist/cli/render.js +102 -0
- package/dist/cli/render.js.map +1 -0
- package/dist/cli/report.d.ts +20 -0
- package/dist/cli/report.js +39 -0
- package/dist/cli/report.js.map +1 -0
- package/dist/cli/sources.d.ts +19 -0
- package/dist/cli/sources.js +86 -0
- package/dist/cli/sources.js.map +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +137 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/language.d.ts +5 -0
- package/dist/language.js +3 -0
- package/dist/language.js.map +1 -0
- package/dist/mermaid/archimateDetector.d.ts +12 -0
- package/dist/mermaid/archimateDetector.js +29 -0
- package/dist/mermaid/archimateDetector.js.map +1 -0
- package/dist/mermaid/archimateDiagram.d.ts +9 -0
- package/dist/mermaid/archimateDiagram.js +75 -0
- package/dist/mermaid/archimateDiagram.js.map +1 -0
- package/dist/mermaid/archimateRenderer.d.ts +6 -0
- package/dist/mermaid/archimateRenderer.js +40 -0
- package/dist/mermaid/archimateRenderer.js.map +1 -0
- package/dist/mermaid/architectureLayout.d.ts +50 -0
- package/dist/mermaid/architectureLayout.js +144 -0
- package/dist/mermaid/architectureLayout.js.map +1 -0
- package/dist/mermaid/geometry.d.ts +3 -0
- package/dist/mermaid/geometry.js +20 -0
- package/dist/mermaid/geometry.js.map +1 -0
- package/dist/mermaid/hierarchy.d.ts +1 -0
- package/dist/mermaid/hierarchy.js +8 -0
- package/dist/mermaid/hierarchy.js.map +1 -0
- package/dist/mermaid/invariant.d.ts +1 -0
- package/dist/mermaid/invariant.js +7 -0
- package/dist/mermaid/invariant.js.map +1 -0
- package/dist/mermaid/orthogonalRouter.d.ts +4 -0
- package/dist/mermaid/orthogonalRouter.js +249 -0
- package/dist/mermaid/orthogonalRouter.js.map +1 -0
- package/dist/mermaid/relationshipPlacement.d.ts +3 -0
- package/dist/mermaid/relationshipPlacement.js +350 -0
- package/dist/mermaid/relationshipPlacement.js.map +1 -0
- package/dist/mermaid/render/draw.d.ts +17 -0
- package/dist/mermaid/render/draw.js +275 -0
- package/dist/mermaid/render/draw.js.map +1 -0
- package/dist/mermaid/render/elkRoutes.d.ts +6 -0
- package/dist/mermaid/render/elkRoutes.js +216 -0
- package/dist/mermaid/render/elkRoutes.js.map +1 -0
- package/dist/mermaid/render/graph.d.ts +17 -0
- package/dist/mermaid/render/graph.js +200 -0
- package/dist/mermaid/render/graph.js.map +1 -0
- package/dist/mermaid/render/labels.d.ts +12 -0
- package/dist/mermaid/render/labels.js +148 -0
- package/dist/mermaid/render/labels.js.map +1 -0
- package/dist/mermaid/render/layout.d.ts +12 -0
- package/dist/mermaid/render/layout.js +60 -0
- package/dist/mermaid/render/layout.js.map +1 -0
- package/dist/mermaid/render/measure.d.ts +16 -0
- package/dist/mermaid/render/measure.js +96 -0
- package/dist/mermaid/render/measure.js.map +1 -0
- package/dist/mermaid/render/place.d.ts +20 -0
- package/dist/mermaid/render/place.js +63 -0
- package/dist/mermaid/render/place.js.map +1 -0
- package/dist/mermaid/render/route.d.ts +29 -0
- package/dist/mermaid/render/route.js +113 -0
- package/dist/mermaid/render/route.js.map +1 -0
- package/dist/mermaid/render/shared.d.ts +83 -0
- package/dist/mermaid/render/shared.js +52 -0
- package/dist/mermaid/render/shared.js.map +1 -0
- package/dist/mermaid/render/svg.d.ts +6 -0
- package/dist/mermaid/render/svg.js +33 -0
- package/dist/mermaid/render/svg.js.map +1 -0
- package/dist/mermaid/render/viewport.d.ts +14 -0
- package/dist/mermaid/render/viewport.js +58 -0
- package/dist/mermaid/render/viewport.js.map +1 -0
- package/dist/mermaid/routing/anchors.d.ts +14 -0
- package/dist/mermaid/routing/anchors.js +134 -0
- package/dist/mermaid/routing/anchors.js.map +1 -0
- package/dist/mermaid/routing/bundles.d.ts +14 -0
- package/dist/mermaid/routing/bundles.js +94 -0
- package/dist/mermaid/routing/bundles.js.map +1 -0
- package/dist/mermaid/routing/congestion.d.ts +8 -0
- package/dist/mermaid/routing/congestion.js +70 -0
- package/dist/mermaid/routing/congestion.js.map +1 -0
- package/dist/mermaid/routing/constants.d.ts +13 -0
- package/dist/mermaid/routing/constants.js +17 -0
- package/dist/mermaid/routing/constants.js.map +1 -0
- package/dist/mermaid/routing/primitives.d.ts +33 -0
- package/dist/mermaid/routing/primitives.js +110 -0
- package/dist/mermaid/routing/primitives.js.map +1 -0
- package/dist/mermaid/routing/search.d.ts +4 -0
- package/dist/mermaid/routing/search.js +171 -0
- package/dist/mermaid/routing/search.js.map +1 -0
- package/dist/mermaid/routing/shapes.d.ts +8 -0
- package/dist/mermaid/routing/shapes.js +82 -0
- package/dist/mermaid/routing/shapes.js.map +1 -0
- package/dist/mermaid/routing/types.d.ts +37 -0
- package/dist/mermaid/routing/types.js +14 -0
- package/dist/mermaid/routing/types.js.map +1 -0
- package/dist/mermaid/styles.d.ts +89 -0
- package/dist/mermaid/styles.js +166 -0
- package/dist/mermaid/styles.js.map +1 -0
- package/docs/reference.md +86 -0
- package/examples/cross-layer-relationships.mmd +79 -0
- package/examples/cross-layer-relationships.svg +33 -0
- package/examples/element-preview.svg +1 -0
- package/examples/nested-components.mmd +21 -0
- package/examples/nested-components.svg +4 -0
- package/examples/order-fulfilment.mmd +10 -0
- package/examples/order-management.mmd +15 -0
- package/examples/order-management.svg +2 -0
- package/package.json +91 -4
- package/skills/archimaid/SKILL.md +123 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { ArchiMateBackground } from '../index.js';
|
|
2
|
+
export declare class RenderSetupError extends Error {
|
|
3
|
+
}
|
|
4
|
+
export declare const mermaidThemes: readonly ["default", "base", "dark", "forest", "neutral"];
|
|
5
|
+
export type MermaidTheme = (typeof mermaidThemes)[number];
|
|
6
|
+
export interface RenderOptions {
|
|
7
|
+
readonly theme: MermaidTheme | undefined;
|
|
8
|
+
readonly background: ArchiMateBackground;
|
|
9
|
+
}
|
|
10
|
+
export declare function renderSvg(source: string, { theme, background }: RenderOptions): Promise<string>;
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { dirname, extname, isAbsolute, relative, resolve, sep } from 'node:path';
|
|
3
|
+
import { fileURLToPath } from 'node:url';
|
|
4
|
+
export class RenderSetupError extends Error {
|
|
5
|
+
}
|
|
6
|
+
export const mermaidThemes = ['default', 'base', 'dark', 'forest', 'neutral'];
|
|
7
|
+
const origin = 'http://archimate.render';
|
|
8
|
+
// Marker IDs derive from the diagram ID; keeping the ID of the earlier render script keeps committed example SVGs stable.
|
|
9
|
+
const diagramId = 'archimate-example';
|
|
10
|
+
const contentTypes = {
|
|
11
|
+
'.mjs': 'text/javascript',
|
|
12
|
+
'.js': 'text/javascript',
|
|
13
|
+
'.css': 'text/css',
|
|
14
|
+
'.json': 'application/json',
|
|
15
|
+
};
|
|
16
|
+
function mermaidDirectory() {
|
|
17
|
+
try {
|
|
18
|
+
return dirname(fileURLToPath(import.meta.resolve('mermaid')));
|
|
19
|
+
}
|
|
20
|
+
catch (error) {
|
|
21
|
+
throw new RenderSetupError('archimaid render needs Mermaid. Install it with: npm install mermaid', {
|
|
22
|
+
cause: error,
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
async function launchChromium() {
|
|
27
|
+
let chromium;
|
|
28
|
+
try {
|
|
29
|
+
({ chromium } = await import('playwright'));
|
|
30
|
+
}
|
|
31
|
+
catch (error) {
|
|
32
|
+
throw new RenderSetupError('archimaid render needs Playwright. Install it with: npm install --save-dev playwright && npx playwright install chromium', { cause: error });
|
|
33
|
+
}
|
|
34
|
+
try {
|
|
35
|
+
return await chromium.launch();
|
|
36
|
+
}
|
|
37
|
+
catch (error) {
|
|
38
|
+
throw new RenderSetupError('Playwright could not start Chromium. Install it with: npx playwright install chromium', { cause: error });
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
function isInside(root, file) {
|
|
42
|
+
const path = relative(root, file);
|
|
43
|
+
return path !== '..' && !path.startsWith('..' + sep) && !isAbsolute(path);
|
|
44
|
+
}
|
|
45
|
+
// The page loads Mermaid's and this package's prebuilt ES modules, so rendering needs no bundler.
|
|
46
|
+
async function serveModules(route, roots) {
|
|
47
|
+
const { pathname } = new URL(route.request().url());
|
|
48
|
+
const [, mount = '', ...rest] = pathname.split('/');
|
|
49
|
+
const root = roots[mount];
|
|
50
|
+
const file = root === undefined ? undefined : resolve(root, ...rest.map(decodeURIComponent));
|
|
51
|
+
if (root === undefined || file === undefined || !isInside(root, file)) {
|
|
52
|
+
await route.fulfill({ status: 404 });
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
try {
|
|
56
|
+
const body = await readFile(file);
|
|
57
|
+
await route.fulfill({ body, contentType: contentTypes[extname(file)] ?? 'application/octet-stream' });
|
|
58
|
+
}
|
|
59
|
+
catch {
|
|
60
|
+
await route.fulfill({ status: 404 });
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
export async function renderSvg(source, { theme, background }) {
|
|
64
|
+
const roots = {
|
|
65
|
+
mermaid: mermaidDirectory(),
|
|
66
|
+
plugin: fileURLToPath(new URL('../bundle/', import.meta.url)),
|
|
67
|
+
};
|
|
68
|
+
const browser = await launchChromium();
|
|
69
|
+
try {
|
|
70
|
+
const page = await browser.newPage();
|
|
71
|
+
await page.route(`${origin}/**`, (route) => serveModules(route, roots));
|
|
72
|
+
await page.route(`${origin}/`, (route) => route.fulfill({
|
|
73
|
+
contentType: 'text/html',
|
|
74
|
+
body: '<!doctype html><meta charset="utf-8"><title>ArchiMate render</title>',
|
|
75
|
+
}));
|
|
76
|
+
await page.goto(`${origin}/`);
|
|
77
|
+
const input = {
|
|
78
|
+
source,
|
|
79
|
+
mermaidUrl: `${origin}/mermaid/mermaid.esm.min.mjs`,
|
|
80
|
+
pluginUrl: `${origin}/plugin/archimaid.esm.min.mjs`,
|
|
81
|
+
config: { startOnLoad: false, securityLevel: 'strict', ...(theme !== undefined && { theme }) },
|
|
82
|
+
background,
|
|
83
|
+
diagramId,
|
|
84
|
+
};
|
|
85
|
+
return await page.evaluate(async ({ source, mermaidUrl, pluginUrl, config, background, diagramId }) => {
|
|
86
|
+
const { default: mermaid } = (await import(mermaidUrl));
|
|
87
|
+
const plugin = (await import(pluginUrl));
|
|
88
|
+
mermaid.initialize(config);
|
|
89
|
+
await mermaid.registerExternalDiagrams([plugin.createArchiMatePlugin({ useMaxWidth: false, background })]);
|
|
90
|
+
const { svg } = await mermaid.render(diagramId, source);
|
|
91
|
+
// Mermaid serializes for HTML. Export XML so that standalone SVG viewers accept every label.
|
|
92
|
+
const root = new DOMParser().parseFromString(svg, 'text/html').querySelector('svg');
|
|
93
|
+
if (!root)
|
|
94
|
+
throw new Error('Mermaid did not return an SVG diagram.');
|
|
95
|
+
return new XMLSerializer().serializeToString(root);
|
|
96
|
+
}, input);
|
|
97
|
+
}
|
|
98
|
+
finally {
|
|
99
|
+
await browser.close();
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
//# sourceMappingURL=render.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/cli/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,MAAM,OAAO,gBAAiB,SAAQ,KAAK;CAAG;AAE9C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAQvF,MAAM,MAAM,GAAG,yBAAyB,CAAC;AACzC,0HAA0H;AAC1H,MAAM,SAAS,GAAG,mBAAmB,CAAC;AACtC,MAAM,YAAY,GAAqC;IACrD,MAAM,EAAE,iBAAiB;IACzB,KAAK,EAAE,iBAAiB;IACxB,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,kBAAkB;CAC5B,CAAC;AAEF,SAAS,gBAAgB;IACvB,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,gBAAgB,CAAC,sEAAsE,EAAE;YACjG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc;IAC3B,IAAI,QAA8C,CAAC;IACnD,IAAI,CAAC;QACH,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,gBAAgB,CACxB,0HAA0H,EAC1H,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;IACJ,CAAC;IACD,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,gBAAgB,CACxB,uFAAuF,EACvF,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY,EAAE,IAAY;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,OAAO,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC5E,CAAC;AAED,kGAAkG;AAClG,KAAK,UAAU,YAAY,CAAC,KAAY,EAAE,KAAuC;IAC/E,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IACpD,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC7F,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;QACtE,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IACxG,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAWD,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAc,EAAE,EAAE,KAAK,EAAE,UAAU,EAAiB;IAClF,MAAM,KAAK,GAAG;QACZ,OAAO,EAAE,gBAAgB,EAAE;QAC3B,MAAM,EAAE,aAAa,CAAC,IAAI,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAC9D,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,cAAc,EAAE,CAAC;IACvC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACxE,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CACvC,KAAK,CAAC,OAAO,CAAC;YACZ,WAAW,EAAE,WAAW;YACxB,IAAI,EAAE,sEAAsE;SAC7E,CAAC,CACH,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;QAC9B,MAAM,KAAK,GAAc;YACvB,MAAM;YACN,UAAU,EAAE,GAAG,MAAM,8BAA8B;YACnD,SAAS,EAAE,GAAG,MAAM,+BAA+B;YACnD,MAAM,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE;YAC9F,UAAU;YACV,SAAS;SACV,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAa,EAAE,EAAE;YAC/G,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAyB,CAAC;YAChF,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAA4D,CAAC;YACpG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC3B,MAAM,OAAO,CAAC,wBAAwB,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3G,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACxD,6FAA6F;YAC7F,MAAM,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACpF,IAAI,CAAC,IAAI;gBAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACrE,OAAO,IAAI,aAAa,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC;YAAS,CAAC;QACT,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;AACH,CAAC","sourcesContent":["import { readFile } from 'node:fs/promises';\nimport { dirname, extname, isAbsolute, relative, resolve, sep } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport type { Mermaid, MermaidConfig } from 'mermaid';\nimport type { Browser, Route } from 'playwright';\nimport type { ArchiMateBackground, createArchiMatePlugin } from '../index.js';\n\nexport class RenderSetupError extends Error {}\n\nexport const mermaidThemes = ['default', 'base', 'dark', 'forest', 'neutral'] as const;\nexport type MermaidTheme = (typeof mermaidThemes)[number];\n\nexport interface RenderOptions {\n readonly theme: MermaidTheme | undefined;\n readonly background: ArchiMateBackground;\n}\n\nconst origin = 'http://archimate.render';\n// Marker IDs derive from the diagram ID; keeping the ID of the earlier render script keeps committed example SVGs stable.\nconst diagramId = 'archimate-example';\nconst contentTypes: Readonly<Record<string, string>> = {\n '.mjs': 'text/javascript',\n '.js': 'text/javascript',\n '.css': 'text/css',\n '.json': 'application/json',\n};\n\nfunction mermaidDirectory(): string {\n try {\n return dirname(fileURLToPath(import.meta.resolve('mermaid')));\n } catch (error) {\n throw new RenderSetupError('archimaid render needs Mermaid. Install it with: npm install mermaid', {\n cause: error,\n });\n }\n}\n\nasync function launchChromium(): Promise<Browser> {\n let chromium: typeof import('playwright').chromium;\n try {\n ({ chromium } = await import('playwright'));\n } catch (error) {\n throw new RenderSetupError(\n 'archimaid render needs Playwright. Install it with: npm install --save-dev playwright && npx playwright install chromium',\n { cause: error },\n );\n }\n try {\n return await chromium.launch();\n } catch (error) {\n throw new RenderSetupError(\n 'Playwright could not start Chromium. Install it with: npx playwright install chromium',\n { cause: error },\n );\n }\n}\n\nfunction isInside(root: string, file: string): boolean {\n const path = relative(root, file);\n return path !== '..' && !path.startsWith('..' + sep) && !isAbsolute(path);\n}\n\n// The page loads Mermaid's and this package's prebuilt ES modules, so rendering needs no bundler.\nasync function serveModules(route: Route, roots: Readonly<Record<string, string>>): Promise<void> {\n const { pathname } = new URL(route.request().url());\n const [, mount = '', ...rest] = pathname.split('/');\n const root = roots[mount];\n const file = root === undefined ? undefined : resolve(root, ...rest.map(decodeURIComponent));\n if (root === undefined || file === undefined || !isInside(root, file)) {\n await route.fulfill({ status: 404 });\n return;\n }\n try {\n const body = await readFile(file);\n await route.fulfill({ body, contentType: contentTypes[extname(file)] ?? 'application/octet-stream' });\n } catch {\n await route.fulfill({ status: 404 });\n }\n}\n\ninterface PageInput {\n readonly source: string;\n readonly mermaidUrl: string;\n readonly pluginUrl: string;\n readonly config: MermaidConfig;\n readonly background: ArchiMateBackground;\n readonly diagramId: string;\n}\n\nexport async function renderSvg(source: string, { theme, background }: RenderOptions): Promise<string> {\n const roots = {\n mermaid: mermaidDirectory(),\n plugin: fileURLToPath(new URL('../bundle/', import.meta.url)),\n };\n const browser = await launchChromium();\n try {\n const page = await browser.newPage();\n await page.route(`${origin}/**`, (route) => serveModules(route, roots));\n await page.route(`${origin}/`, (route) =>\n route.fulfill({\n contentType: 'text/html',\n body: '<!doctype html><meta charset=\"utf-8\"><title>ArchiMate render</title>',\n }),\n );\n await page.goto(`${origin}/`);\n const input: PageInput = {\n source,\n mermaidUrl: `${origin}/mermaid/mermaid.esm.min.mjs`,\n pluginUrl: `${origin}/plugin/archimaid.esm.min.mjs`,\n config: { startOnLoad: false, securityLevel: 'strict', ...(theme !== undefined && { theme }) },\n background,\n diagramId,\n };\n return await page.evaluate(async ({ source, mermaidUrl, pluginUrl, config, background, diagramId }: PageInput) => {\n const { default: mermaid } = (await import(mermaidUrl)) as { default: Mermaid };\n const plugin = (await import(pluginUrl)) as { createArchiMatePlugin: typeof createArchiMatePlugin };\n mermaid.initialize(config);\n await mermaid.registerExternalDiagrams([plugin.createArchiMatePlugin({ useMaxWidth: false, background })]);\n const { svg } = await mermaid.render(diagramId, source);\n // Mermaid serializes for HTML. Export XML so that standalone SVG viewers accept every label.\n const root = new DOMParser().parseFromString(svg, 'text/html').querySelector('svg');\n if (!root) throw new Error('Mermaid did not return an SVG diagram.');\n return new XMLSerializer().serializeToString(root);\n }, input);\n } finally {\n await browser.close();\n }\n}\n"]}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { ArchiMateDiagnostic } from '../language.js';
|
|
2
|
+
export declare const outputFormats: readonly ["text", "json", "github"];
|
|
3
|
+
export type OutputFormat = (typeof outputFormats)[number];
|
|
4
|
+
export type FileDiagnostic = ArchiMateDiagnostic & {
|
|
5
|
+
readonly file: string;
|
|
6
|
+
};
|
|
7
|
+
export interface CheckedFile {
|
|
8
|
+
readonly file: string;
|
|
9
|
+
readonly diagrams: number;
|
|
10
|
+
readonly errors: number;
|
|
11
|
+
}
|
|
12
|
+
export interface ValidationReport {
|
|
13
|
+
readonly files: readonly CheckedFile[];
|
|
14
|
+
readonly diagnostics: readonly FileDiagnostic[];
|
|
15
|
+
}
|
|
16
|
+
export interface ReportOutput {
|
|
17
|
+
readonly stdout: string[];
|
|
18
|
+
readonly stderr: string[];
|
|
19
|
+
}
|
|
20
|
+
export declare function formatReport(report: ValidationReport, format: OutputFormat): ReportOutput;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
export const outputFormats = ['text', 'json', 'github'];
|
|
2
|
+
function textReport({ files, diagnostics }) {
|
|
3
|
+
return {
|
|
4
|
+
stderr: diagnostics.map(({ file, line, column, severity, message }) => `${file}:${line}:${column}: ${severity === 'warning' ? 'warning: ' : ''}${message}`),
|
|
5
|
+
stdout: files
|
|
6
|
+
.filter(({ errors }) => errors === 0)
|
|
7
|
+
.map(({ file }) => `${file}: diagram syntax and structure checks passed`),
|
|
8
|
+
};
|
|
9
|
+
}
|
|
10
|
+
// https://docs.github.com/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
|
|
11
|
+
const escapeData = (text) => text.replaceAll('%', '%25').replaceAll('\r', '%0D').replaceAll('\n', '%0A');
|
|
12
|
+
const escapeProperty = (text) => escapeData(text).replaceAll(':', '%3A').replaceAll(',', '%2C');
|
|
13
|
+
function githubReport({ diagnostics }) {
|
|
14
|
+
return {
|
|
15
|
+
stderr: [],
|
|
16
|
+
stdout: diagnostics.map(({ file, line, column, endLine, endColumn, severity, code, message }) => {
|
|
17
|
+
const properties = [
|
|
18
|
+
`file=${escapeProperty(file)}`,
|
|
19
|
+
`line=${line}`,
|
|
20
|
+
`col=${column}`,
|
|
21
|
+
`endLine=${endLine}`,
|
|
22
|
+
`endColumn=${endColumn}`,
|
|
23
|
+
`title=${escapeProperty(code)}`,
|
|
24
|
+
];
|
|
25
|
+
return `::${severity} ${properties.join(',')}::${escapeData(message)}`;
|
|
26
|
+
}),
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
export function formatReport(report, format) {
|
|
30
|
+
switch (format) {
|
|
31
|
+
case 'text':
|
|
32
|
+
return textReport(report);
|
|
33
|
+
case 'github':
|
|
34
|
+
return githubReport(report);
|
|
35
|
+
case 'json':
|
|
36
|
+
return { stdout: [JSON.stringify(report, null, 2)], stderr: [] };
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=report.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/cli/report.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC;AAqBjE,SAAS,UAAU,CAAC,EAAE,KAAK,EAAE,WAAW,EAAoB;IAC1D,OAAO;QACL,MAAM,EAAE,WAAW,CAAC,GAAG,CACrB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,CAC5C,GAAG,IAAI,IAAI,IAAI,IAAI,MAAM,KAAK,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CACtF;QACD,MAAM,EAAE,KAAK;aACV,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;aACpC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,8CAA8C,CAAC;KAC5E,CAAC;AACJ,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CAC1C,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC9E,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAEhH,SAAS,YAAY,CAAC,EAAE,WAAW,EAAoB;IACrD,OAAO;QACL,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;YAC9F,MAAM,UAAU,GAAG;gBACjB,QAAQ,cAAc,CAAC,IAAI,CAAC,EAAE;gBAC9B,QAAQ,IAAI,EAAE;gBACd,OAAO,MAAM,EAAE;gBACf,WAAW,OAAO,EAAE;gBACpB,aAAa,SAAS,EAAE;gBACxB,SAAS,cAAc,CAAC,IAAI,CAAC,EAAE;aAChC,CAAC;YACF,OAAO,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACzE,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAwB,EAAE,MAAoB;IACzE,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM;YACT,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;QAC9B,KAAK,MAAM;YACT,OAAO,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACrE,CAAC;AACH,CAAC","sourcesContent":["import type { ArchiMateDiagnostic } from '../language.js';\n\nexport const outputFormats = ['text', 'json', 'github'] as const;\nexport type OutputFormat = (typeof outputFormats)[number];\n\nexport type FileDiagnostic = ArchiMateDiagnostic & { readonly file: string };\n\nexport interface CheckedFile {\n readonly file: string;\n readonly diagrams: number;\n readonly errors: number;\n}\n\nexport interface ValidationReport {\n readonly files: readonly CheckedFile[];\n readonly diagnostics: readonly FileDiagnostic[];\n}\n\nexport interface ReportOutput {\n readonly stdout: string[];\n readonly stderr: string[];\n}\n\nfunction textReport({ files, diagnostics }: ValidationReport): ReportOutput {\n return {\n stderr: diagnostics.map(\n ({ file, line, column, severity, message }) =>\n `${file}:${line}:${column}: ${severity === 'warning' ? 'warning: ' : ''}${message}`,\n ),\n stdout: files\n .filter(({ errors }) => errors === 0)\n .map(({ file }) => `${file}: diagram syntax and structure checks passed`),\n };\n}\n\n// https://docs.github.com/actions/reference/workflow-commands-for-github-actions#setting-an-error-message\nconst escapeData = (text: string): string =>\n text.replaceAll('%', '%25').replaceAll('\\r', '%0D').replaceAll('\\n', '%0A');\nconst escapeProperty = (text: string): string => escapeData(text).replaceAll(':', '%3A').replaceAll(',', '%2C');\n\nfunction githubReport({ diagnostics }: ValidationReport): ReportOutput {\n return {\n stderr: [],\n stdout: diagnostics.map(({ file, line, column, endLine, endColumn, severity, code, message }) => {\n const properties = [\n `file=${escapeProperty(file)}`,\n `line=${line}`,\n `col=${column}`,\n `endLine=${endLine}`,\n `endColumn=${endColumn}`,\n `title=${escapeProperty(code)}`,\n ];\n return `::${severity} ${properties.join(',')}::${escapeData(message)}`;\n }),\n };\n}\n\nexport function formatReport(report: ValidationReport, format: OutputFormat): ReportOutput {\n switch (format) {\n case 'text':\n return textReport(report);\n case 'github':\n return githubReport(report);\n case 'json':\n return { stdout: [JSON.stringify(report, null, 2)], stderr: [] };\n }\n}\n"]}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export declare const stdinName = "<stdin>";
|
|
2
|
+
export interface DiagramSource {
|
|
3
|
+
readonly source: string;
|
|
4
|
+
readonly lineOffset: number;
|
|
5
|
+
}
|
|
6
|
+
export interface SourceFile {
|
|
7
|
+
readonly file: string;
|
|
8
|
+
readonly diagrams: readonly DiagramSource[];
|
|
9
|
+
}
|
|
10
|
+
export interface UnreadableInput {
|
|
11
|
+
readonly file: string;
|
|
12
|
+
readonly message: string;
|
|
13
|
+
}
|
|
14
|
+
export declare function isArchiMateSource(source: string): boolean;
|
|
15
|
+
export declare function markdownDiagrams(markdown: string): DiagramSource[];
|
|
16
|
+
export declare function collectSources(inputs: readonly string[]): Promise<{
|
|
17
|
+
readonly files: SourceFile[];
|
|
18
|
+
readonly unreadable: UnreadableInput[];
|
|
19
|
+
}>;
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { readFileSync } from 'node:fs';
|
|
2
|
+
import { readdir, readFile, stat } from 'node:fs/promises';
|
|
3
|
+
import { extname, join } from 'node:path';
|
|
4
|
+
import { blankFrontmatter } from '../archimate/frontmatter.js';
|
|
5
|
+
export const stdinName = '<stdin>';
|
|
6
|
+
const markdownExtensions = new Set(['.md', '.markdown']);
|
|
7
|
+
const diagramExtensions = new Set(['.mmd', '.mermaid']);
|
|
8
|
+
export function isArchiMateSource(source) {
|
|
9
|
+
const withoutByteOrderMark = source.startsWith('') ? source.slice(1) : source;
|
|
10
|
+
return /^\s*archimate-beta(?=\s|$)/u.test(blankFrontmatter(withoutByteOrderMark.replaceAll('\r\n', '\n')).text);
|
|
11
|
+
}
|
|
12
|
+
const fenceOpening = /^( {0,3})(`{3,}|~{3,})[ \t]*mermaid(?:[ \t].*)?$/u;
|
|
13
|
+
// CommonMark fences: a block closes at a fence of the same character that is at least as long, or at the end of the file.
|
|
14
|
+
export function markdownDiagrams(markdown) {
|
|
15
|
+
const lines = markdown.split(/\r?\n/u);
|
|
16
|
+
const diagrams = [];
|
|
17
|
+
for (let index = 0; index < lines.length; index++) {
|
|
18
|
+
const fence = fenceOpening.exec(lines[index] ?? '')?.[2];
|
|
19
|
+
if (fence === undefined)
|
|
20
|
+
continue;
|
|
21
|
+
const closing = new RegExp(`^ {0,3}${fence[0] === '`' ? '`' : '~'}{${fence.length},}[ \\t]*$`, 'u');
|
|
22
|
+
const start = index + 1;
|
|
23
|
+
let end = start;
|
|
24
|
+
while (end < lines.length && !closing.test(lines[end] ?? ''))
|
|
25
|
+
end++;
|
|
26
|
+
const source = lines.slice(start, end).join('\n');
|
|
27
|
+
if (isArchiMateSource(source))
|
|
28
|
+
diagrams.push({ source, lineOffset: start });
|
|
29
|
+
index = end;
|
|
30
|
+
}
|
|
31
|
+
return diagrams;
|
|
32
|
+
}
|
|
33
|
+
function isMarkdown(file) {
|
|
34
|
+
return markdownExtensions.has(extname(file).toLowerCase());
|
|
35
|
+
}
|
|
36
|
+
// An explicitly named diagram file is always validated; a file found in a directory only when it is an ArchiMate diagram.
|
|
37
|
+
function diagramsIn(file, text, explicit) {
|
|
38
|
+
if (isMarkdown(file))
|
|
39
|
+
return markdownDiagrams(text);
|
|
40
|
+
return explicit || isArchiMateSource(text) ? [{ source: text, lineOffset: 0 }] : [];
|
|
41
|
+
}
|
|
42
|
+
async function filesUnder(directory) {
|
|
43
|
+
const entries = await readdir(directory, { withFileTypes: true });
|
|
44
|
+
const nested = await Promise.all(entries
|
|
45
|
+
.filter(({ name }) => !name.startsWith('.') && name !== 'node_modules')
|
|
46
|
+
.toSorted((left, right) => left.name.localeCompare(right.name))
|
|
47
|
+
.map(async (entry) => {
|
|
48
|
+
const path = join(directory, entry.name);
|
|
49
|
+
if (entry.isDirectory())
|
|
50
|
+
return filesUnder(path);
|
|
51
|
+
const extension = extname(entry.name).toLowerCase();
|
|
52
|
+
return entry.isFile() && (diagramExtensions.has(extension) || markdownExtensions.has(extension)) ? [path] : [];
|
|
53
|
+
}));
|
|
54
|
+
return nested.flat();
|
|
55
|
+
}
|
|
56
|
+
function errorMessage(error) {
|
|
57
|
+
if (error instanceof Error && 'code' in error && error.code === 'ENOENT')
|
|
58
|
+
return 'No such file or directory.';
|
|
59
|
+
return error instanceof Error ? error.message : String(error);
|
|
60
|
+
}
|
|
61
|
+
export async function collectSources(inputs) {
|
|
62
|
+
const files = [];
|
|
63
|
+
const unreadable = [];
|
|
64
|
+
for (const input of inputs) {
|
|
65
|
+
try {
|
|
66
|
+
if (input === '-') {
|
|
67
|
+
files.push({ file: stdinName, diagrams: diagramsIn(stdinName, readFileSync(0, 'utf8'), true) });
|
|
68
|
+
}
|
|
69
|
+
else if ((await stat(input)).isDirectory()) {
|
|
70
|
+
for (const file of await filesUnder(input)) {
|
|
71
|
+
const diagrams = diagramsIn(file, await readFile(file, 'utf8'), false);
|
|
72
|
+
if (diagrams.length > 0)
|
|
73
|
+
files.push({ file, diagrams });
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
else {
|
|
77
|
+
files.push({ file: input, diagrams: diagramsIn(input, await readFile(input, 'utf8'), true) });
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
catch (error) {
|
|
81
|
+
unreadable.push({ file: input, message: errorMessage(error) });
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return { files, unreadable };
|
|
85
|
+
}
|
|
86
|
+
//# sourceMappingURL=sources.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sources.js","sourceRoot":"","sources":["../../src/cli/sources.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC;AAkBnC,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;AACzD,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAExD,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,MAAM,oBAAoB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC/E,OAAO,6BAA6B,CAAC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAClH,CAAC;AAED,MAAM,YAAY,GAAG,mDAAmD,CAAC;AAEzE,0HAA0H;AAC1H,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,MAAM,YAAY,EAAE,GAAG,CAAC,CAAC;QACpG,MAAM,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC;QACxB,IAAI,GAAG,GAAG,KAAK,CAAC;QAChB,OAAO,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAAE,GAAG,EAAE,CAAC;QACpE,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,iBAAiB,CAAC,MAAM,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5E,KAAK,GAAG,GAAG,CAAC;IACd,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,0HAA0H;AAC1H,SAAS,UAAU,CAAC,IAAY,EAAE,IAAY,EAAE,QAAiB;IAC/D,IAAI,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO,QAAQ,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtF,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,SAAiB;IACzC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,OAAO;SACJ,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,cAAc,CAAC;SACtE,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC9D,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,KAAK,CAAC,WAAW,EAAE;YAAE,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACpD,OAAO,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjH,CAAC,CAAC,CACL,CAAC;IACF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,4BAA4B,CAAC;IAC9G,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAyB;IAI5D,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAsB,EAAE,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,IAAI,KAAK,KAAK,GAAG,EAAE,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAClG,CAAC;iBAAM,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC7C,KAAK,MAAM,IAAI,IAAI,MAAM,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;oBACvE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;wBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAChG,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAC/B,CAAC","sourcesContent":["import { readFileSync } from 'node:fs';\nimport { readdir, readFile, stat } from 'node:fs/promises';\nimport { extname, join } from 'node:path';\nimport { blankFrontmatter } from '../archimate/frontmatter.js';\n\nexport const stdinName = '<stdin>';\n\nexport interface DiagramSource {\n readonly source: string;\n // Lines before the diagram in its file, so diagnostics report file lines.\n readonly lineOffset: number;\n}\n\nexport interface SourceFile {\n readonly file: string;\n readonly diagrams: readonly DiagramSource[];\n}\n\nexport interface UnreadableInput {\n readonly file: string;\n readonly message: string;\n}\n\nconst markdownExtensions = new Set(['.md', '.markdown']);\nconst diagramExtensions = new Set(['.mmd', '.mermaid']);\n\nexport function isArchiMateSource(source: string): boolean {\n const withoutByteOrderMark = source.startsWith('') ? source.slice(1) : source;\n return /^\\s*archimate-beta(?=\\s|$)/u.test(blankFrontmatter(withoutByteOrderMark.replaceAll('\\r\\n', '\\n')).text);\n}\n\nconst fenceOpening = /^( {0,3})(`{3,}|~{3,})[ \\t]*mermaid(?:[ \\t].*)?$/u;\n\n// CommonMark fences: a block closes at a fence of the same character that is at least as long, or at the end of the file.\nexport function markdownDiagrams(markdown: string): DiagramSource[] {\n const lines = markdown.split(/\\r?\\n/u);\n const diagrams: DiagramSource[] = [];\n for (let index = 0; index < lines.length; index++) {\n const fence = fenceOpening.exec(lines[index] ?? '')?.[2];\n if (fence === undefined) continue;\n const closing = new RegExp(`^ {0,3}${fence[0] === '`' ? '`' : '~'}{${fence.length},}[ \\\\t]*$`, 'u');\n const start = index + 1;\n let end = start;\n while (end < lines.length && !closing.test(lines[end] ?? '')) end++;\n const source = lines.slice(start, end).join('\\n');\n if (isArchiMateSource(source)) diagrams.push({ source, lineOffset: start });\n index = end;\n }\n return diagrams;\n}\n\nfunction isMarkdown(file: string): boolean {\n return markdownExtensions.has(extname(file).toLowerCase());\n}\n\n// An explicitly named diagram file is always validated; a file found in a directory only when it is an ArchiMate diagram.\nfunction diagramsIn(file: string, text: string, explicit: boolean): DiagramSource[] {\n if (isMarkdown(file)) return markdownDiagrams(text);\n return explicit || isArchiMateSource(text) ? [{ source: text, lineOffset: 0 }] : [];\n}\n\nasync function filesUnder(directory: string): Promise<string[]> {\n const entries = await readdir(directory, { withFileTypes: true });\n const nested = await Promise.all(\n entries\n .filter(({ name }) => !name.startsWith('.') && name !== 'node_modules')\n .toSorted((left, right) => left.name.localeCompare(right.name))\n .map(async (entry) => {\n const path = join(directory, entry.name);\n if (entry.isDirectory()) return filesUnder(path);\n const extension = extname(entry.name).toLowerCase();\n return entry.isFile() && (diagramExtensions.has(extension) || markdownExtensions.has(extension)) ? [path] : [];\n }),\n );\n return nested.flat();\n}\n\nfunction errorMessage(error: unknown): string {\n if (error instanceof Error && 'code' in error && error.code === 'ENOENT') return 'No such file or directory.';\n return error instanceof Error ? error.message : String(error);\n}\n\nexport async function collectSources(inputs: readonly string[]): Promise<{\n readonly files: SourceFile[];\n readonly unreadable: UnreadableInput[];\n}> {\n const files: SourceFile[] = [];\n const unreadable: UnreadableInput[] = [];\n for (const input of inputs) {\n try {\n if (input === '-') {\n files.push({ file: stdinName, diagrams: diagramsIn(stdinName, readFileSync(0, 'utf8'), true) });\n } else if ((await stat(input)).isDirectory()) {\n for (const file of await filesUnder(input)) {\n const diagrams = diagramsIn(file, await readFile(file, 'utf8'), false);\n if (diagrams.length > 0) files.push({ file, diagrams });\n }\n } else {\n files.push({ file: input, diagrams: diagramsIn(input, await readFile(input, 'utf8'), true) });\n }\n } catch (error) {\n unreadable.push({ file: input, message: errorMessage(error) });\n }\n }\n return { files, unreadable };\n}\n"]}
|
package/dist/cli.d.ts
ADDED
package/dist/cli.js
ADDED
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { readFileSync } from 'node:fs';
|
|
3
|
+
import { readFile, writeFile } from 'node:fs/promises';
|
|
4
|
+
import { parseArgs } from 'node:util';
|
|
5
|
+
import { formatReport, outputFormats, } from './cli/report.js';
|
|
6
|
+
import { collectSources, stdinName } from './cli/sources.js';
|
|
7
|
+
import { validateArchiMate } from './language.js';
|
|
8
|
+
const usage = `Usage:
|
|
9
|
+
archimaid validate [--format text|json|github] <file|directory|->...
|
|
10
|
+
archimaid render [--theme default|base|dark|forest|neutral] [--background theme|transparent] <input.mmd|-> <output.svg>
|
|
11
|
+
archimaid --version
|
|
12
|
+
archimaid --help
|
|
13
|
+
|
|
14
|
+
validate checks .mmd files, and archimate-beta blocks in fenced mermaid code blocks of Markdown files.
|
|
15
|
+
Directories are searched recursively for .mmd, .mermaid, .md and .markdown files.`;
|
|
16
|
+
class UsageError extends Error {
|
|
17
|
+
}
|
|
18
|
+
const backgrounds = ['theme', 'transparent'];
|
|
19
|
+
function oneOf(name, value, allowed) {
|
|
20
|
+
if (value === undefined)
|
|
21
|
+
return undefined;
|
|
22
|
+
const match = allowed.find((candidate) => candidate === value);
|
|
23
|
+
if (match === undefined)
|
|
24
|
+
throw new UsageError(`--${name} must be one of: ${allowed.join(', ')}.`);
|
|
25
|
+
return match;
|
|
26
|
+
}
|
|
27
|
+
function write({ stdout, stderr }) {
|
|
28
|
+
if (stdout.length > 0)
|
|
29
|
+
console.log(stdout.join('\n'));
|
|
30
|
+
if (stderr.length > 0)
|
|
31
|
+
console.error(stderr.join('\n'));
|
|
32
|
+
}
|
|
33
|
+
async function validate(inputs, format) {
|
|
34
|
+
if (inputs.length === 0)
|
|
35
|
+
throw new UsageError('validate needs at least one file, directory or -.');
|
|
36
|
+
const { files, unreadable } = await collectSources(inputs);
|
|
37
|
+
const checked = [];
|
|
38
|
+
const diagnostics = [];
|
|
39
|
+
for (const { file, diagrams } of files) {
|
|
40
|
+
let errors = 0;
|
|
41
|
+
for (const { source, lineOffset } of diagrams) {
|
|
42
|
+
for (const diagnostic of validateArchiMate(source, { lineOffset }).diagnostics) {
|
|
43
|
+
diagnostics.push({ ...diagnostic, file });
|
|
44
|
+
if (diagnostic.severity === 'error')
|
|
45
|
+
errors++;
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
checked.push({ file, diagrams: diagrams.length, errors });
|
|
49
|
+
}
|
|
50
|
+
const withDiagrams = checked.filter(({ diagrams }) => diagrams > 0);
|
|
51
|
+
write(formatReport({ files: withDiagrams, diagnostics }, format));
|
|
52
|
+
for (const { file, message } of unreadable)
|
|
53
|
+
console.error(`${file}: ${message}`);
|
|
54
|
+
if (withDiagrams.length === 0 && unreadable.length === 0) {
|
|
55
|
+
console.error('No archimate-beta diagrams found.');
|
|
56
|
+
return 1;
|
|
57
|
+
}
|
|
58
|
+
return unreadable.length > 0 || checked.some(({ errors }) => errors > 0) ? 1 : 0;
|
|
59
|
+
}
|
|
60
|
+
async function render(inputs, theme, background) {
|
|
61
|
+
const [input, output, ...extra] = inputs;
|
|
62
|
+
if (input === undefined || output === undefined || extra.length > 0) {
|
|
63
|
+
throw new UsageError('render needs one input file (or -) and one output file.');
|
|
64
|
+
}
|
|
65
|
+
// Loaded on demand so that validate never touches the optional Playwright peer dependency.
|
|
66
|
+
const { mermaidThemes, renderSvg, RenderSetupError } = await import('./cli/render.js');
|
|
67
|
+
const name = input === '-' ? stdinName : input;
|
|
68
|
+
const source = input === '-' ? readFileSync(0, 'utf8') : await readFile(input, 'utf8');
|
|
69
|
+
const { diagnostics } = validateArchiMate(source);
|
|
70
|
+
write(formatReport({ files: [], diagnostics: diagnostics.map((diagnostic) => ({ ...diagnostic, file: name })) }, 'text'));
|
|
71
|
+
if (diagnostics.some(({ severity }) => severity === 'error'))
|
|
72
|
+
return 1;
|
|
73
|
+
try {
|
|
74
|
+
const svg = await renderSvg(source, { theme: oneOf('theme', theme, mermaidThemes), background });
|
|
75
|
+
await writeFile(output, `${svg}\n`, 'utf8');
|
|
76
|
+
}
|
|
77
|
+
catch (error) {
|
|
78
|
+
if (error instanceof RenderSetupError) {
|
|
79
|
+
console.error(error.message);
|
|
80
|
+
return 1;
|
|
81
|
+
}
|
|
82
|
+
throw error;
|
|
83
|
+
}
|
|
84
|
+
console.log(output);
|
|
85
|
+
return 0;
|
|
86
|
+
}
|
|
87
|
+
async function main(args) {
|
|
88
|
+
const { values, positionals } = parseArgs({
|
|
89
|
+
args: [...args],
|
|
90
|
+
allowPositionals: true,
|
|
91
|
+
options: {
|
|
92
|
+
help: { type: 'boolean', short: 'h' },
|
|
93
|
+
version: { type: 'boolean', short: 'v' },
|
|
94
|
+
format: { type: 'string' },
|
|
95
|
+
theme: { type: 'string' },
|
|
96
|
+
background: { type: 'string' },
|
|
97
|
+
},
|
|
98
|
+
});
|
|
99
|
+
if (values.help) {
|
|
100
|
+
console.log(usage);
|
|
101
|
+
return 0;
|
|
102
|
+
}
|
|
103
|
+
if (values.version) {
|
|
104
|
+
const { version } = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8'));
|
|
105
|
+
console.log(version);
|
|
106
|
+
return 0;
|
|
107
|
+
}
|
|
108
|
+
const [command, ...inputs] = positionals;
|
|
109
|
+
if (command === 'validate') {
|
|
110
|
+
if (values.theme !== undefined || values.background !== undefined) {
|
|
111
|
+
throw new UsageError('--theme and --background apply to render only.');
|
|
112
|
+
}
|
|
113
|
+
return validate(inputs, oneOf('format', values.format, outputFormats) ?? 'text');
|
|
114
|
+
}
|
|
115
|
+
if (command === 'render') {
|
|
116
|
+
if (values.format !== undefined)
|
|
117
|
+
throw new UsageError('--format applies to validate only.');
|
|
118
|
+
return render(inputs, values.theme, oneOf('background', values.background, backgrounds) ?? 'theme');
|
|
119
|
+
}
|
|
120
|
+
throw new UsageError(command === undefined ? 'Missing command.' : `Unknown command "${command}".`);
|
|
121
|
+
}
|
|
122
|
+
try {
|
|
123
|
+
process.exitCode = await main(process.argv.slice(2));
|
|
124
|
+
}
|
|
125
|
+
catch (error) {
|
|
126
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
127
|
+
console.error(message);
|
|
128
|
+
if (error instanceof UsageError ||
|
|
129
|
+
(error instanceof Error && 'code' in error && String(error.code).startsWith('ERR_PARSE_ARGS'))) {
|
|
130
|
+
console.error(usage);
|
|
131
|
+
process.exitCode = 2;
|
|
132
|
+
}
|
|
133
|
+
else {
|
|
134
|
+
process.exitCode = 1;
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EACL,YAAY,EACZ,aAAa,GAKd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAGlD,MAAM,KAAK,GAAG;;;;;;;kFAOoE,CAAC;AAEnF,MAAM,UAAW,SAAQ,KAAK;CAAG;AAEjC,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,aAAa,CAAmD,CAAC;AAE/F,SAAS,KAAK,CAAyB,IAAY,EAAE,KAAyB,EAAE,OAAqB;IACnG,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC;IAC/D,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,UAAU,CAAC,KAAK,IAAI,oBAAoB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClG,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,EAAgB;IAC7C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,MAAyB,EAAE,MAAoB;IACrE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,mDAAmD,CAAC,CAAC;IACnG,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,KAAK,EAAE,CAAC;QACvC,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC9C,KAAK,MAAM,UAAU,IAAI,iBAAiB,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;gBAC/E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1C,IAAI,UAAU,CAAC,QAAQ,KAAK,OAAO;oBAAE,MAAM,EAAE,CAAC;YAChD,CAAC;QACH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;IACpE,KAAK,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,KAAK,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,UAAU;QAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;IACjF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzD,OAAO,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACnD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,KAAK,UAAU,MAAM,CACnB,MAAyB,EACzB,KAAyB,EACzB,UAA+B;IAE/B,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,MAAM,CAAC;IACzC,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpE,MAAM,IAAI,UAAU,CAAC,yDAAyD,CAAC,CAAC;IAClF,CAAC;IACD,2FAA2F;IAC3F,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACvF,MAAM,IAAI,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;IAC/C,MAAM,MAAM,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvF,MAAM,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAClD,KAAK,CACH,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CACnH,CAAC;IACF,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,KAAK,OAAO,CAAC;QAAE,OAAO,CAAC,CAAC;IACvE,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;QACjG,MAAM,SAAS,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;YACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,OAAO,CAAC,CAAC;AACX,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,IAAuB;IACzC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;QACxC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;QACf,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE;YACP,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;YACrC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;YACxC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC/B;KACF,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAEjG,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,GAAG,WAAW,CAAC;IACzC,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3B,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAClE,MAAM,IAAI,UAAU,CAAC,gDAAgD,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,CAAC;IACnF,CAAC;IACD,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,IAAI,UAAU,CAAC,oCAAoC,CAAC,CAAC;QAC5F,OAAO,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,OAAO,CAAC,CAAC;IACtG,CAAC;IACD,MAAM,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,OAAO,IAAI,CAAC,CAAC;AACrG,CAAC;AAED,IAAI,CAAC;IACH,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,IACE,KAAK,YAAY,UAAU;QAC3B,CAAC,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,EAC9F,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport { readFileSync } from 'node:fs';\nimport { readFile, writeFile } from 'node:fs/promises';\nimport { parseArgs } from 'node:util';\nimport {\n formatReport,\n outputFormats,\n type CheckedFile,\n type FileDiagnostic,\n type OutputFormat,\n type ReportOutput,\n} from './cli/report.js';\nimport { collectSources, stdinName } from './cli/sources.js';\nimport { validateArchiMate } from './language.js';\nimport type { ArchiMateBackground } from './index.js';\n\nconst usage = `Usage:\n archimaid validate [--format text|json|github] <file|directory|->...\n archimaid render [--theme default|base|dark|forest|neutral] [--background theme|transparent] <input.mmd|-> <output.svg>\n archimaid --version\n archimaid --help\n\nvalidate checks .mmd files, and archimate-beta blocks in fenced mermaid code blocks of Markdown files.\nDirectories are searched recursively for .mmd, .mermaid, .md and .markdown files.`;\n\nclass UsageError extends Error {}\n\nconst backgrounds = ['theme', 'transparent'] as const satisfies readonly ArchiMateBackground[];\n\nfunction oneOf<const T extends string>(name: string, value: string | undefined, allowed: readonly T[]): T | undefined {\n if (value === undefined) return undefined;\n const match = allowed.find((candidate) => candidate === value);\n if (match === undefined) throw new UsageError(`--${name} must be one of: ${allowed.join(', ')}.`);\n return match;\n}\n\nfunction write({ stdout, stderr }: ReportOutput): void {\n if (stdout.length > 0) console.log(stdout.join('\\n'));\n if (stderr.length > 0) console.error(stderr.join('\\n'));\n}\n\nasync function validate(inputs: readonly string[], format: OutputFormat): Promise<number> {\n if (inputs.length === 0) throw new UsageError('validate needs at least one file, directory or -.');\n const { files, unreadable } = await collectSources(inputs);\n const checked: CheckedFile[] = [];\n const diagnostics: FileDiagnostic[] = [];\n for (const { file, diagrams } of files) {\n let errors = 0;\n for (const { source, lineOffset } of diagrams) {\n for (const diagnostic of validateArchiMate(source, { lineOffset }).diagnostics) {\n diagnostics.push({ ...diagnostic, file });\n if (diagnostic.severity === 'error') errors++;\n }\n }\n checked.push({ file, diagrams: diagrams.length, errors });\n }\n const withDiagrams = checked.filter(({ diagrams }) => diagrams > 0);\n write(formatReport({ files: withDiagrams, diagnostics }, format));\n for (const { file, message } of unreadable) console.error(`${file}: ${message}`);\n if (withDiagrams.length === 0 && unreadable.length === 0) {\n console.error('No archimate-beta diagrams found.');\n return 1;\n }\n return unreadable.length > 0 || checked.some(({ errors }) => errors > 0) ? 1 : 0;\n}\n\nasync function render(\n inputs: readonly string[],\n theme: string | undefined,\n background: ArchiMateBackground,\n): Promise<number> {\n const [input, output, ...extra] = inputs;\n if (input === undefined || output === undefined || extra.length > 0) {\n throw new UsageError('render needs one input file (or -) and one output file.');\n }\n // Loaded on demand so that validate never touches the optional Playwright peer dependency.\n const { mermaidThemes, renderSvg, RenderSetupError } = await import('./cli/render.js');\n const name = input === '-' ? stdinName : input;\n const source = input === '-' ? readFileSync(0, 'utf8') : await readFile(input, 'utf8');\n const { diagnostics } = validateArchiMate(source);\n write(\n formatReport({ files: [], diagnostics: diagnostics.map((diagnostic) => ({ ...diagnostic, file: name })) }, 'text'),\n );\n if (diagnostics.some(({ severity }) => severity === 'error')) return 1;\n try {\n const svg = await renderSvg(source, { theme: oneOf('theme', theme, mermaidThemes), background });\n await writeFile(output, `${svg}\\n`, 'utf8');\n } catch (error) {\n if (error instanceof RenderSetupError) {\n console.error(error.message);\n return 1;\n }\n throw error;\n }\n console.log(output);\n return 0;\n}\n\nasync function main(args: readonly string[]): Promise<number> {\n const { values, positionals } = parseArgs({\n args: [...args],\n allowPositionals: true,\n options: {\n help: { type: 'boolean', short: 'h' },\n version: { type: 'boolean', short: 'v' },\n format: { type: 'string' },\n theme: { type: 'string' },\n background: { type: 'string' },\n },\n });\n if (values.help) {\n console.log(usage);\n return 0;\n }\n if (values.version) {\n const { version } = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8')) as {\n version: string;\n };\n console.log(version);\n return 0;\n }\n const [command, ...inputs] = positionals;\n if (command === 'validate') {\n if (values.theme !== undefined || values.background !== undefined) {\n throw new UsageError('--theme and --background apply to render only.');\n }\n return validate(inputs, oneOf('format', values.format, outputFormats) ?? 'text');\n }\n if (command === 'render') {\n if (values.format !== undefined) throw new UsageError('--format applies to validate only.');\n return render(inputs, values.theme, oneOf('background', values.background, backgrounds) ?? 'theme');\n }\n throw new UsageError(command === undefined ? 'Missing command.' : `Unknown command \"${command}\".`);\n}\n\ntry {\n process.exitCode = await main(process.argv.slice(2));\n} catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n console.error(message);\n if (\n error instanceof UsageError ||\n (error instanceof Error && 'code' in error && String(error.code).startsWith('ERR_PARSE_ARGS'))\n ) {\n console.error(usage);\n process.exitCode = 2;\n } else {\n process.exitCode = 1;\n }\n}\n"]}
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,GAGtB,MAAM,gCAAgC,CAAC","sourcesContent":["export {\n archimate,\n createArchiMatePlugin,\n type ArchiMateBackground,\n type ArchiMatePluginOptions,\n} from './mermaid/archimateDetector.js';\nexport type { ArchiMatePalette } from './mermaid/styles.js';\n"]}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { parseArchiMate, validateArchiMate, ArchiMateError, relationshipConnectors } from './archimate/parser.js';
|
|
2
|
+
export type { ArchiMateDiagnostic, ArchiMateErrorCode, ArchiMateErrorDiagnostic, ArchiMateParseOptions, ArchiMateSourceRange, ArchiMateValidationResult, ArchiMateWarningCode, ArchiMateWarningDiagnostic, } from './archimate/parser.js';
|
|
3
|
+
export { elementTypes, getElementType, relationshipNames, relationshipTypes } from './archimate/catalogue.js';
|
|
4
|
+
export type { AccessMode, SpecifiedAccessMode, ElementAspect, ElementType, RelationshipType, } from './archimate/catalogue.js';
|
|
5
|
+
export type { ArchiMateDirection, ArchiMateElement, ArchiMateLayout, ArchiMateLink, ArchiMateLinkTarget, ArchiMateModel, ArchiMateNesting, ArchiMateNote, ArchiMateRelationship, } from './archimate/model.js';
|
package/dist/language.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"language.js","sourceRoot":"","sources":["../src/language.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAWlH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC","sourcesContent":["export { parseArchiMate, validateArchiMate, ArchiMateError, relationshipConnectors } from './archimate/parser.js';\nexport type {\n ArchiMateDiagnostic,\n ArchiMateErrorCode,\n ArchiMateErrorDiagnostic,\n ArchiMateParseOptions,\n ArchiMateSourceRange,\n ArchiMateValidationResult,\n ArchiMateWarningCode,\n ArchiMateWarningDiagnostic,\n} from './archimate/parser.js';\nexport { elementTypes, getElementType, relationshipNames, relationshipTypes } from './archimate/catalogue.js';\nexport type {\n AccessMode,\n SpecifiedAccessMode,\n ElementAspect,\n ElementType,\n RelationshipType,\n} from './archimate/catalogue.js';\nexport type {\n ArchiMateDirection,\n ArchiMateElement,\n ArchiMateLayout,\n ArchiMateLink,\n ArchiMateLinkTarget,\n ArchiMateModel,\n ArchiMateNesting,\n ArchiMateNote,\n ArchiMateRelationship,\n} from './archimate/model.js';\n"]}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ExternalDiagramDefinition } from 'mermaid';
|
|
2
|
+
import type { ArchiMatePalette } from './styles.js';
|
|
3
|
+
export interface ArchiMatePluginOptions {
|
|
4
|
+
readonly palette?: ArchiMatePalette;
|
|
5
|
+
readonly diagramPadding?: number;
|
|
6
|
+
readonly useMaxWidth?: boolean;
|
|
7
|
+
readonly maxRowWidth?: number;
|
|
8
|
+
readonly background?: ArchiMateBackground;
|
|
9
|
+
}
|
|
10
|
+
export type ArchiMateBackground = 'theme' | 'transparent';
|
|
11
|
+
export declare function createArchiMatePlugin({ palette, diagramPadding, useMaxWidth, maxRowWidth, background, }?: ArchiMatePluginOptions): ExternalDiagramDefinition;
|
|
12
|
+
export declare const archimate: ExternalDiagramDefinition;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
const diagramId = 'archimate';
|
|
2
|
+
export function createArchiMatePlugin({ palette = 'modern', diagramPadding = 24, useMaxWidth = true, maxRowWidth = 1200, background = 'theme', } = {}) {
|
|
3
|
+
if (!Number.isFinite(diagramPadding) || diagramPadding < 0) {
|
|
4
|
+
throw new RangeError('ArchiMate diagramPadding must be a finite, nonnegative number.');
|
|
5
|
+
}
|
|
6
|
+
// Infinity is accepted and turns row wrapping off.
|
|
7
|
+
if (typeof maxRowWidth !== 'number' || Number.isNaN(maxRowWidth) || maxRowWidth <= 0) {
|
|
8
|
+
throw new RangeError('ArchiMate maxRowWidth must be a number greater than 0, or Infinity.');
|
|
9
|
+
}
|
|
10
|
+
// JavaScript callers can pass any value.
|
|
11
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
12
|
+
if (background !== 'theme' && background !== 'transparent') {
|
|
13
|
+
throw new RangeError(`ArchiMate background must be "theme" or "transparent".`);
|
|
14
|
+
}
|
|
15
|
+
if (typeof useMaxWidth !== 'boolean') {
|
|
16
|
+
throw new TypeError('ArchiMate useMaxWidth must be a boolean.');
|
|
17
|
+
}
|
|
18
|
+
return {
|
|
19
|
+
id: diagramId,
|
|
20
|
+
detector: (text) => /^\s*archimate-beta(?=\s|$)/u.test(text),
|
|
21
|
+
async loader() {
|
|
22
|
+
const { createArchimateDiagram } = await import('./archimateDiagram.js');
|
|
23
|
+
const diagram = createArchimateDiagram({ palette, diagramPadding, useMaxWidth, maxRowWidth, background });
|
|
24
|
+
return { id: diagramId, diagram };
|
|
25
|
+
},
|
|
26
|
+
};
|
|
27
|
+
}
|
|
28
|
+
export const archimate = createArchiMatePlugin();
|
|
29
|
+
//# sourceMappingURL=archimateDetector.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"archimateDetector.js","sourceRoot":"","sources":["../../src/mermaid/archimateDetector.ts"],"names":[],"mappings":"AAGA,MAAM,SAAS,GAAG,WAAW,CAAC;AAY9B,MAAM,UAAU,qBAAqB,CAAC,EACpC,OAAO,GAAG,QAAQ,EAClB,cAAc,GAAG,EAAE,EACnB,WAAW,GAAG,IAAI,EAClB,WAAW,GAAG,IAAI,EAClB,UAAU,GAAG,OAAO,MACM,EAAE;IAC5B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,UAAU,CAAC,gEAAgE,CAAC,CAAC;IACzF,CAAC;IACD,mDAAmD;IACnD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;QACrF,MAAM,IAAI,UAAU,CAAC,qEAAqE,CAAC,CAAC;IAC9F,CAAC;IACD,yCAAyC;IACzC,uEAAuE;IACvE,IAAI,UAAU,KAAK,OAAO,IAAI,UAAU,KAAK,aAAa,EAAE,CAAC;QAC3D,MAAM,IAAI,UAAU,CAAC,wDAAwD,CAAC,CAAC;IACjF,CAAC;IACD,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC;IACD,OAAO;QACL,EAAE,EAAE,SAAS;QACb,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5D,KAAK,CAAC,MAAM;YACV,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC;YACzE,MAAM,OAAO,GAAG,sBAAsB,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;YAC1G,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QACpC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,qBAAqB,EAAE,CAAC","sourcesContent":["import type { ExternalDiagramDefinition } from 'mermaid';\nimport type { ArchiMatePalette } from './styles.js';\n\nconst diagramId = 'archimate';\n\nexport interface ArchiMatePluginOptions {\n readonly palette?: ArchiMatePalette;\n readonly diagramPadding?: number;\n readonly useMaxWidth?: boolean;\n readonly maxRowWidth?: number;\n readonly background?: ArchiMateBackground;\n}\n\nexport type ArchiMateBackground = 'theme' | 'transparent';\n\nexport function createArchiMatePlugin({\n palette = 'modern',\n diagramPadding = 24,\n useMaxWidth = true,\n maxRowWidth = 1200,\n background = 'theme',\n}: ArchiMatePluginOptions = {}): ExternalDiagramDefinition {\n if (!Number.isFinite(diagramPadding) || diagramPadding < 0) {\n throw new RangeError('ArchiMate diagramPadding must be a finite, nonnegative number.');\n }\n // Infinity is accepted and turns row wrapping off.\n if (typeof maxRowWidth !== 'number' || Number.isNaN(maxRowWidth) || maxRowWidth <= 0) {\n throw new RangeError('ArchiMate maxRowWidth must be a number greater than 0, or Infinity.');\n }\n // JavaScript callers can pass any value.\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (background !== 'theme' && background !== 'transparent') {\n throw new RangeError(`ArchiMate background must be \"theme\" or \"transparent\".`);\n }\n if (typeof useMaxWidth !== 'boolean') {\n throw new TypeError('ArchiMate useMaxWidth must be a boolean.');\n }\n return {\n id: diagramId,\n detector: (text) => /^\\s*archimate-beta(?=\\s|$)/u.test(text),\n async loader() {\n const { createArchimateDiagram } = await import('./archimateDiagram.js');\n const diagram = createArchimateDiagram({ palette, diagramPadding, useMaxWidth, maxRowWidth, background });\n return { id: diagramId, diagram };\n },\n };\n}\n\nexport const archimate = createArchiMatePlugin();\n"]}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { ExternalDiagramDefinition } from 'mermaid';
|
|
2
|
+
import type { ArchiMatePluginOptions } from './archimateDetector.js';
|
|
3
|
+
type DiagramDefinition = Awaited<ReturnType<ExternalDiagramDefinition['loader']>>['diagram'];
|
|
4
|
+
export interface ArchiMateLogger {
|
|
5
|
+
readonly warn: (message: string) => void;
|
|
6
|
+
}
|
|
7
|
+
export declare function toLogger(log: unknown): ArchiMateLogger | undefined;
|
|
8
|
+
export declare function createArchimateDiagram(options: Required<ArchiMatePluginOptions>): DiagramDefinition;
|
|
9
|
+
export {};
|