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
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

//! Command-line interface definitions using [`clap`].

use crate::comment::todo::TodoType;
use clap::{Parser, Subcommand, ValueEnum};
use std::path::PathBuf;

/// Top-level CLI parser. Use [`Cli::command`] to access the chosen subcommand.
#[derive(Debug, Parser)]
#[command(
    name = "towl",
    author,
    version,
    about = "Todo Owl - watches over your project's source code for TODO comments",
    long_about = "Todo Owl (tOwl) - Scans your codebase for TODO comments and outputs them in various formats"
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: TowlCommands,
}

#[derive(Debug, Subcommand)]
pub enum TowlCommands {
    /// Initialize a new .towl.toml configuration file
    Init {
        /// Path for the configuration file
        #[arg(long, short = 'p', default_value = ".towl.toml")]
        path: PathBuf,

        /// Overwrite existing configuration file
        #[arg(long, short = 'F')]
        force: bool,
    },

    /// Scan for TODO comments in source code
    Scan {
        /// Path to a .towl.toml configuration file
        #[arg(long, short = 'c')]
        config: Option<PathBuf>,

        /// Directory to scan for TODO comments
        #[arg(default_value = ".")]
        path: PathBuf,

        /// Disable interactive TUI mode (for CI/scripting)
        #[arg(long, short = 'N')]
        non_interactive: bool,

        /// Output format for non-interactive mode
        #[arg(long, short = 'f', value_enum, default_value = "terminal")]
        format: OutputFormat,

        /// Write output to a file instead of stdout
        #[arg(long, short = 'o')]
        output: Option<PathBuf>,

        /// Filter results by TODO type
        #[arg(long, short = 't', value_enum)]
        todo_type: Option<TodoType>,

        /// Show detailed scan statistics
        #[arg(long, short = 'v')]
        verbose: bool,

        /// Create GitHub issues for found TODOs
        #[arg(long, short = 'g')]
        github: bool,

        /// Preview GitHub issues without creating them
        #[arg(long, short = 'n')]
        dry_run: bool,

        /// Analyse TODOs with AI to validate relevance
        #[arg(long)]
        ai: bool,
    },

    /// Display the current configuration
    Config {
        /// Path to a .towl.toml configuration file
        #[arg(long, short = 'c')]
        config: Option<PathBuf>,
    },
}

/// Output format for non-interactive scan results.
#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum OutputFormat {
    Table,
    Json,
    Csv,
    Toml,
    Markdown,
    Terminal,
}