snippy 0.1.0

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
use snippy::content_extractor::delimiter_identifier::DelimiterIdentifier;
use snippy::content_extractor::parser::BlockType;
use tracing::debug;

#[tokio::test]
async fn test_no_filename_comment_or_heading() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ```rust
    fn main() {
        println!(\"This block has no heading or filename comment\");
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename, None);
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_rust_code_block_with_filename_comment() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content =
        "```rust\n// filename: test.rs\nfn main() { println!(\"Hello, world!\"); }\n```\n";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("test.rs"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_heading_with_filename() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/test.rs
    ```rust
    fn main() {
        println!(\"Hello, world!\");
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("path/tofile/test.rs")
    );
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_heading_and_filename_comment() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/wrong_test.rs
    ```rust
    // filename: correct_test.rs
    fn main() {
        println!(\"Hello, world!\");
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("correct_test.rs"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_heading_with_no_filename_comment() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/no_comment.rs
    ```rust
    fn main() {
        println!(\"No filename comment available\");
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("path/tofile/no_comment.rs")
    );
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_html_comment_block_with_filename() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content =
        "```html\n<!-- filename: test.html -->\n<html><body>Hello, world!</body></html>\n```\n";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("test.html"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_css_comment_block_with_filename() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "```css\n/* filename: test.css */\nbody { background-color: #fff; }\n```\n";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("test.css"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_python_comment_block_with_filename() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "```py\n# filename: test.py\nprint(\"Hello, world!\")\n```\n";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("test.py"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_malformed_filename_comment() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "```rust\n// filename test.rs\nfn main() { println!(\"Hello, world!\"); }\n```\n";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2); // Both the start and end delimiter should be captured
    assert_eq!(delimiters[0].filename, None); // Filename should not be captured due to malformed comment
}

#[tokio::test]
async fn test_mixed_blocks_with_and_without_headings() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/first.rs
    ```rust
    fn first() {
        println!(\"This is the first block\");
    }
    ```

    ```rust
    // filename: second.rs
    fn second() {
        println!(\"This is the second block\");
    }
    ```

    ## path/tofile/third.rs
    ```rust
    fn third() {
        println!(\"This is the third block\");
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 6);

    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("path/tofile/first.rs")
    );
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);

    assert_eq!(delimiters[2].filename.as_deref(), Some("second.rs"));
    assert_eq!(delimiters[2].block_type, BlockType::FullContent);
    assert!(delimiters[2].is_start);
    assert!(!delimiters[3].is_start);

    assert_eq!(
        delimiters[4].filename.as_deref(),
        Some("path/tofile/third.rs")
    );
    assert_eq!(delimiters[4].block_type, BlockType::FullContent);
    assert!(delimiters[4].is_start);
    assert!(!delimiters[5].is_start);
}

#[tokio::test]
async fn test_multiple_headings_with_filenames() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/first_heading.rs
    ```rust
    fn first_heading() {
        println!(\"First heading\");
    }
    ```

    ## path/tofile/second_heading.rs
    ```rust
    fn second_heading() {
        println!(\"Second heading\");
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 4);

    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("path/tofile/first_heading.rs")
    );
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);

    assert_eq!(
        delimiters[2].filename.as_deref(),
        Some("path/tofile/second_heading.rs")
    );
    assert_eq!(delimiters[2].block_type, BlockType::FullContent);
    assert!(delimiters[2].is_start);
    assert!(!delimiters[3].is_start);
}

#[tokio::test]
async fn test_mixed_content() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ```rust
    # filename: test.rs
    fn main() { println!(\"Hello, world!\"); }
    ```
    ```html
    <!-- filename: test.html -->
    <html>
    <body>Hello, world!</body>
    </html>
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 4);

    assert_eq!(delimiters[0].filename.as_deref(), Some("test.rs"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);

    assert!(!delimiters[1].is_start);

    assert_eq!(delimiters[2].filename.as_deref(), Some("test.html"));
    assert_eq!(delimiters[2].block_type, BlockType::FullContent);
    assert!(delimiters[2].is_start);

    assert!(!delimiters[3].is_start);
}

#[tokio::test]
async fn test_nested_blocks_with_headings_and_comments() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/outer.rs
    ```rust
    // filename: outer.rs
    fn outer() {
        println!(\"This is the outer block\");

        ## path/tofile/inner.rs
        ```rust
        // filename: inner.rs
        fn inner() {
            println!(\"This is the inner block\");
        }
        ```
    }
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 4);

    assert_eq!(delimiters[0].filename.as_deref(), Some("outer.rs"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(delimiters[1].is_start);

    assert_eq!(delimiters[1].filename.as_deref(), Some("inner.rs"));
    assert_eq!(delimiters[1].block_type, BlockType::FullContent);
    assert!(!delimiters[2].is_start);
    assert!(!delimiters[3].is_start);
}

#[tokio::test]
async fn test_nested_code_blocks_with_filename() {
    let delimiter_identifier = DelimiterIdentifier::new();

    let content = r#"
    ```rust
    // filename: outer_block.rs
    fn main() {
        println!("This is the outer block");

        ```lang
        // filename: inner_block.rs
        fn inner() {
            println!("This is the inner block");
        }
        ```
    }
    ```
    "#;

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(
        delimiters.len(),
        4,
        "Expected 4 delimiters, got {}",
        delimiters.len()
    );
    assert_eq!(delimiters[0].filename.as_deref(), Some("outer_block.rs"));
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);

    assert!(delimiters[1].is_start);
    assert_eq!(delimiters[1].filename.as_deref(), Some("inner_block.rs"));
    assert_eq!(delimiters[1].block_type, BlockType::FullContent);
    assert!(!delimiters[2].is_start);

    assert!(!delimiters[3].is_start);
}

#[tokio::test]
async fn test_code_blocks_without_filename() {
    let delimiter_identifier = DelimiterIdentifier::new();

    // Test case with a code block without a filename header
    let content = r#"
    ```rust
    // This block does not have a filename header
    fn main() {
        println!("This block should be ignored");
    }
    ```
    "#;

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(
        delimiters.len(),
        2,
        "Expected 2 delimiters, got {}",
        delimiters.len()
    );
    assert_eq!(delimiters[0].filename, None);
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_mixed_code_blocks_with_and_without_filenames() {
    let delimiter_identifier = DelimiterIdentifier::new();

    // Test case with a mix of code blocks with and without filename headers
    let content = r#"
    ```rust
    // filename: test_with_filename.rs
    fn main() {
        println!("This block should be processed");
    }
    ```

    ```rust
    // This block does not have a filename header
    fn main() {
        println!("This block should be ignored");
    }
    ```

    ```rust
    // filename: another_test_with_filename.rs
    fn main() {
        println!("This block should also be processed");
    }
    ```
    "#;

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(
        delimiters.len(),
        6,
        "Expected 6 delimiters, got {}",
        delimiters.len()
    );
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("test_with_filename.rs")
    );
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);

    assert!(!delimiters[1].is_start);

    assert_eq!(delimiters[2].filename.as_deref(), None,);
    assert_eq!(delimiters[2].block_type, BlockType::FullContent);
    assert!(delimiters[2].is_start);
    assert!(!delimiters[3].is_start);

    assert_eq!(
        delimiters[4].filename.as_deref(),
        Some("another_test_with_filename.rs")
    );
    assert_eq!(delimiters[4].block_type, BlockType::FullContent);
    assert!(delimiters[4].is_start);
    assert!(!delimiters[5].is_start);
}

#[tokio::test]
async fn test_code_block_with_improper_filename_comment() {
    let delimiter_identifier = DelimiterIdentifier::new();

    // Test case with a code block with an improper filename comment
    let content = r#"
    ```rust
    // filename test_with_improper_comment.rs
    fn main() {
        println!("This block has an improper filename comment and should be ignored");
    }
    ```
    "#;

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(
        delimiters.len(),
        2,
        "Expected 2 delimiters, got {}",
        delimiters.len()
    );
    assert_eq!(delimiters[0].filename, None);
    assert_eq!(delimiters[0].block_type, BlockType::FullContent);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_heading_with_unified_diff_block() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ## path/tofile/unified.diff
    ```diff
    --- a/original
    +++ b/modified
    @@ -1,3 +1,3 @@
    - print(\"old line\")
    + print(\"new line\")
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("original"));
    assert_eq!(delimiters[0].block_type, BlockType::UnifiedDiff);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_diff_block_with_filepath() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ```diff
    --- a/file1
    +++ b/file2
    @@ -1,3 +1,3 @@
    -old line
    +new line
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].filename.as_deref(), Some("file1"));
    assert_eq!(delimiters[0].block_type, BlockType::UnifiedDiff);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);
}

#[tokio::test]
async fn test_search_replace_block_identification_heading() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    # test_search_replace.rs
    ```replace
    <<<<<<< SEARCH
    fn main() {
        println!(\"This is a search block\");
    }
    =======
    fn main() {
        println!(\"This is a replace block\");
    }
    >>>>>>> REPLACE
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].block_type, BlockType::SearchReplaceBlock);
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("test_search_replace.rs")
    );
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);

    debug!("Test passed for search-replace block identification.");
}

#[tokio::test]
async fn test_search_replace_block_identification_body() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ```replace
    // filename: test_search_replace.rs
    <<<<<<< SEARCH
    fn main() {
        println!(\"This is a search block\");
    }
    =======
    fn main() {
        println!(\"This is a replace block\");
    }
    >>>>>>> REPLACE
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].block_type, BlockType::SearchReplaceBlock);
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("test_search_replace.rs")
    );
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);

    debug!("Test passed for search-replace block identification.");
}

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

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("test_search_replace.rs")
    );
    assert_eq!(delimiters[0].block_type, BlockType::SearchReplaceBlock);
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);

    debug!("Test passed for search-replace block with filename.");
}

#[tokio::test]
async fn test_multiple_search_replace_blocks() {
    let delimiter_identifier = DelimiterIdentifier::new();
    let content = "
    ```replace
    // filename: test_search_replace.rs
    <<<<<<< SEARCH
    fn main() {
        println!(\"First search block\");
    }
    =======
    fn main() {
        println!(\"First replace block\");
    }
    >>>>>>> REPLACE

    <<<<<<< SEARCH
    fn hello() {
        println!(\"Second search block\");
    }
    =======
    fn hello() {
        println!(\"Second replace block\");
    }
    >>>>>>> REPLACE
    ```
    ";

    let delimiters = delimiter_identifier
        .identify_delimiters(content)
        .unwrap_or_else(|e| panic!("Failed to identify delimiters: {:?}", e));

    assert_eq!(delimiters.len(), 2);
    assert_eq!(delimiters[0].block_type, BlockType::SearchReplaceBlock);
    assert_eq!(
        delimiters[0].filename.as_deref(),
        Some("test_search_replace.rs")
    );
    assert!(delimiters[0].is_start);
    assert!(!delimiters[1].is_start);

    debug!("Test passed for multiple search-replace blocks.");
}