opencode-snippets 1.4.2 → 1.4.3

package/src/loader.ts

@@ -1,268 +0,0 @@
-import { mkdir, readdir, readFile, unlink, writeFile } from "node:fs/promises";
-import { basename, join } from "node:path";
-import matter from "gray-matter";
-import { CONFIG, PATHS } from "./constants.js";
-import { logger } from "./logger.js";
-import type { SnippetFrontmatter, SnippetInfo, SnippetRegistry } from "./types.js";
-
-/**
- * Loads all snippets from global and project directories
- *
- * @param projectDir - Optional project directory path (from ctx.directory)
- * @param globalDir - Optional global snippets directory (for testing)
- * @returns A map of snippet keys (lowercase) to their SnippetInfo
- */
-export async function loadSnippets(
-  projectDir?: string,
-  globalDir?: string,
-): Promise<SnippetRegistry> {
-  const snippets: SnippetRegistry = new Map();
-
-  // Load from global directory first (use provided or default)
-  const globalSnippetsDir = globalDir ?? PATHS.SNIPPETS_DIR;
-  await loadFromDirectory(globalSnippetsDir, snippets, "global");
-
-  // Load from project directory if provided (overrides global)
-  if (projectDir) {
-    const projectSnippetsDir = join(projectDir, ".opencode", "snippet");
-    await loadFromDirectory(projectSnippetsDir, snippets, "project");
-  }
-
-  return snippets;
-}
-
-/**
- * Loads snippets from a specific directory
- *
- * @param dir - Directory to load snippets from
- * @param registry - Registry to populate
- * @param source - Source label for logging
- */
-async function loadFromDirectory(
-  dir: string,
-  registry: SnippetRegistry,
-  source: "global" | "project",
-): Promise<void> {
-  try {
-    const files = await readdir(dir);
-
-    for (const file of files) {
-      if (!file.endsWith(CONFIG.SNIPPET_EXTENSION)) continue;
-
-      const snippet = await loadSnippetFile(dir, file, source);
-      if (snippet) {
-        registerSnippet(registry, snippet);
-      }
-    }
-
-    logger.debug(`Loaded snippets from ${source} directory`, {
-      path: dir,
-      fileCount: files.length,
-    });
-  } catch (error) {
-    // Snippets directory doesn't exist or can't be read - that's fine
-    logger.debug(`${source} snippets directory not found or unreadable`, {
-      path: dir,
-      error: error instanceof Error ? error.message : String(error),
-    });
-  }
-}
-
-/**
- * Loads and parses a single snippet file
- *
- * @param dir - Directory containing the snippet file
- * @param filename - The filename to load (e.g., "my-snippet.md")
- * @param source - Whether this is a global or project snippet
- * @returns The parsed snippet info, or null if parsing failed
- */
-async function loadSnippetFile(
-  dir: string,
-  filename: string,
-  source: "global" | "project",
-): Promise<SnippetInfo | null> {
-  try {
-    const name = basename(filename, CONFIG.SNIPPET_EXTENSION);
-    const filePath = join(dir, filename);
-    const fileContent = await readFile(filePath, "utf-8");
-    const parsed = matter(fileContent);
-
-    const content = parsed.content.trim();
-    const frontmatter = parsed.data as SnippetFrontmatter;
-
-    // Handle aliases: accept both 'aliases' (plural) and 'alias' (singular)
-    // Prefer 'aliases' if both are present
-    let aliases: string[] = [];
-    const aliasSource = frontmatter.aliases ?? frontmatter.alias;
-    if (aliasSource) {
-      if (Array.isArray(aliasSource)) {
-        aliases = aliasSource;
-      } else {
-        aliases = [aliasSource];
-      }
-    }
-
-    return {
-      name,
-      content,
-      aliases,
-      description: frontmatter.description,
-      filePath,
-      source,
-    };
-  } catch (error) {
-    // Failed to read or parse this snippet - skip it
-    logger.warn("Failed to load snippet file", {
-      filename,
-      error: error instanceof Error ? error.message : String(error),
-    });
-    return null;
-  }
-}
-
-/**
- * Registers a snippet and its aliases in the registry
- *
- * @param registry - The registry to add the snippet to
- * @param snippet - The snippet info to register
- */
-function registerSnippet(registry: SnippetRegistry, snippet: SnippetInfo): void {
-  const key = snippet.name.toLowerCase();
-
-  // If snippet with same name exists, remove its old aliases first
-  const existing = registry.get(key);
-  if (existing) {
-    for (const alias of existing.aliases) {
-      registry.delete(alias.toLowerCase());
-    }
-  }
-
-  // Register the snippet under its name
-  registry.set(key, snippet);
-
-  // Register under all aliases (pointing to the same snippet info)
-  for (const alias of snippet.aliases) {
-    registry.set(alias.toLowerCase(), snippet);
-  }
-}
-
-/**
- * Lists all unique snippets (by name) from the registry
- *
- * @param registry - The snippet registry
- * @returns Array of unique snippet info objects
- */
-export function listSnippets(registry: SnippetRegistry): SnippetInfo[] {
-  const seen = new Set<string>();
-  const snippets: SnippetInfo[] = [];
-
-  for (const snippet of registry.values()) {
-    if (!seen.has(snippet.name)) {
-      seen.add(snippet.name);
-      snippets.push(snippet);
-    }
-  }
-
-  return snippets;
-}
-
-/**
- * Ensures the snippets directory exists
- */
-export async function ensureSnippetsDir(projectDir?: string): Promise<string> {
-  const dir = projectDir ? join(projectDir, ".opencode", "snippet") : PATHS.SNIPPETS_DIR;
-  await mkdir(dir, { recursive: true });
-  return dir;
-}
-
-/**
- * Creates a new snippet file
- *
- * @param name - The snippet name (without extension)
- * @param content - The snippet content
- * @param options - Optional metadata (aliases, description)
- * @param projectDir - If provided, creates in project directory; otherwise global
- * @returns The path to the created snippet file
- */
-export async function createSnippet(
-  name: string,
-  content: string,
-  options: { aliases?: string[]; description?: string } = {},
-  projectDir?: string,
-): Promise<string> {
-  const dir = await ensureSnippetsDir(projectDir);
-  const filePath = join(dir, `${name}${CONFIG.SNIPPET_EXTENSION}`);
-
-  // Build frontmatter if we have metadata
-  const frontmatter: SnippetFrontmatter = {};
-  if (options.aliases?.length) {
-    frontmatter.aliases = options.aliases;
-  }
-  if (options.description) {
-    frontmatter.description = options.description;
-  }
-
-  // Create file content with frontmatter if needed
-  let fileContent: string;
-  if (Object.keys(frontmatter).length > 0) {
-    fileContent = matter.stringify(content, frontmatter);
-  } else {
-    fileContent = content;
-  }
-
-  await writeFile(filePath, fileContent, "utf-8");
-  logger.info("Created snippet", { name, path: filePath });
-
-  return filePath;
-}
-
-/**
- * Deletes a snippet file
- *
- * @param name - The snippet name (without extension)
- * @param projectDir - If provided, looks in project directory first; otherwise global
- * @returns The path of the deleted file, or null if not found
- */
-export async function deleteSnippet(name: string, projectDir?: string): Promise<string | null> {
-  // Try project directory first if provided
-  if (projectDir) {
-    const projectPath = join(
-      projectDir,
-      ".opencode",
-      "snippet",
-      `${name}${CONFIG.SNIPPET_EXTENSION}`,
-    );
-    try {
-      await unlink(projectPath);
-      logger.info("Deleted project snippet", { name, path: projectPath });
-      return projectPath;
-    } catch {
-      // Not found in project, try global
-    }
-  }
-
-  // Try global directory
-  const globalPath = join(PATHS.SNIPPETS_DIR, `${name}${CONFIG.SNIPPET_EXTENSION}`);
-  try {
-    await unlink(globalPath);
-    logger.info("Deleted global snippet", { name, path: globalPath });
-    return globalPath;
-  } catch {
-    logger.warn("Snippet not found for deletion", { name });
-    return null;
-  }
-}
-
-/**
- * Reloads snippets into the registry from disk
- */
-export async function reloadSnippets(
-  registry: SnippetRegistry,
-  projectDir?: string,
-): Promise<void> {
-  registry.clear();
-  const fresh = await loadSnippets(projectDir);
-  for (const [key, value] of fresh) {
-    registry.set(key, value);
-  }
-}

package/src/logger.test.ts

@@ -1,136 +0,0 @@
-import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "bun:test";
-import { existsSync, mkdtempSync, readFileSync, rmSync } from "fs";
-import { tmpdir } from "os";
-import { join } from "path";
-
-describe("Logger", () => {
-  let tempDir: string;
-  let originalEnv: NodeJS.ProcessEnv;
-  let Logger: typeof import("../src/logger.js").Logger;
-
-  beforeAll(() => {
-    originalEnv = { ...process.env };
-  });
-
-  beforeEach(() => {
-    tempDir = mkdtempSync(join(tmpdir(), "snippets-logger-test-"));
-    Logger = require("../src/logger.js").Logger;
-  });
-
-  afterEach(() => {
-    rmSync(tempDir, { recursive: true, force: true });
-    vi.restoreAllMocks();
-    process.env = originalEnv;
-  });
-
-  describe("isDebugEnabled", () => {
-    it("should return false when DEBUG_SNIPPETS is not set", () => {
-      delete process.env.DEBUG_SNIPPETS;
-      const testLogger = new Logger(join(tempDir, "logs"));
-      expect(testLogger.enabled).toBe(false);
-    });
-
-    it("should return true when DEBUG_SNIPPETS=1", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const testLogger = new Logger(join(tempDir, "logs"));
-      expect(testLogger.enabled).toBe(true);
-    });
-
-    it("should return true when DEBUG_SNIPPETS=true", () => {
-      process.env.DEBUG_SNIPPETS = "true";
-      const testLogger = new Logger(join(tempDir, "logs"));
-      expect(testLogger.enabled).toBe(true);
-    });
-
-    it("should return false for other values", () => {
-      process.env.DEBUG_SNIPPETS = "yes";
-      const testLogger = new Logger(join(tempDir, "logs"));
-      expect(testLogger.enabled).toBe(false);
-    });
-  });
-
-  describe("log writing", () => {
-    it("should not write logs when debug is disabled", () => {
-      delete process.env.DEBUG_SNIPPETS;
-      const writeSpy = vi.spyOn(require("fs"), "writeFileSync");
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.debug("test message", { key: "value" });
-      expect(writeSpy).not.toHaveBeenCalled();
-    });
-
-    it("should write logs when debug is enabled", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.debug("test debug message", { test: true });
-      logger.info("test info message");
-      logger.warn("test warn message");
-      logger.error("test error message");
-    });
-
-    it("should format data correctly", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.debug("with data", {
-        string: "hello",
-        number: 42,
-        bool: true,
-        nullVal: null,
-        undefinedVal: undefined,
-      });
-    });
-
-    it("should handle empty data", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.debug("no data");
-      logger.debug("empty object", {});
-      logger.debug("empty array", { items: [] as unknown[] });
-    });
-
-    it("should format arrays compactly", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.debug("small array", { items: [1, 2, 3] });
-      logger.debug("large array", { items: [1, 2, 3, 4, 5, 6] });
-    });
-
-    it("should handle objects in data", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.debug("nested object", {
-        nested: { a: 1, b: 2 },
-        long: "this is a very long string that should be truncated if over 50 characters",
-      });
-    });
-  });
-
-  describe("file output", () => {
-    it("should create log file in daily directory", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.info("file output test", { test: true });
-
-      const today = new Date().toISOString().split("T")[0];
-      const logFile = join(tempDir, "logs", "daily", `${today}.log`);
-
-      expect(existsSync(logFile)).toBe(true);
-      const content = readFileSync(logFile, "utf-8");
-      expect(content).toContain("file output test");
-      expect(content).toContain("test=true");
-    });
-
-    it("should append to existing log file", () => {
-      process.env.DEBUG_SNIPPETS = "1";
-      const logger = new Logger(join(tempDir, "logs"));
-      logger.info("first message");
-      logger.info("second message");
-
-      const today = new Date().toISOString().split("T")[0];
-      const logFile = join(tempDir, "logs", "daily", `${today}.log`);
-      const content = readFileSync(logFile, "utf-8");
-
-      expect(content).toContain("first message");
-      expect(content).toContain("second message");
-    });
-  });
-});

package/src/logger.ts

@@ -1,121 +0,0 @@
-import { existsSync, mkdirSync, writeFileSync } from "fs";
-import { join } from "path";
-import { PATHS } from "./constants.js";
-
-/**
- * Check if debug logging is enabled via environment variable
- */
-function isDebugEnabled(): boolean {
-  const value = process.env.DEBUG_SNIPPETS;
-  return value === "1" || value === "true";
-}
-
-export class Logger {
-  private logDir: string;
-
-  constructor(logDirOverride?: string) {
-    this.logDir = logDirOverride ?? join(PATHS.CONFIG_DIR, "logs", "snippets");
-  }
-
-  get enabled(): boolean {
-    return isDebugEnabled();
-  }
-
-  private ensureLogDir() {
-    if (!existsSync(this.logDir)) {
-      mkdirSync(this.logDir, { recursive: true });
-    }
-  }
-
-  private formatData(data?: Record<string, unknown>): string {
-    if (!data) return "";
-
-    const parts: string[] = [];
-    for (const [key, value] of Object.entries(data)) {
-      if (value === undefined || value === null) continue;
-
-      // Format arrays compactly
-      if (Array.isArray(value)) {
-        if (value.length === 0) continue;
-        parts.push(
-          `${key}=[${value.slice(0, 3).join(",")}${value.length > 3 ? `...+${value.length - 3}` : ""}]`,
-        );
-      } else if (typeof value === "object") {
-        const str = JSON.stringify(value);
-        if (str.length < 50) {
-          parts.push(`${key}=${str}`);
-        }
-      } else {
-        parts.push(`${key}=${value}`);
-      }
-    }
-    return parts.join(" ");
-  }
-
-  private getCallerFile(): string {
-    const originalPrepareStackTrace = Error.prepareStackTrace;
-    try {
-      const err = new Error();
-      Error.prepareStackTrace = (_, stack) => stack;
-      const stack = err.stack as unknown as NodeJS.CallSite[];
-      Error.prepareStackTrace = originalPrepareStackTrace;
-
-      for (let i = 3; i < stack.length; i++) {
-        const filename = stack[i]?.getFileName();
-        if (filename && !filename.includes("logger.")) {
-          const match = filename.match(/([^/\\]+)\.[tj]s$/);
-          return match ? match[1] : "unknown";
-        }
-      }
-      return "unknown";
-    } catch {
-      return "unknown";
-    }
-  }
-
-  private write(level: string, component: string, message: string, data?: Record<string, unknown>) {
-    if (!this.enabled) return;
-
-    try {
-      this.ensureLogDir();
-
-      const timestamp = new Date().toISOString();
-      const dataStr = this.formatData(data);
-
-      const dailyLogDir = join(this.logDir, "daily");
-      if (!existsSync(dailyLogDir)) {
-        mkdirSync(dailyLogDir, { recursive: true });
-      }
-
-      const logLine = `${timestamp} ${level.padEnd(5)} ${component}: ${message}${dataStr ? ` | ${dataStr}` : ""}\n`;
-
-      const logFile = join(dailyLogDir, `${new Date().toISOString().split("T")[0]}.log`);
-      writeFileSync(logFile, logLine, { flag: "a" });
-    } catch {
-      // Silent fail
-    }
-  }
-
-  info(message: string, data?: Record<string, unknown>) {
-    const component = this.getCallerFile();
-    this.write("INFO", component, message, data);
-  }
-
-  debug(message: string, data?: Record<string, unknown>) {
-    const component = this.getCallerFile();
-    this.write("DEBUG", component, message, data);
-  }
-
-  warn(message: string, data?: Record<string, unknown>) {
-    const component = this.getCallerFile();
-    this.write("WARN", component, message, data);
-  }
-
-  error(message: string, data?: Record<string, unknown>) {
-    const component = this.getCallerFile();
-    this.write("ERROR", component, message, data);
-  }
-}
-
-// Export singleton logger instance
-export const logger = new Logger();

package/src/notification.ts

@@ -1,30 +0,0 @@
-import { logger } from "./logger.js";
-import type { OpencodeClient } from "./types.js";
-
-/**
- * Sends a message that will be displayed but ignored by the AI
- * Used for command output that shouldn't trigger AI responses
- *
- * @param client - The OpenCode client instance
- * @param sessionId - The current session ID
- * @param text - The text to display
- */
-export async function sendIgnoredMessage(
-  client: OpencodeClient,
-  sessionId: string,
-  text: string,
-): Promise<void> {
-  try {
-    await client.session.prompt({
-      path: { id: sessionId },
-      body: {
-        noReply: true,
-        parts: [{ type: "text", text, ignored: true }],
-      },
-    });
-  } catch (error) {
-    logger.error("Failed to send ignored message", {
-      error: error instanceof Error ? error.message : String(error),
-    });
-  }
-}

package/src/shell.ts

@@ -1,50 +0,0 @@
-import { PATTERNS } from "./constants.js";
-import { logger } from "./logger.js";
-
-/**
- * Executes shell commands in text using !`command` syntax
- *
- * @param text - The text containing shell commands to execute
- * @param ctx - The plugin context (with Bun shell)
- * @returns The text with shell commands replaced by their output
- */
-export type ShellContext = {
-  $: (
-    template: TemplateStringsArray,
-    ...args: unknown[]
-  ) => {
-    quiet: () => { nothrow: () => { text: () => Promise<string> } };
-  };
-};
-
-export async function executeShellCommands(text: string, ctx: ShellContext): Promise<string> {
-  let result = text;
-
-  // Reset regex state (global flag requires this)
-  PATTERNS.SHELL_COMMAND.lastIndex = 0;
-
-  // Find all shell command matches
-  const matches = [...text.matchAll(PATTERNS.SHELL_COMMAND)];
-
-  // Execute each command and replace in text
-  for (const match of matches) {
-    const cmd = match[1];
-    const _placeholder = match[0];
-
-    try {
-      const output = await ctx.$`${{ raw: cmd }}`.quiet().nothrow().text();
-      // Deviate from slash commands' substitution mechanism: print command first, then output
-      const replacement = `$ ${cmd}\n--> ${output.trim()}`;
-      result = result.replace(_placeholder, replacement);
-    } catch (error) {
-      // If shell command fails, leave it as-is
-      // This preserves the original syntax for debugging
-      logger.warn("Shell command execution failed", {
-        command: cmd,
-        error: error instanceof Error ? error.message : String(error),
-      });
-    }
-  }
-
-  return result;
-}

package/src/types.ts

@@ -1,71 +0,0 @@
-import type { createOpencodeClient } from "@opencode-ai/sdk";
-
-/**
- * OpenCode client type from the SDK
- */
-export type OpencodeClient = ReturnType<typeof createOpencodeClient>;
-
-/**
- * A snippet with its content and metadata
- */
-export interface Snippet {
-  /** The primary name/key of the snippet */
-  name: string;
-  /** The content of the snippet (without frontmatter) */
-  content: string;
-  /** Alternative names that also trigger this snippet */
-  aliases: string[];
-}
-
-/**
- * Extended snippet info with file metadata
- */
-export interface SnippetInfo {
-  name: string;
-  content: string;
-  aliases: string[];
-  description?: string;
-  filePath: string;
-  source: "global" | "project";
-}
-
-/**
- * Snippet registry that maps keys to snippet info
- */
-export type SnippetRegistry = Map<string, SnippetInfo>;
-
-/**
- * Frontmatter data from snippet files
- */
-export interface SnippetFrontmatter {
-  /** Alternative hashtags for this snippet (plural form, preferred) */
-  aliases?: string | string[];
-  /** Alternative hashtags for this snippet (singular form, also accepted) */
-  alias?: string | string[];
-  /** Optional description of what this snippet does */
-  description?: string;
-}
-
-/**
- * Parsed snippet content with inline text and prepend/append blocks
- */
-export interface ParsedSnippetContent {
-  /** Content outside blocks (replaces hashtag inline) */
-  inline: string;
-  /** <prepend> block contents in document order */
-  prepend: string[];
-  /** <append> block contents in document order */
-  append: string[];
-}
-
-/**
- * Result of expanding hashtags, including collected prepend/append blocks
- */
-export interface ExpansionResult {
-  /** The inline-expanded text */
-  text: string;
-  /** Collected prepend blocks from all expanded snippets */
-  prepend: string[];
-  /** Collected append blocks from all expanded snippets */
-  append: string[];
-}