Skip to content

Commit 52530e5

Browse files
koki-developclaude
andcommitted
docs: Enhance CLAUDE.md with improved project documentation
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 5953b26 commit 52530e5

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

CLAUDE.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1515
- **Test cat**: `bun test src/lib/cat.spec.ts` - Run cat vocabulary and emotion detection tests
1616
- **Development**: `bun run src/index.tsx` - Run the app directly without building
1717
- **Install globally**: `bun link` - Install as global `cat-code` command for testing
18+
- **Pre-commit hooks**: Automatically runs linting and formatting via Husky
1819

1920
## Project Architecture
2021

@@ -33,6 +34,8 @@ This is a terminal-based chat UI CLI tool that simulates a conversation with a c
3334
- `cat.ts`: Cat class with emotion-based response generation and vocabulary system
3435
- `util.ts`: Reusable utility functions (e.g., indent for text formatting)
3536
- **Build System** (`scripts/build.ts`): Custom Bun build script that creates executable CLI binary
37+
- **File Editor System** (`src/lib/fileEditor.ts`): Handles random file editing with cat sounds
38+
- **Git Integration** (`src/lib/git.ts`): Manages git repository detection and file tracking
3639

3740
### Technology Stack
3841
- **Runtime**: Bun (primary development runtime)
@@ -42,6 +45,9 @@ This is a terminal-based chat UI CLI tool that simulates a conversation with a c
4245
- **Build Tool**: Custom Bun build script that creates executable CLI binary
4346
- **Linting/Formatting**: Biome (replaces ESLint + Prettier)
4447
- **Package Manager**: Bun with lockfile management
48+
- **Git Operations**: simple-git for repository interactions
49+
- **File Pattern Matching**: glob for non-git file discovery
50+
- **Terminal Styling**: chalk for ANSI color support
4551

4652
### InputField Keybindings
4753
The custom InputField component supports comprehensive terminal-style keybindings:
@@ -160,4 +166,11 @@ The application supports a `--safe` flag that prevents actual file modifications
160166
### Implementation Details
161167
- **Constructor Pattern**: Cat and FileEditor classes use config object parameters instead of boolean flags
162168
- **State Propagation**: Safe mode state flows through component hierarchy via props
163-
- **File Cleanup**: Temporary files are properly cleaned up in safe mode using `unlink()`
169+
- **File Cleanup**: Temporary files are properly cleaned up in safe mode using `unlink()`
170+
171+
## Testing Strategy
172+
173+
- **Test Framework**: Bun's built-in test runner with `.spec.ts` file naming
174+
- **Current Test Coverage**: Utility functions in `src/lib/util.spec.ts`
175+
- **Test Location**: Test files are co-located with source files
176+
- **Run Options**: Single file testing supported with `bun test [file-path]`

0 commit comments

Comments
 (0)