opencode-froggy: Instructions file for Codex

AGENTS.md

This repository is an OpenCode plugin written in TypeScript. The guidance below is for agentic coding tools that will modify or run code here.

Scope and structure

• Source code lives in src/.
• Tests live alongside sources in src/**/*.test.ts.
• Build output goes to dist/.
• Hooks configuration lives in hook/hooks.md (YAML frontmatter).
• Agents, commands, and skills are loaded from agent/, command/, and skill/.
• Skills are discovered by skill/<name>/SKILL.md.

Setup

• Requires Bun 1.3+.
• Install dependencies with:
  • bun install

Build, typecheck, lint, test

There is no dedicated lint script or ESLint config. Use typecheck as the closest linting step.

• Build:
  • bun run build
• Typecheck (strict):
  • bun run typecheck
• Tests (all):
  • bun test
• Test coverage:
  • bun run test:coverage
• Test watch (local dev):
  • bun test --watch

Run a single test file

Bun is configured via bunfig.toml and runs src/**/*.test.ts.

Use any of the following:

• bun test src/index.test.ts
• bun test src/index.test.ts --watch

Run a single test by name

• bun test -t "should parse valid frontmatter"

Run a single test file and name

• bun test src/index.test.ts -t "should parse valid frontmatter"

Optional quick checks

• Typecheck only:
  • bun run typecheck
• Build only:
  • bun run build

Code style and conventions

TypeScript

• Use TypeScript (ES module syntax) and keep strict type safety.
• Avoid any. Prefer explicit types or narrow types with guards.
• Prefer unknown for untrusted data, then validate or narrow.
• Prefer Record<string, unknown> over loose object types.
• Use type-only imports for types (import { type Foo } ...).

Imports

• Use ESM imports, with node: specifiers for core modules (Bun implements them):
  • import { join } from "node:path"
• Prefer named imports; avoid default imports when not required.
• Keep imports grouped and ordered:
  1. Node core modules
  2. External dependencies
  3. Local modules