towl 0.3.7

A fast CLI tool to scan codebases for TODO comments and output them in multiple formats
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

use serde::{Deserialize, Serialize};

/// Metadata for a successfully created GitHub issue.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct CreatedIssue {
    pub number: u64,
    pub title: String,
    pub html_url: String,
    pub todo_id: String,
}

impl CreatedIssue {
    #[must_use]
    pub const fn new(number: u64, title: String, html_url: String, todo_id: String) -> Self {
        Self {
            number,
            title,
            html_url,
            todo_id,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use proptest::prelude::*;

    proptest! {
        #[test]
        fn prop_created_issue_json_roundtrip(
            number in 1u64..100_000,
            title in "[a-zA-Z0-9 ]{1,50}",
            todo_id in "[a-zA-Z0-9_]{1,30}"
        ) {
            let url = format!("https://github.com/owner/repo/issues/{number}");
            let issue = CreatedIssue::new(
                number,
                title,
                url,
                todo_id,
            );

            let json = serde_json::to_string(&issue).unwrap();
            let decoded: CreatedIssue = serde_json::from_str(&json).unwrap();

            prop_assert_eq!(decoded, issue);
        }
    }
}