@cogit/cli 0.25.1 → 0.25.3

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.
@@ -15,7 +15,7 @@ import {
15
15
  uninstallGitHooks,
16
16
  withHookBlock,
17
17
  withoutHookBlock
18
- } from "./chunk-YU7XXCX3.js";
18
+ } from "./chunk-NCRW3URU.js";
19
19
  export {
20
20
  BLOCK_END,
21
21
  BLOCK_START,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cogit/cli",
3
- "version": "0.25.1",
3
+ "version": "0.25.3",
4
4
  "description": "Git remembers what changed. cogit remembers why.",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -88,20 +88,31 @@ message's node, with the node's commit hashes:
88
88
  "shape": { "tools": [{ "kind": "pseudo", "text": "1. ...\n2. ..." }], "commits": ["abc1234"] }
89
89
  ```
90
90
 
91
- Three tools:
91
+ Tools (at most three, the ones that say the most; never two that tell the same thing):
92
92
 
93
- - `mermaid`: a Mermaid `flowchart TD` (or `LR`) of the new path between files or functions,
94
- at most 15 nodes. Quote labels that hold spaces or punctuation.
93
+ - `mermaid`: a Mermaid `flowchart TD` (or `LR`) of a path through code, at most 10 nodes.
94
+ Quote labels that hold spaces or punctuation.
95
+ - `sequence`: a Mermaid `sequenceDiagram` when work is handed between actors over time (a hook
96
+ starting a job, a client and a server, a queue drained later), at most 6 participants.
95
97
  - `table`: Before / After, one `case | before | after` line per case (at most 8), for a
96
98
  change someone can see: a fix, a new default, a rule that now says yes or no.
99
+ - `interface`: one `item | before | after` line per command, flag, exported function, config
100
+ key or stored schema field that changed, only what is reached from outside the module;
101
+ `—` for nothing.
102
+ - `example`: one concrete case with real values, each result on its own line after `→`. A new
103
+ or changed command or flag always gets one that runs it.
97
104
  - `pseudo`: numbered plain-language steps of the new logic, naming the functions and files.
98
105
 
99
- A change across two or more files gets the diagram and the steps; a visible behaviour change
100
- also gets the table; order them diagram, table, steps. `{ "tools": [] }` means nothing worth
101
- showing. Skip messages whose
102
- commits are only release/version bumps, lockfiles or CHANGELOG, or change fewer than 5 lines
103
- in total. Write it in the conversation's language; the CLI validates each output and keeps an
104
- invalid diagram as text.
106
+ Write names the same way in every tool: a role in plain words (`Git`, `cogit`, `Record`), a
107
+ file with its extension (`session.ts`), a function with `()`, a field with its owner
108
+ (`node.commits`), a command after `$`, printed text in quotes. In a diagram, name actors and
109
+ boxes by role with the code name in parentheses (`Queue (shape-queue.ts)`) and label arrows
110
+ with plain verbs. Tables have no header row. Order the tools diagram, tables, example, steps.
111
+
112
+ `{ "tools": [] }` means nothing worth showing: give it for a change nobody would notice from
113
+ outside (a refactor, a rename). Skip messages whose commits are only release/version bumps,
114
+ lockfiles or CHANGELOG, or change fewer than 5 lines in total. Write it in the conversation's
115
+ language; the CLI validates each output and keeps an invalid diagram as text.
105
116
 
106
117
  ## Branch summary
107
118