npm - eidosmd - Versions diffs - 0.1.0 → 0.3.0 - Mend

eidosmd 0.1.0 → 0.3.0

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.

Files changed (107) hide show

package/README.md +50 -29
package/browser/dist/assets/index-Cc3cNWHY.css +1 -0
package/browser/dist/assets/index-DQgCQRa5.js +46 -0
package/browser/dist/favicon.svg +5 -0
package/browser/dist/index.html +15 -0
package/browser/dist/mark.svg +4 -0
package/dist/src/cli.js +7 -0
package/dist/src/commands/agents.js +1 -1
package/dist/src/commands/canvas.js +77 -0
package/dist/src/commands/check.js +10 -4
package/dist/src/commands/configure.js +201 -0
package/dist/src/commands/framework.js +37 -7
package/dist/src/commands/index.js +4 -4
package/dist/src/commands/init.js +5 -0
package/dist/src/commands/instructions.js +1 -1
package/dist/src/commands/list.js +8 -8
package/dist/src/commands/migrate.js +32 -0
package/dist/src/commands/new.js +3 -3
package/dist/src/commands/property.js +125 -0
package/dist/src/commands/seeds.js +5 -5
package/dist/src/commands/setup.js +131 -0
package/dist/src/commands/version.js +44 -0
package/dist/src/commands/whoami.js +4 -4
package/dist/src/context.js +5 -5
package/dist/src/core/blueprint.js +16 -11
package/dist/src/core/canvas-schema.js +148 -0
package/dist/src/core/canvas.js +732 -0
package/dist/src/core/check.js +221 -70
package/dist/src/core/convert.js +7 -6
package/dist/src/core/edits.js +1381 -0
package/dist/src/core/framework-markdown.js +119 -34
package/dist/src/core/framework-model.js +62 -10
package/dist/src/core/framework-structured.js +222 -47
package/dist/src/core/framework.js +13 -13
package/dist/src/core/frontmatter.js +61 -1
package/dist/src/core/git.js +84 -0
package/dist/src/core/index-leaf.js +2 -2
package/dist/src/core/links.js +87 -0
package/dist/src/core/markdown.js +16 -9
package/dist/src/core/me.js +16 -8
package/dist/src/core/migrate.js +319 -0
package/dist/src/core/naming.js +1 -1
package/dist/src/core/regions.js +117 -0
package/dist/src/core/root.js +2 -2
package/dist/src/core/scaffold.js +33 -27
package/dist/src/core/seed.js +187 -71
package/dist/src/core/server.js +1410 -53
package/dist/src/core/settings.js +232 -0
package/dist/src/core/store.js +315 -0
package/dist/src/core/template.js +32 -0
package/dist/src/core/versions.js +84 -0
package/dist/src/output.js +4 -1
package/dist/src/program.js +421 -41
package/instructions/authoring.md +15 -12
package/instructions/configuring.md +81 -34
package/instructions/init-required.md +4 -4
package/instructions/overview.md +21 -9
package/instructions/validating.md +9 -6
package/package.json +21 -12
package/standard/EIDOS.md +142 -259
package/standard/seeds/README.md +12 -16
package/standard/seeds/book/Framework.yaml +61 -0
package/standard/seeds/book/README.md +10 -5
package/standard/seeds/book/_gitignore +9 -3
package/standard/seeds/book/me.md +1 -1
package/standard/seeds/book/roles/README.md +3 -3
package/standard/seeds/book/roles/framework-owner.md +2 -2
package/standard/seeds/book/{shapes → templates}/chapter.full.md +0 -8
package/standard/seeds/book/{shapes → templates}/chapter.sketch.md +0 -7
package/standard/seeds/book/{shapes → templates}/frame.market.md +0 -6
package/standard/seeds/book/templates/frame.premise.md +17 -0
package/standard/seeds/book/{shapes → templates}/frame.reader.md +0 -6
package/standard/seeds/book/{shapes → templates}/frame.voice.md +0 -7
package/standard/seeds/research/Framework.yaml +61 -0
package/standard/seeds/research/README.md +10 -5
package/standard/seeds/research/_gitignore +9 -3
package/standard/seeds/research/me.md +1 -1
package/standard/seeds/research/roles/README.md +3 -3
package/standard/seeds/research/roles/framework-owner.md +2 -2
package/standard/seeds/research/{shapes → templates}/frame.ethics.md +0 -6
package/standard/seeds/research/{shapes → templates}/frame.method.md +0 -7
package/standard/seeds/research/{shapes → templates}/frame.prior-work.md +0 -6
package/standard/seeds/research/{shapes → templates}/frame.question.md +0 -7
package/standard/seeds/research/{shapes → templates}/investigation.full.md +0 -8
package/standard/seeds/research/{shapes → templates}/investigation.note.md +0 -7
package/standard/seeds/software/Framework.yaml +62 -0
package/standard/seeds/software/README.md +7 -6
package/standard/seeds/software/_gitignore +9 -3
package/standard/seeds/software/me.md +1 -1
package/standard/seeds/software/roles/README.md +3 -3
package/standard/seeds/software/roles/framework-owner.md +2 -2
package/standard/seeds/software/roles/project-manager.md +2 -2
package/standard/seeds/software/roles/stakeholder.md +1 -1
package/standard/seeds/software/{shapes → templates}/frame.architecture.md +0 -7
package/standard/seeds/software/{shapes → templates}/frame.audience.md +1 -8
package/standard/seeds/software/{shapes → templates}/frame.criteria.md +0 -8
package/standard/seeds/software/{shapes → templates}/frame.market.md +0 -8
package/standard/seeds/software/{shapes → templates}/spec.full.md +0 -8
package/standard/seeds/software/{shapes → templates}/spec.micro.md +0 -9
package/browser/index.html +0 -268
package/dist/src/commands/convert.js +0 -30
package/dist/src/core/shape.js +0 -26
package/standard/seeds/book/Framework.md +0 -87
package/standard/seeds/book/shapes/frame.premise.md +0 -24
package/standard/seeds/research/Framework.md +0 -88
package/standard/seeds/software/Framework.md +0 -88
/package/standard/seeds/software/{shapes → templates}/.gitkeep +0 -0

package/browser/dist/favicon.svg ADDED Viewed

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" role="img" aria-label="Eidos">
+  <rect width="32" height="32" rx="7" fill="#000000"/>
+  <rect x="5.1" y="5.1" width="21.8" height="21.8" rx="5" fill="none" stroke="#e08a63" stroke-width="1.8" opacity="0.5"/>
+  <path d="M16 9.4 21.9 16 16 22.6 10.1 16 16 9.4Z" fill="#e08a63"/>
+</svg>

package/browser/dist/index.html ADDED Viewed

@@ -0,0 +1,15 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="color-scheme" content="dark light" />
+    <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
+    <title>Eidos</title>
+    <script type="module" crossorigin src="/assets/index-DQgCQRa5.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-Cc3cNWHY.css">
+  </head>
+  <body>
+    <div id="app"></div>
+  </body>
+</html>

package/browser/dist/mark.svg ADDED Viewed

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" fill="none" role="img" aria-label="Eidos">
+  <rect x="2.75" y="2.75" width="26.5" height="26.5" rx="6.25" stroke="#e08a63" stroke-width="1.9" opacity="0.42"/>
+  <path d="M16 8.6 22.9 16 16 23.4 9.1 16 16 8.6Z" fill="#e08a63"/>
+</svg>

package/dist/src/cli.js CHANGED Viewed

@@ -2,4 +2,11 @@
 // The executable entry point: one root of Eidos blueprints, scaffolded,
 // validated, and indexed from the shell.
 import { buildProgram } from './program.js';
+// A reader that closes the pipe early (`eidos framework | head`) is not an
+// error worth a stack trace: stop writing and leave quietly.
+process.stdout.on('error', (error) => {
+    if (error.code === 'EPIPE')
+        process.exit(0);
+    throw error;
+});
 buildProgram().parse(process.argv);

package/dist/src/commands/agents.js CHANGED Viewed

@@ -10,7 +10,7 @@ export function nudge() {
         NUDGE_START,
         '## Eidos',
         '',
-        'This repository keeps its blueprints in an Eidos root. Before creating, editing, reviewing, or discussing a blueprint or the framework, run `eidos instructions overview` and follow it; it names the guide to read for each kind of work. Use the `eidos` CLI for structure (`eidos new`, `eidos check`, `eidos index`); never hand-assemble frontmatter or edit an `index.md`.',
+        'This repository keeps its blueprints in an Eidos root. Before creating, editing, reviewing, or discussing a blueprint or the framework, run `eidos instructions overview` and follow it; it names the guide to read for each kind of work. Use the `eidos` CLI for structure (`eidos new`, `eidos check`, `eidos index`); never hand-assemble frontmatter or edit the generated index in the framework document.',
         NUDGE_END,
     ].join('\n');
 }

package/dist/src/commands/canvas.js ADDED Viewed

@@ -0,0 +1,77 @@
+// `eidos canvas`: the canvas maps a root keeps under .eidos/plugins/eidosmd/maps/, listed or
+// created from the shell; the browser is where they are drawn.
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { stringify } from 'yaml';
+import { createCanvas, findPage, listCanvases, loadCanvas, CanvasError } from '../core/canvas.js';
+import { CANVAS_SCHEMA } from '../core/canvas-schema.js';
+import { CliError, EXIT_OK, print, printJson } from '../output.js';
+export function runCanvasList(context, options) {
+    const canvases = listCanvases(context.framework);
+    if (options.json) {
+        printJson(canvases.map((canvas) => ({ id: canvas.id, title: canvas.title, path: path.relative(context.root, canvas.file).split(path.sep).join('/'), pages: canvas.pages.map((page) => ({ id: page.id, title: page.title, nodes: page.nodes.length, edges: page.edges.length })), problems: canvas.problems })));
+        return EXIT_OK;
+    }
+    if (canvases.length === 0) {
+        print('no canvases under .eidos/plugins/eidosmd/maps/; create one: eidos canvas new "<title>", or open eidos browser');
+        return EXIT_OK;
+    }
+    for (const canvas of canvases) {
+        print(`${canvas.id}  —  ${canvas.title}`);
+        for (const page of canvas.pages) {
+            print(`  ${page.id}: ${page.title} (${page.nodes.length} node${page.nodes.length === 1 ? '' : 's'}, ${page.edges.length} edge${page.edges.length === 1 ? '' : 's'})`);
+        }
+    }
+    return EXIT_OK;
+}
+export function runCanvasNew(context, title, options) {
+    let canvas;
+    try {
+        canvas = createCanvas(context.framework, title);
+    }
+    catch (cause) {
+        if (cause instanceof CanvasError) {
+            throw new CliError(cause.message);
+        }
+        throw cause;
+    }
+    const rel = path.relative(context.root, canvas.file).split(path.sep).join('/');
+    if (options.json) {
+        printJson({ id: canvas.id, title: canvas.title, path: rel });
+        return EXIT_OK;
+    }
+    print(`✓ ${rel}  (canvas ${canvas.id}, one page: overview)`, '  next: eidos browser, and draw');
+    return EXIT_OK;
+}
+// The file as it is, or one page of it, for a person or an agent about to edit it.
+export function runCanvasShow(context, id, options) {
+    let canvas;
+    try {
+        canvas = loadCanvas(context.framework, id);
+        if (options.page !== undefined) {
+            const page = findPage(canvas, options.page);
+            if (options.json)
+                printJson(page);
+            else
+                print(stringify(page).trimEnd());
+            return EXIT_OK;
+        }
+    }
+    catch (cause) {
+        if (cause instanceof CanvasError) {
+            throw new CliError(cause.message);
+        }
+        throw cause;
+    }
+    if (options.json) {
+        printJson({ id: canvas.id, title: canvas.title, path: path.relative(context.root, canvas.file).split(path.sep).join('/'), pages: canvas.pages, problems: canvas.problems });
+        return EXIT_OK;
+    }
+    print(readFileSync(canvas.file, 'utf8').trimEnd());
+    return EXIT_OK;
+}
+// The JSON Schema of the file, for whoever edits one without the browser.
+export function runCanvasSchema() {
+    printJson(CANVAS_SCHEMA);
+    return EXIT_OK;
+}

package/dist/src/commands/check.js CHANGED Viewed

@@ -3,8 +3,13 @@
 // whether anything was an error.
 import path from 'node:path';
 import { checkRoot } from '../core/check.js';
+import { readSettings } from '../core/settings.js';
 import { standardVersion } from '../paths.js';
 import { CliError, EXIT_FINDINGS, EXIT_OK, print, printJson } from '../output.js';
+// Whether a warning fails this run: the flag when given, else the root's setting.
+export function strictFor(root, flag) {
+    return flag ?? readSettings(root).shared.check.strict;
+}
 function mark(finding) {
     return finding.level === 'error' ? '✗' : '⚠';
 }
@@ -16,17 +21,18 @@ export function runCheck(context, paths, options) {
             const resolved = path.resolve(context.cwd, given);
             const match = context.blueprints.find((blueprint) => path.resolve(blueprint.path) === resolved);
             if (!match) {
-                throw new CliError(`${given} is not a blueprint in ${context.root} (not in a declared collection, or an index.md)`);
+                throw new CliError(`${given} is not a blueprint in ${context.root} (not in a declared collection)`);
             }
             only.add(match.path);
         }
     }
     const report = checkRoot(context.framework, context.blueprints, { only, standardVersion: standardVersion() });
-    const failed = report.errors > 0 || (options.strict && report.warnings > 0);
+    const strict = strictFor(context.root, options.strict);
+    const failed = report.errors > 0 || (strict && report.warnings > 0);
     if (options.json) {
         printJson({
             ok: !failed,
-            strict: options.strict,
+            strict,
             root: report.root,
             eidos_version: report.eidosVersion,
             naming: report.naming,
@@ -55,7 +61,7 @@ export function runCheck(context, paths, options) {
     }
     else {
         const parts = [`${report.errors} error${report.errors === 1 ? '' : 's'}`, `${report.warnings} warning${report.warnings === 1 ? '' : 's'}`];
-        print(`${failed ? '✗' : '⚠'} ${parts.join(', ')}${options.strict && report.errors === 0 && report.warnings > 0 ? ' (--strict)' : ''}`);
+        print(`${failed ? '✗' : '⚠'} ${parts.join(', ')}${strict && report.errors === 0 && report.warnings > 0 ? (options.strict === undefined ? ' (strict: this root fails on warnings)' : ' (--strict)') : ''}`);
     }
     return failed ? EXIT_FINDINGS : EXIT_OK;
 }

package/dist/src/commands/configure.js ADDED Viewed

@@ -0,0 +1,201 @@
+// `eidos configure:<noun> <operation>`: the framework edited from the shell.
+// Every mutating command builds a plan (src/core/edits.ts), prints it whole,
+// and asks before writing; --dry-run prints and stops, --yes proceeds
+// without the question, --force proceeds through what needs forcing. With
+// no terminal and no switch the command refuses and names the switch, so an
+// agent learns it from the error instead of hanging on a prompt.
+import { readFileSync } from 'node:fs';
+import { applyPlan, editContext, EditError, planJson } from '../core/edits.js';
+import { listRoles } from '../core/me.js';
+import { readSettings } from '../core/settings.js';
+import { standardVersion } from '../paths.js';
+import { askYesNo, interactive } from './setup.js';
+import { CliError, EXIT_FINDINGS, EXIT_OK, EXIT_USAGE, print, printJson } from '../output.js';
+const describe = (step) => {
+    switch (step.kind) {
+        case 'document':
+            return `~ ${step.path}  ${step.what}`;
+        case 'key':
+            if (step.op === 'rename')
+                return `~ ${step.path}  ${step.key} → ${step.to ?? ''}`;
+            if (step.op === 'delete')
+                return `~ ${step.path}  drop ${step.key}`;
+            return `~ ${step.path}  ${step.key}: ${JSON.stringify(step.before ?? null)} → ${JSON.stringify(step.after ?? '')}`;
+        case 'links':
+            return `~ ${step.path}  ${step.count} link${step.count === 1 ? '' : 's'} rewritten`;
+        case 'write':
+            return `+ ${step.path}  ${step.what}`;
+        case 'move':
+            return `> ${step.from} → ${step.to}`;
+        case 'remove':
+            return `- ${step.path}  ${step.what}`;
+        case 'settings':
+            return `~ ${step.path}  ${step.what}`;
+        default:
+            return '';
+    }
+};
+function printPlan(plan) {
+    print(`plan: ${plan.command}`);
+    if (plan.steps.length === 0)
+        print('  nothing to change');
+    for (const step of plan.steps)
+        print(`  ${describe(step)}`);
+    if (plan.lost.length > 0) {
+        print('', 'values that will be gone:');
+        for (const lost of plan.lost)
+            print(`  ${lost.path}  ${lost.key}: ${JSON.stringify(lost.value)}`);
+    }
+    if (plan.notes.length > 0) {
+        print('', 'note:');
+        for (const note of plan.notes)
+            print(`  ${note}`);
+    }
+    if (plan.conflicts.length > 0) {
+        print('', 'conflicts:');
+        for (const conflict of plan.conflicts)
+            print(`  ✗ ${conflict.message}`);
+    }
+}
+// Build, show, confirm, apply, then index and check: the one path every
+// mutating configure command takes.
+export async function runPlan(context, build, options) {
+    let plan;
+    try {
+        plan = build(editContext(context.root));
+    }
+    catch (cause) {
+        if (cause instanceof EditError)
+            throw new CliError(cause.message);
+        throw cause;
+    }
+    if (!options.json)
+        printPlan(plan);
+    const blocking = plan.conflicts.filter((conflict) => !conflict.force || !options.force);
+    if (blocking.length > 0) {
+        if (options.json)
+            printJson({ ok: false, applied: false, ...planJson(plan) });
+        const forcible = blocking.every((conflict) => conflict.force);
+        throw new CliError(forcible ? 'the plan needs --force to proceed (see conflicts)' : `the plan cannot proceed: ${blocking.map((conflict) => conflict.message).join('; ')}`);
+    }
+    if (options.dryRun) {
+        if (options.json)
+            printJson({ ok: true, applied: false, dry_run: true, ...planJson(plan) });
+        else
+            print('', 'dry run: nothing written');
+        return EXIT_OK;
+    }
+    if (plan.steps.length === 0) {
+        if (options.json)
+            printJson({ ok: true, applied: false, ...planJson(plan) });
+        return EXIT_OK;
+    }
+    if (!options.yes && !options.force) {
+        if (!interactive()) {
+            if (options.json)
+                printJson({ ok: false, applied: false, ...planJson(plan) });
+            throw new CliError(plan.destructive ? 'not a terminal: values or files would be gone; run with --force to proceed, or --dry-run to see the plan' : 'not a terminal: run with --yes to proceed, or --dry-run to see the plan', EXIT_USAGE);
+        }
+        const go = await askYesNo(plan.destructive ? 'Proceed? Values or files listed above will be gone' : 'Proceed?', !plan.destructive);
+        if (!go) {
+            print('nothing written');
+            return EXIT_OK;
+        }
+    }
+    else if (plan.destructive && !options.force && !interactive()) {
+        if (options.json)
+            printJson({ ok: false, applied: false, ...planJson(plan) });
+        throw new CliError('not a terminal: values or files would be gone; --yes is not enough, run with --force', EXIT_USAGE);
+    }
+    const applied = applyPlan(plan, standardVersion());
+    const strict = readSettings(context.root).shared.check.strict;
+    const failed = applied.errors > 0 || (strict && applied.warnings > 0);
+    if (options.json) {
+        printJson({ ok: !failed, applied: true, ...planJson(plan), new_findings: applied.newFindings, errors: applied.errors, warnings: applied.warnings, strict });
+        return failed ? EXIT_FINDINGS : EXIT_OK;
+    }
+    print('', `✓ ${plan.steps.length} step${plan.steps.length === 1 ? '' : 's'} applied; index rewritten`);
+    if (applied.newFindings.length > 0) {
+        print('  check now also reports:');
+        for (const finding of applied.newFindings)
+            print(`    ${finding.level === 'error' ? '✗' : '⚠'} ${finding.path ?? '(root)'}  ${finding.code}  ${finding.message}`);
+    }
+    else {
+        print('  check: nothing new');
+    }
+    return failed ? EXIT_FINDINGS : EXIT_OK;
+}
+// ---- show -------------------------------------------------------------------
+export function showProperty(context, name, json) {
+    const all = [...context.framework.schema.core, ...context.framework.schema.custom, ...Object.values(context.framework.schema.tools).flat()];
+    const chosen = name === undefined ? all : all.filter((property) => property.name === name);
+    if (name !== undefined && chosen.length === 0)
+        throw new CliError(`no property '${name}' (eidos framework lists them)`);
+    const view = chosen.map((property) => ({ name: property.name, type: property.type, applies_to: property.appliesTo, required: property.required, ...(property.options ? { options: property.options } : {}), meaning: property.meaning, owner: property.owner, ...(property.tools ? { tools: property.tools } : {}) }));
+    if (json) {
+        printJson(name === undefined ? view : view[0]);
+        return EXIT_OK;
+    }
+    for (const property of view) {
+        print(`${property.name}  (${property.type}, ${property.applies_to === 'all' ? 'all' : property.applies_to.join(', ')}${property.required ? ', required' : ''}; ${property.owner === 'eidos' ? "the standard's" : property.owner === 'custom' ? 'yours' : `${property.owner}'s`})`);
+        if (property.meaning)
+            print(`  ${property.meaning}`);
+        if (property.options)
+            print(`  options: ${property.options.join(', ')}`);
+    }
+    return EXIT_OK;
+}
+export function showCollection(context, name, json) {
+    const chosen = name === undefined ? context.framework.collections : context.framework.collections.filter((collection) => collection.name.toLowerCase() === name.toLowerCase());
+    if (name !== undefined && chosen.length === 0)
+        throw new CliError(`no collection '${name}'`);
+    const view = chosen.map((collection) => ({ name: collection.name, description: collection.description, unit: collection.variants.find((variant) => variant.isDefault)?.unit ?? null, variants: collection.variants.map((variant) => ({ name: variant.name, template: variant.template, default: variant.isDefault, description: variant.description })), grouping: collection.grouping }));
+    if (json) {
+        printJson(name === undefined ? view : view[0]);
+        return EXIT_OK;
+    }
+    for (const collection of view) {
+        print(`${collection.name}${collection.unit ? `  (unit ${collection.unit})` : ''}`);
+        if (collection.description)
+            print(`  ${collection.description}`);
+        print(`  variants: ${collection.variants.map((variant) => `${variant.name}${variant.default ? ' (default)' : ''}`).join(', ')}`);
+        if (collection.grouping)
+            print(`  ${collection.grouping.label}${collection.grouping.property ? ` (${collection.grouping.property})` : ''}: ${collection.grouping.groups.map((group) => group.name).join(', ') || 'none yet'}`);
+    }
+    return EXIT_OK;
+}
+// Every folder at the root as the framework declares it, with its type; a
+// collection's variants and grouping are `configure:collection show`'s.
+export function showFolder(context, name, json) {
+    const chosen = name === undefined ? context.framework.folders : context.framework.folders.filter((folder) => folder.name.toLowerCase() === name.toLowerCase());
+    if (name !== undefined && chosen.length === 0)
+        throw new CliError(`no folder '${name}' (eidos framework lists them)`);
+    const view = chosen.map((folder) => ({ name: folder.name, type: folder.type, description: folder.description }));
+    if (json) {
+        printJson(name === undefined ? view : view[0]);
+        return EXIT_OK;
+    }
+    for (const folder of view) {
+        print(`${folder.name}  (${folder.type})`);
+        if (folder.description)
+            print(`  ${folder.description}`);
+    }
+    return EXIT_OK;
+}
+export function showRole(context, name, json) {
+    const roles = listRoles(context.root);
+    const chosen = name === undefined ? roles : roles.filter((role) => role.name === name);
+    if (name !== undefined && chosen.length === 0)
+        throw new CliError(`no role '${name}' (eidos roles lists them)`);
+    if (json) {
+        printJson(name === undefined ? chosen.map((role) => ({ name: role.name, title: role.title, summary: role.summary })) : { name: chosen[0]?.name, title: chosen[0]?.title, summary: chosen[0]?.summary, text: readFileSync(chosen[0]?.file ?? '', 'utf8') });
+        return EXIT_OK;
+    }
+    if (name === undefined) {
+        for (const role of chosen)
+            print(`${role.name}  ${role.title}${role.summary ? `: ${role.summary}` : ''}`);
+        return EXIT_OK;
+    }
+    process.stdout.write(readFileSync(chosen[0]?.file ?? '', 'utf8'));
+    return EXIT_OK;
+}

package/dist/src/commands/framework.js CHANGED Viewed

@@ -1,7 +1,8 @@
 // `eidos framework`: what the root's framework document declares, as a human
 // summary, as JSON an agent can read instead of parsing the file, or as the
-// YAML document a scriptable root keeps on disk.
+// document itself, normalized.
 import path from 'node:path';
+import { isCollection, unitOf } from '../core/framework-model.js';
 import { frameworkToDocument, serializeDocument } from '../core/framework-structured.js';
 import { CliError, EXIT_OK, print, printJson } from '../output.js';
 export function frameworkJson(framework) {
@@ -16,7 +17,7 @@ export function runFramework(context, options) {
     const { framework } = context;
     if (options.as !== undefined) {
         if (options.as !== 'yaml') {
-            throw new CliError('--as takes yaml (the markdown form is authored, not generated)');
+            throw new CliError('--as takes yaml');
         }
         process.stdout.write(serializeDocument(frameworkToDocument(framework)));
         return EXIT_OK;
@@ -44,6 +45,10 @@ export function runFramework(context, options) {
         if (collection.framing) {
             tags.push('framing');
         }
+        const unit = unitOf(collection);
+        if (unit) {
+            tags.push(`unit: ${unit}`);
+        }
         if (collection.grouping) {
             tags.push(`grouped by ${collection.grouping.label}${collection.grouping.property ? ` (\`${collection.grouping.property}\`)` : ''}`);
         }
@@ -54,14 +59,21 @@ export function runFramework(context, options) {
         if (collection.description) {
             print(`    ${collection.description}`);
         }
-        const flavors = collection.flavors.map((flavor) => `${flavor.name}${flavor.isDefault ? ' (default)' : ''}`);
-        print(`    flavors: ${flavors.length > 0 ? flavors.join(', ') : 'none declared'}`);
+        const variants = collection.variants.map((variant) => `${variant.name}${variant.isDefault ? ' (default)' : ''}`);
+        print(`    variants: ${variants.length > 0 ? variants.join(', ') : 'none declared'}`);
         if (collection.grouping && collection.grouping.groups.length > 0) {
             print(`    groups: ${collection.grouping.groups.map((group) => group.name).join(', ')}`);
         }
     }
-    print('', 'Schema');
-    print(`  core:   ${framework.schema.core.map((property) => property.name).join(', ')}`);
+    const plain = framework.folders.filter((folder) => !isCollection(folder));
+    if (plain.length > 0) {
+        print('', 'Folders');
+        for (const folder of plain) {
+            print(`  ${folder.name}  (${folder.type})${folder.description ? ` — ${folder.description}` : ''}`);
+        }
+    }
+    print('', 'Properties');
+    print(`  core:   ${framework.schema.core.map((property) => `${property.name}${property.required ? ' (required)' : ''}`).join(', ')}`);
     if (framework.schema.custom.length === 0) {
         print('  custom: none');
     }
@@ -69,7 +81,25 @@ export function runFramework(context, options) {
         print('  custom:');
         for (const property of framework.schema.custom) {
             const scope = property.appliesTo === 'all' ? 'all' : property.appliesTo.join(', ');
-            print(`    ${property.name} (${property.type}, ${scope}) — ${property.meaning}`);
+            const tools = property.tools ? `  [${Object.keys(property.tools).join(', ')}]` : '';
+            print(`    ${property.name} (${property.type}, ${scope}${property.required ? ', required' : ''}) — ${property.meaning}${tools}`);
+            if (property.options)
+                print(`      options: ${property.options.join(', ')}`);
+        }
+    }
+    for (const [tool, block] of Object.entries(framework.schema.tools)) {
+        print(`  ${tool} (the tool's own block):`);
+        for (const property of block) {
+            const scope = property.appliesTo === 'all' ? 'all' : property.appliesTo.join(', ');
+            print(`    ${property.name} (${property.type}, ${scope}${property.required ? ', required' : ''}) — ${property.meaning}`);
+            if (property.options)
+                print(`      options: ${property.options.join(', ')}`);
+        }
+    }
+    if (framework.vocabulary.length > 0) {
+        print('', 'Vocabulary');
+        for (const term of framework.vocabulary) {
+            print(`  ${term.term}: ${term.means}${term.not.length > 0 ? `  (not: ${term.not.join('; ')})` : ''}`);
         }
     }
     return EXIT_OK;

package/dist/src/commands/index.js CHANGED Viewed

@@ -1,4 +1,4 @@
-// `eidos index`: regenerate each collection's index.md, or verify them with --check.
+// `eidos index`: regenerate each collection's index in the framework document, or verify them with --check.
 import path from 'node:path';
 import { buildIndexes } from '../core/index-leaf.js';
 import { findCollection } from '../core/framework.js';
@@ -9,13 +9,13 @@ export function runIndex(context, options) {
         collections = options.collection.map((name) => {
             const found = findCollection(context.framework, name);
             if (!found) {
-                throw new CliError(`collection '${name}' is not declared in Framework.md`);
+                throw new CliError(`collection '${name}' is not declared in the framework document`);
             }
             return found;
         });
     }
     if (context.framework.collections.length === 0) {
-        throw new CliError('no collections declared in _eidos/Framework.md (## Collections)');
+        throw new CliError('no collections declared in the framework document');
     }
     const results = buildIndexes(context.framework, context.blueprints, { collections, check: options.check });
     const stale = results.some((result) => result.status === 'stale');
@@ -39,7 +39,7 @@ export function runIndex(context, options) {
         const count = `${result.count} blueprint${result.count === 1 ? '' : 's'}`;
         switch (result.status) {
             case 'folder-missing':
-                printError(`  ✗ ${result.collection.name}: folder not found (${path.dirname(result.file)})`);
+                printError(`  ✗ ${result.collection.name}: folder not found (${path.join(context.root, result.collection.name)})`);
                 break;
             case 'stale':
                 print(`  ✗ stale: ${relFile}`);

package/dist/src/commands/init.js CHANGED Viewed

@@ -23,6 +23,7 @@ export function runInit(rootArg, options, cwd = process.cwd()) {
             naming,
             groups: options.group,
             product: options.product ?? null,
+            framing: options.framing,
             date: options.date,
             dryRun: options.dryRun,
         });
@@ -41,6 +42,7 @@ export function runInit(rootArg, options, cwd = process.cwd()) {
             naming: result.naming,
             framework_file: result.frameworkFile,
             collections: result.collections,
+            folders: result.folders,
             grouped_collection: result.groupedCollection,
             groups: result.groups,
             scaffolded: result.scaffolded,
@@ -58,6 +60,9 @@ export function runInit(rootArg, options, cwd = process.cwd()) {
         collections += `; groups under ${result.groupedCollection}: ${result.groups.join(', ')}`;
     }
     print(collections);
+    if (result.folders.length > 0) {
+        print(`  folders: ${result.folders.join(', ')}`);
+    }
     if (result.scaffolded.length > 0) {
         print(`  blank frames: ${result.scaffolded.join(', ')}`);
     }

package/dist/src/commands/instructions.js CHANGED Viewed

@@ -8,7 +8,7 @@ export const GUIDES = [
     { name: 'overview', summary: 'Required first read before answering any request in a root' },
     { name: 'authoring', summary: 'How to place, scaffold, fill, and check a blueprint with the owner' },
     { name: 'validating', summary: 'How to run a check, read its findings, and report a review' },
-    { name: 'configuring', summary: 'How to add a collection, a flavor, or a property, and keep the Framework current' },
+    { name: 'configuring', summary: 'How to add a collection, a variant, or a property, and keep the Framework current' },
     { name: 'init-required', summary: 'How to create a root when there is none here' },
 ];
 export function guideText(name) {

package/dist/src/commands/list.js CHANGED Viewed

@@ -1,17 +1,17 @@
 // `eidos list`: the blueprints in the root, filterable by collection, group,
-// flavor, or any property value.
-import { blueprintId, blueprintTitle, propertyString, resolveFlavor } from '../core/blueprint.js';
+// variant, or any property value.
+import { blueprintId, blueprintTitle, propertyString, resolveVariant } from '../core/blueprint.js';
 import { findCollection } from '../core/framework.js';
 import { CliError, EXIT_OK, print, printJson, table } from '../output.js';
 export function blueprintJson(blueprint) {
-    const { flavor, declared } = resolveFlavor(blueprint);
+    const { variant, declared } = resolveVariant(blueprint);
     return {
         id: blueprintId(blueprint),
         title: blueprintTitle(blueprint),
         summary: propertyString(blueprint, 'summary'),
         collection: blueprint.collection.name,
         group: blueprint.group,
-        flavor: flavor?.name ?? declared,
+        variant: variant?.name ?? declared,
         path: blueprint.rel,
         properties: blueprint.properties ?? {},
     };
@@ -46,9 +46,9 @@ export function runList(context, collectionArg, options) {
         const wanted = options.group.toLowerCase();
         selected = selected.filter((blueprint) => blueprint.group?.toLowerCase() === wanted);
     }
-    if (options.flavor !== undefined) {
-        const wanted = options.flavor.toLowerCase();
-        selected = selected.filter((blueprint) => resolveFlavor(blueprint).flavor?.name.toLowerCase() === wanted);
+    if (options.variant !== undefined) {
+        const wanted = options.variant.toLowerCase();
+        selected = selected.filter((blueprint) => resolveVariant(blueprint).variant?.name.toLowerCase() === wanted);
     }
     for (const clause of options.where) {
         selected = selected.filter((blueprint) => matchesWhere(blueprint, clause));
@@ -65,7 +65,7 @@ export function runList(context, collectionArg, options) {
         blueprintId(blueprint) ?? '(no id)',
         blueprintTitle(blueprint),
         blueprint.group === null ? blueprint.collection.name : `${blueprint.collection.name}/${blueprint.group}`,
-        resolveFlavor(blueprint).flavor?.name ?? '?',
+        resolveVariant(blueprint).variant?.name ?? '?',
     ]);
     print(...table([['ID', 'TITLE', 'COLLECTION', 'FLAVOR'], ...rows]));
     print('', `${selected.length} blueprint${selected.length === 1 ? '' : 's'}`);

package/dist/src/commands/migrate.js ADDED Viewed

@@ -0,0 +1,32 @@
+// `eidos migrate`: move a root to the standard this CLI carries, mechanically,
+// and say what moved.
+import { findMigratableRoot, migrateRoot, MigrationError } from '../core/migrate.js';
+import { CliError, EXIT_OK, print, printJson } from '../output.js';
+export function runMigrate(options, cwd = process.cwd()) {
+    let report;
+    try {
+        report = migrateRoot(findMigratableRoot(cwd, options.root), { dryRun: options.dryRun });
+    }
+    catch (cause) {
+        if (cause instanceof MigrationError)
+            throw new CliError(cause.message);
+        throw cause;
+    }
+    if (options.json) {
+        printJson(report);
+        return EXIT_OK;
+    }
+    if (report.actions.length === 0) {
+        print(`${report.root} already targets Eidos ${report.to}; nothing to move`);
+    }
+    else {
+        print(`${options.dryRun ? 'would move' : 'moved'} ${report.root} from Eidos ${report.from ?? '?'} to ${report.to}:`);
+        for (const action of report.actions)
+            print(`  ${options.dryRun ? '·' : '✓'} ${action}`);
+    }
+    for (const note of report.notes)
+        print(`  ! ${note}`);
+    if (!options.dryRun && report.actions.length > 0)
+        print('', 'next: eidos check');
+    return EXIT_OK;
+}

package/dist/src/commands/new.js CHANGED Viewed

@@ -20,7 +20,7 @@ export function runNew(context, collection, titleWords, options) {
         result = scaffoldBlueprint(context.framework, context.blueprints, {
             collection,
             title: titleWords.join(' '),
-            flavor: options.flavor ?? null,
+            variant: options.variant ?? null,
             group: options.group ?? null,
             id: options.id ?? null,
             summary: options.summary ?? null,
@@ -45,7 +45,7 @@ export function runNew(context, collection, titleWords, options) {
             id: result.id,
             collection: result.collection.name,
             group: result.group,
-            flavor: result.flavor.name,
+            variant: result.variant.name,
             dry_run: options.dryRun,
             notes: result.notes,
             content: options.dryRun ? result.content : undefined,
@@ -56,7 +56,7 @@ export function runNew(context, collection, titleWords, options) {
         print(`would write ${result.rel}:`, '', result.content);
     }
     else {
-        print(`✓ ${result.rel}  (${result.collection.name}, ${result.flavor.kind}.${result.flavor.name}, id ${result.id})`);
+        print(`✓ ${result.rel}  (${result.collection.name}, ${result.variant.unit}.${result.variant.name}, id ${result.id})`);
     }
     for (const note of result.notes) {
         print(`  ! ${note}`);