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.
45 lines
1.8 KiB
TypeScript
45 lines
1.8 KiB
TypeScript
import assert from 'node:assert/strict';
|
|
import fs from 'node:fs';
|
|
import path from 'node:path';
|
|
import { test } from 'node:test';
|
|
import Ajv2020 from 'ajv/dist/2020';
|
|
import { parse as parseYaml } from 'yaml';
|
|
|
|
const root = path.resolve(__dirname, '..', '..');
|
|
const schemas = path.join(root, 'schemas');
|
|
const fixtures = path.join(root, 'test', 'fixtures');
|
|
|
|
function validator() {
|
|
const ajv = new Ajv2020({ strict: false, allErrors: true });
|
|
// Register every schema under its file name, exactly how the relative
|
|
// $refs in the bundled copies resolve inside VS Code.
|
|
for (const file of fs.readdirSync(schemas)) {
|
|
ajv.addSchema(JSON.parse(fs.readFileSync(path.join(schemas, file), 'utf8')), file);
|
|
}
|
|
return ajv.getSchema('archify.schema.json')!;
|
|
}
|
|
|
|
test('bundled schemas carry no absolute $id', () => {
|
|
for (const file of fs.readdirSync(schemas)) {
|
|
assert.equal(JSON.parse(fs.readFileSync(path.join(schemas, file), 'utf8')).$id, undefined, file);
|
|
}
|
|
});
|
|
|
|
test('the .archify schema accepts every fixture', () => {
|
|
const validate = validator();
|
|
for (const file of fs.readdirSync(fixtures).filter((entry) => fs.statSync(path.join(fixtures, entry)).isFile())) {
|
|
const ok = validate(parseYaml(fs.readFileSync(path.join(fixtures, file), 'utf8')));
|
|
assert.ok(ok, `${file}: ${JSON.stringify(validate.errors?.slice(0, 3))}`);
|
|
}
|
|
});
|
|
|
|
test('the .archify schema applies the schema of the declared type', () => {
|
|
const validate = validator();
|
|
const sequence = parseYaml(fs.readFileSync(path.join(fixtures, 'cache-miss.archify'), 'utf8'));
|
|
// A sequence diagram is not a valid architecture diagram.
|
|
assert.equal(validate({ ...sequence, diagram_type: 'architecture' }), false);
|
|
assert.equal(validate({ ...sequence, diagram_type: 'poster' }), false);
|
|
const { diagram_type: _omitted, ...untyped } = sequence;
|
|
assert.equal(validate(untyped), false);
|
|
});
|