code-digest 0.5.0

High-performance CLI tool to convert codebases to Markdown for LLM context
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# Code Digest Examples

This directory contains example projects and configuration files to demonstrate the capabilities of `code-digest`.

## Directory Structure

```
examples/
├── sample-rust-project/    # Pure Rust project example
├── sample-mixed-project/   # Mixed-language project (JS, Python)
├── config-examples/        # Configuration file examples
└── README.md              # This file
```

## Sample Projects

### sample-rust-project

A minimal Rust project demonstrating:
- Basic Cargo project structure
- Source files with documentation
- Test modules
- Dependencies

### sample-mixed-project

A mixed-language project showing:
- Node.js/Express backend
- Python utility scripts
- JavaScript tests
- Multiple file types and structures
- Custom `.digestignore` and `.digestkeep` files

## Configuration Examples

### minimal.toml

Shows the bare minimum configuration needed:
- Token limit setting
- Single priority rule

### comprehensive.toml

Demonstrates all available configuration options:
- Detailed priority weights
- Custom ignore patterns
- Output formatting options
- Performance tuning
- Logging configuration

## Testing the Tool

You can test `code-digest` with these examples:

```bash
# Process the Rust project
code-digest -d examples/sample-rust-project

# Process with token limit
code-digest -d examples/sample-mixed-project --max-tokens 10000

# Use custom configuration
code-digest -d examples/sample-mixed-project -c examples/config-examples/comprehensive.toml

# Save output to file
code-digest -d examples/sample-rust-project -o rust-project.md
```

## Creating Your Own Examples

To add new examples:

1. Create a new directory under `examples/`
2. Add relevant source files
3. Include `.digestignore` for exclusions
4. Include `.digestkeep` for priorities
5. Add a README explaining the example

## Tips for Testing

1. **Token Limits**: Test with various `--max-tokens` values to see prioritization in action
2. **File Types**: Include diverse file extensions to test language detection
3. **Large Files**: Add some larger files to test performance and chunking
4. **Binary Files**: Include some binary files to test detection and skipping
5. **Symbolic Links**: Create symlinks to test handling (if supported by your OS)