alpm_buildinfo/
cli.rs

1use std::{
2    fmt::{Display, Formatter},
3    path::PathBuf,
4    str::FromStr,
5};
6
7use alpm_types::{
8    Architecture,
9    BuildDate,
10    BuildDirectory,
11    BuildEnvironmentOption,
12    BuildTool,
13    BuildToolVersion,
14    InstalledPackage,
15    Name,
16    PackageOption,
17    Packager,
18    StartDirectory,
19    Version,
20};
21use clap::{Args, Parser, Subcommand, ValueEnum};
22use strum::Display;
23
24use crate::{Error, schema::BuildInfoSchema};
25
26/// A type wrapping a PathBuf with a default value
27///
28/// This type is used in circumstances where an output file is required that defaults to
29/// ".BUILDINFO"
30#[derive(Clone, Debug)]
31pub struct OutputFile(pub PathBuf);
32
33impl Default for OutputFile {
34    fn default() -> Self {
35        OutputFile(PathBuf::from(".BUILDINFO"))
36    }
37}
38
39impl Display for OutputFile {
40    fn fmt(&self, fmt: &mut Formatter) -> std::fmt::Result {
41        write!(fmt, "{}", self.0.display())
42    }
43}
44
45impl FromStr for OutputFile {
46    type Err = Error;
47
48    fn from_str(s: &str) -> Result<Self, Self::Err> {
49        Ok(OutputFile(PathBuf::from(s)))
50    }
51}
52
53#[derive(Clone, Debug, Parser)]
54#[command(about, author, name = "alpm-buildinfo", version)]
55pub struct Cli {
56    #[command(subcommand)]
57    pub command: Command,
58}
59
60#[allow(clippy::large_enum_variant)]
61#[derive(Clone, Debug, Subcommand)]
62pub enum Command {
63    /// Create a BUILDINFO file according to a schema
64    ///
65    /// If the input can be validated according to the schema, the program exits with no output and
66    /// a return code of 0. If the input can not be validated according to the schema, an error
67    /// is emitted on stderr and the program exits with a non-zero exit code.
68    #[command()]
69    Create {
70        #[command(subcommand)]
71        command: CreateCommand,
72    },
73
74    /// Validate a BUILDINFO file
75    ///
76    /// Validate a BUILDINFO file according to a schema.
77    /// If the file can be validated, the program exits with no output and a return code of 0.
78    /// If the file can not be validated, an error is emitted on stderr and the program exits with
79    /// a non-zero exit code.
80    #[command()]
81    Validate {
82        #[command(flatten)]
83        args: ValidateArgs,
84    },
85
86    /// Parse a BUILDINFO file and output it in a different format
87    #[command()]
88    Format {
89        #[command(flatten)]
90        args: ValidateArgs,
91
92        /// Provide the output format
93        #[arg(
94            short,
95            long,
96            value_name = "OUTPUT_FORMAT",
97            default_value_t = OutputFormat::Json
98        )]
99        output_format: OutputFormat,
100
101        /// Pretty-print the output
102        #[arg(short, long)]
103        pretty: bool,
104    },
105}
106
107/// Arguments for validating and parsing a BUILDINFO file
108#[derive(Clone, Debug, Args)]
109pub struct ValidateArgs {
110    /// Provide the BUILDINFO schema version to use.
111    ///
112    /// If no schema version is provided, it will be deduced from the file itself.
113    #[arg(short, long, value_name = "VERSION")]
114    pub schema: Option<BuildInfoSchema>,
115    /// Provide the file to read
116    #[arg(value_name = "FILE")]
117    pub file: Option<PathBuf>,
118}
119
120/// Arguments for creating a BUILDINFO file according to the format version 1 schema
121///
122/// This struct is defined separately for reusing it for both v1 and v2 since they have
123/// an overlapping set of fields.
124#[derive(Clone, Debug, Args)]
125pub struct V1CreateArgs {
126    /// Provide a builddate
127    #[arg(env = "BUILDINFO_BUILDDATE", long, value_name = "BUILDDATE")]
128    pub builddate: BuildDate,
129    /// Provide a builddir
130    #[arg(env = "BUILDINFO_BUILDDIR", long, value_name = "BUILDDIR")]
131    pub builddir: BuildDirectory,
132    /// Provide one or more buildenv
133    #[arg(
134        env = "BUILDINFO_BUILDENV",
135        long,
136        value_delimiter = ' ',
137        value_name = "BUILDENV"
138    )]
139    pub buildenv: Vec<BuildEnvironmentOption>,
140    /// Provide one or more installed
141    #[arg(
142        env = "BUILDINFO_INSTALLED",
143        long,
144        value_delimiter = ' ',
145        value_name = "INSTALLED"
146    )]
147    pub installed: Vec<InstalledPackage>,
148    /// Provide one or more options
149    #[arg(
150        env = "BUILDINFO_OPTIONS",
151        long,
152        value_delimiter = ' ',
153        value_name = "OPTIONS"
154    )]
155    pub options: Vec<PackageOption>,
156    /// Provide a packager
157    #[arg(env = "BUILDINFO_PACKAGER", long, value_name = "PACKAGER")]
158    pub packager: Packager,
159    /// Provide a pkgarch
160    #[arg(env = "BUILDINFO_PKGARCH", long, value_name = "PKGARCH")]
161    pub pkgarch: Architecture,
162    /// Provide a pkgbase
163    #[arg(env = "BUILDINFO_PKGBASE", long, value_name = "PKGBASE")]
164    pub pkgbase: Name,
165    /// Provide a pkgbuild_sha256sum
166    #[arg(
167        env = "BUILDINFO_PKGBUILD_SHA256SUM",
168        long,
169        value_name = "PKGBUILD_SHA256SUM"
170    )]
171    pub pkgbuild_sha256sum: String,
172    /// Provide a pkgname
173    #[arg(env = "BUILDINFO_PKGNAME", long, value_name = "PKGNAME")]
174    pub pkgname: Name,
175    /// Provide a pkgver
176    #[arg(env = "BUILDINFO_PKGVER", long, value_name = "PKGVER")]
177    pub pkgver: Version,
178    /// Provide a file to write to
179    #[arg(default_value_t = OutputFile::default(), env = "BUILDINFO_OUTPUT_FILE", value_name = "FILE")]
180    pub output: OutputFile,
181}
182
183/// Create an BUILDINFO file according to a schema
184///
185/// If the input can be validated according to the schema, the program exits with no output and
186/// a return code of 0. If the input can not be validated according to the schema, an error
187/// is emitted on stderr and the program exits with a non-zero exit code.
188#[derive(Clone, Debug, Subcommand)]
189pub enum CreateCommand {
190    /// Create a BUILDINFO version 1 file
191    V1 {
192        #[command(flatten)]
193        args: V1CreateArgs,
194    },
195    /// Create a BUILDINFO version 2 file
196    V2 {
197        #[command(flatten)]
198        args: V1CreateArgs,
199
200        /// Provide a startdir
201        #[arg(env = "BUILDINFO_STARTDIR", long, value_name = "STARTDIR")]
202        startdir: StartDirectory,
203
204        /// Provide a buildtool
205        #[arg(env = "BUILDINFO_BUILDTOOL", long, value_name = "BUILDTOOL")]
206        buildtool: BuildTool,
207
208        /// Provide a buildtoolver
209        #[arg(env = "BUILDINFO_BUILDTOOLVER", long, value_name = "BUILDTOOLVER")]
210        buildtoolver: BuildToolVersion,
211    },
212}
213
214/// Output format for the format command
215#[derive(Clone, Debug, Default, Display, ValueEnum)]
216#[non_exhaustive]
217pub enum OutputFormat {
218    #[default]
219    #[strum(to_string = "json")]
220    Json,
221}
alpm_buildinfo/cli.rs

alpm_buildinfo/
cli.rs
