natlint 0.1.0

A linter for Solidity natspec comments.
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

//! Defines the client interface for natlint.

use clap::{command, Parser};

/// The command line interface for natlint.
#[derive(Clone, Debug, Parser)]
#[command(version, about, long_about = None)]
pub struct NatlintCli {
    /// The subcommand to run.
    #[command(subcommand)]
    pub command: Commands,
}

/// The subcommands for natlint.
#[derive(Clone, Debug, Parser)]
pub enum Commands {
    /// Run natlint.
    Run(run::Args),
    /// Create a default configuration file.
    Init(init::Args),
}

/// The arguments for the run subcommand.
pub mod run {
    use super::Parser;

    /// The arguments for the run subcommand.
    #[derive(Clone, Debug, Parser)]
    pub struct Args {
        /// The root directory for the linter.
        #[clap(long, default_value = ".")]
        pub root: String,

        /// The include globs for the linter (e.g., "**/*.sol" to find all Solidity files).
        /// Put multiple patterns in quotes: "**/*.sol" "**/*.sol.txt"
        #[clap(short = 'i', long)]
        pub include: Vec<String>,

        /// The exclude globs for the linter.
        /// Put multiple patterns in quotes: "`node_modules/**`" "`dist/**`"
        #[clap(short = 'e', long)]
        pub exclude: Vec<String>,

        /// The configuration file for linter.
        #[clap(short = 'c', long, default_value = "natlint.toml")]
        pub config: String,

        /// The verbosity of the linter.
        #[clap(short = 'v', long)]
        pub verbose: bool,
    }
}

/// The arguments for the init subcommand.
pub mod init {
    use super::Parser;

    /// The arguments for the init subcommand.
    #[derive(Clone, Debug, Parser)]
    pub struct Args {
        /// The path to the configuration file to create.
        #[clap(short = 'c', long, default_value = "natlint.toml")]
        pub config: String,
    }
}