eidosmd 0.1.0 → 0.2.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.
- package/README.md +50 -29
- package/browser/dist/assets/index-C2NMN_D4.css +1 -0
- package/browser/dist/assets/index-C65k1ihb.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 +1 -1
- package/dist/src/commands/framework.js +24 -5
- package/dist/src/commands/index.js +4 -4
- package/dist/src/commands/init.js +1 -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/seeds.js +5 -5
- package/dist/src/commands/setup.js +119 -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 +722 -0
- package/dist/src/core/check.js +127 -51
- package/dist/src/core/convert.js +7 -6
- package/dist/src/core/framework-markdown.js +113 -34
- package/dist/src/core/framework-model.js +27 -10
- package/dist/src/core/framework-structured.js +132 -33
- package/dist/src/core/framework.js +13 -13
- package/dist/src/core/git.js +59 -0
- package/dist/src/core/index-leaf.js +2 -2
- package/dist/src/core/me.js +16 -8
- package/dist/src/core/migrate.js +243 -0
- package/dist/src/core/naming.js +1 -1
- package/dist/src/core/root.js +2 -2
- package/dist/src/core/scaffold.js +19 -19
- package/dist/src/core/seed.js +151 -60
- package/dist/src/core/server.js +1236 -52
- package/dist/src/core/settings.js +181 -0
- package/dist/src/core/store.js +259 -0
- package/dist/src/core/template.js +32 -0
- package/dist/src/core/versions.js +79 -0
- package/dist/src/output.js +4 -1
- package/dist/src/program.js +134 -39
- package/instructions/authoring.md +13 -12
- package/instructions/configuring.md +65 -34
- package/instructions/init-required.md +4 -4
- package/instructions/overview.md +17 -7
- package/instructions/validating.md +5 -4
- package/package.json +21 -12
- package/standard/EIDOS.md +129 -188
- package/standard/seeds/README.md +6 -6
- package/standard/seeds/book/Framework.yaml +81 -0
- package/standard/seeds/book/README.md +9 -5
- package/standard/seeds/book/_gitignore +3 -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 +81 -0
- package/standard/seeds/research/README.md +9 -5
- package/standard/seeds/research/_gitignore +3 -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 +82 -0
- package/standard/seeds/software/README.md +5 -5
- package/standard/seeds/software/_gitignore +3 -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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
## Validating blueprints
|
|
2
2
|
|
|
3
|
-
Validation is framework-defined. `eidos check` reads the root's own
|
|
3
|
+
Validation is framework-defined. `eidos check` reads the root's own `.eidos/Framework.yaml` and templates and enforces those, never a contract of its own.
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
6
|
eidos check # the whole root: framework, layout, every blueprint
|
|
@@ -13,8 +13,8 @@ Exit code 0 means no errors; 1 means at least one error (or, with `--strict`, an
|
|
|
13
13
|
|
|
14
14
|
### What the levels mean
|
|
15
15
|
|
|
16
|
-
- An **error** is wrong on any reading: frontmatter that does not parse, a missing `id` or `title`, an `id`
|
|
17
|
-
- A **warning** is a gap the standard says to note and offer, never refuse: a missing or empty property the
|
|
16
|
+
- An **error** is wrong on any reading: frontmatter that does not parse, a missing `id` or `title`, an `id` used twice (its form is free: a slug, a number, a GUID), a `variant` the collection does not declare, a link to a file that does not exist, a template file the framework points at but does not have.
|
|
17
|
+
- A **warning** is a gap the standard says to note and offer, never refuse: a missing or empty property the Properties table applies to this collection (every block of it: the core, yours, a tool's), a property no block declares, a work-tracking field, a body section the variant's template declares but the blueprint lacks, a section the template does not know, sections out of the template's order, a grouping value that does not match its folder, a declared frame nobody has written, a stale index, a version gap, a near-miss the Vocabulary names (`term-near-miss`, with the declared term beside it).
|
|
18
18
|
|
|
19
19
|
### Reporting a review
|
|
20
20
|
|
|
@@ -25,9 +25,10 @@ The output is a review the owner acts on. When you report:
|
|
|
25
25
|
- Offer to add a missing core property with a note on why it exists; never refuse the file.
|
|
26
26
|
- Confirm no work-tracking fields crept in, and that any section describing approach reads as intent, not progress.
|
|
27
27
|
- A version gap is worth one line and an offer to migrate, once per session; then carry on with the framework as it stands.
|
|
28
|
+
- A `term-near-miss` is a suggestion: name the declared term, ask, and leave the word to the owner. Never swap it in.
|
|
28
29
|
|
|
29
30
|
Do not fix silently. Show the finding, propose the change, and let the owner decide, unless the change is purely mechanical and they have asked for it (regenerating an index, adding a blank property stub).
|
|
30
31
|
|
|
31
32
|
### Things `check` cannot judge
|
|
32
33
|
|
|
33
|
-
Whether the prose is true, whether the scope is right, and whether an open question should be settled are the owner's. `check` tells you the file is well-formed against its framework; it says nothing about whether the
|
|
34
|
+
Whether the prose is true, whether the scope is right, and whether an open question should be settled are the owner's. `check` tells you the file is well-formed against its framework; it says nothing about whether the product described is the one they mean. Read the blueprint with the frames in mind and raise what does not fit.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eidosmd",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "The Eidos CLI: scaffold, validate, index, and browse a root of Eidos blueprints, and hand any agent the workflow it needs to work in one.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eidos",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
},
|
|
26
26
|
"files": [
|
|
27
27
|
"dist/src",
|
|
28
|
-
"browser",
|
|
28
|
+
"browser/dist",
|
|
29
29
|
"instructions",
|
|
30
30
|
"standard",
|
|
31
31
|
"NOTICE"
|
|
@@ -33,21 +33,30 @@
|
|
|
33
33
|
"engines": {
|
|
34
34
|
"node": ">=20"
|
|
35
35
|
},
|
|
36
|
+
"scripts": {
|
|
37
|
+
"build": "tsc -p tsconfig.json && vite build browser",
|
|
38
|
+
"clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
|
|
39
|
+
"test": "pnpm build && node --test \"dist/test/**/*.test.js\"",
|
|
40
|
+
"check": "tsc -p tsconfig.json --noEmit && tsc -p browser/tsconfig.json --noEmit",
|
|
41
|
+
"prepublishOnly": "pnpm clean && pnpm test",
|
|
42
|
+
"sync-standard": "node scripts/sync-standard.mjs",
|
|
43
|
+
"build:browser": "vite build browser",
|
|
44
|
+
"dev:browser": "vite browser"
|
|
45
|
+
},
|
|
36
46
|
"dependencies": {
|
|
37
47
|
"commander": "^14.0.0",
|
|
38
48
|
"marked": "^18.0.13",
|
|
39
49
|
"yaml": "^2.8.0"
|
|
40
50
|
},
|
|
41
51
|
"devDependencies": {
|
|
52
|
+
"@preact/preset-vite": "^2.10.6",
|
|
42
53
|
"@types/node": "^22.0.0",
|
|
43
|
-
"
|
|
54
|
+
"@types/react": "^19.3.0",
|
|
55
|
+
"@types/react-dom": "^19.3.0",
|
|
56
|
+
"html-to-image": "^1.11.13",
|
|
57
|
+
"preact": "^10.29.8",
|
|
58
|
+
"typescript": "^5.9.0",
|
|
59
|
+
"vite": "^8.3.0"
|
|
44
60
|
},
|
|
45
|
-
"bugs": "https://gitlab.com/the-virtual-panda/eidosmd/-/issues"
|
|
46
|
-
|
|
47
|
-
"build": "tsc -p tsconfig.json",
|
|
48
|
-
"clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
|
|
49
|
-
"test": "pnpm build && node --test \"dist/test/**/*.test.js\"",
|
|
50
|
-
"check": "tsc -p tsconfig.json --noEmit",
|
|
51
|
-
"sync-standard": "node scripts/sync-standard.mjs"
|
|
52
|
-
}
|
|
53
|
-
}
|
|
61
|
+
"bugs": "https://gitlab.com/the-virtual-panda/eidosmd/-/issues"
|
|
62
|
+
}
|