opencode-froggy AGENTS.md

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 Node.js 18+.
• Install dependencies with:
  • npm install

Build, typecheck, lint, test

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

• Build:
  • npm run build
• Typecheck (strict):
  • npm run typecheck
• Tests (all):
  • npm test
• Test watch (local dev):
  • npx vitest

Run a single test file

Vitest is configured via vitest.config.ts and runs src/**/*.test.ts.

Use any of the following:

• npm test -- src/index.test.ts
• npx vitest run src/index.test.ts

Run a single test by name

• npm test -- -t "should parse valid frontmatter"
• npx vitest run -t "should parse valid frontmatter"

Run a single test file and name

• npx vitest run src/index.test.ts -t "should parse valid frontmatter"

Optional quick checks

• Typecheck only:
  • npm run typecheck
• Build only:
  • npm 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 Node.js ESM imports, with node: specifiers for core modules:
  • 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