arborist-cli 0.1.1

CLI for arborist-metrics: cognitive/cyclomatic complexity and SLOC metrics
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

use std::path::PathBuf;

use clap::{Parser, Subcommand, ValueEnum};

#[derive(Debug, Clone, ValueEnum)]
pub enum OutputFormat {
    Table,
    Json,
    Csv,
}

#[derive(Debug, Clone, ValueEnum)]
pub enum SortMetric {
    Cognitive,
    Cyclomatic,
    Sloc,
    Name,
}

#[derive(Debug, Parser)]
#[command(
    name = "arborist",
    version,
    about = "Code complexity metrics powered by arborist-metrics"
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Option<Command>,

    #[command(flatten)]
    pub analyze: AnalyzeArgs,
}

#[derive(Debug, Subcommand)]
pub enum Command {
    /// Check for updates and install the latest version
    Update {
        /// Only check for available updates without installing
        #[arg(long)]
        check: bool,
    },
}

#[derive(Debug, clap::Args)]
pub struct AnalyzeArgs {
    /// Files or directories to analyze
    #[arg()]
    pub paths: Vec<PathBuf>,

    /// Output format
    #[arg(long, default_value = "table")]
    pub format: OutputFormat,

    /// Language for stdin input (required when piping)
    #[arg(long)]
    pub language: Option<String>,

    /// Cognitive complexity threshold
    #[arg(long)]
    pub threshold: Option<u64>,

    /// Show only functions exceeding the threshold
    #[arg(long)]
    pub exceeds_only: bool,

    /// Sort results by metric
    #[arg(long)]
    pub sort: Option<SortMetric>,

    /// Show only the top N results
    #[arg(long)]
    pub top: Option<usize>,

    /// Filter directory traversal by language (comma-separated)
    #[arg(long, value_delimiter = ',')]
    pub languages: Option<Vec<String>>,

    /// Respect .gitignore patterns during directory traversal
    #[arg(long)]
    pub gitignore: bool,

    /// Exclude method-level analysis
    #[arg(long)]
    pub no_methods: bool,
}