stego-cli 0.3.3 → 0.4.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 (78) hide show
  1. package/README.md +10 -0
  2. package/dist/comments/comment-domain.js +919 -0
  3. package/dist/comments/comments-command.js +356 -64
  4. package/dist/metadata/metadata-command.js +127 -0
  5. package/dist/metadata/metadata-domain.js +209 -0
  6. package/dist/spine/spine-command.js +129 -0
  7. package/dist/spine/spine-domain.js +274 -0
  8. package/dist/stego-cli.js +205 -426
  9. package/package.json +3 -2
  10. package/projects/fiction-example/spine/characters/CHAR-AGNES.md +17 -0
  11. package/projects/fiction-example/spine/characters/CHAR-ETIENNE.md +17 -0
  12. package/projects/fiction-example/spine/characters/CHAR-MATTHAEUS.md +17 -0
  13. package/projects/fiction-example/spine/characters/CHAR-RAOUL.md +17 -0
  14. package/projects/fiction-example/spine/characters/_category.md +6 -0
  15. package/projects/fiction-example/spine/locations/LOC-CHARNEL.md +17 -0
  16. package/projects/fiction-example/spine/locations/LOC-COLLEGE.md +17 -0
  17. package/projects/fiction-example/spine/locations/LOC-HOTELDIEU.md +17 -0
  18. package/projects/fiction-example/spine/locations/LOC-QUAY.md +17 -0
  19. package/projects/fiction-example/spine/locations/_category.md +6 -0
  20. package/projects/fiction-example/spine/sources/SRC-CONJUNCTION.md +20 -0
  21. package/projects/fiction-example/spine/sources/SRC-GALEN.md +20 -0
  22. package/projects/fiction-example/spine/sources/SRC-WARD-DATA.md +20 -0
  23. package/projects/fiction-example/spine/sources/_category.md +6 -0
  24. package/projects/fiction-example/stego-project.json +1 -18
  25. package/projects/stego-docs/manuscript/500-project-configuration.md +3 -3
  26. package/projects/stego-docs/spine/commands/CMD-BUILD.md +11 -0
  27. package/projects/stego-docs/spine/commands/CMD-CHECK-STAGE.md +11 -0
  28. package/projects/stego-docs/spine/commands/CMD-EXPORT.md +11 -0
  29. package/projects/stego-docs/spine/commands/CMD-INIT.md +11 -0
  30. package/projects/stego-docs/spine/commands/CMD-LIST-PROJECTS.md +10 -0
  31. package/projects/stego-docs/spine/commands/CMD-NEW-PROJECT.md +10 -0
  32. package/projects/stego-docs/spine/commands/CMD-NEW.md +11 -0
  33. package/projects/stego-docs/spine/commands/CMD-VALIDATE.md +11 -0
  34. package/projects/stego-docs/spine/commands/_category.md +6 -0
  35. package/projects/stego-docs/spine/concepts/CON-COMPILE-STRUCTURE.md +9 -0
  36. package/projects/stego-docs/spine/concepts/CON-DIST.md +9 -0
  37. package/projects/stego-docs/spine/concepts/CON-MANUSCRIPT.md +9 -0
  38. package/projects/stego-docs/spine/concepts/CON-METADATA.md +9 -0
  39. package/projects/stego-docs/spine/concepts/CON-NOTES.md +9 -0
  40. package/projects/stego-docs/spine/concepts/CON-PROJECT.md +9 -0
  41. package/projects/stego-docs/spine/concepts/CON-SPINE-CATEGORY.md +11 -0
  42. package/projects/stego-docs/spine/concepts/CON-SPINE.md +9 -0
  43. package/projects/stego-docs/spine/concepts/CON-STAGE-GATE.md +10 -0
  44. package/projects/stego-docs/spine/concepts/CON-WORKSPACE.md +9 -0
  45. package/projects/stego-docs/spine/concepts/_category.md +6 -0
  46. package/projects/stego-docs/spine/configuration/CFG-ALLOWED-STATUSES.md +9 -0
  47. package/projects/stego-docs/spine/configuration/CFG-COMPILE-LEVELS.md +9 -0
  48. package/projects/stego-docs/spine/configuration/CFG-COMPILE-STRUCTURE.md +9 -0
  49. package/projects/stego-docs/spine/configuration/CFG-REQUIRED-METADATA.md +9 -0
  50. package/projects/stego-docs/spine/configuration/CFG-SPINE-CATEGORIES.md +9 -0
  51. package/projects/stego-docs/spine/configuration/CFG-STAGE-POLICIES.md +9 -0
  52. package/projects/stego-docs/spine/configuration/CFG-STEGO-CONFIG.md +9 -0
  53. package/projects/stego-docs/spine/configuration/CFG-STEGO-PROJECT.md +9 -0
  54. package/projects/stego-docs/spine/configuration/_category.md +6 -0
  55. package/projects/stego-docs/spine/integrations/INT-CSPELL.md +9 -0
  56. package/projects/stego-docs/spine/integrations/INT-MARKDOWNLINT.md +9 -0
  57. package/projects/stego-docs/spine/integrations/INT-PANDOC.md +9 -0
  58. package/projects/stego-docs/spine/integrations/INT-SAURUS-EXTENSION.md +9 -0
  59. package/projects/stego-docs/spine/integrations/INT-STEGO-EXTENSION.md +9 -0
  60. package/projects/stego-docs/spine/integrations/INT-VSCODE.md +9 -0
  61. package/projects/stego-docs/spine/integrations/_category.md +6 -0
  62. package/projects/stego-docs/spine/workflows/FLOW-BUILD-EXPORT.md +10 -0
  63. package/projects/stego-docs/spine/workflows/FLOW-DAILY-WRITING.md +10 -0
  64. package/projects/stego-docs/spine/workflows/FLOW-INIT-WORKSPACE.md +9 -0
  65. package/projects/stego-docs/spine/workflows/FLOW-NEW-PROJECT.md +10 -0
  66. package/projects/stego-docs/spine/workflows/FLOW-PROOF-RELEASE.md +10 -0
  67. package/projects/stego-docs/spine/workflows/FLOW-STAGE-PROMOTION.md +10 -0
  68. package/projects/stego-docs/spine/workflows/_category.md +6 -0
  69. package/projects/stego-docs/stego-project.json +1 -28
  70. package/dist/comments/add-comment.js +0 -382
  71. package/projects/fiction-example/spine/characters.md +0 -35
  72. package/projects/fiction-example/spine/locations.md +0 -37
  73. package/projects/fiction-example/spine/sources.md +0 -31
  74. package/projects/stego-docs/spine/commands.md +0 -71
  75. package/projects/stego-docs/spine/concepts.md +0 -72
  76. package/projects/stego-docs/spine/configuration.md +0 -57
  77. package/projects/stego-docs/spine/integrations.md +0 -43
  78. package/projects/stego-docs/spine/workflows.md +0 -48
@@ -1,71 +0,0 @@
1
- # Commands
2
-
3
- ## CMD-INIT
4
- label: stego init [--force]
5
-
6
- - `stego init [--force]`
7
- - Initialize a Stego workspace in the current directory.
8
- - Related workflows: FLOW-INIT-WORKSPACE.
9
- - Related concepts: CON-WORKSPACE, CON-PROJECT.
10
- - Related integrations: INT-VSCODE.
11
-
12
- ## CMD-LIST-PROJECTS
13
- label: stego list-projects [--root <path>]
14
-
15
- - `stego list-projects [--root <path>]`
16
- - List projects found in the current workspace.
17
- - Related workflows: FLOW-INIT-WORKSPACE, FLOW-DAILY-WRITING.
18
- - Related concepts: CON-WORKSPACE, CON-PROJECT.
19
-
20
- ## CMD-NEW-PROJECT
21
- label: stego new-project --project <project-id> [--title <title>] [--root <path>]
22
-
23
- - `stego new-project --project <project-id> [--title <title>] [--root <path>]`
24
- - Scaffold a new project under `projects/`.
25
- - Related workflows: FLOW-NEW-PROJECT.
26
- - Related concepts: CON-PROJECT, CON-MANUSCRIPT, CON-NOTES, CON-DIST.
27
-
28
- ## CMD-NEW
29
- label: stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]
30
-
31
- - `stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]`
32
- - Create a new manuscript file with an inferred numeric prefix and draft frontmatter.
33
- - Related workflows: FLOW-DAILY-WRITING.
34
- - Related concepts: CON-MANUSCRIPT, CON-METADATA.
35
- - Related configuration: CFG-REQUIRED-METADATA.
36
-
37
- ## CMD-VALIDATE
38
- label: stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]
39
-
40
- - `stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]`
41
- - Validate project configuration, manuscript structure, metadata, and references.
42
- - Related workflows: FLOW-DAILY-WRITING, FLOW-STAGE-PROMOTION.
43
- - Related concepts: CON-METADATA, CON-SPINE.
44
- - Related configuration: CFG-REQUIRED-METADATA, CFG-SPINE-CATEGORIES.
45
-
46
- ## CMD-BUILD
47
- label: stego build --project <project-id> [--root <path>]
48
-
49
- - `stego build --project <project-id> [--root <path>]`
50
- - Compile manuscript files into one generated markdown output.
51
- - Related workflows: FLOW-BUILD-EXPORT, FLOW-DAILY-WRITING.
52
- - Related concepts: CON-MANUSCRIPT, CON-DIST, CON-COMPILE-STRUCTURE.
53
- - Related configuration: CFG-COMPILE-STRUCTURE, CFG-COMPILE-LEVELS.
54
-
55
- ## CMD-CHECK-STAGE
56
- label: stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]
57
-
58
- - `stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]`
59
- - Run stage-aware checks for a requested editorial stage.
60
- - Related workflows: FLOW-STAGE-PROMOTION, FLOW-PROOF-RELEASE.
61
- - Related concepts: CON-STAGE-GATE, CON-METADATA.
62
- - Related configuration: CFG-STAGE-POLICIES, CFG-ALLOWED-STATUSES.
63
-
64
- ## CMD-EXPORT
65
- label: stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]
66
-
67
- - `stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]`
68
- - Export compiled output to target formats.
69
- - Related workflows: FLOW-BUILD-EXPORT, FLOW-PROOF-RELEASE.
70
- - Related concepts: CON-DIST.
71
- - Related integrations: INT-PANDOC.
@@ -1,72 +0,0 @@
1
- # Concepts
2
-
3
- ## CON-WORKSPACE
4
- label: A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
5
-
6
- - A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
7
- - Related commands: CMD-INIT, CMD-LIST-PROJECTS.
8
- - Related workflows: FLOW-INIT-WORKSPACE.
9
-
10
- ## CON-PROJECT
11
- label: A project is one writing unit inside `projects/<project-id>/` with its own `stego-project.json` and manuscript files in `/projects/<project-id>/manuscripts`.
12
-
13
- - A project is one writing unit inside `projects/<project-id>/` with its own `stego-project.json` and manuscript files in `/projects/<project-id>/manuscripts`.
14
- - Related commands: CMD-NEW-PROJECT, CMD-VALIDATE, CMD-BUILD.
15
- - Related workflows: FLOW-NEW-PROJECT, FLOW-DAILY-WRITING.
16
-
17
- ## CON-MANUSCRIPT
18
- label: `manuscript/` contains canonical source writing files ordered by filename prefix.
19
-
20
- - `manuscript/` contains canonical source writing files ordered by filename prefix.
21
- - Related commands: CMD-VALIDATE, CMD-BUILD.
22
- - Related configuration: CFG-REQUIRED-METADATA, CFG-COMPILE-STRUCTURE.
23
-
24
- ## CON-SPINE
25
- label: `spine/` stores canonical entities used for continuity and navigation.
26
-
27
- - `spine/` stores canonical entities used for continuity and navigation.
28
- - Related configuration: CFG-SPINE-CATEGORIES.
29
- - Related integrations: INT-STEGO-EXTENSION.
30
-
31
- ## CON-NOTES
32
- label: `notes/` contains supporting material that is not part of compiled manuscript output.
33
-
34
- - `notes/` contains supporting material that is not part of compiled manuscript output.
35
- - Related commands: CMD-NEW-PROJECT.
36
- - Related workflows: FLOW-DAILY-WRITING.
37
-
38
- ## CON-DIST
39
- label: `dist/` is generated output only and can be rebuilt from sources.
40
-
41
- - `dist/` is generated output only and can be rebuilt from sources.
42
- - Related commands: CMD-BUILD, CMD-EXPORT.
43
- - Related workflows: FLOW-BUILD-EXPORT, FLOW-PROOF-RELEASE.
44
-
45
- ## CON-METADATA
46
- label: "Frontmatter metadata drives validation, stage checks, grouping, and continuity references."
47
-
48
- - Frontmatter metadata drives validation, stage checks, grouping, and continuity references.
49
- - Related commands: CMD-VALIDATE, CMD-CHECK-STAGE.
50
- - Related configuration: CFG-REQUIRED-METADATA, CFG-ALLOWED-STATUSES.
51
-
52
- ## CON-STAGE-GATE
53
- label: Stage gates apply stricter checks as work moves from drafting to release.
54
-
55
- - Stage gates apply stricter checks as work moves from drafting to release.
56
- - Related commands: CMD-CHECK-STAGE.
57
- - Related workflows: FLOW-STAGE-PROMOTION, FLOW-PROOF-RELEASE.
58
- - Related configuration: CFG-STAGE-POLICIES.
59
-
60
- ## CON-COMPILE-STRUCTURE
61
- label: Compile structure groups ordered files into larger sections during build.
62
-
63
- - Compile structure groups ordered files into larger sections during build.
64
- - Related commands: CMD-BUILD.
65
- - Related configuration: CFG-COMPILE-STRUCTURE, CFG-COMPILE-LEVELS.
66
-
67
- ## CON-SPINE-CATEGORY
68
- label: "A spine category defines a metadata key, ID prefix, and canonical notes file."
69
-
70
- - A spine category defines a metadata key, ID prefix, and canonical notes file.
71
- - Related concepts: CON-SPINE, CON-METADATA.
72
- - Related configuration: CFG-SPINE-CATEGORIES.
@@ -1,57 +0,0 @@
1
- # Configuration
2
-
3
- ## CFG-STEGO-CONFIG
4
- label: Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
5
-
6
- - Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
7
- - Related concepts: CON-WORKSPACE.
8
- - Related commands: CMD-LIST-PROJECTS, CMD-CHECK-STAGE.
9
-
10
- ## CFG-STEGO-PROJECT
11
- label: "Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories."
12
-
13
- - Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories.
14
- - Related concepts: CON-PROJECT, CON-METADATA, CON-SPINE.
15
- - Related commands: CMD-VALIDATE, CMD-BUILD.
16
-
17
- ## CFG-REQUIRED-METADATA
18
- label: Advisory list of frontmatter keys expected in manuscript files.
19
-
20
- - Advisory list of frontmatter keys expected in manuscript files.
21
- - Related concepts: CON-METADATA.
22
- - Related commands: CMD-VALIDATE.
23
-
24
- ## CFG-COMPILE-STRUCTURE
25
- label: Build grouping configuration that defines structural levels and heading behavior.
26
-
27
- - Build grouping configuration that defines structural levels and heading behavior.
28
- - Related concepts: CON-COMPILE-STRUCTURE.
29
- - Related commands: CMD-BUILD.
30
-
31
- ## CFG-COMPILE-LEVELS
32
- label: "The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options."
33
-
34
- - The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options.
35
- - Related configuration: CFG-COMPILE-STRUCTURE.
36
- - Related concepts: CON-COMPILE-STRUCTURE.
37
-
38
- ## CFG-SPINE-CATEGORIES
39
- label: Per-project category definitions mapping metadata keys to ID prefixes and spine files.
40
-
41
- - Per-project category definitions mapping metadata keys to ID prefixes and spine files.
42
- - Related concepts: CON-SPINE, CON-SPINE-CATEGORY.
43
- - Related commands: CMD-VALIDATE.
44
-
45
- ## CFG-STAGE-POLICIES
46
- label: Stage policy settings determine which checks are enforced at each stage.
47
-
48
- - Stage policy settings determine which checks are enforced at each stage.
49
- - Related concepts: CON-STAGE-GATE.
50
- - Related commands: CMD-CHECK-STAGE.
51
-
52
- ## CFG-ALLOWED-STATUSES
53
- label: Workspace-level list of allowed manuscript statuses.
54
-
55
- - Workspace-level list of allowed manuscript statuses.
56
- - Related concepts: CON-METADATA, CON-STAGE-GATE.
57
- - Related commands: CMD-VALIDATE, CMD-CHECK-STAGE.
@@ -1,43 +0,0 @@
1
- # Integrations
2
-
3
- ## INT-VSCODE
4
- label: VS Code is the primary editor environment for Stego projects.
5
-
6
- - VS Code is the primary editor environment for Stego projects.
7
- - Related workflows: FLOW-INIT-WORKSPACE, FLOW-DAILY-WRITING.
8
- - Related commands: CMD-INIT.
9
-
10
- ## INT-STEGO-EXTENSION
11
- label: "The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation."
12
-
13
- - The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation.
14
- - Related concepts: CON-SPINE, CON-STAGE-GATE.
15
- - Related workflows: FLOW-DAILY-WRITING, FLOW-STAGE-PROMOTION.
16
-
17
- ## INT-SAURUS-EXTENSION
18
- label: The Saurus extension complements prose editing and research workflows in project folders.
19
-
20
- - The Saurus extension complements prose editing and research workflows in project folders.
21
- - Related integrations: INT-VSCODE.
22
- - Related workflows: FLOW-DAILY-WRITING.
23
-
24
- ## INT-PANDOC
25
- label: "Pandoc is used for optional export formats such as docx, pdf, and epub."
26
-
27
- - Pandoc is used for optional export formats such as docx, pdf, and epub.
28
- - Related commands: CMD-EXPORT.
29
- - Related workflows: FLOW-BUILD-EXPORT.
30
-
31
- ## INT-MARKDOWNLINT
32
- label: Markdownlint is used in stricter proofreading and release stages.
33
-
34
- - Markdownlint is used in stricter proofreading and release stages.
35
- - Related concepts: CON-STAGE-GATE.
36
- - Related workflows: FLOW-PROOF-RELEASE.
37
-
38
- ## INT-CSPELL
39
- label: CSpell supports spelling and terminology checks during later-stage quality passes.
40
-
41
- - CSpell supports spelling and terminology checks during later-stage quality passes.
42
- - Related concepts: CON-STAGE-GATE.
43
- - Related workflows: FLOW-PROOF-RELEASE.
@@ -1,48 +0,0 @@
1
- # Workflows
2
-
3
- ## FLOW-INIT-WORKSPACE
4
- label: "Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects."
5
-
6
- - Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects.
7
- - Related commands: CMD-INIT, CMD-LIST-PROJECTS.
8
- - Related concepts: CON-WORKSPACE, CON-PROJECT.
9
-
10
- ## FLOW-DAILY-WRITING
11
- label: "Open one project, write in manuscript files, validate, build, and commit progress."
12
-
13
- - Open one project, write in manuscript files, validate, build, and commit progress.
14
- - Related commands: CMD-VALIDATE, CMD-BUILD.
15
- - Related concepts: CON-MANUSCRIPT, CON-METADATA, CON-DIST.
16
- - Related integrations: INT-VSCODE.
17
-
18
- ## FLOW-NEW-PROJECT
19
- label: "Create a new project, review generated folders, and configure project metadata rules."
20
-
21
- - Create a new project, review generated folders, and configure project metadata rules.
22
- - Related commands: CMD-NEW-PROJECT, CMD-VALIDATE.
23
- - Related concepts: CON-PROJECT, CON-MANUSCRIPT, CON-SPINE.
24
- - Related configuration: CFG-STEGO-PROJECT.
25
-
26
- ## FLOW-STAGE-PROMOTION
27
- label: Move files through statuses and verify readiness with stage checks.
28
-
29
- - Move files through statuses and verify readiness with stage checks.
30
- - Related commands: CMD-CHECK-STAGE, CMD-VALIDATE.
31
- - Related concepts: CON-STAGE-GATE, CON-METADATA.
32
- - Related configuration: CFG-STAGE-POLICIES, CFG-ALLOWED-STATUSES.
33
-
34
- ## FLOW-BUILD-EXPORT
35
- label: Build a compiled markdown manuscript and export distribution formats.
36
-
37
- - Build a compiled markdown manuscript and export distribution formats.
38
- - Related commands: CMD-BUILD, CMD-EXPORT.
39
- - Related concepts: CON-DIST, CON-COMPILE-STRUCTURE.
40
- - Related integrations: INT-PANDOC.
41
-
42
- ## FLOW-PROOF-RELEASE
43
- label: "Run strict checks, build outputs, export artifacts, and archive release files."
44
-
45
- - Run strict checks, build outputs, export artifacts, and archive release files.
46
- - Related commands: CMD-CHECK-STAGE, CMD-BUILD, CMD-EXPORT.
47
- - Related concepts: CON-STAGE-GATE, CON-DIST.
48
- - Related integrations: INT-MARKDOWNLINT, INT-CSPELL.