codebank 0.4.5

A powerful code documentation generator that creates structured markdown documentation from your codebase. Supports multiple languages including Rust, Python, TypeScript, C, and Go with intelligent parsing and formatting. Features test code filtering, summary generation, and customizable documentation strategies.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# CODE BANK TASKS

## High Priority Tasks

### Task 1: Implement Rust Parser
**Description**: Complete the implementation of the Rust parser using tree-sitter-rust.
**Status**: In Progress
**Subtasks**:
- [x] Set up tree-sitter-rust grammar integration
- [x] Create basic AST traversal mechanism
- [x] Implement function parsing
- [x] Implement module parsing
- [x] Implement struct/enum parsing
- [x] Improve documentation extraction
- [x] Support module structure and imports

### Task 2: Implement Bank Trait
**Description**: Implement the Bank trait for code generation.
**Status**: Not Started
**Subtasks**:
- [ ] Create directory traversal using walkdir
- [ ] Implement file extension detection
- [ ] Route files to appropriate language parsers
- [ ] Format output according to BankStrategy
- [ ] Write markdown with proper formatting

### Task 3: Implement Command Line Interface
**Description**: Build the CLI interface using clap.
**Status**: Not Started
**Subtasks**:
- [ ] Define command-line arguments with clap
- [ ] Add input validation and error reporting
- [ ] Support different output formats
- [ ] Add help text and examples
- [ ] Implement proper error handling for user input

## Medium Priority Tasks

### Task 4: Implement Python Parser
**Description**: Complete the implementation of the Python parser using tree-sitter-python.
**Status**: Not Started
**Subtasks**:
- [ ] Set up tree-sitter-python grammar integration
- [ ] Create query patterns for Python syntax elements
- [ ] Implement AST traversal for nested structures
- [ ] Extract public interfaces
- [ ] Handle documentation comments
- [ ] Support module structure and imports

### Task 5: Implement TypeScript Parser
**Description**: Complete the implementation of the TypeScript parser using tree-sitter-typescript.
**Status**: Not Started
**Subtasks**:
- [ ] Set up tree-sitter-typescript grammar integration
- [ ] Create query patterns for TypeScript syntax elements
- [ ] Implement AST traversal for nested structures
- [ ] Extract public interfaces
- [ ] Handle documentation comments
- [ ] Support module structure and imports

### Task 6: Implement C Parser
**Description**: Complete the implementation of the C parser using tree-sitter-c.
**Status**: Not Started
**Subtasks**:
- [ ] Set up tree-sitter-c grammar integration
- [ ] Create query patterns for C syntax elements
- [ ] Implement AST traversal for nested structures
- [ ] Extract public interfaces
- [ ] Handle documentation comments
- [ ] Support header files and includes

## Low Priority Tasks

### Task 7: Add Configuration Options
**Description**: Add configuration options for customizing output.
**Status**: Not Started
**Subtasks**:
- [ ] Design configuration format (TOML/YAML)
- [ ] Add file exclusion patterns
- [ ] Support custom templates for output
- [ ] Add verbosity levels
- [ ] Implement configuration file loading

### Task 8: Write Examples
**Description**: Create example code and documentation.
**Status**: Not Started
**Subtasks**:
- [ ] Create example Rust project
- [ ] Create example Python project
- [ ] Create example TypeScript project
- [ ] Create example C project
- [ ] Document usage scenarios with example commands

### Task 9: Write Tests
**Description**: Write comprehensive tests for all components.
**Status**: In Progress
**Subtasks**:
- [x] Write unit test for Rust parser
- [ ] Write unit tests for parser infrastructure
- [ ] Write integration tests for each language parser
- [ ] Write end-to-end tests for CLI
- [ ] Set up CI for automated testing
- [ ] Create test fixtures for parsing scenarios