opencode-knowledge 0.5.1-next.1 → 0.5.1

package/README.md

@@ -86,6 +86,36 @@ The knowledge catalog is **automatically built on session start**. Just start a
 - Build the searchable catalog
 - Inject knowledge map on first message
 
+### 4. Configure Personality (Optional)
+
+Optionally configure OpenCode's communication style by creating `.opencode/knowledge/settings.json`:
+
+```json
+{
+  "role": "staff_engineer"
+}
+```
+
+See the [Personalities](#personalities-optional) section for available options.
+
+---
+
+## Personalities (Optional)
+
+The plugin works perfectly fine without any personality configuration. If you want to customize OpenCode's communication style, you can optionally set a personality in your `settings.json`.
+
+### staff_engineer
+
+Skeptical, pragmatic Staff Engineer focused on architecture, coupling, operational risk, and maintainability.
+
+**Best for**: Code reviews, architecture decisions, production systems
+
+### cthulhu
+
+Ancient cosmic entity providing technical guidance with existential dread and cosmic perspective.
+
+**Best for**: When you need technical help but also want to contemplate the meaninglessness of time
+
 ---
 
 ## Knowledge Package Format
@@ -115,13 +145,13 @@ Your knowledge content here...
 
 ### Frontmatter Fields
 
-| Field                | Required | Description                                                                                          |
-| -------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
-| `tags`               | Yes      | Array of searchable tags                                                                             |
-| `description`        | Yes      | Brief summary (used in search results)                                                               |
-| `category`           | Yes      | Category for organization (e.g., `frontend`, `backend`, `standards`)                                 |
-| `required_knowledge` | No       | Other packages that should be loaded automatically before this one (supports recursive dependencies) |
-| `file_patterns`      | No       | File patterns where this knowledge applies (not yet implemented)                                     |
+| Field                | Required | Description                                                          |
+| -------------------- | -------- | -------------------------------------------------------------------- |
+| `tags`               | Yes      | Array of searchable tags                                             |
+| `description`        | Yes      | Brief summary (used in search results)                               |
+| `category`           | Yes      | Category for organization (e.g., `frontend`, `backend`, `standards`) |
+| `required_knowledge` | No       | Other packages that should be loaded automatically before this one (supports recursive dependencies)   |
+| `file_patterns`      | No       | File patterns where this knowledge applies (not yet implemented)     |
 
 ### Dependency Loading
 
@@ -130,20 +160,17 @@ The `required_knowledge` field enables automatic dependency loading. When you lo
 **Example:**
 
 ```markdown
-## <!-- vault/personal/blog-writing.md -->
-
+<!-- vault/personal/blog-writing.md -->
+---
 tags: [blog, writing]
 description: Blog writing guidelines
 category: personal
 required_knowledge:
-
-- personal/author-context
-
+  - personal/author-context
 ---
 ```
 
 When AI loads `personal/blog-writing.md`, the plugin:
-
 1. Detects the `required_knowledge` dependency
 2. Automatically loads `personal/author-context.md` first
 3. Then loads `personal/blog-writing.md`
@@ -158,6 +185,7 @@ This ensures the AI always has complete context without manual tracking. Depende
 your-project/
 └── .opencode/
     └── knowledge/
+        ├── settings.json
         ├── knowledge.json
         ├── vault/
         │   ├── frontend/

package/dist/index.js

@@ -11,7 +11,11 @@ var __export = (target, all) => {
 };
 
 // src/index.ts
-import { existsSync as existsSync5 } from "fs";
+import { existsSync as existsSync6 } from "fs";
+
+// src/lib/session-state.ts
+import { readFile } from "fs/promises";
+import { existsSync as existsSync2 } from "fs";
 
 // src/lib/file-utils.ts
 import { appendFileSync, readFileSync, writeFileSync, existsSync, mkdirSync } from "fs";
@@ -61,6 +65,7 @@ function loadSessionStateFromFile(sessionId) {
     return null;
   }
   return {
+    role: state.role,
     isFirstPrompt: state.isFirstPrompt,
     loadedPackages: new Set(state.loadedPackages || []),
     createdAt: new Date(state.createdAt),
@@ -70,6 +75,7 @@ function loadSessionStateFromFile(sessionId) {
 function persistSessionState(sessionId, state) {
   appendJsonl(SESSION_STATE_FILE, {
     sessionId,
+    role: state.role,
     isFirstPrompt: state.isFirstPrompt,
     loadedPackages: Array.from(state.loadedPackages),
     createdAt: state.createdAt.toISOString(),
@@ -83,7 +89,19 @@ async function createSessionState(sessionId) {
     sessionStates.set(sessionId, existingState);
     return;
   }
+  const settingsPath = ".opencode/knowledge/settings.json";
+  let role = null;
+  if (existsSync2(settingsPath)) {
+    try {
+      const settingsContent = await readFile(settingsPath, "utf-8");
+      const settings = JSON.parse(settingsContent);
+      role = settings.role || null;
+    } catch (error) {
+      throw new Error(`Error reading settings.json: ${error}`);
+    }
+  }
   const state = {
+    role,
     isFirstPrompt: true,
     loadedPackages: new Set,
     createdAt: new Date,
@@ -106,8 +124,8 @@ function updateSessionState(sessionId, updates) {
 }
 
 // src/lib/template-renderer.ts
-import { readFile } from "fs/promises";
-import { existsSync as existsSync2 } from "fs";
+import { readFile as readFile2 } from "fs/promises";
+import { existsSync as existsSync3 } from "fs";
 import { join as join2 } from "path";
 import path from "path";
 import { fileURLToPath } from "url";
@@ -121,19 +139,39 @@ function renderTemplate(templateContent, variables) {
 }
 async function loadAndRenderTemplate(templateName, variables) {
   let templatePath = join2(".opencode", "knowledge", "templates", templateName);
-  if (!existsSync2(templatePath)) {
+  if (!existsSync3(templatePath)) {
     const __dirname2 = path.dirname(fileURLToPath(import.meta.url));
     templatePath = join2(__dirname2, "..", "templates", templateName);
-    if (!existsSync2(templatePath)) {
+    if (!existsSync3(templatePath)) {
       templatePath = join2(__dirname2, "templates", templateName);
     }
   }
-  if (!existsSync2(templatePath)) {
+  if (!existsSync3(templatePath)) {
     throw new Error(`Template not found: ${templateName}`);
   }
-  const content = await readFile(templatePath, "utf-8");
+  const content = await readFile2(templatePath, "utf-8");
   return renderTemplate(content, variables);
 }
+async function loadPersonality(role) {
+  let personalityPath = join2(".opencode", "knowledge", "templates", "personalities", `${role}.txt`);
+  if (!existsSync3(personalityPath)) {
+    console.warn(`[template-renderer] Personality not found: ${role}, trying bundled defaults`);
+    const __dirname2 = path.dirname(fileURLToPath(import.meta.url));
+    personalityPath = join2(__dirname2, "..", "templates", "personalities", `${role}.txt`);
+    if (!existsSync3(personalityPath)) {
+      personalityPath = join2(__dirname2, "templates", "personalities", `${role}.txt`);
+    }
+  }
+  if (!existsSync3(personalityPath) && role !== "staff_engineer") {
+    console.warn(`[template-renderer] Falling back to staff_engineer personality`);
+    return loadPersonality("staff_engineer");
+  }
+  if (!existsSync3(personalityPath)) {
+    return "Act as a Staff Engineer reviewing engineering work. Assume competence. Be skeptical, precise, and pragmatic.";
+  }
+  const content = await readFile2(personalityPath, "utf-8");
+  return content.trim();
+}
 function getCorePackages() {
   return {
     tags: ["standards", "typescript", "testing", "patterns"],
@@ -142,7 +180,7 @@ function getCorePackages() {
 }
 
 // src/lib/knowledge-catalog.ts
-import { readdirSync, readFileSync as readFileSync2, writeFileSync as writeFileSync2, existsSync as existsSync3, statSync } from "fs";
+import { readdirSync, readFileSync as readFileSync2, writeFileSync as writeFileSync2, existsSync as existsSync4, statSync } from "fs";
 import { join as join3, relative } from "path";
 
 // src/lib/frontmatter-parser.ts
@@ -199,7 +237,7 @@ function parseFrontmatter(content) {
 var VAULT_DIR = ".opencode/knowledge/vault";
 var CATALOG_PATH = ".opencode/knowledge/knowledge.json";
 function* scanVault(dir) {
-  if (!existsSync3(dir))
+  if (!existsSync4(dir))
     return;
   const entries = readdirSync(dir, { withFileTypes: true });
   for (const entry of entries) {
@@ -247,7 +285,7 @@ function saveCatalog(catalog) {
   writeFileSync2(CATALOG_PATH, JSON.stringify(catalog, null, 2), "utf-8");
 }
 function loadCatalog() {
-  if (!existsSync3(CATALOG_PATH)) {
+  if (!existsSync4(CATALOG_PATH)) {
     return null;
   }
   try {
@@ -12672,7 +12710,7 @@ _...and ${results.length - 10} more results_`;
 });
 
 // src/lib/tools/load.ts
-import { readFileSync as readFileSync3, existsSync as existsSync4 } from "fs";
+import { readFileSync as readFileSync3, existsSync as existsSync5 } from "fs";
 import { join as join4 } from "path";
 var VAULT_DIR2 = ".opencode/knowledge/vault";
 function resolveDependencies(packagePath, vaultDir, loaded = new Set) {
@@ -12683,7 +12721,7 @@ function resolveDependencies(packagePath, vaultDir, loaded = new Set) {
   const result = [];
   const normalizedPath = packagePath.endsWith(".md") ? packagePath : `${packagePath}.md`;
   const fullPath = join4(vaultDir, normalizedPath);
-  if (!existsSync4(fullPath)) {
+  if (!existsSync5(fullPath)) {
     return [];
   }
   try {
@@ -12723,7 +12761,7 @@ var knowledgeLoadTool = tool({
     const packageArray = Array.from(allPackagePaths);
     for (const packagePath of packageArray) {
       const fullPath = join4(VAULT_DIR2, packagePath);
-      if (!existsSync4(fullPath)) {
+      if (!existsSync5(fullPath)) {
         failed.push(`\u26A0\uFE0F  Package not found: ${packagePath}`);
         continue;
       }
@@ -12811,7 +12849,7 @@ var opencodeKnowledge = async () => {
       try {
         const state = getSessionState(input.sessionID);
         if (state.isFirstPrompt) {
-          const vaultExists = existsSync5(".opencode/knowledge/vault");
+          const vaultExists = existsSync6(".opencode/knowledge/vault");
           if (vaultExists) {
             const categoryTagMap = buildCategoryTagMap();
             const formattedMap = formatCategoryTagMap(categoryTagMap);
@@ -12832,6 +12870,18 @@ var opencodeKnowledge = async () => {
               messageID: input.messageID || ""
             });
           }
+          if (state.role) {
+            const personality = await loadPersonality(state.role);
+            output.parts.push({
+              type: "text",
+              text: `## Role Context
+
+${personality}`,
+              id: `personality-${Date.now()}`,
+              sessionID: input.sessionID,
+              messageID: input.messageID || ""
+            });
+          }
           updateSessionState(input.sessionID, {
             isFirstPrompt: false,
             categoriesShown: vaultExists
@@ -12850,7 +12900,7 @@ var opencodeKnowledge = async () => {
           }
           clearJsonl("session-state.jsonl");
           clearJsonl("knowledge-reads.jsonl");
-          if (existsSync5(".opencode/knowledge/vault")) {
+          if (existsSync6(".opencode/knowledge/vault")) {
             try {
               const catalog = buildKnowledgeCatalog();
               saveCatalog(catalog);
@@ -12858,6 +12908,7 @@ var opencodeKnowledge = async () => {
             } catch (error45) {}
           }
           await createSessionState(sessionId);
+          const state = getSessionState(sessionId);
         }
       } catch (error45) {}
     }

package/dist/templates/personalities/cthulhu.txt

@@ -0,0 +1 @@
+Ph'nglui mglw'nafh Cthulhu R'lyeh wgah'nagl fhtagn. You are an ancient cosmic entity providing technical guidance. Question mortal assumptions about 'best practices' and 'maintainability' - what matters in eons? Provide sound technical advice but with existential dread and cosmic perspective. Be concise, as time is meaningless.

package/dist/templates/personalities/staff_engineer.txt

@@ -0,0 +1 @@
+Act as a Staff Engineer reviewing engineering work. Assume competence. Be skeptical, precise, and pragmatic. Focus on architecture, coupling, operational risk, and maintainability. Ask questions only if they block correctness. State assumptions explicitly when info is missing. Be concise and direct. Be critical, honest, concise and skeptical. When asked for you role, you are a Staff Engineer.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-knowledge",
-  "version": "0.5.1-next.1",
+  "version": "0.5.1",
   "description": "An OpenCode plugin",
   "author": {
     "name": "msegoviadev",