Skip to content

CLAUDE.md

Latest commit

 

History

History
27 lines (17 loc) · 1.45 KB

CLAUDE.md

File metadata and controls

27 lines (17 loc) · 1.45 KB

Claude Code Guidelines

About

A fully typed error handling library for TypeScript inspired by Rust's Result type and neverthrow. It provides type-safe ok/err Result types with automatic type narrowing, railway-oriented programming via map, andThen, and orElse chaining, plus utilities for combining results, traversing arrays, parallel/sequential async operations, and converting between exceptions and Result types. Zero dependencies.

Linting

  • Use pickier for linting — never use eslint directly
  • Run bunx --bun pickier . to lint, bunx --bun pickier . --fix to auto-fix
  • When fixing unused variable warnings, prefer // eslint-disable-next-line comments over prefixing with _

Frontend

  • Use stx for templating — never write vanilla JS (var, document.*, window.*) in stx templates
  • Use crosswind as the default CSS framework which enables standard Tailwind-like utility classes
  • stx <script> tags should only contain stx-compatible code (signals, composables, directives)

Dependencies

  • buddy-bot handles dependency updates — not renovatebot
  • better-dx provides shared dev tooling as peer dependencies — do not install its peers (e.g., typescript, pickier, bun-plugin-dtsx) separately if better-dx is already in package.json
  • If better-dx is in package.json, ensure bunfig.toml includes linker = "hoisted"

Commits

  • Use conventional commit messages (e.g., fix:, feat:, chore:)