Writing Plugins

import { definePlugin } from "@the-brain/core";

export default definePlugin({
  name: "my-plugin",
  version: "0.1.0",
  description: "Does something useful",
  setup(hooks) {
    hooks.hook("BEFORE_PROMPT", async (ctx) => {
      ctx.inject("Always use TypeScript strict mode.");
    });
  },
});

packages/plugin-<name>/
├── package.json
├── src/
│   ├── index.ts
│   └── __tests__/
├── CHANGELOG.md
└── README.md

import { definePlugin, HookEvent } from "@the-brain/core";

export default definePlugin({
  name: "coding-standards",
  setup(hooks) {
    const standards = `Prefer functional components.
Use async/await over .then().`;

    hooks.hook(HookEvent.BEFORE_PROMPT, async (ctx) => {
      ctx.inject(standards);
    });
  },
});

import { describe, test, expect } from "bun:test";
import { createHookSystem, HookEvent } from "@the-brain/core";
import myPlugin from "../index";

describe("my-plugin", () => {
  test("injects context on BEFORE_PROMPT", async () => {
    const hooks = createHookSystem();
    await myPlugin.setup(hooks);

    const ctx = { prompt: "hello", injected: [],
      inject(s: string) { this.injected.push(s); } };
    await hooks.callHook(HookEvent.BEFORE_PROMPT, ctx);

    expect(ctx.injected.length).toBeGreaterThan(0);
  });
});

{
  "name": "@the-brain/plugin-<name>",
  "version": "0.1.0",
  "type": "module",
  "main": "./src/index.ts",
  "dependencies": {
    "@the-brain/core": "workspace:*"
  }
}