rnk 0.3.0

A React-like declarative terminal UI framework for Rust, inspired by Ink
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
104
105
106
107
108
109
110
111
112
113
114
115

# Tink - Terminal Ink for Rust

A terminal UI framework inspired by [ink](https://github.com/vadimdemedes/ink).

## Development Guidelines

### Code Quality Commands

```bash
# Quick validation (before every commit)
cargo fmt && cargo clippy && cargo test --lib

# Full validation
cargo test --all-targets

# Property tests (finds edge cases)
cargo test --test property_tests

# Run a specific example
cargo run --example interactive_demo
```

### Module Testing

```bash
# Layout module
cargo test layout::

# Renderer module
cargo test renderer::

# Hooks module
cargo test hooks::

# Components module
cargo test components::

# Testing utilities
cargo test testing::
```

### Key Invariants

1. **Unicode Width**: Layout and render must use same width calculation
   - ASCII = 1 cell, CJK = 2 cells, Box-drawing = 1 cell
   - Test: `cargo test testing::generators::tests::test_unicode_width_cases`

2. **Layout Bounds**: All coordinates and dimensions non-negative
   - Test: `cargo test testing::renderer::tests::test_layout_validation`

3. **Style Isolation**: Styles must not leak between elements
   - Every styled span ends with reset code

4. **Hook State Persistence**: Signal values persist across renders
   - Test: `cargo test hooks::use_signal::tests`

### Common Bug Patterns

| Bug | Symptom | Check |
|-----|---------|-------|
| Unicode width mismatch | Text misaligned | `output.rs:write()` uses `char.width()` |
| Style leakage | Wrong colors | Reset codes in `render()` |
| Child position error | Overlapping elements | `render_element()` offset calculation |
| Hook state loss | Values reset | `HookContext` hook ordering |

### Skills (Claude Code)

Located in `.claude/skills/`:

- **tink-layout-validator.md** - Validate layout calculations
- **tink-render-validator.md** - Validate rendering output
- **tink-hooks-validator.md** - Validate hooks system
- **tink-component-validator.md** - Validate components
- **tink-full-validation.md** - Complete pre-commit validation

### Architecture

```
src/
├── core/           # Element, Style, Color
├── components/     # Box, Text, Spacer, Transform, Static
├── hooks/          # use_signal, use_effect, use_input, use_focus, ...
├── layout/         # LayoutEngine (Taffy), text measurement
├── renderer/       # App runner, Terminal, Output buffer
└── testing/        # TestRenderer, assertions, golden tests, generators
```

### Testing Infrastructure

```rust
use tink::testing::{TestRenderer, assert_layout_valid, GoldenTest};

// Layout validation
let renderer = TestRenderer::new(80, 24);
renderer.validate_layout(&element).expect("valid");

// Golden file testing
GoldenTest::new("my_component").assert_match(&element);

// Assertions
element.assert_renders_containing("expected text");
element.assert_layout_valid();
```

### CI

GitHub Actions runs on every push/PR:
1. Format check
2. Clippy
3. Library tests
4. Doc tests
5. Property tests
6. Integration tests
7. Cross-platform (Linux, macOS, Windows)
8. Code coverage