firefly: Instructions file for GitHub Copilot

Development Instructions

Firefly

Firefly is a CLI orchestrator for automatic semantic versioning, git-cliff changelog generation, and creating release all in one command.

1. Technology Stack

• Runtime: Bun for execution and package management.
• Validation: Zod for runtime validation and compile-time type inference.

2. Coding Standards

• YAGNI Principle: Start simple and add complexity only when you have concrete requirements for it.
• Defensive Programming: Validate all inputs/outputs at boundaries; treat external data as potentially invalid.
• Readable & Intentional: Code should convey why it exists; avoid redundant comments on how it works.
• Extract Complex Expressions: Break down complex expressions into well-named intermediate variables or functions/classes.

3. Coding Patterns

• Locality of Behavior: Keep related logic close together.
• Inward Dependency Flow: Outer layers depend on inner layers, never the reverse.
• Explicit Interfaces: Define clear contracts between layers and modules.
• Performance: Optimize by default and avoid common pitfalls; favor clarity over premature micro-optimizations.

4. Result & Error Handling

• Rust-Style Semantics: Use neverthrow for explicit success/error handling.
• No exceptions: EXPLICITLY DO NOT USE ANY try/catch OR throw STATEMENTS.
• Explicit Unpacking: Use isOk() / isErr() guards for clarity and control flow.
• Shallow Method Chains: Limit chaining to two links; use named variables for intermediate results.

Types

• FireflyResult<T>

  • A synchronous Result<T, FireflyError>.

• FireflyAsyncResult<T>

  • An asynchronous ResultAsync<T, FireflyError> — behaves like Promise<Result<T, FireflyError>>.
  • Do not wrap it in Promise.
  • Do not mark a function returning FireflyAsyncResult<T> as async.

• Promise<FireflyResult<T>>

  • Use only when you need to await inside the function body (e.g., to unwrap a FireflyAsyncResult).
  • This is the correct type for functions that internally await other async operations and then return a FireflyResult.