typst-count 0.1.0

Count words and characters in Typst documents
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

# Examples

This directory contains example Typst documents for testing and demonstrating typst-count functionality.

## Files

### simple.typ
A basic Typst document with common formatting elements:
- Headings
- Body text
- Lists (bulleted and numbered)
- Bold and italic text
- Multiple sections

Expected count: approximately 80-90 words

Usage:
```bash
typst-count examples/simple.typ
```

### with_imports.typ
A main document that imports and includes content from other files. This demonstrates how typst-count handles multi-file projects.

Related files:
- `shared.typ` - Shared functions and definitions
- `chapter1.typ` - First chapter content
- `chapter2.typ` - Second chapter content

Expected count (with imports): approximately 450-500 words
Expected count (without imports): approximately 30-40 words

Usage:
```bash
# Count all content (default)
typst-count examples/with_imports.typ

# Count only the main file
typst-count examples/with_imports.typ --exclude-imports
```

### shared.typ
Contains reusable function definitions and variables. This file is imported by `with_imports.typ` but contains minimal text content (only comments and function definitions).

### chapter1.typ
A standalone chapter about Typst basics. Can be compiled independently or included in other documents.

Expected count: approximately 150-170 words

### chapter2.typ
A standalone chapter about advanced Typst features. Can be compiled independently or included in other documents.

Expected count: approximately 250-270 words

## Testing Different Scenarios

### Basic counting
```bash
typst-count examples/simple.typ
```

### Multiple files
```bash
typst-count examples/simple.typ examples/chapter1.typ examples/chapter2.typ
```

### JSON output
```bash
typst-count examples/simple.typ --format json
```

### CSV output
```bash
typst-count examples/*.typ --format csv --output counts.csv
```

### Exclude imports
```bash
typst-count examples/with_imports.typ --exclude-imports
```

### Word count only
```bash
typst-count examples/simple.typ --words
```

### Character count only
```bash
typst-count examples/simple.typ --characters
```

### Limit checking
```bash
# Should succeed
typst-count examples/simple.typ --min-words 50 --max-words 150

# Should fail (word count too low)
typst-count examples/simple.typ --min-words 200
```

## Creating Your Own Examples

When creating test documents:
1. Use realistic content that demonstrates typical use cases
2. Include various Typst features (headings, lists, emphasis, etc.)
3. Document the expected word/character counts
4. Test both simple and complex scenarios (imports, includes, etc.)
5. Keep examples focused and not too large