snippy 0.2.1

A command-line tool for that makes using LLMs for code generation a breeze
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
use snippy::extractor::markdown::MarkdownExtractor;
use snippy::extractor::{BlockType, Extractor};
use tracing::debug;

#[tokio::test]
async fn test_markdown_extractor_simple_filename_as_comment() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
// filename: path/to/file.rs
fn main() {
    println!("Hello, world!");
}
```
    "#;

    let expected_content = r#"fn main() {
    println!("Hello, world!");
}
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(blocks[0].filename, "path/to/file.rs", "Filename mismatch");
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch"
    );
    assert!(
        !blocks[0].content.contains("path/to/file.rs"),
        "Content should not contain the filename"
    );
    assert_eq!(blocks[0].content, expected_content);
    debug!("Test passed for MarkdownExtractor simple filename as comment.");
}

#[tokio::test]
async fn test_markdown_extractor_simple_filename_as_heading() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `path/to/file.rs`
```rust
fn main() {
    println!("Hello, world!");
}
```
    "#;

    let expected_content = r#"fn main() {
    println!("Hello, world!");
}
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(blocks[0].filename, "path/to/file.rs", "Filename mismatch");
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch"
    );
    assert!(
        !blocks[0].content.contains("path/to/file.rs"),
        "Content should not contain the filename"
    );
    assert_eq!(blocks[0].content, expected_content);

    debug!("Test passed for MarkdownExtractor simple filename as heading.");
}

#[tokio::test]
async fn test_markdown_extractor_simple_diff_block() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```diff
--- a/test.rs
+++ b/test.rs
@@ -1,3 +1,3 @@
-println!("Hello, world!");
+println!("Hello, Rust!");
```
    "#;

    let expected_content = r#"--- a/test.rs
+++ b/test.rs
@@ -1,3 +1,3 @@
-println!("Hello, world!");
+println!("Hello, Rust!");
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(blocks[0].filename, "test.rs", "Filename mismatch");
    assert_eq!(
        blocks[0].block_type,
        BlockType::UnifiedDiff,
        "Block type mismatch"
    );
    assert_eq!(blocks[0].content, expected_content);

    debug!("Test passed for MarkdownExtractor simple diff block.");
}

#[tokio::test]
async fn test_markdown_extractor_multiple_blocks() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
// filename: test1.rs
fn main() {
    println!("Hello, world 1!");
}
```

```rust
// filename: test2.rs
fn main() {
    println!("Hello, world 2!");
}
```

```diff
--- a/test.rs
+++ b/test.rs
@@ -1,3 +1,3 @@
-println!("Hello, world!");
+println!("Hello, Rust!");
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 3, "Expected 3 blocks, got {}", blocks.len());

    assert_eq!(
        blocks[0].filename, "test1.rs",
        "Filename mismatch for block 0"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch for block 0"
    );

    assert_eq!(
        blocks[1].filename, "test2.rs",
        "Filename mismatch for block 1"
    );
    assert_eq!(
        blocks[1].block_type,
        BlockType::FullContent,
        "Block type mismatch for block 1"
    );

    assert_eq!(
        blocks[2].filename, "test.rs",
        "Filename mismatch for block 2"
    );
    assert_eq!(
        blocks[2].block_type,
        BlockType::UnifiedDiff,
        "Block type mismatch for block 2"
    );

    debug!("Test passed for MarkdownExtractor multiple blocks extraction.");
}

#[tokio::test]
async fn test_markdown_extractor_no_filename() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
fn main() {
    println!("Hello, world!");
}
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 0, "Expected 0 blocks, got {}", blocks.len());

    debug!("Test passed for MarkdownExtractor no filename extraction.");
}

#[tokio::test]
async fn test_markdown_extractor_with_backticks_in_content() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
// filename: test_backticks.rs
fn main() {
    println!("Hello, world!");
    println!("This is a code block with backticks: ```code```");
}
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(blocks[0].filename, "test_backticks.rs", "Filename mismatch");
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch"
    );
    assert!(
        blocks[0].content.contains("```code```"),
        "Content missing '```code```'"
    );

    debug!("Test passed for MarkdownExtractor with backticks in content.");
}

#[tokio::test]
async fn test_markdown_extractor_mixed_blocks_with_backticks() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
// filename: test1.rs
fn main() {
    println!("Hello, world!");
}
```

```diff
--- a/test.rs
+++ b/test.rs
@@ -1,3 +1,3 @@
-println!("Hello, world!");
+println!("Hello, Rust!");
// Comment with backticks: ```comment```
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 2, "Expected 2 blocks, got {}", blocks.len());

    assert_eq!(
        blocks[0].filename, "test1.rs",
        "Filename mismatch for block 0"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch for block 0"
    );

    assert_eq!(
        blocks[1].filename, "test.rs",
        "Filename mismatch for block 1"
    );
    assert_eq!(
        blocks[1].block_type,
        BlockType::UnifiedDiff,
        "Block type mismatch for block 1"
    );
    assert!(
        blocks[1].content.contains("```comment```"),
        "Content missing '```comment```'"
    );

    debug!("Test passed for MarkdownExtractor mixed blocks with backticks.");
}

#[tokio::test]
async fn test_markdown_extractor_blocks_with_different_languages() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
// filename: test_rust.rs
fn main() {
    println!("Hello, Rust!");
}
```

```python
# filename: test_python.py
def main():
    print("Hello, Python!")
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 2, "Expected 2 blocks, got {}", blocks.len());

    assert_eq!(
        blocks[0].filename, "test_rust.rs",
        "Filename mismatch for block 0"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch for block 0"
    );

    assert_eq!(
        blocks[1].filename, "test_python.py",
        "Filename mismatch for block 1"
    );
    assert_eq!(
        blocks[1].block_type,
        BlockType::FullContent,
        "Block type mismatch for block 1"
    );

    debug!("Test passed for MarkdownExtractor blocks with different languages.");
}

#[tokio::test]
async fn test_markdown_extractor_non_standard_file_extensions() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```rust
// filename: test.customext
fn main() {
    println!("Hello, custom extension!");
}
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));
    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(blocks[0].filename, "test.customext", "Filename mismatch");
    assert_eq!(
        blocks[0].block_type,
        BlockType::FullContent,
        "Block type mismatch"
    );

    debug!("Test passed for MarkdownExtractor non-standard file extensions.");
}

#[tokio::test]
async fn test_search_replace_block_without_filename() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```replace
<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 0, "Expected 0 blocks, got {}", blocks.len());
    debug!("Test passed for MarkdownExtractor search-replace block without filename.");
}

#[tokio::test]
async fn test_search_replace_block_with_filename_comment() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
```replace
// filename: test_search_replace.rs
<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
```
    "#;

    let expected_content = r#"<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(
        blocks[0].filename, "test_search_replace.rs",
        "Filename mismatch"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch"
    );
    assert_eq!(blocks[0].content, expected_content);
    debug!("Test passed for MarkdownExtractor search-replace block with filename comment.");
}

#[tokio::test]
async fn test_search_replace_block_with_filename_heading() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `test_search_replace_heading.rs`
```replace
<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
```
    "#;

    let expected_content = r#"<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(
        blocks[0].filename, "test_search_replace_heading.rs",
        "Filename mismatch"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch"
    );
    assert_eq!(blocks[0].content, expected_content);
    debug!("Test passed for MarkdownExtractor search-replace block with filename heading.");
}

#[tokio::test]
async fn test_search_replace_block_with_additional_delimiters() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `test_additional_delimiters.rs`
```replace
<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
additional_code();
```
    "#;

    let expected_content = r#"<<<<<<< SEARCH
old_function();
=======
new_function();
>>>>>>> REPLACE
additional_code();
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(
        blocks[0].filename, "test_additional_delimiters.rs",
        "Filename mismatch"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch"
    );
    assert_eq!(blocks[0].content, expected_content);
    debug!("Test passed for MarkdownExtractor search-replace block with additional delimiters.");
}

#[tokio::test]
async fn test_search_replace_multiple_blocks_in_one_code_block() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `test_multiple_blocks.rs`
```replace
<<<<<<< SEARCH
old_function_1();
=======
new_function_1();
>>>>>>> REPLACE
<<<<<<< SEARCH
old_function_2();
=======
new_function_2();
>>>>>>> REPLACE
```
    "#;

    let expected_content = r#"<<<<<<< SEARCH
old_function_1();
=======
new_function_1();
>>>>>>> REPLACE
<<<<<<< SEARCH
old_function_2();
=======
new_function_2();
>>>>>>> REPLACE
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 1, "Expected 1 block, got {}", blocks.len());
    assert_eq!(
        blocks[0].filename, "test_multiple_blocks.rs",
        "Filename mismatch"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch"
    );
    assert_eq!(blocks[0].content, expected_content);
    debug!("Test passed for MarkdownExtractor search-replace block with multiple blocks in one code block.");
}

#[tokio::test]
async fn test_search_replace_block_with_different_number_of_delimiters() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `test_incorrect_syntax.rs`
```replace
<<<<< SEARCH
old_function();
====
new_function();
>>>> REPLACE
```
    "#;

    let expected_content = r#"<<<<< SEARCH
old_function();
====
new_function();
>>>> REPLACE
"#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 1, "Expected 1 blocks, got {}", blocks.len());
    assert_eq!(
        blocks[0].filename, "test_incorrect_syntax.rs",
        "Filename mismatch for block 0"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 0"
    );
    assert_eq!(blocks[0].content, expected_content);
}

#[tokio::test]
async fn test_mixed_search_replace_blocks_with_headings_and_comments() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `path/tofile/first.rs`
```replace
// filename: first.rs
<<<<<<< SEARCH
fn first() {
    println!("This is the first block");
}
=======
fn first_updated() {
    println!("This is the first block updated");
}
>>>>>>> REPLACE
```

```replace
// filename: second.rs
<<<<<<< SEARCH
fn second() {
    println!("This is the second block");
}
=======
fn second_updated() {
    println!("This is the second block updated");
}
>>>>>>> REPLACE
```

### `test_no_filename.rs`
```replace
<<<<<<< SEARCH
fn no_filename() {
    println!("No filename specified in comment or heading");
}
=======
fn no_filename_updated() {
    println!("Updated block with no filename specified in comment or heading");
}
>>>>>>> REPLACE
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 3, "Expected 3 blocks, got {}", blocks.len());

    assert_eq!(
        blocks[0].filename, "first.rs",
        "Filename mismatch for block 0"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 0"
    );

    assert_eq!(
        blocks[1].filename, "second.rs",
        "Filename mismatch for block 1"
    );
    assert_eq!(
        blocks[1].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 1"
    );

    assert_eq!(
        blocks[2].filename, "test_no_filename.rs",
        "Filename mismatch for block 2"
    );
    assert_eq!(
        blocks[2].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 2"
    );

    debug!(
        "Test passed for MarkdownExtractor mixed search-replace blocks with headings and comments."
    );
}

#[tokio::test]
async fn test_mixed_search_replace_blocks_with_and_without_headings() {
    let extractor = MarkdownExtractor::new();
    let content = r#"
### `path/tofile/first.rs`
```replace
// filename: first.rs
<<<<<<< SEARCH
fn first() {
    println!("This is the first block");
}
=======
fn first_updated() {
    println!("This is the first block updated");
}
>>>>>>> REPLACE
```

```replace
// filename: second.rs
<<<<<<< SEARCH
fn second() {
    println!("This is the second block");
}
=======
fn second_updated() {
    println!("This is the second block updated");
}
>>>>>>> REPLACE
```

### `path/tofile/third.rs`
```replace
<<<<<<< SEARCH
fn third() {
    println!("This is the third block");
}
=======
fn third_updated() {
    println!("This is the third block updated");
}
>>>>>>> REPLACE
```
    "#;

    let blocks = extractor
        .extract(content)
        .unwrap_or_else(|e| panic!("Failed to extract content: {:?}", e));

    assert_eq!(blocks.len(), 3, "Expected 3 blocks, got {}", blocks.len());

    assert_eq!(
        blocks[0].filename, "first.rs",
        "Filename mismatch for block 0"
    );
    assert_eq!(
        blocks[0].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 0"
    );

    assert_eq!(
        blocks[1].filename, "second.rs",
        "Filename mismatch for block 1"
    );
    assert_eq!(
        blocks[1].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 1"
    );

    assert_eq!(
        blocks[2].filename, "path/tofile/third.rs",
        "Filename mismatch for block 2"
    );
    assert_eq!(
        blocks[2].block_type,
        BlockType::SearchReplaceBlock,
        "Block type mismatch for block 2"
    );

    debug!(
        "Test passed for MarkdownExtractor mixed search-replace blocks with and without headings."
    );
}