@try-works/dsh-memory 0.1.18 → 0.1.20

package/src/store.js

@@ -1,128 +1,128 @@
-// Memory store layout: paths, .gitignore, memory.json, layer templates, and the
-// MemoryStore class. Node built-ins only (unit-testable standalone).
-import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
-import { join } from 'node:path'
-import { resolveConfig } from './defaults.js'
-import { GLOBAL_LAYERED, LAYER_DIRS, LAYERED } from './entry.js'
-import { sanitizeKey, deriveWorkspaceKey } from './workspace-key.js'
-import { workingPreamble } from './working.js'
-
-export const LAYER_FILES = ['INDEX.md', 'semantic.md', 'episodic.md', 'procedural.md', 'working.md', 'learnings.md', 'junk.md', 'codebase.md', 'history.md', 'decisions.md', 'state.md']
-
-/** Working memory is the current-state head of ONE repo/workspace, never of the
- * whole store: a global working.md would mix unrelated repositories together. */
-export const WORKSPACE_LAYER_FILES = LAYER_FILES
-/** working.md is per workspace; the codebase map describes one repository. */
-export const WORKSPACE_ONLY_FILES = ['working.md', 'codebase.md', 'history.md', 'state.md']
-export const GLOBAL_LAYER_FILES = LAYER_FILES.filter((file) => !WORKSPACE_ONLY_FILES.includes(file))
-
-export const GITIGNORE = [
-  '# dsh-memory: derived + device-local state (regenerated; never committed)',
-  'index/', 'state/', 'digests/', 'logs/', '*.lock', '.dsh-tmp/', '',
-].join('\n')
-
-export function globalDir(root) { return join(root, 'global') }
-export function workspacesDir(root) { return join(root, 'workspaces') }
-export function workspaceDir(root, key) { return join(workspacesDir(root), key) }
-export function layerDir(root, scope, key) { return scope === 'global' ? globalDir(root) : workspaceDir(root, key) }
-export function memoryJsonPath(root) { return join(root, 'memory.json') }
-
-export function memoryJsonTemplate() { return { schemaVersion: 1, git: { remote: '', branch: 'main' }, workspaces: {} } }
-
-export function layerTemplate(scope, key, file) {
-  const title = scope === 'global' ? 'Global' : (key ?? 'workspace')
-  if (file === 'INDEX.md') return '# ' + title + ' memory — index\n\nTopic map for the ' + scope + ' layer. One line per topic, linking into a layer file section.\n\n'
-  if (file === 'working.md') return '# ' + title + ' — working memory' + String.fromCharCode(10,10) + workingPreamble() + String.fromCharCode(10,10)
-  if (file === 'codebase.md') return '# ' + title + ' — codebase\n\nMap of this repository: one entry per module or subsystem as it is discovered.\n\n'
-  if (file === 'history.md') return '# ' + title + ' — history\n\nHow this repository changed: one entry per commit, grouped by day.\n\n'
-  if (file === 'state.md') return '# ' + title + ' — state\n\nWhat this repository is right now, section by section. Each section carries when it was last verified.\n\n'
-  if (file === 'decisions.md') return '# ' + title + ' — decisions\n\nSettled choices and why they won: dependencies, conventions, architecture. One entry per decision.\n\n'
-  return '# ' + title + ' — ' + file.replace(/\.md$/, '') + '\n\n'
-}
-
-/** Last recorded sync outcome (state/sync.json) plus whether a conflict marker stands. */
-function readSyncState(root) {
-  const state = { last: null, conflicted: existsSync(join(root, 'state', 'CONFLICT.md')) }
-  try { state.last = JSON.parse(readFileSync(join(root, 'state', 'sync.json'), 'utf8')) } catch {}
-  return state
-}
-
-function writeIfAbsent(file, content) { if (!existsSync(file)) writeFileSync(file, content, 'utf8') }
-
-/** Drop a pre-existing global working.md, but only while it is still the untouched
- * template - anything the user actually wrote there is theirs to keep. */
-function retireGlobalWorking(root) {
-  const file = join(globalDir(root), 'working.md')
-  try {
-    if (!existsSync(file)) return
-    if (readFileSync(file, 'utf8') !== layerTemplate('global', '', 'working.md')) return
-    rmSync(file)
-  } catch {}
-}
-
-export class MemoryStore {
-  constructor(config = {}) {
-    this.config = resolveConfig(config)
-    this.root = this.config.memoryRoot
-  }
-
-  get globalPath() { return globalDir(this.root) }
-  get workspacesPath() { return workspacesDir(this.root) }
-
-  resolveKey({ explicit, remote, basename } = {}) {
-    return sanitizeKey(explicit) ?? deriveWorkspaceKey({ remote, basename })
-  }
-
-  ensureLayout() {
-    for (const dir of [this.root, this.globalPath, this.workspacesPath, join(this.root, 'index'), join(this.root, 'state'), join(this.root, 'digests'), join(this.root, 'logs')]) {
-      mkdirSync(dir, { recursive: true })
-    }
-    writeIfAbsent(join(this.root, '.gitignore'), GITIGNORE)
-    writeIfAbsent(memoryJsonPath(this.root), JSON.stringify(memoryJsonTemplate(), null, 2) + '\n')
-    for (const file of GLOBAL_LAYER_FILES) writeIfAbsent(join(this.globalPath, file), layerTemplate('global', '', file))
-    for (const dir of GLOBAL_LAYERED) mkdirSync(join(this.globalPath, LAYER_DIRS[dir]), { recursive: true })
-    retireGlobalWorking(this.root)
-    return this.root
-  }
-
-  ensureWorkspace(key, meta = {}) {
-    const safe = sanitizeKey(key)
-    if (!safe) throw new Error('invalid workspace key: ' + String(key))
-    const dir = workspaceDir(this.root, safe)
-    mkdirSync(dir, { recursive: true })
-    writeIfAbsent(join(dir, 'meta.json'), JSON.stringify({ key: safe, title: meta.title ?? safe, remotes: meta.remotes ?? [], createdAt: new Date().toISOString() }, null, 2) + '\n')
-    for (const file of WORKSPACE_LAYER_FILES) writeIfAbsent(join(dir, file), layerTemplate('workspace', safe, file))
-    for (const name of LAYERED) mkdirSync(join(dir, LAYER_DIRS[name]), { recursive: true })
-    return safe
-  }
-
-  readMemoryJson() { try { return JSON.parse(readFileSync(memoryJsonPath(this.root), 'utf8')) } catch { return memoryJsonTemplate() } }
-  writeMemoryJson(value) { writeFileSync(memoryJsonPath(this.root), JSON.stringify(value, null, 2) + '\n') }
-
-  /**
-   * Keep the registry's git block in step with the resolved configuration. memory.json is
-   * committed, so it should say where this store syncs; it previously stayed empty because
-   * only workspace association ever wrote the file.
-   */
-  syncGitBlock() {
-    const mem = this.readMemoryJson()
-    const remote = this.config.gitRemote ?? ''
-    const branch = this.config.gitBranch ?? 'main'
-    if ((mem.git?.remote ?? '') === remote && (mem.git?.branch ?? '') === branch) return false
-    mem.git = { remote, branch }
-    this.writeMemoryJson(mem)
-    return true
-  }
-
-  status() {
-    return {
-      root: this.root,
-      initialized: existsSync(memoryJsonPath(this.root)),
-      gitIgnored: existsSync(join(this.root, '.gitignore')),
-      globalLayer: existsSync(this.globalPath),
-      sync: readSyncState(this.root),
-    }
-  }
-
-  dispose() {}
-}
+// Memory store layout: paths, .gitignore, memory.json, layer templates, and the
+// MemoryStore class. Node built-ins only (unit-testable standalone).
+import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { resolveConfig } from './defaults.js'
+import { GLOBAL_LAYERED, LAYER_DIRS, LAYERED } from './entry.js'
+import { sanitizeKey, deriveWorkspaceKey } from './workspace-key.js'
+import { workingPreamble } from './working.js'
+
+export const LAYER_FILES = ['INDEX.md', 'semantic.md', 'episodic.md', 'procedural.md', 'working.md', 'learnings.md', 'junk.md', 'codebase.md', 'history.md', 'decisions.md', 'state.md']
+
+/** Working memory is the current-state head of ONE repo/workspace, never of the
+ * whole store: a global working.md would mix unrelated repositories together. */
+export const WORKSPACE_LAYER_FILES = LAYER_FILES
+/** working.md is per workspace; the codebase map describes one repository. */
+export const WORKSPACE_ONLY_FILES = ['working.md', 'codebase.md', 'history.md', 'state.md']
+export const GLOBAL_LAYER_FILES = LAYER_FILES.filter((file) => !WORKSPACE_ONLY_FILES.includes(file))
+
+export const GITIGNORE = [
+  '# dsh-memory: derived + device-local state (regenerated; never committed)',
+  'index/', 'state/', 'digests/', 'logs/', '*.lock', '.dsh-tmp/', '',
+].join('\n')
+
+export function globalDir(root) { return join(root, 'global') }
+export function workspacesDir(root) { return join(root, 'workspaces') }
+export function workspaceDir(root, key) { return join(workspacesDir(root), key) }
+export function layerDir(root, scope, key) { return scope === 'global' ? globalDir(root) : workspaceDir(root, key) }
+export function memoryJsonPath(root) { return join(root, 'memory.json') }
+
+export function memoryJsonTemplate() { return { schemaVersion: 1, git: { remote: '', branch: 'main' }, workspaces: {} } }
+
+export function layerTemplate(scope, key, file) {
+  const title = scope === 'global' ? 'Global' : (key ?? 'workspace')
+  if (file === 'INDEX.md') return '# ' + title + ' memory — index\n\nTopic map for the ' + scope + ' layer. One line per topic, linking into a layer file section.\n\n'
+  if (file === 'working.md') return '# ' + title + ' — working memory' + String.fromCharCode(10,10) + workingPreamble() + String.fromCharCode(10,10)
+  if (file === 'codebase.md') return '# ' + title + ' — codebase\n\nMap of this repository: one entry per module or subsystem as it is discovered.\n\n'
+  if (file === 'history.md') return '# ' + title + ' — history\n\nHow this repository changed: one entry per commit, grouped by day.\n\n'
+  if (file === 'state.md') return '# ' + title + ' — state\n\nWhat this repository is right now, section by section. Each section carries when it was last verified.\n\n'
+  if (file === 'decisions.md') return '# ' + title + ' — decisions\n\nSettled choices and why they won: dependencies, conventions, architecture. One entry per decision.\n\n'
+  return '# ' + title + ' — ' + file.replace(/\.md$/, '') + '\n\n'
+}
+
+/** Last recorded sync outcome (state/sync.json) plus whether a conflict marker stands. */
+function readSyncState(root) {
+  const state = { last: null, conflicted: existsSync(join(root, 'state', 'CONFLICT.md')) }
+  try { state.last = JSON.parse(readFileSync(join(root, 'state', 'sync.json'), 'utf8')) } catch {}
+  return state
+}
+
+function writeIfAbsent(file, content) { if (!existsSync(file)) writeFileSync(file, content, 'utf8') }
+
+/** Drop a pre-existing global working.md, but only while it is still the untouched
+ * template - anything the user actually wrote there is theirs to keep. */
+function retireGlobalWorking(root) {
+  const file = join(globalDir(root), 'working.md')
+  try {
+    if (!existsSync(file)) return
+    if (readFileSync(file, 'utf8') !== layerTemplate('global', '', 'working.md')) return
+    rmSync(file)
+  } catch {}
+}
+
+export class MemoryStore {
+  constructor(config = {}) {
+    this.config = resolveConfig(config)
+    this.root = this.config.memoryRoot
+  }
+
+  get globalPath() { return globalDir(this.root) }
+  get workspacesPath() { return workspacesDir(this.root) }
+
+  resolveKey({ explicit, remote, basename } = {}) {
+    return sanitizeKey(explicit) ?? deriveWorkspaceKey({ remote, basename })
+  }
+
+  ensureLayout() {
+    for (const dir of [this.root, this.globalPath, this.workspacesPath, join(this.root, 'index'), join(this.root, 'state'), join(this.root, 'digests'), join(this.root, 'logs')]) {
+      mkdirSync(dir, { recursive: true })
+    }
+    writeIfAbsent(join(this.root, '.gitignore'), GITIGNORE)
+    writeIfAbsent(memoryJsonPath(this.root), JSON.stringify(memoryJsonTemplate(), null, 2) + '\n')
+    for (const file of GLOBAL_LAYER_FILES) writeIfAbsent(join(this.globalPath, file), layerTemplate('global', '', file))
+    for (const dir of GLOBAL_LAYERED) mkdirSync(join(this.globalPath, LAYER_DIRS[dir]), { recursive: true })
+    retireGlobalWorking(this.root)
+    return this.root
+  }
+
+  ensureWorkspace(key, meta = {}) {
+    const safe = sanitizeKey(key)
+    if (!safe) throw new Error('invalid workspace key: ' + String(key))
+    const dir = workspaceDir(this.root, safe)
+    mkdirSync(dir, { recursive: true })
+    writeIfAbsent(join(dir, 'meta.json'), JSON.stringify({ key: safe, title: meta.title ?? safe, remotes: meta.remotes ?? [], createdAt: new Date().toISOString() }, null, 2) + '\n')
+    for (const file of WORKSPACE_LAYER_FILES) writeIfAbsent(join(dir, file), layerTemplate('workspace', safe, file))
+    for (const name of LAYERED) mkdirSync(join(dir, LAYER_DIRS[name]), { recursive: true })
+    return safe
+  }
+
+  readMemoryJson() { try { return JSON.parse(readFileSync(memoryJsonPath(this.root), 'utf8')) } catch { return memoryJsonTemplate() } }
+  writeMemoryJson(value) { writeFileSync(memoryJsonPath(this.root), JSON.stringify(value, null, 2) + '\n') }
+
+  /**
+   * Keep the registry's git block in step with the resolved configuration. memory.json is
+   * committed, so it should say where this store syncs; it previously stayed empty because
+   * only workspace association ever wrote the file.
+   */
+  syncGitBlock() {
+    const mem = this.readMemoryJson()
+    const remote = this.config.gitRemote ?? ''
+    const branch = this.config.gitBranch ?? 'main'
+    if ((mem.git?.remote ?? '') === remote && (mem.git?.branch ?? '') === branch) return false
+    mem.git = { remote, branch }
+    this.writeMemoryJson(mem)
+    return true
+  }
+
+  status() {
+    return {
+      root: this.root,
+      initialized: existsSync(memoryJsonPath(this.root)),
+      gitIgnored: existsSync(join(this.root, '.gitignore')),
+      globalLayer: existsSync(this.globalPath),
+      sync: readSyncState(this.root),
+    }
+  }
+
+  dispose() {}
+}