alignfirst 0.3.1 → 0.3.2

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.
@@ -7,7 +7,7 @@ const MAX_FILE_BYTES = 64 * 1024;
7
7
  const MAX_OUTPUT_BYTES = 30 * 1024;
8
8
  const PLAN_FILE = /^[A-Z]\d+-(?:main-plan|plan-.*)\.md$/;
9
9
  const OMISSION_NOTICE = `Content omitted: over the ${formatSize(MAX_FILE_BYTES)} limit.`;
10
- const TOO_LARGE_NOTICE = `History too large to print (over the ${formatSize(MAX_OUTPUT_BYTES)} budget). Read the relevant files among the entries above, skipping the plans (\`*-plan.md\`, \`*-main-plan.md\`, \`*-plan-*.md\`): their \`.summary.md\` files cover them.`;
10
+ const TOO_LARGE_NOTICE = `History too large to print (over the ${formatSize(MAX_OUTPUT_BYTES)} budget). Read the relevant files among the entries above, skipping the plans (\`*-plan.md\`, \`*-main-plan.md\`, \`*-plan-*.md\`): the specs and \`.summary.md\` files provide the catch-up context.`;
11
11
  export function renderCatchup(cwd, ticket, report) {
12
12
  const files = ticket.entries.flatMap((entry) => catchupFile(cwd, ticket.dir, entry));
13
13
  if (files.length === 0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "alignfirst",
3
- "version": "0.3.1",
3
+ "version": "0.3.2",
4
4
  "license": "CC0-1.0",
5
5
  "author": "Thomas MUR",
6
6
  "description": "The AlignFirst CLI: protocols, work files and docs in one command.",
@@ -1,5 +1,17 @@
1
1
  # AlignFirst Protocols
2
2
 
3
- `{{CMD}} guide <protocol>` prints a collaborative protocol to follow when the user names AlignFirst or a protocol alias. A guide already in context is not reloaded. Each named guide includes the ticket directory and work file rules; `--protocol-only` omits them when they are already in context.
3
+ When the user names AlignFirst with one of these protocols, or uses a protocol alias, run `{{CMD}} guide <protocol>` and follow it. Do not reload a guide already in context. Each guide includes the ticket directory and work file rules; use `--protocol-only` when those rules are already in context.
4
4
 
5
- Aliases: `alspec` → `spec`, `alplan` → `plan`, `al` or `AAD` → `aad`, `almerge` → `merge`, `alreview` → `review`, `aldescription` → `description`. `alcatchup` stands for `{{CMD}} ticket --catchup` followed by the user's instructions; `alcatchupaad` and `alcatchupspec` run it before the `aad` or `spec` protocol.
5
+ Protocols and aliases:
6
+
7
+ - `spec` (`alspec`)
8
+ - `plan` (`alplan`)
9
+ - `aad` (`AAD`, `al`)
10
+ - `merge` (`almerge`)
11
+ - `review` (`alreview`)
12
+ - `description` (`aldescription`)
13
+
14
+ Catch-up workflows and aliases:
15
+
16
+ - Catch up (`alcatchup`) — run `{{CMD}} ticket --catchup`.
17
+ - Catch up, then `aad` (`alcatchupaad`) or `spec` (`alcatchupspec`) — run `{{CMD}} ticket --catchup`, then follow the selected protocol.