get-tbd 0.2.3 → 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.
- package/README.md +38 -6
- package/dist/bin.mjs +3494 -949
- package/dist/bin.mjs.map +1 -1
- package/dist/cli.mjs +1827 -1312
- package/dist/cli.mjs.map +1 -1
- package/dist/{config-1ouUTKQr.mjs → config-B1w3pAkY.mjs} +142 -290
- package/dist/config-B1w3pAkY.mjs.map +1 -0
- package/dist/config-DXhifxOw.mjs +3 -0
- package/dist/doc-cache-CamtXfi4.mjs +1035 -0
- package/dist/doc-cache-CamtXfi4.mjs.map +1 -0
- package/dist/doc-cache-CiBwpDTf.mjs +3 -0
- package/dist/doc-fork-BMjqzfAs.mjs +3 -0
- package/dist/doc-fork-CoPi1G1N.mjs +304 -0
- package/dist/doc-fork-CoPi1G1N.mjs.map +1 -0
- package/dist/docref-C7g0sjvL.mjs +167 -0
- package/dist/docref-C7g0sjvL.mjs.map +1 -0
- package/dist/docs/README.md +38 -6
- package/dist/docs/SKILL.md +13 -4
- package/dist/docs/guidelines/backward-compatibility-rules.md +1 -0
- package/dist/docs/guidelines/bun-monorepo-patterns.md +1 -0
- package/dist/docs/guidelines/cli-agent-skill-patterns.md +124 -38
- package/dist/docs/guidelines/commit-conventions.md +1 -0
- package/dist/docs/guidelines/common-doc-guidelines.md +1 -0
- package/dist/docs/guidelines/convex-limits-best-practices.md +1 -0
- package/dist/docs/guidelines/convex-rules.md +1 -0
- package/dist/docs/guidelines/electron-app-development-patterns.md +1 -0
- package/dist/docs/guidelines/error-handling-rules.md +1 -0
- package/dist/docs/guidelines/general-coding-rules.md +1 -0
- package/dist/docs/guidelines/general-comment-rules.md +1 -0
- package/dist/docs/guidelines/general-eng-agent-principles.md +1 -0
- package/dist/docs/guidelines/general-tdd-guidelines.md +1 -0
- package/dist/docs/guidelines/general-testing-rules.md +1 -0
- package/dist/docs/guidelines/golden-testing-guidelines.md +1 -0
- package/dist/docs/guidelines/pnpm-monorepo-patterns.md +1 -0
- package/dist/docs/guidelines/python-cli-patterns.md +1 -0
- package/dist/docs/guidelines/python-modern-guidelines.md +1 -0
- package/dist/docs/guidelines/python-rules.md +1 -0
- package/dist/docs/guidelines/release-notes-guidelines.md +1 -0
- package/dist/docs/guidelines/supply-chain-hardening.md +3 -2
- package/dist/docs/guidelines/tbd-sync-troubleshooting.md +1 -0
- package/dist/docs/guidelines/typescript-cli-tool-rules.md +1 -0
- package/dist/docs/guidelines/typescript-code-coverage.md +1 -0
- package/dist/docs/guidelines/typescript-rules.md +1 -0
- package/dist/docs/guidelines/typescript-sorting-patterns.md +1 -0
- package/dist/docs/guidelines/typescript-yaml-handling-rules.md +1 -0
- package/dist/docs/references/docmap-format.md +64 -0
- package/dist/docs/references/docref-format.md +71 -0
- package/dist/docs/shortcuts/standard/checkout-third-party-repo.md +17 -4
- package/dist/docs/shortcuts/standard/new-shortcut.md +5 -5
- package/dist/docs/shortcuts/standard/plan-implementation-with-beads.md +1 -1
- package/dist/docs/shortcuts/standard/suggest-upstream-improvements.md +69 -0
- package/dist/docs/shortcuts/standard/sync-failure-recovery.md +1 -1
- package/dist/docs/shortcuts/standard/welcome-user.md +28 -0
- package/dist/docs/shortcuts/system/skill-baseline.md +13 -4
- package/dist/docs/tbd-design.md +141 -0
- package/dist/docs/tbd-docs.md +169 -5
- package/dist/docs/tbd-prime.md +0 -1
- package/dist/docs/templates/qa-playbook.md +3 -1
- package/dist/docs/templates/research-brief.md +2 -2
- package/dist/fork-manifest-ByU7U2do.mjs +253 -0
- package/dist/fork-manifest-ByU7U2do.mjs.map +1 -0
- package/dist/fork-manifest-C7lGRq-6.mjs +3 -0
- package/dist/{id-mapping-mtoSP9Qt.mjs → id-mapping-D0iitY-F.mjs} +1 -1
- package/dist/{id-mapping-687_UEsy.mjs → id-mapping-DAIeLKzm.mjs} +8 -200
- package/dist/id-mapping-DAIeLKzm.mjs.map +1 -0
- package/dist/index.d.mts +90 -13
- package/dist/index.mjs +3 -3
- package/dist/lockfile-BR0laSDy.mjs +198 -0
- package/dist/lockfile-BR0laSDy.mjs.map +1 -0
- package/dist/paths-C1DpnZJW.mjs +405 -0
- package/dist/paths-C1DpnZJW.mjs.map +1 -0
- package/dist/{schemas-f0EcuAVu.mjs → schemas-lCwRk30L.mjs} +19 -6
- package/dist/schemas-lCwRk30L.mjs.map +1 -0
- package/dist/{src-DTyyuaG_.mjs → src-CxKOynr1.mjs} +3 -3
- package/dist/src-CxKOynr1.mjs.map +1 -0
- package/dist/tbd +3494 -949
- package/dist/yaml-utils-BPy991by.mjs.map +1 -1
- package/package.json +1 -1
- package/dist/config-1ouUTKQr.mjs.map +0 -1
- package/dist/config-YRRW9l89.mjs +0 -3
- package/dist/id-mapping-687_UEsy.mjs.map +0 -1
- package/dist/schemas-f0EcuAVu.mjs.map +0 -1
- package/dist/src-DTyyuaG_.mjs.map +0 -1
|
@@ -1,204 +1,12 @@
|
|
|
1
|
-
import { b as IdMappingYamlSchema } from "./schemas-
|
|
1
|
+
import { b as IdMappingYamlSchema } from "./schemas-lCwRk30L.mjs";
|
|
2
2
|
import { i as parseYamlToleratingDuplicateKeys, r as hasMergeConflictMarkers, s as stringifyYaml } from "./yaml-utils-BPy991by.mjs";
|
|
3
|
-
import {
|
|
3
|
+
import { n as withLockfile } from "./lockfile-BR0laSDy.mjs";
|
|
4
|
+
import { mkdir, readFile } from "node:fs/promises";
|
|
4
5
|
import { dirname, join } from "node:path";
|
|
5
6
|
import { writeFile } from "atomically";
|
|
6
|
-
import { randomBytes
|
|
7
|
+
import { randomBytes } from "node:crypto";
|
|
7
8
|
import { monotonicFactory } from "ulid";
|
|
8
9
|
|
|
9
|
-
//#region src/utils/lockfile.ts
|
|
10
|
-
/**
|
|
11
|
-
* Directory-based mutual exclusion for concurrent file access.
|
|
12
|
-
*
|
|
13
|
-
* Note: Despite the name "lockfile", this is NOT a POSIX file lock (flock/fcntl).
|
|
14
|
-
* It uses mkdir to create a lock *directory* as a coordination convention — no
|
|
15
|
-
* OS-level file locking syscalls are involved. This makes it portable across all
|
|
16
|
-
* filesystems, including NFS and other network mounts where flock/fcntl locks
|
|
17
|
-
* are unreliable or unsupported.
|
|
18
|
-
*
|
|
19
|
-
* This is the same strategy used by:
|
|
20
|
-
*
|
|
21
|
-
* - **Git** for ref updates (e.g., `.git/refs/heads/main.lock`)
|
|
22
|
-
* See: https://git-scm.com/docs/gitrepository-layout ("lockfile protocol")
|
|
23
|
-
* - **npm** for package-lock.json concurrent access
|
|
24
|
-
*
|
|
25
|
-
* ## Why mkdir?
|
|
26
|
-
*
|
|
27
|
-
* `mkdir(2)` is atomic on all common filesystems (local and network): it either
|
|
28
|
-
* creates the directory or returns EEXIST. Unlike `open(O_CREAT|O_EXCL)`,
|
|
29
|
-
* a directory lock is trivially distinguishable from normal files.
|
|
30
|
-
*
|
|
31
|
-
* Node.js `fs.mkdir` maps directly to the mkdir(2) syscall, preserving
|
|
32
|
-
* the atomicity guarantee:
|
|
33
|
-
* https://nodejs.org/api/fs.html#fsmkdirpath-options-callback
|
|
34
|
-
*
|
|
35
|
-
* ## Lock lifecycle
|
|
36
|
-
*
|
|
37
|
-
* 1. **Acquire**: `mkdir(lockDir)` — fails with EEXIST if held by another process
|
|
38
|
-
* 2. **Hold**: Execute the critical section
|
|
39
|
-
* 3. **Release**: `rmdir(lockDir)` — in a finally block, with a bounded retry to
|
|
40
|
-
* absorb transient Windows failures (EBUSY/EPERM from AV scanners or lingering
|
|
41
|
-
* handles) that would otherwise orphan the lock directory.
|
|
42
|
-
* 4. **Stale detection**: If lock mtime exceeds a threshold, assume the holder
|
|
43
|
-
* crashed and break the lock. Breaking is done **atomically** by renaming the
|
|
44
|
-
* stale directory aside (only one waiter can win the rename), so two waiters can
|
|
45
|
-
* never both break the same lock and end up running concurrently. This is a
|
|
46
|
-
* heuristic — safe when the critical section is short-lived (sub-second for
|
|
47
|
-
* file I/O).
|
|
48
|
-
*
|
|
49
|
-
* ## Failure on timeout
|
|
50
|
-
*
|
|
51
|
-
* If the lock cannot be acquired within the timeout, a LockAcquisitionError is
|
|
52
|
-
* thrown. This prevents the dangerous "degraded mode" where the critical section
|
|
53
|
-
* runs without mutual exclusion, which can cause data loss (e.g., lost ID
|
|
54
|
-
* mappings during concurrent `tbd create`).
|
|
55
|
-
*
|
|
56
|
-
* IMPORTANT: `timeoutMs` must be greater than `staleMs` so stale locks from
|
|
57
|
-
* crashed processes are always detected and broken before the timeout expires.
|
|
58
|
-
*/
|
|
59
|
-
const DEFAULT_TIMEOUT_MS = 1e4;
|
|
60
|
-
const DEFAULT_POLL_MS = 50;
|
|
61
|
-
const DEFAULT_STALE_MS = 5e3;
|
|
62
|
-
/**
|
|
63
|
-
* Lock timing profile for shared data-sync operations.
|
|
64
|
-
*
|
|
65
|
-
* Issue sync can include fetch, merge, push, and outbox import work, so it must
|
|
66
|
-
* not use the short stale window intended for single-file writes. `timeoutMs`
|
|
67
|
-
* is kept just above `staleMs` so a crashed-process lock is always broken as
|
|
68
|
-
* stale before the timeout expires, matching the invariant documented above.
|
|
69
|
-
*
|
|
70
|
-
* Accepted trade-off (no heartbeat): a live `tbd sync` that hangs longer than
|
|
71
|
-
* `staleMs` (30 min) can have its lock broken by another process mid-operation.
|
|
72
|
-
* For current data sizes this is acceptable — single-repo sync workloads
|
|
73
|
-
* complete well under the window — and adding heartbeat metadata adds
|
|
74
|
-
* cross-process state machinery without changing the common case. If sync
|
|
75
|
-
* workloads grow or the lock-break race becomes observable in practice,
|
|
76
|
-
* revisit by adding heartbeat metadata inside the lock directory (touch mtime
|
|
77
|
-
* periodically; treat as stale only if heartbeat is older than `staleMs`).
|
|
78
|
-
* See: plan-2026-05-17-shared-common-dir-sync-worktree.md §Post-Review
|
|
79
|
-
* Hardening H6.
|
|
80
|
-
*/
|
|
81
|
-
const DATA_SYNC_LOCK_OPTIONS = {
|
|
82
|
-
timeoutMs: 35 * 6e4,
|
|
83
|
-
pollMs: 250,
|
|
84
|
-
staleMs: 30 * 6e4
|
|
85
|
-
};
|
|
86
|
-
/**
|
|
87
|
-
* Error thrown when the lock cannot be acquired within the timeout.
|
|
88
|
-
*/
|
|
89
|
-
var LockAcquisitionError = class extends Error {
|
|
90
|
-
constructor(lockPath, timeoutMs) {
|
|
91
|
-
super(`Failed to acquire lock at ${lockPath} within ${timeoutMs}ms. Another process may be holding the lock. If this persists, delete the lock directory manually and retry.`);
|
|
92
|
-
this.name = "LockAcquisitionError";
|
|
93
|
-
}
|
|
94
|
-
};
|
|
95
|
-
/** Filesystem error codes that are transient on Windows and worth retrying. */
|
|
96
|
-
const TRANSIENT_RMDIR_CODES = new Set([
|
|
97
|
-
"EBUSY",
|
|
98
|
-
"EPERM",
|
|
99
|
-
"EACCES",
|
|
100
|
-
"ENOTEMPTY"
|
|
101
|
-
]);
|
|
102
|
-
/**
|
|
103
|
-
* Remove a lock directory, tolerating transient Windows failures.
|
|
104
|
-
*
|
|
105
|
-
* `rmdir` can intermittently fail with EBUSY/EPERM on Windows (antivirus scanners
|
|
106
|
-
* or lingering directory handles). A few short retries make release reliable; if it
|
|
107
|
-
* still fails, we give up and let stale detection reclaim the directory rather than
|
|
108
|
-
* throwing from a best-effort cleanup path.
|
|
109
|
-
*/
|
|
110
|
-
async function removeLockDir(lockPath, attempts = 5) {
|
|
111
|
-
for (let attempt = 0; attempt < attempts; attempt++) try {
|
|
112
|
-
await rmdir(lockPath);
|
|
113
|
-
return;
|
|
114
|
-
} catch (error) {
|
|
115
|
-
const code = error.code;
|
|
116
|
-
if (code === "ENOENT") return;
|
|
117
|
-
if (attempt < attempts - 1 && code && TRANSIENT_RMDIR_CODES.has(code)) {
|
|
118
|
-
await new Promise((resolve) => setTimeout(resolve, 20 * (attempt + 1)));
|
|
119
|
-
continue;
|
|
120
|
-
}
|
|
121
|
-
return;
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
/**
|
|
125
|
-
* Atomically break a stale lock.
|
|
126
|
-
*
|
|
127
|
-
* Renames the stale directory to a unique sidecar path and removes it. `rename` is
|
|
128
|
-
* atomic, so when several waiters race to break the same stale lock only one wins the
|
|
129
|
-
* rename; the losers see ENOENT and simply retry. This prevents the classic
|
|
130
|
-
* non-atomic break race (rmdir + mkdir) where two waiters both break the lock and both
|
|
131
|
-
* acquire it, defeating mutual exclusion.
|
|
132
|
-
*/
|
|
133
|
-
async function breakStaleLock(lockPath) {
|
|
134
|
-
const sidecar = `${lockPath}.stale-${randomUUID()}`;
|
|
135
|
-
try {
|
|
136
|
-
await rename(lockPath, sidecar);
|
|
137
|
-
} catch {
|
|
138
|
-
return;
|
|
139
|
-
}
|
|
140
|
-
await removeLockDir(sidecar);
|
|
141
|
-
}
|
|
142
|
-
/**
|
|
143
|
-
* Execute `fn` while holding a lockfile.
|
|
144
|
-
*
|
|
145
|
-
* The lock is a directory at `lockPath` (typically `<target-file>.lock`).
|
|
146
|
-
* Concurrent callers will wait up to `timeoutMs` for the lock, polling
|
|
147
|
-
* every `pollMs`. Stale locks older than `staleMs` are broken automatically.
|
|
148
|
-
*
|
|
149
|
-
* If the lock cannot be acquired within the timeout, a LockAcquisitionError
|
|
150
|
-
* is thrown. This ensures mutual exclusion is never silently bypassed, which
|
|
151
|
-
* prevents data loss from concurrent writes.
|
|
152
|
-
*
|
|
153
|
-
* @param lockPath - Path to use as the lock directory (e.g., "/path/to/ids.yml.lock")
|
|
154
|
-
* @param fn - Critical section to execute under the lock
|
|
155
|
-
* @param options - Timing parameters for lock acquisition
|
|
156
|
-
* @returns The return value of `fn`
|
|
157
|
-
* @throws LockAcquisitionError if the lock cannot be acquired within the timeout
|
|
158
|
-
*
|
|
159
|
-
* @example
|
|
160
|
-
* ```ts
|
|
161
|
-
* await withLockfile('/path/to/ids.yml.lock', async () => {
|
|
162
|
-
* const data = await readFile('/path/to/ids.yml', 'utf-8');
|
|
163
|
-
* const updated = mergeEntries(data, newEntries);
|
|
164
|
-
* await writeFile('/path/to/ids.yml', updated);
|
|
165
|
-
* });
|
|
166
|
-
* ```
|
|
167
|
-
*/
|
|
168
|
-
async function withLockfile(lockPath, fn, options) {
|
|
169
|
-
const timeoutMs = options?.timeoutMs ?? DEFAULT_TIMEOUT_MS;
|
|
170
|
-
const pollMs = options?.pollMs ?? DEFAULT_POLL_MS;
|
|
171
|
-
const staleMs = options?.staleMs ?? DEFAULT_STALE_MS;
|
|
172
|
-
const deadline = Date.now() + timeoutMs;
|
|
173
|
-
let acquired = false;
|
|
174
|
-
while (Date.now() < deadline) try {
|
|
175
|
-
await mkdir(lockPath);
|
|
176
|
-
acquired = true;
|
|
177
|
-
break;
|
|
178
|
-
} catch (error) {
|
|
179
|
-
if (error.code !== "EEXIST") throw error;
|
|
180
|
-
let lockStat;
|
|
181
|
-
try {
|
|
182
|
-
lockStat = await stat(lockPath);
|
|
183
|
-
} catch {
|
|
184
|
-
continue;
|
|
185
|
-
}
|
|
186
|
-
if (!lockStat.isDirectory()) throw new Error(`Lock path exists but is not a directory: ${lockPath}. Refusing to break it; remove the conflicting file and retry.`);
|
|
187
|
-
if (Date.now() - lockStat.mtimeMs > staleMs) {
|
|
188
|
-
await breakStaleLock(lockPath);
|
|
189
|
-
continue;
|
|
190
|
-
}
|
|
191
|
-
await new Promise((resolve) => setTimeout(resolve, pollMs));
|
|
192
|
-
}
|
|
193
|
-
if (!acquired) throw new LockAcquisitionError(lockPath, timeoutMs);
|
|
194
|
-
try {
|
|
195
|
-
return await fn();
|
|
196
|
-
} finally {
|
|
197
|
-
await removeLockDir(lockPath);
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
//#endregion
|
|
202
10
|
//#region src/lib/ids.ts
|
|
203
11
|
/**
|
|
204
12
|
* ID generation and validation utilities.
|
|
@@ -518,7 +326,7 @@ async function loadIdMapping(baseDir) {
|
|
|
518
326
|
* inside the lock. This prevents the lost-update problem when multiple `tbd create`
|
|
519
327
|
* commands run in parallel.
|
|
520
328
|
*
|
|
521
|
-
* The merge is safe because ID mappings are append-only
|
|
329
|
+
* The merge is safe because ID mappings are append-only; entries are never
|
|
522
330
|
* intentionally removed. If the lock cannot be acquired within the timeout,
|
|
523
331
|
* a LockAcquisitionError is thrown rather than proceeding without protection.
|
|
524
332
|
*/
|
|
@@ -533,7 +341,7 @@ async function saveIdMapping(baseDir, mapping) {
|
|
|
533
341
|
onDiskSize = onDisk.shortToUlid.size;
|
|
534
342
|
if (onDiskSize > 0) merged = mergeIdMappings(mapping, onDisk);
|
|
535
343
|
} catch {}
|
|
536
|
-
if (merged.shortToUlid.size < onDiskSize) throw new Error(`Refusing to save ID mapping: would lose ${onDiskSize - merged.shortToUlid.size} entries (on-disk: ${onDiskSize}, proposed: ${merged.shortToUlid.size}). ID mappings are append-only
|
|
344
|
+
if (merged.shortToUlid.size < onDiskSize) throw new Error(`Refusing to save ID mapping: would lose ${onDiskSize - merged.shortToUlid.size} entries (on-disk: ${onDiskSize}, proposed: ${merged.shortToUlid.size}). ID mappings are append-only; this indicates a bug.`);
|
|
537
345
|
const data = {};
|
|
538
346
|
const sortedKeys = naturalSort(Array.from(merged.shortToUlid.keys()));
|
|
539
347
|
for (const key of sortedKeys) data[key] = merged.shortToUlid.get(key);
|
|
@@ -772,5 +580,5 @@ function resolveIdMappingConflicts(content) {
|
|
|
772
580
|
}
|
|
773
581
|
|
|
774
582
|
//#endregion
|
|
775
|
-
export {
|
|
776
|
-
//# sourceMappingURL=id-mapping-
|
|
583
|
+
export { formatDisplayId as _, hasShortId as a, normalizeIssueId as b, parseIdMappingFromYaml as c, resolveToInternalId as d, saveIdMapping as f, formatDebugId as g, extractUlidFromInternalId as h, generateUniqueShortId as i, reconcileMappings as l, extractShortId as m, calculateOptimalLength as n, loadIdMapping as o, extractPrefix as p, createShortIdMapping as r, mergeIdMappings as s, addIdMapping as t, resolveIdMappingConflicts as u, generateInternalId as v, validateIssueId as x, makeInternalId as y };
|
|
584
|
+
//# sourceMappingURL=id-mapping-DAIeLKzm.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"id-mapping-DAIeLKzm.mjs","names":[],"sources":["../src/lib/ids.ts","../src/lib/sort.ts","../src/file/id-mapping.ts"],"sourcesContent":["/**\n * ID generation and validation utilities.\n *\n * The system uses dual IDs for usability:\n * - Internal ID: is-{ulid} - ULID-based (26 lowercase chars), stored in files\n * - External ID: {prefix}-{short} - 4-5 base36 chars for CLI display/input\n *\n * For Beads compatibility, bd- prefix is accepted on input for external IDs.\n *\n * See: tbd-design.md §2.5 ID Generation\n */\n\nimport { monotonicFactory } from 'ulid';\nimport { randomBytes } from 'node:crypto';\n\n// Monotonic factory ensures ULIDs are strictly increasing even within the same\n// millisecond. This guarantees that lexicographic sort = creation order, which\n// is critical for deterministic list output (the tiebreaker sort is by ULID).\nconst ulid = monotonicFactory();\n\n// =============================================================================\n// Branded Types for Type-Safe ID Handling\n// =============================================================================\n\n/**\n * Branded type for internal issue IDs (is-{ulid} format).\n *\n * Internal IDs are stored in files and used as the canonical identifier.\n * Format: is-{26 lowercase alphanumeric chars}\n * Example: is-01hx5zzkbkactav9wevgemmvrz\n *\n * Use this type when:\n * - Reading/writing issue files\n * - Storing parent_id, dependencies, child_order_hints\n * - Passing IDs between internal functions\n */\ndeclare const InternalIssueIdBrand: unique symbol;\nexport type InternalIssueId = string & { [InternalIssueIdBrand]: never };\n\n/**\n * Branded type for display issue IDs ({prefix}-{short} format).\n *\n * Display IDs are shown to users and accepted as CLI input.\n * Format: {prefix}-{short} where short is typically 4 base36 chars\n * Example: tbd-a7k2, bd-100\n *\n * Use this type when:\n * - Formatting output for users\n * - Accepting user input (before resolution)\n * - Building tree views for display\n */\ndeclare const DisplayIssueIdBrand: unique symbol;\nexport type DisplayIssueId = string & { [DisplayIssueIdBrand]: never };\n\n/**\n * Cast a string to InternalIssueId after validation.\n * Use this when you've validated that a string is a valid internal ID.\n */\nexport function asInternalId(id: string): InternalIssueId {\n return id as InternalIssueId;\n}\n\n/**\n * Cast a string to DisplayIssueId.\n * Use this when formatting an ID for display.\n */\nexport function asDisplayId(id: string): DisplayIssueId {\n return id as DisplayIssueId;\n}\n\n/**\n * Prefix for internal IDs (ULID-based).\n * All internal IDs are formatted as: {INTERNAL_ID_PREFIX}-{ulid}\n */\nexport const INTERNAL_ID_PREFIX = 'is';\n\n/**\n * Length of internal ID prefix including the hyphen (e.g., \"is-\" = 3).\n */\nexport const INTERNAL_ID_PREFIX_LENGTH = INTERNAL_ID_PREFIX.length + 1;\n\n/**\n * Construct an internal ID from a ULID.\n *\n * @param ulidValue - The ULID (26 chars)\n * @returns Internal ID in format {prefix}-{ulid}\n */\nexport function makeInternalId(ulidValue: string): InternalIssueId {\n return `${INTERNAL_ID_PREFIX}-${ulidValue.toLowerCase()}` as InternalIssueId;\n}\n\n/**\n * Generate a unique internal ID using ULID.\n * Format: is-{ulid} (26 lowercase alphanumeric chars)\n * Example: is-01hx5zzkbkactav9wevgemmvrz\n *\n * ULID provides:\n * - Time-ordered sorting (48-bit timestamp)\n * - 80-bit randomness (no collisions)\n * - Lexicographic sort = chronological order\n */\nexport function generateInternalId(): InternalIssueId {\n return makeInternalId(ulid());\n}\n\n/**\n * Generate a short ID for external display.\n * Format: base36 characters (a-z, 0-9)\n * Example: a7k2\n *\n * @param length - Number of characters (default 4)\n */\nexport function generateShortId(length = 4): string {\n const chars = '0123456789abcdefghijklmnopqrstuvwxyz';\n let result = '';\n const bytes = randomBytes(length);\n for (let i = 0; i < length; i++) {\n result += chars[bytes[i]! % 36];\n }\n return result;\n}\n\n// Regex pattern for validating internal IDs - built from prefix constant\nconst INTERNAL_ID_PATTERN = new RegExp(`^${INTERNAL_ID_PREFIX}-[0-9a-z]{26}$`);\n\n// Expected length of a full internal ID (prefix + hyphen + 26-char ULID)\nconst INTERNAL_ID_LENGTH = INTERNAL_ID_PREFIX_LENGTH + 26;\n\n/**\n * Validate an internal issue ID matches the ULID format.\n * Format: {prefix}-{26 lowercase alphanumeric chars}\n */\nexport function validateIssueId(id: string): boolean {\n return INTERNAL_ID_PATTERN.test(id);\n}\n\n/**\n * Validate a short/external ID format.\n * Format: 1+ base36 characters (typically 4 for new IDs, but imports may preserve longer IDs).\n */\nexport function validateShortId(id: string): boolean {\n return /^[0-9a-z]+$/.test(id);\n}\n\n/**\n * Check if an input looks like an internal ID (ULID-based).\n */\nexport function isInternalId(input: string): boolean {\n const lower = input.toLowerCase();\n // Check if it starts with the internal prefix and has correct length\n const prefixWithHyphen = `${INTERNAL_ID_PREFIX}-`;\n if (lower.startsWith(prefixWithHyphen) && lower.length === INTERNAL_ID_LENGTH) {\n return INTERNAL_ID_PATTERN.test(lower);\n }\n return false;\n}\n\n/**\n * Check if an input looks like a short/external ID.\n * Returns true for IDs like \"a7k2\", \"bd-a7k2\", \"100\", \"tbd-100\".\n * Short IDs are 16 characters or less (ULIDs are 26 characters).\n */\nexport function isShortId(input: string): boolean {\n const lower = input.toLowerCase();\n // Strip prefix if present\n const stripped = lower.replace(/^[a-z]+-/, '');\n // Must be 1-16 alphanumeric chars (short IDs, not ULIDs which are 26 chars)\n return /^[0-9a-z]+$/.test(stripped) && stripped.length >= 1 && stripped.length <= 16;\n}\n\n/**\n * Extract the short ID portion from an external ID.\n * Examples:\n * \"tbd-100\" -> \"100\"\n * \"bd-a7k2\" -> \"a7k2\"\n * \"a7k2\" -> \"a7k2\"\n * \"100\" -> \"100\"\n */\nexport function extractShortId(externalId: string): string {\n return externalId.toLowerCase().replace(/^[a-z]+-/, '');\n}\n\n/**\n * Extract the prefix portion from an external ID.\n * Returns the prefix (letters before the hyphen) or null if no prefix found.\n * Examples:\n * \"tbd-100\" -> \"tbd\"\n * \"bd-a7k2\" -> \"bd\"\n * \"TBD-100\" -> \"tbd\" (normalized to lowercase)\n * \"a7k2\" -> null (no prefix)\n * \"100\" -> null (no prefix)\n */\nexport function extractPrefix(externalId: string): string | null {\n const match = /^([a-zA-Z]+)-/.exec(externalId);\n return match?.[1]?.toLowerCase() ?? null;\n}\n\n/**\n * Extract the ULID portion from an internal ID.\n *\n * Internal IDs have the format: {prefix}-{ulid}\n * This function strips any prefix to return just the ULID.\n *\n * Examples:\n * \"is-01hx5zzkbkactav9wevgemmvrz\" -> \"01hx5zzkbkactav9wevgemmvrz\"\n * \"01hx5zzkbkactav9wevgemmvrz\" -> \"01hx5zzkbkactav9wevgemmvrz\" (no prefix)\n *\n * @param internalId - The internal ID (with or without prefix)\n * @returns The ULID portion without any prefix\n */\nexport function extractUlidFromInternalId(internalId: string): string {\n // Strip any prefix in format {letters}- (e.g., \"is-\", \"bd-\")\n return internalId.toLowerCase().replace(/^[a-z]+-/, '');\n}\n\n/** Prefix used in Beads for compatibility */\nconst BEADS_COMPAT_PREFIX = 'bd';\n\n/**\n * Normalize an internal issue ID.\n *\n * This function expects a full internal ID ({prefix}-{ulid}).\n * If given a short ID, it won't be able to resolve it without\n * access to the ID mapping.\n *\n * Handles:\n * - Uppercase (converts to lowercase)\n * - Ensures internal ID prefix\n * - Beads compatibility (bd- prefix)\n */\nexport function normalizeIssueId(input: string): string {\n const lower = input.toLowerCase();\n const internalPrefixWithHyphen = `${INTERNAL_ID_PREFIX}-`;\n const beadsPrefixWithHyphen = `${BEADS_COMPAT_PREFIX}-`;\n\n // If already a valid internal ID, return as-is\n if (validateIssueId(lower)) {\n return lower;\n }\n\n // If it starts with internal prefix but wrong length, might be corrupted\n if (lower.startsWith(internalPrefixWithHyphen)) {\n return lower; // Return as-is, let validation fail later\n }\n\n // If it starts with bd- (Beads compat), convert prefix\n if (lower.startsWith(beadsPrefixWithHyphen)) {\n const rest = lower.slice(beadsPrefixWithHyphen.length);\n if (rest.length === 26) {\n return makeInternalId(rest);\n }\n // Short ID - can't resolve without mapping\n return lower;\n }\n\n // Bare ID without prefix\n if (lower.length === 26 && /^[0-9a-z]{26}$/.test(lower)) {\n return makeInternalId(lower);\n }\n\n // Can't normalize - return as-is\n return lower;\n}\n\nimport type { IdMapping } from '../file/id-mapping.js';\n\n/**\n * Format an internal ID for display with the configured prefix.\n *\n * Uses the short ID (4 chars) from the mapping.\n * Throws an error if the mapping is missing or doesn't contain the ID.\n *\n * IMPORTANT: All user-facing output MUST use short IDs, never internal ULIDs.\n * If you see a ULID in user output, it's a bug.\n *\n * @param internalId - The internal ID (is-{ulid})\n * @param mapping - ID mapping for short ID lookup (required)\n * @param prefix - Display prefix (should come from config.display.id_prefix; defaults to 'tbd' as fallback)\n * @throws Error if mapping is missing or ID not found in mapping\n */\nexport function formatDisplayId(\n internalId: InternalIssueId | string,\n mapping: IdMapping,\n prefix = 'tbd',\n): DisplayIssueId {\n // Extract the ULID portion\n const ulidPart = extractUlidFromInternalId(internalId);\n\n // Get short ID from mapping\n const shortId = mapping.ulidToShort.get(ulidPart);\n if (!shortId) {\n throw new Error(\n `No short ID mapping found for internal ID: ${internalId}. ` +\n `This is a bug - all issues must have a short ID mapping.`,\n );\n }\n\n return `${prefix}-${shortId}` as DisplayIssueId;\n}\n\n/**\n * Format an ID for debug output, showing both public and internal IDs.\n *\n * @param internalId - The internal ID (is-{ulid})\n * @param mapping - ID mapping for short ID lookup\n * @param prefix - Display prefix (should come from config.display.id_prefix; defaults to 'tbd' as fallback)\n */\nexport function formatDebugId(\n internalId: InternalIssueId | string,\n mapping: IdMapping,\n prefix = 'tbd',\n): string {\n const displayId = formatDisplayId(internalId, mapping, prefix);\n return `${displayId} (${internalId})`;\n}\n","/**\n * Natural sort utilities.\n *\n * Provides alphanumeric sorting where numeric portions are sorted numerically.\n * Similar to `sort -V` (version sort) or `sort -n` for numbers.\n *\n * Examples:\n * [\"1\", \"2\", \"9\", \"10\", \"11\"] instead of [\"1\", \"10\", \"11\", \"2\", \"9\"]\n * [\"a1\", \"a2\", \"a10\"] instead of [\"a1\", \"a10\", \"a2\"]\n * [\"file1.txt\", \"file2.txt\", \"file10.txt\"] instead of [\"file1.txt\", \"file10.txt\", \"file2.txt\"]\n */\n\n/**\n * Split a string into alternating runs of digits and non-digits.\n * @param str - The string to split\n * @returns Array of [isNumeric, value] tuples\n */\nfunction splitIntoChunks(str: string): [boolean, string][] {\n const chunks: [boolean, string][] = [];\n let current = '';\n let currentIsNumeric: boolean | null = null;\n\n for (const char of str) {\n const isDigit = char >= '0' && char <= '9';\n\n if (currentIsNumeric === null) {\n // First character\n currentIsNumeric = isDigit;\n current = char;\n } else if (isDigit === currentIsNumeric) {\n // Same type, continue accumulating\n current += char;\n } else {\n // Type changed, push current chunk and start new one\n chunks.push([currentIsNumeric, current]);\n currentIsNumeric = isDigit;\n current = char;\n }\n }\n\n // Push final chunk\n if (current) {\n chunks.push([currentIsNumeric!, current]);\n }\n\n return chunks;\n}\n\n/**\n * Compare two strings using natural (alphanumeric) ordering.\n *\n * Numeric portions are compared numerically, non-numeric portions are\n * compared lexicographically (case-insensitive). Numbers sort before letters\n * when they appear at the same position in mixed comparisons, matching\n * the behavior of `sort -V` (version sort).\n *\n * @param a - First string\n * @param b - Second string\n * @returns Negative if a < b, positive if a > b, zero if equal\n */\nexport function naturalCompare(a: string, b: string): number {\n // Handle empty strings\n if (!a && !b) return 0;\n if (!a) return -1;\n if (!b) return 1;\n\n const chunksA = splitIntoChunks(a);\n const chunksB = splitIntoChunks(b);\n\n const minLen = Math.min(chunksA.length, chunksB.length);\n\n for (let i = 0; i < minLen; i++) {\n const [isNumericA, valueA] = chunksA[i]!;\n const [isNumericB, valueB] = chunksB[i]!;\n\n if (isNumericA && isNumericB) {\n // Both are numeric - compare as numbers\n const numA = parseInt(valueA, 10);\n const numB = parseInt(valueB, 10);\n if (numA !== numB) {\n return numA - numB;\n }\n // If numerically equal but different strings (e.g., \"01\" vs \"1\"),\n // prefer shorter (fewer leading zeros)\n if (valueA.length !== valueB.length) {\n return valueA.length - valueB.length;\n }\n } else if (!isNumericA && !isNumericB) {\n // Both are non-numeric - compare lexicographically (case-insensitive)\n const lowerA = valueA.toLowerCase();\n const lowerB = valueB.toLowerCase();\n if (lowerA !== lowerB) {\n return lowerA.localeCompare(lowerB);\n }\n // Same when lowercased - they're equal for sorting purposes\n } else {\n // Mixed: numeric comes before non-numeric\n // (so \"1\" comes before \"a\" at the same position)\n // This matches `sort -V` behavior\n return isNumericA ? -1 : 1;\n }\n }\n\n // All compared chunks are equal, shorter string comes first\n return chunksA.length - chunksB.length;\n}\n\n/**\n * Sort an array of strings using natural (alphanumeric) ordering.\n *\n * @param arr - Array to sort\n * @returns New sorted array (does not mutate original)\n */\nexport function naturalSort(arr: readonly string[]): string[] {\n return [...arr].sort(naturalCompare);\n}\n\n/**\n * Sort an array of objects by a string key using natural ordering.\n *\n * @param arr - Array to sort\n * @param keyFn - Function to extract the sort key from each element\n * @returns New sorted array (does not mutate original)\n */\nexport function naturalSortBy<T>(arr: readonly T[], keyFn: (item: T) => string): T[] {\n return [...arr].sort((a, b) => naturalCompare(keyFn(a), keyFn(b)));\n}\n","/**\n * ID mapping management for short public IDs.\n *\n * Maps 4-char base36 short IDs to 26-char ULIDs.\n * Stored in .tbd/data-sync/mappings/ids.yml\n *\n * See: tbd-design.md §2.5 ID Generation\n */\n\nimport { readFile, mkdir } from 'node:fs/promises';\nimport { join, dirname } from 'node:path';\nimport { writeFile } from 'atomically';\n\nimport {\n parseYamlToleratingDuplicateKeys,\n stringifyYaml,\n hasMergeConflictMarkers,\n} from '../utils/yaml-utils.js';\nimport { withLockfile } from '../utils/lockfile.js';\n\nimport {\n generateShortId,\n extractUlidFromInternalId,\n makeInternalId,\n isInternalId,\n extractShortId,\n asInternalId,\n type InternalIssueId,\n} from '../lib/ids.js';\nimport { naturalSort } from '../lib/sort.js';\nimport { IdMappingYamlSchema } from '../lib/schemas.js';\n\n/**\n * ID mapping from short ID to ULID.\n * Format in ids.yml:\n * a7k2: 01hx5zzkbkactav9wevgemmvrz\n * b3m9: 01hx5zzkbkbctav9wevgemmvrz\n */\nexport interface IdMapping {\n shortToUlid: Map<string, string>;\n ulidToShort: Map<string, string>;\n}\n\n/**\n * Get the path to the ids.yml mapping file.\n */\nfunction getMappingPath(baseDir: string): string {\n return join(baseDir, 'mappings', 'ids.yml');\n}\n\n/**\n * Load the ID mapping from disk.\n * Returns empty mapping if file doesn't exist.\n */\nexport async function loadIdMapping(baseDir: string): Promise<IdMapping> {\n const filePath = getMappingPath(baseDir);\n\n let content: string;\n try {\n content = await readFile(filePath, 'utf-8');\n } catch {\n // File doesn't exist - return empty mapping\n return {\n shortToUlid: new Map(),\n ulidToShort: new Map(),\n };\n }\n\n // Parse tolerating duplicate keys; this handles the case where a git merge\n // conflict resolution kept entries from both sides, creating duplicate YAML keys.\n // Without this, the yaml parser throws \"Map keys must be unique\".\n const { data: rawData, duplicateKeys } = parseYamlToleratingDuplicateKeys<unknown>(\n content,\n filePath,\n );\n const data = rawData ?? {};\n\n if (duplicateKeys.length > 0) {\n console.warn(\n `Warning: ${filePath} contains ${duplicateKeys.length} duplicate key(s): ${duplicateKeys.join(', ')}. ` +\n `This usually happens after a git merge conflict resolution. ` +\n `The file will be auto-fixed on next save.`,\n );\n }\n\n // Validate with Zod schema - ensures all keys are valid short IDs and values are ULIDs\n const parseResult = IdMappingYamlSchema.safeParse(data);\n if (!parseResult.success) {\n throw new Error(`Invalid ID mapping format in ${filePath}: ${parseResult.error.message}`);\n }\n const validData = parseResult.data;\n\n const shortToUlid = new Map<string, string>();\n const ulidToShort = new Map<string, string>();\n\n for (const [shortId, ulid] of Object.entries(validData)) {\n shortToUlid.set(shortId, ulid);\n ulidToShort.set(ulid, shortId);\n }\n\n return { shortToUlid, ulidToShort };\n}\n\n/**\n * Save the ID mapping to disk with mutual exclusion.\n *\n * Uses a lockfile to serialize concurrent writers, then performs read-merge-write\n * inside the lock. This prevents the lost-update problem when multiple `tbd create`\n * commands run in parallel.\n *\n * The merge is safe because ID mappings are append-only; entries are never\n * intentionally removed. If the lock cannot be acquired within the timeout,\n * a LockAcquisitionError is thrown rather than proceeding without protection.\n */\nexport async function saveIdMapping(baseDir: string, mapping: IdMapping): Promise<void> {\n const filePath = getMappingPath(baseDir);\n\n // Ensure directory exists\n await mkdir(dirname(filePath), { recursive: true });\n\n await withLockfile(filePath + '.lock', async () => {\n // Inside the lock: read current on-disk state, merge with our in-memory\n // mapping, and write the result. Our entries take precedence for short ID\n // conflicts (extremely unlikely with random 4-char base36 IDs).\n let merged = mapping;\n let onDiskSize = 0;\n try {\n const onDisk = await loadIdMappingRaw(filePath);\n onDiskSize = onDisk.shortToUlid.size;\n if (onDiskSize > 0) {\n merged = mergeIdMappings(mapping, onDisk);\n }\n } catch {\n // File doesn't exist or is unreadable; proceed with our mapping only\n }\n\n // Safety check: ID mappings are append-only. If the merged result has fewer\n // entries than what's on disk, something went wrong. Refuse to write so the\n // caller can investigate rather than silently destroying entries.\n if (merged.shortToUlid.size < onDiskSize) {\n throw new Error(\n `Refusing to save ID mapping: would lose ${onDiskSize - merged.shortToUlid.size} entries ` +\n `(on-disk: ${onDiskSize}, proposed: ${merged.shortToUlid.size}). ` +\n `ID mappings are append-only; this indicates a bug.`,\n );\n }\n\n const data: Record<string, string> = {};\n const sortedKeys = naturalSort(Array.from(merged.shortToUlid.keys()));\n for (const key of sortedKeys) {\n data[key] = merged.shortToUlid.get(key)!;\n }\n\n const content = stringifyYaml(data);\n await writeFile(filePath, content);\n });\n}\n\n/**\n * Load an ID mapping directly from a file path (internal helper for save merging).\n * Separated from loadIdMapping to avoid coupling the save path to baseDir resolution.\n */\nasync function loadIdMappingRaw(filePath: string): Promise<IdMapping> {\n const content = await readFile(filePath, 'utf-8');\n\n const { data: rawData } = parseYamlToleratingDuplicateKeys<unknown>(content, filePath);\n const data = rawData ?? {};\n\n const parseResult = IdMappingYamlSchema.safeParse(data);\n if (!parseResult.success) {\n throw new Error(`Invalid ID mapping format in ${filePath}: ${parseResult.error.message}`);\n }\n const validData = parseResult.data;\n\n const shortToUlid = new Map<string, string>();\n const ulidToShort = new Map<string, string>();\n\n for (const [shortId, ulid] of Object.entries(validData)) {\n shortToUlid.set(shortId, ulid);\n ulidToShort.set(ulid, shortId);\n }\n\n return { shortToUlid, ulidToShort };\n}\n\n/**\n * Calculate the optimal short ID length based on existing ID count.\n *\n * At 50K issues, switches from 4-char to 5-char IDs to keep\n * collision probability low (~3% per attempt with 4 chars at 50K).\n *\n * With 10 retries per length, actual failure probability is astronomically low.\n */\nexport function calculateOptimalLength(existingCount: number): number {\n return existingCount < 50_000 ? 4 : 5;\n}\n\n/**\n * Generate a unique short ID that doesn't collide with existing ones.\n *\n * Calculates optimal length (4 or 5 chars) based on existing ID count,\n * then retries with the next length if collisions occur.\n *\n * @returns The new short ID\n * @throws If unable to generate a unique ID after max attempts\n */\nexport function generateUniqueShortId(mapping: IdMapping): string {\n const ATTEMPTS_PER_LENGTH = 10;\n const existingCount = mapping.shortToUlid.size;\n const optimalLength = calculateOptimalLength(existingCount);\n\n // Try optimal length first, then fall back to longer if needed\n for (const length of [optimalLength, optimalLength + 1]) {\n for (let attempt = 0; attempt < ATTEMPTS_PER_LENGTH; attempt++) {\n const shortId = generateShortId(length);\n if (!mapping.shortToUlid.has(shortId)) {\n return shortId;\n }\n }\n }\n\n throw new Error(\n `Failed to generate unique short ID after 20 attempts with ${existingCount} existing IDs. ` +\n `This should be extremely rare - please report if you see this error.`,\n );\n}\n\n/**\n * Register a new ID mapping.\n * @param ulid - The ULID (without is- prefix)\n * @param shortId - The short ID (4 chars)\n */\nexport function addIdMapping(mapping: IdMapping, ulid: string, shortId: string): void {\n mapping.shortToUlid.set(shortId, ulid);\n mapping.ulidToShort.set(ulid, shortId);\n}\n\n/**\n * Get the short ID for a ULID.\n * @param ulid - The ULID (without is- prefix)\n * @returns The short ID, or undefined if not found\n */\nexport function getShortId(mapping: IdMapping, ulid: string): string | undefined {\n return mapping.ulidToShort.get(ulid);\n}\n\n/**\n * Get the ULID for a short ID.\n * @param shortId - The short ID\n * @returns The ULID (without is- prefix), or undefined if not found\n */\nexport function getUlid(mapping: IdMapping, shortId: string): string | undefined {\n return mapping.shortToUlid.get(shortId);\n}\n\n/**\n * Check if a short ID exists in the mapping.\n */\nexport function hasShortId(mapping: IdMapping, shortId: string): boolean {\n return mapping.shortToUlid.has(shortId);\n}\n\n/**\n * Create a short ID mapping for a new internal ID.\n * Generates a unique short ID and registers it in the mapping.\n *\n * @param internalId - The internal ID (is-{ulid})\n * @param mapping - The ID mapping to update\n * @returns The generated short ID\n */\nexport function createShortIdMapping(internalId: string, mapping: IdMapping): string {\n // Extract ULID from internal ID (remove prefix)\n const ulid = extractUlidFromInternalId(internalId);\n\n // Check if already mapped\n const existing = mapping.ulidToShort.get(ulid);\n if (existing) {\n return existing;\n }\n\n // Generate unique short ID\n const shortId = generateUniqueShortId(mapping);\n\n // Register mapping\n addIdMapping(mapping, ulid, shortId);\n\n return shortId;\n}\n\n/**\n * Resolve any ID input to an internal ID ({prefix}-{ulid}).\n *\n * Handles:\n * - Internal IDs: {prefix}-{ulid} -> {prefix}-{ulid}\n * - Short IDs: a7k2 -> {prefix}-{ulid from mapping}\n * - Prefixed short IDs: bd-a7k2 -> {prefix}-{ulid from mapping}\n *\n * @param input - The ID input (short ID, prefixed short ID, or internal ID)\n * @param mapping - The ID mapping for short ID resolution\n * @returns The internal ID ({prefix}-{ulid})\n * @throws If the short ID is not found in the mapping\n */\nexport function resolveToInternalId(input: string, mapping: IdMapping): InternalIssueId {\n const lower = input.toLowerCase();\n\n // If it's already an internal ID, return it\n if (isInternalId(lower)) {\n return asInternalId(lower);\n }\n\n // Extract the short ID portion (strips any prefix like \"bd-\" or \"is-\")\n const shortId = extractShortId(lower);\n\n // If it's a full ULID (26 chars), it might be a bare internal ID\n if (shortId.length === 26 && /^[0-9a-z]{26}$/.test(shortId)) {\n return makeInternalId(shortId);\n }\n\n // Must be a short ID - look it up in the mapping\n const ulid = mapping.shortToUlid.get(shortId);\n if (!ulid) {\n throw new Error(`Unknown issue ID: ${input}. ` + `Short ID \"${shortId}\" not found in mapping.`);\n }\n\n return makeInternalId(ulid);\n}\n\n/**\n * Parse an ID mapping from raw YAML content.\n * Used for loading mappings from git show output during conflict resolution.\n *\n * @throws MergeConflictError if content contains merge conflict markers\n */\nexport function parseIdMappingFromYaml(content: string): IdMapping {\n // Parse tolerating duplicate keys; handles post-merge-conflict duplicates\n const { data: rawData, duplicateKeys } = parseYamlToleratingDuplicateKeys<unknown>(content);\n const data = rawData ?? {};\n\n if (duplicateKeys.length > 0) {\n console.warn(\n `Warning: ID mapping YAML contains ${duplicateKeys.length} duplicate key(s): ${duplicateKeys.join(', ')}. ` +\n `Duplicates will be auto-resolved.`,\n );\n }\n\n // Validate with Zod schema\n const parseResult = IdMappingYamlSchema.safeParse(data);\n if (!parseResult.success) {\n throw new Error(`Invalid ID mapping format: ${parseResult.error.message}`);\n }\n const validData = parseResult.data;\n\n const shortToUlid = new Map<string, string>();\n const ulidToShort = new Map<string, string>();\n\n for (const [shortId, ulid] of Object.entries(validData)) {\n shortToUlid.set(shortId, ulid);\n ulidToShort.set(ulid, shortId);\n }\n\n return { shortToUlid, ulidToShort };\n}\n\n/**\n * Ensure all given internal IDs have short ID mappings.\n * Creates missing mappings for any IDs without entries.\n *\n * This repairs state after git merges that may add issue files\n * without corresponding mapping entries (e.g., when outbox issues\n * are merged from a feature branch but ids.yml doesn't include them).\n *\n * When a `historicalMapping` is provided, the function will try to recover\n * the original short ID from that mapping before generating a new random one.\n * This preserves ID stability so that existing references (in docs, PRs,\n * conversations) remain valid.\n *\n * @param internalIds - Array of internal IDs (is-{ulid}) to reconcile\n * @param mapping - The ID mapping to update (mutated in-place)\n * @param historicalMapping - Optional mapping from prior state (e.g., git history) to recover original short IDs\n * @returns Object with `created` (IDs that got new random short IDs) and `recovered` (IDs restored from history)\n */\nexport function reconcileMappings(\n internalIds: string[],\n mapping: IdMapping,\n historicalMapping?: IdMapping,\n): { created: string[]; recovered: string[] } {\n const created: string[] = [];\n const recovered: string[] = [];\n\n for (const id of internalIds) {\n const ulid = extractUlidFromInternalId(id);\n if (mapping.ulidToShort.has(ulid)) {\n continue; // Already has a mapping\n }\n\n // Try to recover original short ID from historical mapping\n const historicalShortId = historicalMapping?.ulidToShort.get(ulid);\n if (historicalShortId && !mapping.shortToUlid.has(historicalShortId)) {\n // Recovered: restore the original short ID\n addIdMapping(mapping, ulid, historicalShortId);\n recovered.push(id);\n } else {\n // No history available or short ID conflicts; generate new random one\n createShortIdMapping(id, mapping);\n created.push(id);\n }\n }\n\n return { created, recovered };\n}\n\n/**\n * Merge two ID mappings by combining all entries from both.\n * ID mappings are always additive (new IDs are only added, never removed),\n * so merging simply unions all key-value pairs.\n *\n * If the same short ID maps to different ULIDs in each mapping (a conflict),\n * the local mapping takes precedence (caller should log a warning).\n *\n * @param local - The local ID mapping\n * @param remote - The remote ID mapping\n * @returns Merged mapping with all entries from both\n */\nexport function mergeIdMappings(local: IdMapping, remote: IdMapping): IdMapping {\n const merged: IdMapping = {\n shortToUlid: new Map(local.shortToUlid),\n ulidToShort: new Map(local.ulidToShort),\n };\n\n // Add all remote entries that don't conflict\n for (const [shortId, ulid] of remote.shortToUlid) {\n if (!merged.shortToUlid.has(shortId)) {\n merged.shortToUlid.set(shortId, ulid);\n merged.ulidToShort.set(ulid, shortId);\n }\n // If shortId already exists with different ulid, keep local (conflict resolution)\n }\n\n // Also check for ULIDs that exist in remote but not in local\n // (different short ID for same ULID - shouldn't happen but handle gracefully)\n for (const [ulid, shortId] of remote.ulidToShort) {\n if (!merged.ulidToShort.has(ulid) && !merged.shortToUlid.has(shortId)) {\n merged.shortToUlid.set(shortId, ulid);\n merged.ulidToShort.set(ulid, shortId);\n }\n }\n\n return merged;\n}\n\n/**\n * Resolve merge conflicts in ids.yml content by extracting both sides and merging.\n *\n * ids.yml is a sorted key-value YAML map where entries are append-only.\n * The most common merge conflict is both sides adding non-overlapping keys,\n * which is trivially auto-resolvable by keeping all entries from both sides.\n *\n * @param content - Raw file content that may contain git merge conflict markers\n * @returns Merged IdMapping with entries from both sides\n */\nexport function resolveIdMappingConflicts(content: string): IdMapping {\n if (!hasMergeConflictMarkers(content)) {\n return parseIdMappingFromYaml(content);\n }\n\n const lines = content.split('\\n');\n const oursLines: string[] = [];\n const theirsLines: string[] = [];\n let inConflict: 'none' | 'ours' | 'theirs' = 'none';\n\n for (const line of lines) {\n if (line.startsWith('<<<<<<< ')) {\n inConflict = 'ours';\n continue;\n }\n if (line === '=======' && inConflict === 'ours') {\n inConflict = 'theirs';\n continue;\n }\n if (line.startsWith('>>>>>>> ') && inConflict === 'theirs') {\n inConflict = 'none';\n continue;\n }\n\n if (inConflict === 'none') {\n oursLines.push(line);\n theirsLines.push(line);\n } else if (inConflict === 'ours') {\n oursLines.push(line);\n } else {\n theirsLines.push(line);\n }\n }\n\n const oursMapping = parseIdMappingFromYaml(oursLines.join('\\n'));\n const theirsMapping = parseIdMappingFromYaml(theirsLines.join('\\n'));\n\n return mergeIdMappings(oursMapping, theirsMapping);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAkBA,MAAM,OAAO,kBAAkB;;;;;AAwC/B,SAAgB,aAAa,IAA6B;AACxD,QAAO;;;;;;AAeT,MAAa,qBAAqB;;;;AAKlC,MAAa,4BAA4B;;;;;;;AAQzC,SAAgB,eAAe,WAAoC;AACjE,QAAO,GAAG,mBAAmB,GAAG,UAAU,aAAa;;;;;;;;;;;;AAazD,SAAgB,qBAAsC;AACpD,QAAO,eAAe,MAAM,CAAC;;;;;;;;;AAU/B,SAAgB,gBAAgB,SAAS,GAAW;CAClD,MAAM,QAAQ;CACd,IAAI,SAAS;CACb,MAAM,QAAQ,YAAY,OAAO;AACjC,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,IAC1B,WAAU,MAAM,MAAM,KAAM;AAE9B,QAAO;;AAIT,MAAM,sBAAsB,IAAI,OAAO,IAAI,mBAAmB,gBAAgB;AAG9E,MAAM,qBAAqB,4BAA4B;;;;;AAMvD,SAAgB,gBAAgB,IAAqB;AACnD,QAAO,oBAAoB,KAAK,GAAG;;;;;AAcrC,SAAgB,aAAa,OAAwB;CACnD,MAAM,QAAQ,MAAM,aAAa;CAEjC,MAAM,mBAAmB,GAAG,mBAAmB;AAC/C,KAAI,MAAM,WAAW,iBAAiB,IAAI,MAAM,WAAW,mBACzD,QAAO,oBAAoB,KAAK,MAAM;AAExC,QAAO;;;;;;;;;;AAwBT,SAAgB,eAAe,YAA4B;AACzD,QAAO,WAAW,aAAa,CAAC,QAAQ,YAAY,GAAG;;;;;;;;;;;;AAazD,SAAgB,cAAc,YAAmC;AAE/D,QADc,gBAAgB,KAAK,WAAW,GAC/B,IAAI,aAAa,IAAI;;;;;;;;;;;;;;;AAgBtC,SAAgB,0BAA0B,YAA4B;AAEpE,QAAO,WAAW,aAAa,CAAC,QAAQ,YAAY,GAAG;;;AAIzD,MAAM,sBAAsB;;;;;;;;;;;;;AAc5B,SAAgB,iBAAiB,OAAuB;CACtD,MAAM,QAAQ,MAAM,aAAa;CACjC,MAAM,2BAA2B,GAAG,mBAAmB;CACvD,MAAM,wBAAwB,GAAG,oBAAoB;AAGrD,KAAI,gBAAgB,MAAM,CACxB,QAAO;AAIT,KAAI,MAAM,WAAW,yBAAyB,CAC5C,QAAO;AAIT,KAAI,MAAM,WAAW,sBAAsB,EAAE;EAC3C,MAAM,OAAO,MAAM,MAAM,sBAAsB,OAAO;AACtD,MAAI,KAAK,WAAW,GAClB,QAAO,eAAe,KAAK;AAG7B,SAAO;;AAIT,KAAI,MAAM,WAAW,MAAM,iBAAiB,KAAK,MAAM,CACrD,QAAO,eAAe,MAAM;AAI9B,QAAO;;;;;;;;;;;;;;;;AAmBT,SAAgB,gBACd,YACA,SACA,SAAS,OACO;CAEhB,MAAM,WAAW,0BAA0B,WAAW;CAGtD,MAAM,UAAU,QAAQ,YAAY,IAAI,SAAS;AACjD,KAAI,CAAC,QACH,OAAM,IAAI,MACR,8CAA8C,WAAW,4DAE1D;AAGH,QAAO,GAAG,OAAO,GAAG;;;;;;;;;AAUtB,SAAgB,cACd,YACA,SACA,SAAS,OACD;AAER,QAAO,GADW,gBAAgB,YAAY,SAAS,OAAO,CAC1C,IAAI,WAAW;;;;;;;;;;;;;;;;;;;;;ACxSrC,SAAS,gBAAgB,KAAkC;CACzD,MAAM,SAA8B,EAAE;CACtC,IAAI,UAAU;CACd,IAAI,mBAAmC;AAEvC,MAAK,MAAM,QAAQ,KAAK;EACtB,MAAM,UAAU,QAAQ,OAAO,QAAQ;AAEvC,MAAI,qBAAqB,MAAM;AAE7B,sBAAmB;AACnB,aAAU;aACD,YAAY,iBAErB,YAAW;OACN;AAEL,UAAO,KAAK,CAAC,kBAAkB,QAAQ,CAAC;AACxC,sBAAmB;AACnB,aAAU;;;AAKd,KAAI,QACF,QAAO,KAAK,CAAC,kBAAmB,QAAQ,CAAC;AAG3C,QAAO;;;;;;;;;;;;;;AAeT,SAAgB,eAAe,GAAW,GAAmB;AAE3D,KAAI,CAAC,KAAK,CAAC,EAAG,QAAO;AACrB,KAAI,CAAC,EAAG,QAAO;AACf,KAAI,CAAC,EAAG,QAAO;CAEf,MAAM,UAAU,gBAAgB,EAAE;CAClC,MAAM,UAAU,gBAAgB,EAAE;CAElC,MAAM,SAAS,KAAK,IAAI,QAAQ,QAAQ,QAAQ,OAAO;AAEvD,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK;EAC/B,MAAM,CAAC,YAAY,UAAU,QAAQ;EACrC,MAAM,CAAC,YAAY,UAAU,QAAQ;AAErC,MAAI,cAAc,YAAY;GAE5B,MAAM,OAAO,SAAS,QAAQ,GAAG;GACjC,MAAM,OAAO,SAAS,QAAQ,GAAG;AACjC,OAAI,SAAS,KACX,QAAO,OAAO;AAIhB,OAAI,OAAO,WAAW,OAAO,OAC3B,QAAO,OAAO,SAAS,OAAO;aAEvB,CAAC,cAAc,CAAC,YAAY;GAErC,MAAM,SAAS,OAAO,aAAa;GACnC,MAAM,SAAS,OAAO,aAAa;AACnC,OAAI,WAAW,OACb,QAAO,OAAO,cAAc,OAAO;QAOrC,QAAO,aAAa,KAAK;;AAK7B,QAAO,QAAQ,SAAS,QAAQ;;;;;;;;AASlC,SAAgB,YAAY,KAAkC;AAC5D,QAAO,CAAC,GAAG,IAAI,CAAC,KAAK,eAAe;;;;;;;;;;;;;;;;ACpEtC,SAAS,eAAe,SAAyB;AAC/C,QAAO,KAAK,SAAS,YAAY,UAAU;;;;;;AAO7C,eAAsB,cAAc,SAAqC;CACvE,MAAM,WAAW,eAAe,QAAQ;CAExC,IAAI;AACJ,KAAI;AACF,YAAU,MAAM,SAAS,UAAU,QAAQ;SACrC;AAEN,SAAO;GACL,6BAAa,IAAI,KAAK;GACtB,6BAAa,IAAI,KAAK;GACvB;;CAMH,MAAM,EAAE,MAAM,SAAS,kBAAkB,iCACvC,SACA,SACD;CACD,MAAM,OAAO,WAAW,EAAE;AAE1B,KAAI,cAAc,SAAS,EACzB,SAAQ,KACN,YAAY,SAAS,YAAY,cAAc,OAAO,qBAAqB,cAAc,KAAK,KAAK,CAAC,yGAGrG;CAIH,MAAM,cAAc,oBAAoB,UAAU,KAAK;AACvD,KAAI,CAAC,YAAY,QACf,OAAM,IAAI,MAAM,gCAAgC,SAAS,IAAI,YAAY,MAAM,UAAU;CAE3F,MAAM,YAAY,YAAY;CAE9B,MAAM,8BAAc,IAAI,KAAqB;CAC7C,MAAM,8BAAc,IAAI,KAAqB;AAE7C,MAAK,MAAM,CAAC,SAAS,SAAS,OAAO,QAAQ,UAAU,EAAE;AACvD,cAAY,IAAI,SAAS,KAAK;AAC9B,cAAY,IAAI,MAAM,QAAQ;;AAGhC,QAAO;EAAE;EAAa;EAAa;;;;;;;;;;;;;AAcrC,eAAsB,cAAc,SAAiB,SAAmC;CACtF,MAAM,WAAW,eAAe,QAAQ;AAGxC,OAAM,MAAM,QAAQ,SAAS,EAAE,EAAE,WAAW,MAAM,CAAC;AAEnD,OAAM,aAAa,WAAW,SAAS,YAAY;EAIjD,IAAI,SAAS;EACb,IAAI,aAAa;AACjB,MAAI;GACF,MAAM,SAAS,MAAM,iBAAiB,SAAS;AAC/C,gBAAa,OAAO,YAAY;AAChC,OAAI,aAAa,EACf,UAAS,gBAAgB,SAAS,OAAO;UAErC;AAOR,MAAI,OAAO,YAAY,OAAO,WAC5B,OAAM,IAAI,MACR,2CAA2C,aAAa,OAAO,YAAY,KAAK,qBACjE,WAAW,cAAc,OAAO,YAAY,KAAK,uDAEjE;EAGH,MAAM,OAA+B,EAAE;EACvC,MAAM,aAAa,YAAY,MAAM,KAAK,OAAO,YAAY,MAAM,CAAC,CAAC;AACrE,OAAK,MAAM,OAAO,WAChB,MAAK,OAAO,OAAO,YAAY,IAAI,IAAI;AAIzC,QAAM,UAAU,UADA,cAAc,KAAK,CACD;GAClC;;;;;;AAOJ,eAAe,iBAAiB,UAAsC;CAGpE,MAAM,EAAE,MAAM,YAAY,iCAFV,MAAM,SAAS,UAAU,QAAQ,EAE4B,SAAS;CACtF,MAAM,OAAO,WAAW,EAAE;CAE1B,MAAM,cAAc,oBAAoB,UAAU,KAAK;AACvD,KAAI,CAAC,YAAY,QACf,OAAM,IAAI,MAAM,gCAAgC,SAAS,IAAI,YAAY,MAAM,UAAU;CAE3F,MAAM,YAAY,YAAY;CAE9B,MAAM,8BAAc,IAAI,KAAqB;CAC7C,MAAM,8BAAc,IAAI,KAAqB;AAE7C,MAAK,MAAM,CAAC,SAAS,SAAS,OAAO,QAAQ,UAAU,EAAE;AACvD,cAAY,IAAI,SAAS,KAAK;AAC9B,cAAY,IAAI,MAAM,QAAQ;;AAGhC,QAAO;EAAE;EAAa;EAAa;;;;;;;;;;AAWrC,SAAgB,uBAAuB,eAA+B;AACpE,QAAO,gBAAgB,MAAS,IAAI;;;;;;;;;;;AAYtC,SAAgB,sBAAsB,SAA4B;CAChE,MAAM,sBAAsB;CAC5B,MAAM,gBAAgB,QAAQ,YAAY;CAC1C,MAAM,gBAAgB,uBAAuB,cAAc;AAG3D,MAAK,MAAM,UAAU,CAAC,eAAe,gBAAgB,EAAE,CACrD,MAAK,IAAI,UAAU,GAAG,UAAU,qBAAqB,WAAW;EAC9D,MAAM,UAAU,gBAAgB,OAAO;AACvC,MAAI,CAAC,QAAQ,YAAY,IAAI,QAAQ,CACnC,QAAO;;AAKb,OAAM,IAAI,MACR,6DAA6D,cAAc,qFAE5E;;;;;;;AAQH,SAAgB,aAAa,SAAoB,MAAc,SAAuB;AACpF,SAAQ,YAAY,IAAI,SAAS,KAAK;AACtC,SAAQ,YAAY,IAAI,MAAM,QAAQ;;;;;AAwBxC,SAAgB,WAAW,SAAoB,SAA0B;AACvE,QAAO,QAAQ,YAAY,IAAI,QAAQ;;;;;;;;;;AAWzC,SAAgB,qBAAqB,YAAoB,SAA4B;CAEnF,MAAM,OAAO,0BAA0B,WAAW;CAGlD,MAAM,WAAW,QAAQ,YAAY,IAAI,KAAK;AAC9C,KAAI,SACF,QAAO;CAIT,MAAM,UAAU,sBAAsB,QAAQ;AAG9C,cAAa,SAAS,MAAM,QAAQ;AAEpC,QAAO;;;;;;;;;;;;;;;AAgBT,SAAgB,oBAAoB,OAAe,SAAqC;CACtF,MAAM,QAAQ,MAAM,aAAa;AAGjC,KAAI,aAAa,MAAM,CACrB,QAAO,aAAa,MAAM;CAI5B,MAAM,UAAU,eAAe,MAAM;AAGrC,KAAI,QAAQ,WAAW,MAAM,iBAAiB,KAAK,QAAQ,CACzD,QAAO,eAAe,QAAQ;CAIhC,MAAM,OAAO,QAAQ,YAAY,IAAI,QAAQ;AAC7C,KAAI,CAAC,KACH,OAAM,IAAI,MAAM,qBAAqB,MAAM,cAAmB,QAAQ,yBAAyB;AAGjG,QAAO,eAAe,KAAK;;;;;;;;AAS7B,SAAgB,uBAAuB,SAA4B;CAEjE,MAAM,EAAE,MAAM,SAAS,kBAAkB,iCAA0C,QAAQ;CAC3F,MAAM,OAAO,WAAW,EAAE;AAE1B,KAAI,cAAc,SAAS,EACzB,SAAQ,KACN,qCAAqC,cAAc,OAAO,qBAAqB,cAAc,KAAK,KAAK,CAAC,qCAEzG;CAIH,MAAM,cAAc,oBAAoB,UAAU,KAAK;AACvD,KAAI,CAAC,YAAY,QACf,OAAM,IAAI,MAAM,8BAA8B,YAAY,MAAM,UAAU;CAE5E,MAAM,YAAY,YAAY;CAE9B,MAAM,8BAAc,IAAI,KAAqB;CAC7C,MAAM,8BAAc,IAAI,KAAqB;AAE7C,MAAK,MAAM,CAAC,SAAS,SAAS,OAAO,QAAQ,UAAU,EAAE;AACvD,cAAY,IAAI,SAAS,KAAK;AAC9B,cAAY,IAAI,MAAM,QAAQ;;AAGhC,QAAO;EAAE;EAAa;EAAa;;;;;;;;;;;;;;;;;;;;AAqBrC,SAAgB,kBACd,aACA,SACA,mBAC4C;CAC5C,MAAM,UAAoB,EAAE;CAC5B,MAAM,YAAsB,EAAE;AAE9B,MAAK,MAAM,MAAM,aAAa;EAC5B,MAAM,OAAO,0BAA0B,GAAG;AAC1C,MAAI,QAAQ,YAAY,IAAI,KAAK,CAC/B;EAIF,MAAM,oBAAoB,mBAAmB,YAAY,IAAI,KAAK;AAClE,MAAI,qBAAqB,CAAC,QAAQ,YAAY,IAAI,kBAAkB,EAAE;AAEpE,gBAAa,SAAS,MAAM,kBAAkB;AAC9C,aAAU,KAAK,GAAG;SACb;AAEL,wBAAqB,IAAI,QAAQ;AACjC,WAAQ,KAAK,GAAG;;;AAIpB,QAAO;EAAE;EAAS;EAAW;;;;;;;;;;;;;;AAe/B,SAAgB,gBAAgB,OAAkB,QAA8B;CAC9E,MAAM,SAAoB;EACxB,aAAa,IAAI,IAAI,MAAM,YAAY;EACvC,aAAa,IAAI,IAAI,MAAM,YAAY;EACxC;AAGD,MAAK,MAAM,CAAC,SAAS,SAAS,OAAO,YACnC,KAAI,CAAC,OAAO,YAAY,IAAI,QAAQ,EAAE;AACpC,SAAO,YAAY,IAAI,SAAS,KAAK;AACrC,SAAO,YAAY,IAAI,MAAM,QAAQ;;AAOzC,MAAK,MAAM,CAAC,MAAM,YAAY,OAAO,YACnC,KAAI,CAAC,OAAO,YAAY,IAAI,KAAK,IAAI,CAAC,OAAO,YAAY,IAAI,QAAQ,EAAE;AACrE,SAAO,YAAY,IAAI,SAAS,KAAK;AACrC,SAAO,YAAY,IAAI,MAAM,QAAQ;;AAIzC,QAAO;;;;;;;;;;;;AAaT,SAAgB,0BAA0B,SAA4B;AACpE,KAAI,CAAC,wBAAwB,QAAQ,CACnC,QAAO,uBAAuB,QAAQ;CAGxC,MAAM,QAAQ,QAAQ,MAAM,KAAK;CACjC,MAAM,YAAsB,EAAE;CAC9B,MAAM,cAAwB,EAAE;CAChC,IAAI,aAAyC;AAE7C,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,WAAW,WAAW,EAAE;AAC/B,gBAAa;AACb;;AAEF,MAAI,SAAS,aAAa,eAAe,QAAQ;AAC/C,gBAAa;AACb;;AAEF,MAAI,KAAK,WAAW,WAAW,IAAI,eAAe,UAAU;AAC1D,gBAAa;AACb;;AAGF,MAAI,eAAe,QAAQ;AACzB,aAAU,KAAK,KAAK;AACpB,eAAY,KAAK,KAAK;aACb,eAAe,OACxB,WAAU,KAAK,KAAK;MAEpB,aAAY,KAAK,KAAK;;AAO1B,QAAO,gBAHa,uBAAuB,UAAU,KAAK,KAAK,CAAC,EAC1C,uBAAuB,YAAY,KAAK,KAAK,CAAC,CAElB"}
|
package/dist/index.d.mts
CHANGED
|
@@ -234,15 +234,17 @@ declare const SyncStorage: z.ZodEnum<["git-common-dir-v1"]>;
|
|
|
234
234
|
* Doc cache configuration - maps destination paths to source locations.
|
|
235
235
|
*
|
|
236
236
|
* Keys are destination paths relative to .tbd/docs/ (e.g., "shortcuts/standard/code-review-and-commit.md")
|
|
237
|
-
* Values are source
|
|
238
|
-
* - internal:
|
|
239
|
-
* -
|
|
237
|
+
* Values are source docrefs:
|
|
238
|
+
* - internal: bundled docs (e.g., "internal:guidelines/typescript-rules.md")
|
|
239
|
+
* - git: a file in a repo (e.g., "github:owner/repo@main//docs/file.md"; gitlab: too)
|
|
240
|
+
* - url: a plain URL kept verbatim (e.g., "https://example.com/file.md")
|
|
241
|
+
* See `tbd docs show docref-format` for the full grammar.
|
|
240
242
|
*
|
|
241
243
|
* Example:
|
|
242
244
|
* ```yaml
|
|
243
245
|
* doc_cache:
|
|
244
246
|
* shortcuts/standard/code-review-and-commit.md: internal:shortcuts/standard/code-review-and-commit.md
|
|
245
|
-
* shortcuts/custom/my-shortcut.md:
|
|
247
|
+
* shortcuts/custom/my-shortcut.md: github:org/repo@main//shortcuts/my-shortcut.md
|
|
246
248
|
* ```
|
|
247
249
|
*/
|
|
248
250
|
declare const DocCacheConfigSchema: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
@@ -256,11 +258,20 @@ declare const DocsCacheSchema: z.ZodObject<{
|
|
|
256
258
|
/**
|
|
257
259
|
* Files to sync: maps destination paths to source locations.
|
|
258
260
|
* Keys are destination paths relative to .tbd/docs/
|
|
259
|
-
* Values are source
|
|
260
|
-
* - internal:
|
|
261
|
-
* -
|
|
261
|
+
* Values are source docrefs:
|
|
262
|
+
* - internal: bundled docs (e.g., "internal:guidelines/typescript-rules.md")
|
|
263
|
+
* - git: a file in a repo (e.g., "github:owner/repo@main//docs/file.md"; gitlab: too)
|
|
264
|
+
* - url: a plain URL kept verbatim (e.g., "https://example.com/file.md")
|
|
265
|
+
* See `tbd docs show docref-format` for the full grammar.
|
|
262
266
|
*/
|
|
263
267
|
files: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
268
|
+
/**
|
|
269
|
+
* Ordered local-path docrefs (./-prefixed) naming additional in-repo doc
|
|
270
|
+
* directories. They slot into the effective lookup order between the fork
|
|
271
|
+
* dir and the cache; docs found there serve with state `local` and are not
|
|
272
|
+
* forkable or updatable (they already live in the repo).
|
|
273
|
+
*/
|
|
274
|
+
local_dirs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
264
275
|
/**
|
|
265
276
|
* Search paths for doc lookup (like shell $PATH).
|
|
266
277
|
* Earlier paths take precedence when names conflict.
|
|
@@ -269,8 +280,10 @@ declare const DocsCacheSchema: z.ZodObject<{
|
|
|
269
280
|
}, "strip", z.ZodTypeAny, {
|
|
270
281
|
lookup_path: string[];
|
|
271
282
|
files?: Record<string, string> | undefined;
|
|
283
|
+
local_dirs?: string[] | undefined;
|
|
272
284
|
}, {
|
|
273
285
|
files?: Record<string, string> | undefined;
|
|
286
|
+
local_dirs?: string[] | undefined;
|
|
274
287
|
lookup_path?: string[] | undefined;
|
|
275
288
|
}>;
|
|
276
289
|
/**
|
|
@@ -293,6 +306,24 @@ declare const DocsCacheSchema: z.ZodObject<{
|
|
|
293
306
|
*
|
|
294
307
|
* See tbd-format.ts for format version history and migration rules.
|
|
295
308
|
*/
|
|
309
|
+
/**
|
|
310
|
+
* One entry in the config upgrade history (`tbd_upgrades`).
|
|
311
|
+
* Records a tbd version that ran `tbd setup` in this repo.
|
|
312
|
+
*/
|
|
313
|
+
declare const UpgradeEntrySchema: z.ZodObject<{
|
|
314
|
+
/** The tbd version string (e.g. "0.3.0", or a dev build string). */version: z.ZodString;
|
|
315
|
+
/**
|
|
316
|
+
* When this version first ran setup (ISO 8601). Optional: the entry seeded from a
|
|
317
|
+
* pre-f06 config has no timestamp because the original install time is unknown.
|
|
318
|
+
*/
|
|
319
|
+
at: z.ZodOptional<z.ZodString>;
|
|
320
|
+
}, "strip", z.ZodTypeAny, {
|
|
321
|
+
version: string;
|
|
322
|
+
at?: string | undefined;
|
|
323
|
+
}, {
|
|
324
|
+
version: string;
|
|
325
|
+
at?: string | undefined;
|
|
326
|
+
}>;
|
|
296
327
|
declare const ConfigSchema: z.ZodObject<{
|
|
297
328
|
/**
|
|
298
329
|
* Format version for the .tbd/ directory structure.
|
|
@@ -300,7 +331,32 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
300
331
|
* Only bumped for breaking changes that require migration.
|
|
301
332
|
*/
|
|
302
333
|
tbd_format: z.ZodDefault<z.ZodString>;
|
|
334
|
+
/**
|
|
335
|
+
* The tbd version that last ran `tbd setup` in this repo. Updated on every setup.
|
|
336
|
+
* Informational only; functional version gating is via `tbd_format`. See
|
|
337
|
+
* `tbd_upgrades` for the full history. (As of format f06; before f06 this was the
|
|
338
|
+
* install-time version and never changed.)
|
|
339
|
+
*/
|
|
303
340
|
tbd_version: z.ZodString;
|
|
341
|
+
/**
|
|
342
|
+
* Ordered history (oldest first) of tbd versions that have run setup here. Appended
|
|
343
|
+
* on each setup when the version changes; informational. Seeded on the f06 migration
|
|
344
|
+
* from the prior `tbd_version` (without a timestamp). See tbd-format.ts.
|
|
345
|
+
*/
|
|
346
|
+
tbd_upgrades: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
347
|
+
/** The tbd version string (e.g. "0.3.0", or a dev build string). */version: z.ZodString;
|
|
348
|
+
/**
|
|
349
|
+
* When this version first ran setup (ISO 8601). Optional: the entry seeded from a
|
|
350
|
+
* pre-f06 config has no timestamp because the original install time is unknown.
|
|
351
|
+
*/
|
|
352
|
+
at: z.ZodOptional<z.ZodString>;
|
|
353
|
+
}, "strip", z.ZodTypeAny, {
|
|
354
|
+
version: string;
|
|
355
|
+
at?: string | undefined;
|
|
356
|
+
}, {
|
|
357
|
+
version: string;
|
|
358
|
+
at?: string | undefined;
|
|
359
|
+
}>, "many">>;
|
|
304
360
|
sync: z.ZodDefault<z.ZodObject<{
|
|
305
361
|
branch: z.ZodDefault<z.ZodString>;
|
|
306
362
|
remote: z.ZodDefault<z.ZodString>;
|
|
@@ -355,11 +411,20 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
355
411
|
/**
|
|
356
412
|
* Files to sync: maps destination paths to source locations.
|
|
357
413
|
* Keys are destination paths relative to .tbd/docs/
|
|
358
|
-
* Values are source
|
|
359
|
-
* - internal:
|
|
360
|
-
* -
|
|
414
|
+
* Values are source docrefs:
|
|
415
|
+
* - internal: bundled docs (e.g., "internal:guidelines/typescript-rules.md")
|
|
416
|
+
* - git: a file in a repo (e.g., "github:owner/repo@main//docs/file.md"; gitlab: too)
|
|
417
|
+
* - url: a plain URL kept verbatim (e.g., "https://example.com/file.md")
|
|
418
|
+
* See `tbd docs show docref-format` for the full grammar.
|
|
361
419
|
*/
|
|
362
420
|
files: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
421
|
+
/**
|
|
422
|
+
* Ordered local-path docrefs (./-prefixed) naming additional in-repo doc
|
|
423
|
+
* directories. They slot into the effective lookup order between the fork
|
|
424
|
+
* dir and the cache; docs found there serve with state `local` and are not
|
|
425
|
+
* forkable or updatable (they already live in the repo).
|
|
426
|
+
*/
|
|
427
|
+
local_dirs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
363
428
|
/**
|
|
364
429
|
* Search paths for doc lookup (like shell $PATH).
|
|
365
430
|
* Earlier paths take precedence when names conflict.
|
|
@@ -368,13 +433,19 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
368
433
|
}, "strip", z.ZodTypeAny, {
|
|
369
434
|
lookup_path: string[];
|
|
370
435
|
files?: Record<string, string> | undefined;
|
|
436
|
+
local_dirs?: string[] | undefined;
|
|
371
437
|
}, {
|
|
372
438
|
files?: Record<string, string> | undefined;
|
|
439
|
+
local_dirs?: string[] | undefined;
|
|
373
440
|
lookup_path?: string[] | undefined;
|
|
374
441
|
}>>;
|
|
375
442
|
}, "strip", z.ZodTypeAny, {
|
|
376
443
|
tbd_format: string;
|
|
377
444
|
tbd_version: string;
|
|
445
|
+
tbd_upgrades: {
|
|
446
|
+
version: string;
|
|
447
|
+
at?: string | undefined;
|
|
448
|
+
}[];
|
|
378
449
|
sync: {
|
|
379
450
|
branch: string;
|
|
380
451
|
remote: string;
|
|
@@ -391,6 +462,7 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
391
462
|
docs_cache?: {
|
|
392
463
|
lookup_path: string[];
|
|
393
464
|
files?: Record<string, string> | undefined;
|
|
465
|
+
local_dirs?: string[] | undefined;
|
|
394
466
|
} | undefined;
|
|
395
467
|
}, {
|
|
396
468
|
tbd_version: string;
|
|
@@ -398,6 +470,10 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
398
470
|
id_prefix: string;
|
|
399
471
|
};
|
|
400
472
|
tbd_format?: string | undefined;
|
|
473
|
+
tbd_upgrades?: {
|
|
474
|
+
version: string;
|
|
475
|
+
at?: string | undefined;
|
|
476
|
+
}[] | undefined;
|
|
401
477
|
sync?: {
|
|
402
478
|
branch?: string | undefined;
|
|
403
479
|
remote?: string | undefined;
|
|
@@ -410,6 +486,7 @@ declare const ConfigSchema: z.ZodObject<{
|
|
|
410
486
|
} | undefined;
|
|
411
487
|
docs_cache?: {
|
|
412
488
|
files?: Record<string, string> | undefined;
|
|
489
|
+
local_dirs?: string[] | undefined;
|
|
413
490
|
lookup_path?: string[] | undefined;
|
|
414
491
|
} | undefined;
|
|
415
492
|
}>;
|
|
@@ -545,7 +622,7 @@ declare const ISSUE_FIELD_ORDER: readonly ["type", "id", "title", "kind", "statu
|
|
|
545
622
|
/**
|
|
546
623
|
* Canonical field order for config YAML.
|
|
547
624
|
*/
|
|
548
|
-
declare const CONFIG_FIELD_ORDER: readonly ["tbd_format", "tbd_version", "display", "sync", "settings", "docs_cache"];
|
|
625
|
+
declare const CONFIG_FIELD_ORDER: readonly ["tbd_format", "tbd_version", "tbd_upgrades", "display", "sync", "settings", "docs_cache"];
|
|
549
626
|
/**
|
|
550
627
|
* Canonical field order for $GIT_COMMON_DIR/tbd/layout.yml.
|
|
551
628
|
*/
|
|
@@ -675,7 +752,7 @@ interface DocSection {
|
|
|
675
752
|
* All methods are required. Use `noopLogger` when no logging is needed.
|
|
676
753
|
*/
|
|
677
754
|
interface OperationLogger {
|
|
678
|
-
/** Key milestones
|
|
755
|
+
/** Key milestones; drives the spinner in CLI context */
|
|
679
756
|
progress: (message: string) => void;
|
|
680
757
|
/** Operational detail (shown with --verbose or --debug) */
|
|
681
758
|
info: (message: string) => void;
|
|
@@ -710,5 +787,5 @@ declare function serializeIssue(issue: Issue): string;
|
|
|
710
787
|
*/
|
|
711
788
|
declare const VERSION: string;
|
|
712
789
|
//#endregion
|
|
713
|
-
export { ATTIC_ENTRY_FIELD_ORDER, AtticEntry, AtticEntrySchema, BaseEntity, COMMON_DIR_LAYOUT_FIELD_ORDER, CONFIG_FIELD_ORDER, CommonDirLayout, CommonDirLayoutSchema, Config, ConfigSchema, CreateIssueOptions, DATA_SYNC_SCHEMA_VERSION, Dependency, DependencyRelationType, DependencyType, DocCacheConfigSchema, DocSection, DocsCacheSchema, EntityType, ExternalIssueIdInput, GitBranchName, GitRemoteName, ISSUE_BODY_MAX_LENGTH, ISSUE_FIELD_ORDER, ISSUE_TITLE_MAX_LENGTH, IdMappingYamlSchema, Issue, IssueId, IssueKind, IssueKindType, IssueSchema, IssueStatus, IssueStatusType, IssueTitle, LOCAL_STATE_FIELD_ORDER, ListIssuesOptions, LocalState, LocalStateSchema, META_FIELD_ORDER, Meta, MetaSchema, OperationLogger, Priority, PriorityType, SearchIssuesOptions, ShortId, SyncStorage, Timestamp, Ulid, UpdateIssueOptions, VERSION, Version, noopLogger, parseIssue, serializeIssue };
|
|
790
|
+
export { ATTIC_ENTRY_FIELD_ORDER, AtticEntry, AtticEntrySchema, BaseEntity, COMMON_DIR_LAYOUT_FIELD_ORDER, CONFIG_FIELD_ORDER, CommonDirLayout, CommonDirLayoutSchema, Config, ConfigSchema, CreateIssueOptions, DATA_SYNC_SCHEMA_VERSION, Dependency, DependencyRelationType, DependencyType, DocCacheConfigSchema, DocSection, DocsCacheSchema, EntityType, ExternalIssueIdInput, GitBranchName, GitRemoteName, ISSUE_BODY_MAX_LENGTH, ISSUE_FIELD_ORDER, ISSUE_TITLE_MAX_LENGTH, IdMappingYamlSchema, Issue, IssueId, IssueKind, IssueKindType, IssueSchema, IssueStatus, IssueStatusType, IssueTitle, LOCAL_STATE_FIELD_ORDER, ListIssuesOptions, LocalState, LocalStateSchema, META_FIELD_ORDER, Meta, MetaSchema, OperationLogger, Priority, PriorityType, SearchIssuesOptions, ShortId, SyncStorage, Timestamp, Ulid, UpdateIssueOptions, UpgradeEntrySchema, VERSION, Version, noopLogger, parseIssue, serializeIssue };
|
|
714
791
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as Priority, C as IssueSchema, D as LocalStateSchema, E as LOCAL_STATE_FIELD_ORDER, F as Version, M as SyncStorage, N as Timestamp, O as META_FIELD_ORDER, P as Ulid, S as IssueKind, T as IssueTitle, _ as ISSUE_BODY_MAX_LENGTH, a as CONFIG_FIELD_ORDER, b as IdMappingYamlSchema, c as DATA_SYNC_SCHEMA_VERSION, d as DocCacheConfigSchema, f as DocsCacheSchema, g as GitRemoteName, h as GitBranchName, i as COMMON_DIR_LAYOUT_FIELD_ORDER, j as ShortId, k as MetaSchema, l as Dependency, m as ExternalIssueIdInput, n as AtticEntrySchema, o as CommonDirLayoutSchema, p as EntityType, r as BaseEntity, s as ConfigSchema, t as ATTIC_ENTRY_FIELD_ORDER, u as DependencyRelationType, v as ISSUE_FIELD_ORDER, w as IssueStatus, x as IssueId, y as ISSUE_TITLE_MAX_LENGTH } from "./schemas-
|
|
2
|
-
import { c as noopLogger, i as serializeIssue, n as parseIssue, t as VERSION } from "./src-
|
|
1
|
+
import { A as Priority, C as IssueSchema, D as LocalStateSchema, E as LOCAL_STATE_FIELD_ORDER, F as UpgradeEntrySchema, I as Version, M as SyncStorage, N as Timestamp, O as META_FIELD_ORDER, P as Ulid, S as IssueKind, T as IssueTitle, _ as ISSUE_BODY_MAX_LENGTH, a as CONFIG_FIELD_ORDER, b as IdMappingYamlSchema, c as DATA_SYNC_SCHEMA_VERSION, d as DocCacheConfigSchema, f as DocsCacheSchema, g as GitRemoteName, h as GitBranchName, i as COMMON_DIR_LAYOUT_FIELD_ORDER, j as ShortId, k as MetaSchema, l as Dependency, m as ExternalIssueIdInput, n as AtticEntrySchema, o as CommonDirLayoutSchema, p as EntityType, r as BaseEntity, s as ConfigSchema, t as ATTIC_ENTRY_FIELD_ORDER, u as DependencyRelationType, v as ISSUE_FIELD_ORDER, w as IssueStatus, x as IssueId, y as ISSUE_TITLE_MAX_LENGTH } from "./schemas-lCwRk30L.mjs";
|
|
2
|
+
import { c as noopLogger, i as serializeIssue, n as parseIssue, t as VERSION } from "./src-CxKOynr1.mjs";
|
|
3
3
|
|
|
4
|
-
export { ATTIC_ENTRY_FIELD_ORDER, AtticEntrySchema, BaseEntity, COMMON_DIR_LAYOUT_FIELD_ORDER, CONFIG_FIELD_ORDER, CommonDirLayoutSchema, ConfigSchema, DATA_SYNC_SCHEMA_VERSION, Dependency, DependencyRelationType, DocCacheConfigSchema, DocsCacheSchema, EntityType, ExternalIssueIdInput, GitBranchName, GitRemoteName, ISSUE_BODY_MAX_LENGTH, ISSUE_FIELD_ORDER, ISSUE_TITLE_MAX_LENGTH, IdMappingYamlSchema, IssueId, IssueKind, IssueSchema, IssueStatus, IssueTitle, LOCAL_STATE_FIELD_ORDER, LocalStateSchema, META_FIELD_ORDER, MetaSchema, Priority, ShortId, SyncStorage, Timestamp, Ulid, VERSION, Version, noopLogger, parseIssue, serializeIssue };
|
|
4
|
+
export { ATTIC_ENTRY_FIELD_ORDER, AtticEntrySchema, BaseEntity, COMMON_DIR_LAYOUT_FIELD_ORDER, CONFIG_FIELD_ORDER, CommonDirLayoutSchema, ConfigSchema, DATA_SYNC_SCHEMA_VERSION, Dependency, DependencyRelationType, DocCacheConfigSchema, DocsCacheSchema, EntityType, ExternalIssueIdInput, GitBranchName, GitRemoteName, ISSUE_BODY_MAX_LENGTH, ISSUE_FIELD_ORDER, ISSUE_TITLE_MAX_LENGTH, IdMappingYamlSchema, IssueId, IssueKind, IssueSchema, IssueStatus, IssueTitle, LOCAL_STATE_FIELD_ORDER, LocalStateSchema, META_FIELD_ORDER, MetaSchema, Priority, ShortId, SyncStorage, Timestamp, Ulid, UpgradeEntrySchema, VERSION, Version, noopLogger, parseIssue, serializeIssue };
|