Skip to content

CLAUDE.md

Latest commit

 

History

History
87 lines (63 loc) · 3.07 KB

CLAUDE.md

File metadata and controls

87 lines (63 loc) · 3.07 KB

Claude Code Instructions for numberstring

Project Context

This is a lightweight JavaScript library for converting numbers to English words. It's designed to be simple, fast, and have zero dependencies.

Development Commands

npm install        # Install dev dependencies
npm test           # Run Vitest tests
npm run lint       # Run ESLint
npm run test:coverage  # Run tests with coverage report

Code Style

  • ES2022+ syntax (const/let, arrow functions, template literals)
  • ESM modules only (import/export)
  • Full JSDoc documentation
  • 100% test coverage target

Architecture

The library uses a mathematical approach to break numbers into groups of three digits (ones, thousands, millions, etc.) and converts each group to words.

Key constants:

  • ONES - Words for 1-9
  • TEENS - Words for 10-19
  • TENS - Words for 20, 30, 40, etc.
  • ILLIONS - Scale words (thousand, million, billion, trillion, quadrillion, etc.)

When Making Changes

  1. ALWAYS run lint and tests before committing: npm run lint && npm test
  2. Maintain 100% coverage: npm run test:coverage
  3. Update CHANGELOG.md for any user-facing changes
  4. Preserve the fun flair (ASCII art header, tagline)

PR Review Workflow

  • Always check GitHub PR comments before continuing work
  • Review feedback from Codex, human reviewers, and CI systems
  • Fix valid issues before pushing new commits
  • Use gh pr view <number> --comments to fetch PR comments

Supported Languages

  • English (default)
  • Spanish (es, spanish, español)
  • French (fr, french, français)
  • German (de, german, deutsch)
  • Danish (da, danish, dansk)
  • Chinese (zh, chinese, 中文)
  • Hindi (hi, hindi, हिन्दी)
  • Russian (ru, russian, русский)
  • Portuguese (pt, portuguese, português)

Features

  • Number to words (cardinal)
  • Ordinals (1st, 2nd, 3rd)
  • Decimals (3.14 → "three point one four")
  • Currency ($1.23 → "one dollar and twenty-three cents")
  • Fractions (1/2 → "one half")
  • Roman numerals (42 → "XLII")
  • Negative numbers
  • BigInt support up to 10^36

Working Style

Think First, Code Second

For anything non-trivial, plan the approach before writing code. Identify which files change, what the edge cases are, and how to verify it works. A solid plan means fewer iterations and cleaner implementations.

Own the Problem

When something's broken - CI failing, bug reported, error in logs - just go fix it. Read the error, trace the cause, implement the fix. Don't wait for instructions on each step.

Verify, Don't Assume

After making changes, prove they work. Run the tests. Check the output. If asked to review code, be genuinely critical - find the issues, don't just approve.

When Stuck or Wrong

If a solution feels hacky, stop. Rethink from scratch using what you learned. If corrected on a mistake, suggest a CLAUDE.md update to prevent it happening again - be specific about what to avoid.

Stay Focused

Use subagents for research, exploration, or isolated subtasks. Keep the main conversation for coordinating and making decisions.