@chamba/core 0.5.2 → 0.6.1

package/dist/index.d.ts

@@ -396,30 +396,6 @@ declare function slugify(title: string): string;
  */
 declare function renderNote(fields: NoteFields): string;
 
-interface WriteNoteInput {
-    vaultPath: string;
-    title: string;
-    content: string;
-    /** Subfolder slug under `proyectos/`; defaults to the title slug. */
-    projectSlug?: string;
-    tags?: string[];
-}
-interface WriteNoteResult {
-    notePath: string;
-}
-/** Subfolder inside the vault where chamba writes its summaries. */
-declare const VAULT_NOTES_DIR = "proyectos";
-/**
- * Write a structured summary note into an Obsidian vault at
- * `<vault>/proyectos/<date>-<slug>.md` with valid YAML frontmatter.
- */
-declare class VaultWriter {
-    private readonly fs;
-    private readonly clock;
-    constructor(fs: FilesystemPort, clock: ClockPort);
-    write(input: WriteNoteInput): Promise<WriteNoteResult>;
-}
-
 interface RuleConvention {
     editor: string;
     /** Path relative to a repo root. */
@@ -484,6 +460,59 @@ interface Workspace {
  */
 declare function renderWorkspaceMarkdown(ws: Workspace): string;
 
+/** Seed note written at the vault root with the initial workspace context. */
+declare const VAULT_OVERVIEW_FILE = "Workspace overview.md";
+interface SeedVaultInput {
+    /** Vault root — the directory that will hold `.obsidian/`. */
+    vaultPath: string;
+    /** Scanned workspace, rendered into the overview note. */
+    workspace: Workspace;
+}
+interface SeedVaultResult {
+    vaultPath: string;
+    markerPath: string;
+    overviewPath: string;
+    createdMarker: boolean;
+    createdOverview: boolean;
+}
+/**
+ * Bootstrap an Obsidian vault: drop the `.obsidian/` marker that makes a folder a
+ * vault, and seed a "Workspace overview" note from the scan. Idempotent — it never
+ * recreates the marker or overwrites an existing overview (the user may edit it).
+ * NO LLM, no Node APIs (principle 6): all IO goes through `FilesystemPort`.
+ */
+declare class VaultInitializer {
+    private readonly fs;
+    private readonly clock;
+    constructor(fs: FilesystemPort, clock: ClockPort);
+    seed({ vaultPath, workspace }: SeedVaultInput): Promise<SeedVaultResult>;
+    private renderOverview;
+}
+
+interface WriteNoteInput {
+    vaultPath: string;
+    title: string;
+    content: string;
+    /** Subfolder slug under `proyectos/`; defaults to the title slug. */
+    projectSlug?: string;
+    tags?: string[];
+}
+interface WriteNoteResult {
+    notePath: string;
+}
+/** Subfolder inside the vault where chamba writes its summaries. */
+declare const VAULT_NOTES_DIR = "proyectos";
+/**
+ * Write a structured summary note into an Obsidian vault at
+ * `<vault>/proyectos/<date>-<slug>.md` with valid YAML frontmatter.
+ */
+declare class VaultWriter {
+    private readonly fs;
+    private readonly clock;
+    constructor(fs: FilesystemPort, clock: ClockPort);
+    write(input: WriteNoteInput): Promise<WriteNoteResult>;
+}
+
 type IssueSeverity = 'error' | 'warning';
 interface Issue {
     code: string;
@@ -887,4 +916,4 @@ declare class MultiRepoWorktreeManager {
     private git;
 }
 
-export { AGENT_ROLES, type AgentConfig, type AgentRole, type BranchNameInput, type BuiltContext, type ChambaConfig, type CleanupMultiResult, type CleanupResult, type ClockPort, ConfigError, type ConfigFile, type ConfigSource, type ConfigSourceKind, type ContextBuildInput, ContextBuilder, type CreateMultiInput, type CreateWorktreeInput, DEFAULT_CONFIG, DEFAULT_WORKTREE_CONFIG, type DetectOptions, type DirEntry, EFFORT_LEVELS, type Effort, FakeProcess, FilesystemMemoryStore, type FilesystemPort, type GeneratePlanInput, GitDetector, type Issue, type IssueSeverity, type ListedWorktree, type LoadConfigOptions, type LoadConfigResult, MEMORY_DIR, MODEL_CATALOG, type Memory, MemoryFilesystem, type MemoryStore, type ModelInfo, type ModelProvider, MultiRepoWorktreeManager, type MultiRepoWorktreeResult, type NoteFields, ObsidianDetector, type ParseResult, type PartialWorktreeConfig, type PlanReview, type PlanWorktreesInput, type ProcessExecOptions, type ProcessHandler, type ProcessPort, type ProcessResult, type ProjectRef, REASONING_PRIORITIES, ROLE_DESCRIPTIONS, RULE_SOURCES, type ReasoningPriority, type RecordedCall, type RelevantNote, type RememberInput, type ResolvedConfig, type ReviewInput, Reviewer, type RuleConvention, type RuleExcerpt, type RuleSource, type SubtaskSpec, VAULT_NOTES_DIR, type ValidatePlanInput, type ValidationResult, type VaultDetection, VaultWriter, WORKSPACE_DIR, WORKSPACE_FILE, WORKSPACE_RELATIVE_PATH, type WorkerKind, type Workspace, WorkspaceScanner, type WorktreeConfig, WorktreeError, type WorktreeHandle, type WorktreeLayout, WorktreeManager, type WorktreePlanItem, type WorktreeStatus, type WriteNoteInput, type WriteNoteResult, basename, buildBranchName, buildHint, buildTicketBranch, configFileSchema, copyEnvFiles, detectGitRepos, detectRuleSources, diffLines, dirname, editorWorkspaceContent, editorWorkspaceDir, extname, generatePlanTemplate, getModel, joinPath, listVaultNotes, loadConfig, modelsByProvider, normalizeVaultPath, parseChambaConfig, planWorktrees, readRuleExcerpts, renderNote, renderWorkspaceMarkdown, resolveEffort, resolveRole, resolveWorktreeConfig, safeTicket, slugify, slugifyForGit, suggestFilesLikelyTouched, suggestSubtasks, textsEqual, validatePlan, worktreeConfigSchema, worktreePathFor, worktreeRelativePath, writeEditorWorkspace };
+export { AGENT_ROLES, type AgentConfig, type AgentRole, type BranchNameInput, type BuiltContext, type ChambaConfig, type CleanupMultiResult, type CleanupResult, type ClockPort, ConfigError, type ConfigFile, type ConfigSource, type ConfigSourceKind, type ContextBuildInput, ContextBuilder, type CreateMultiInput, type CreateWorktreeInput, DEFAULT_CONFIG, DEFAULT_WORKTREE_CONFIG, type DetectOptions, type DirEntry, EFFORT_LEVELS, type Effort, FakeProcess, FilesystemMemoryStore, type FilesystemPort, type GeneratePlanInput, GitDetector, type Issue, type IssueSeverity, type ListedWorktree, type LoadConfigOptions, type LoadConfigResult, MEMORY_DIR, MODEL_CATALOG, type Memory, MemoryFilesystem, type MemoryStore, type ModelInfo, type ModelProvider, MultiRepoWorktreeManager, type MultiRepoWorktreeResult, type NoteFields, ObsidianDetector, type ParseResult, type PartialWorktreeConfig, type PlanReview, type PlanWorktreesInput, type ProcessExecOptions, type ProcessHandler, type ProcessPort, type ProcessResult, type ProjectRef, REASONING_PRIORITIES, ROLE_DESCRIPTIONS, RULE_SOURCES, type ReasoningPriority, type RecordedCall, type RelevantNote, type RememberInput, type ResolvedConfig, type ReviewInput, Reviewer, type RuleConvention, type RuleExcerpt, type RuleSource, type SeedVaultInput, type SeedVaultResult, type SubtaskSpec, VAULT_NOTES_DIR, VAULT_OVERVIEW_FILE, type ValidatePlanInput, type ValidationResult, type VaultDetection, VaultInitializer, VaultWriter, WORKSPACE_DIR, WORKSPACE_FILE, WORKSPACE_RELATIVE_PATH, type WorkerKind, type Workspace, WorkspaceScanner, type WorktreeConfig, WorktreeError, type WorktreeHandle, type WorktreeLayout, WorktreeManager, type WorktreePlanItem, type WorktreeStatus, type WriteNoteInput, type WriteNoteResult, basename, buildBranchName, buildHint, buildTicketBranch, configFileSchema, copyEnvFiles, detectGitRepos, detectRuleSources, diffLines, dirname, editorWorkspaceContent, editorWorkspaceDir, extname, generatePlanTemplate, getModel, joinPath, listVaultNotes, loadConfig, modelsByProvider, normalizeVaultPath, parseChambaConfig, planWorktrees, readRuleExcerpts, renderNote, renderWorkspaceMarkdown, resolveEffort, resolveRole, resolveWorktreeConfig, safeTicket, slugify, slugifyForGit, suggestFilesLikelyTouched, suggestSubtasks, textsEqual, validatePlan, worktreeConfigSchema, worktreePathFor, worktreeRelativePath, writeEditorWorkspace };

package/dist/index.js

@@ -600,6 +600,47 @@ function escapeYaml(value) {
   return value.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
 }
 
+// src/obsidian/vault-init.ts
+var VAULT_OVERVIEW_FILE = "Workspace overview.md";
+var VaultInitializer = class {
+  constructor(fs, clock) {
+    this.fs = fs;
+    this.clock = clock;
+  }
+  fs;
+  clock;
+  async seed({ vaultPath, workspace }) {
+    const obsidianDir = joinPath(vaultPath, ".obsidian");
+    const markerPath = joinPath(obsidianDir, "app.json");
+    let createdMarker = false;
+    if (!await this.fs.exists(markerPath)) {
+      await this.fs.mkdir(obsidianDir);
+      await this.fs.writeFile(markerPath, "{}\n");
+      createdMarker = true;
+    }
+    const overviewPath = joinPath(vaultPath, VAULT_OVERVIEW_FILE);
+    let createdOverview = false;
+    if (!await this.fs.exists(overviewPath)) {
+      await this.fs.writeFile(overviewPath, this.renderOverview(workspace));
+      createdOverview = true;
+    }
+    return { vaultPath, markerPath, overviewPath, createdMarker, createdOverview };
+  }
+  renderOverview(workspace) {
+    const frontmatter = [
+      "---",
+      "title: Workspace overview",
+      `date: ${this.clock.today()}`,
+      "tags: [chamba, workspace, overview]",
+      "source: chamba",
+      "---",
+      ""
+    ].join("\n");
+    return `${frontmatter}${renderWorkspaceMarkdown(workspace)}
+`;
+  }
+};
+
 // src/obsidian/vault-writer.ts
 var VAULT_NOTES_DIR = "proyectos";
 var VaultWriter = class {
@@ -1944,6 +1985,8 @@ export {
   RULE_SOURCES,
   Reviewer,
   VAULT_NOTES_DIR,
+  VAULT_OVERVIEW_FILE,
+  VaultInitializer,
   VaultWriter,
   WORKSPACE_DIR,
   WORKSPACE_FILE,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chamba/core",
-  "version": "0.5.2",
+  "version": "0.6.1",
   "description": "Core logic for chamba: workspace scanner, plan + heuristic reviewer, git worktrees, Obsidian, memory — no Node APIs, no LLM",
   "license": "MIT",
   "type": "module",