Skip to content

Commit 16d4679

Browse files
committed
fix: add fragment_count to YAML diff output and improve README accuracy
1 parent 6e9e79e commit 16d4679

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ children:
3838
## Usage
3939
4040
```bash
41+
treemapper # current dir, YAML to stdout
4142
treemapper . # YAML to stdout + token count
4243
treemapper . -o tree.yaml # save to file
4344
treemapper . -o # save to tree.yaml (default)
@@ -47,12 +48,12 @@ treemapper . -f txt # plain text with indentation
4748
treemapper . -f md # Markdown with fenced code
4849
treemapper . -f yml # YAML (alias)
4950
treemapper . --no-content # structure only
50-
treemapper . --max-depth 3 # limit directory depth
51-
treemapper . --max-file-bytes 10000 # skip files > 10KB
51+
treemapper . --max-depth 3 # limit depth (0=root, 1=children)
52+
treemapper . --max-file-bytes 10000 # skip files > 10KB (default: 10 MB)
5253
treemapper . --max-file-bytes 0 # no limit
5354
treemapper . -i custom.ignore # custom ignore patterns
54-
treemapper . --no-default-ignores # disable default ignores
55-
treemapper . --log-level info # log level
55+
treemapper . --no-default-ignores # disable .gitignore + defaults
56+
treemapper . --log-level info # log level (default: error)
5657
treemapper . -c # copy to clipboard
5758
treemapper . -c -o tree.yaml # clipboard + save to file
5859
treemapper -v # show version
@@ -66,7 +67,7 @@ minimal set of code fragments needed to understand a change:
6667
```bash
6768
treemapper . --diff HEAD~1..HEAD # recent changes
6869
treemapper . --diff main..feature # feature branch
69-
treemapper . --diff HEAD~1 --budget 30000 # limit tokens
70+
treemapper . --diff HEAD~1 --budget 30000 # limit tokens (HEAD~1 = HEAD~1..HEAD)
7071
treemapper . --diff HEAD~1 --full # all changed code
7172
```
7273

@@ -156,7 +157,8 @@ md_str = to_markdown(tree)
156157
## Ignore Patterns
157158

158159
Respects `.gitignore` and `.treemapperignore` automatically.
159-
Use `--no-default-ignores` to include everything.
160+
Use `--no-default-ignores` to disable all ignore processing
161+
(`.gitignore`, `.treemapperignore`, and built-in defaults).
160162

161163
- Hierarchical: nested ignore files at each directory level
162164
- Negation patterns: `!important.log` un-ignores a file

src/treemapper/writer.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ def write_tree_yaml(file: TextIO, tree: dict[str, Any]) -> None:
115115
file.write(f"type: {tree['type']}\n")
116116

117117
if tree.get("type") == "diff_context" and tree.get("fragments"):
118+
file.write(f"fragment_count: {len(tree['fragments'])}\n")
118119
file.write("fragments:\n")
119120
for frag in tree["fragments"]:
120121
_write_yaml_fragment(file, frag, " ")

0 commit comments

Comments
 (0)