コンテンツにスキップ
TomoriBot

Development Tasks

このコンテンツはまだ日本語訳がありません。

Quick navigation for common TomoriBot implementation tasks and coding conventions.

Task Index

Section titled “Task Index”

Each guide below is self-contained with steps, notes, and a quality gate.

Task Guide
Add a slash command adding-slash-command.md
Add an event handler adding-event-handler.md
Add a built-in tool adding-builtin-tool.md
Add a DB column adding-db-column.md
Add a Full Install setup module adding-setup-module.md
Add a locale adding-locale.md
Add a new AI provider adding-new-provider.md
Add a feature flag-controlled tool adding-feature-flag-tool.md
Add a persona preset adding-persona-preset.md
Add or move docs pages docs-authoring.md

Development Checklist

Section titled “Development Checklist”

Run these before merging any change:

Terminal window
bun run check           # TypeScript strict mode
bun run lint            # Biome lint/format
bun run check-locales   # locale key parity (when locale keys or command metadata changed)
bun run db:lifecycle    # schema lifecycle test (when schema.sql changed; needs local PostgreSQL)

bun run db:lifecycle requires a local disposable PostgreSQL target with CREATE/DROP database permission. It creates and drops its own temporary database, then tests fresh initialization plus backup/restore and DB maintenance scripts.

Coding Conventions

Section titled “Coding Conventions”

These rules apply to all TomoriBot source code regardless of task type.

Formatting and Style

Section titled “Formatting and Style”
  • Use 2 spaces for indentation (Biome project setting).
  • Use double quotes for strings.
  • Run bun run lint after edits.

TypeScript and Validation

Section titled “TypeScript and Validation”
  • Keep TypeScript strict; avoid any.
  • Prefer explicit shared types under src/types/.
  • Use Zod/runtime validation for untrusted external input.
  • Add concise JSDoc for exported/public functions when behavior is non-obvious.

File Organization and Imports

Section titled “File Organization and Imports”
  • Use camelCase file names.
  • Use @/* path aliases for src/* imports.
  • Use node: protocol for Node built-ins (node:path, node:fs, etc.).

Configuration and Magic Numbers

Section titled “Configuration and Magic Numbers”
  • Do not hardcode operational limits/timeouts/thresholds in feature logic.
  • Use env vars with fallback defaults:
const VALUE = Number.parseInt(process.env.CONFIG_VAR || "10", 10);
  • Add required setup vars to .env.example and optional/tuning vars to .env.optional.example, each with a clear comment.

Database and Migrations

Section titled “Database and Migrations”

Cache-Safe Write Pattern

Section titled “Cache-Safe Write Pattern”

When a write affects cached reads:

  1. Perform the DB write successfully.
  2. Then invalidate affected cache key(s).

Do not invalidate before failed writes, and do not manually mutate cached objects. See docs/architecture/subsystems/caching.md for the cache map and invalidation APIs.

Logging and Error Handling

Section titled “Logging and Error Handling”
  • Use log from src/utils/misc/logger.ts.
  • Include useful context metadata (errorType, IDs, action context).
  • Treat startup-critical failures differently from recoverable runtime failures.

Discord Command Rules

Section titled “Discord Command Rules”