eska-presentation 0.15.0

Shared localization and path presentation for ESKA tools
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! Shared native command options and help; execution belongs to eska-build.

use crate::localization::Localizer;
use clap::{Args, ValueEnum};
use std::path::PathBuf;

#[derive(Debug, Default, Args)]
pub struct BuildArgs {
    #[arg(long)]
    pub output: Option<PathBuf>,

    #[arg(long)]
    pub base_configuration: Option<PathBuf>,

    #[arg(long)]
    pub recreate_infobase: bool,

    #[arg(long)]
    pub ibcmd: Option<PathBuf>,

    #[arg(long)]
    pub platform_arch: Option<String>,

    #[arg(long)]
    pub distrobox: Option<String>,

    #[arg(long, conflicts_with = "select_platform")]
    pub platform_version: Option<String>,

    #[arg(long, conflicts_with = "platform_version")]
    pub select_platform: bool,

    #[arg(long, value_enum, default_value_t = OutputFormat::Human)]
    pub format: OutputFormat,

    #[arg(short = 'p', long)]
    pub project: Vec<String>,

    #[arg(long)]
    pub workspace: bool,

    #[command(flatten)]
    pub mode: BuildModeArgs,

    #[arg(short, long, action = clap::ArgAction::Help)]
    pub help: Option<bool>,
}

#[derive(Debug, Default, Args)]
pub struct BuildModeArgs {
    #[arg(long)]
    pub dry_run: bool,

    #[arg(long, conflicts_with = "dry_run")]
    pub manifest: bool,
}

#[derive(Clone, Copy, Debug, Default, ValueEnum)]
pub enum OutputFormat {
    #[default]
    Human,
    Json,
}

/// Attach localized help to the build command and its arguments.
pub fn localize(command: clap::Command, localizer: &Localizer) -> clap::Command {
    command
        .about(localizer.text("build-about"))
        .override_usage(localizer.text("build-usage"))
        .mut_arg("output", |arg| {
            arg.help(localizer.text("build-output-help"))
                .value_name(localizer.text("build-output-value"))
        })
        .mut_arg("base_configuration", |arg| {
            arg.help(localizer.text("build-base-configuration-help"))
                .value_name(localizer.text("build-base-configuration-value"))
        })
        .mut_arg("recreate_infobase", |arg| {
            arg.help(localizer.text("build-recreate-infobase-help"))
        })
        .mut_arg("ibcmd", |arg| {
            arg.help(localizer.text("build-ibcmd-help"))
                .value_name(localizer.text("build-ibcmd-value"))
        })
        .mut_arg("platform_arch", |arg| {
            arg.help(localizer.text("build-arch-help"))
                .value_name(localizer.text("build-arch-value"))
        })
        .mut_arg("distrobox", |arg| {
            arg.help(localizer.text("build-distrobox-help"))
                .value_name(localizer.text("build-distrobox-value"))
        })
        .mut_arg("platform_version", |arg| {
            arg.help(localizer.text("build-platform-version-help"))
                .value_name(localizer.text("build-platform-version-value"))
        })
        .mut_arg("select_platform", |arg| {
            arg.help(localizer.text("build-select-platform-help"))
        })
        .mut_arg("format", |arg| {
            arg.help(localizer.text("build-format-help"))
                .value_name(localizer.text("build-format-value"))
        })
        .mut_arg("project", |arg| {
            arg.help(localizer.text("build-project-help"))
                .value_name(localizer.text("build-project-value"))
        })
        .mut_arg("workspace", |arg| {
            arg.help(localizer.text("build-workspace-help"))
        })
        .mut_arg("dry_run", |arg| {
            arg.help(localizer.text("build-dry-run-help"))
        })
        .mut_arg("manifest", |arg| {
            arg.help(localizer.text("build-manifest-help"))
        })
        .mut_arg("help", |arg| arg.help(localizer.text("cli-help")))
}

impl BuildArgs {
    /// The shell needs VCS only when execution will actually publish a provenance manifest.
    #[must_use]
    pub const fn needs_provenance(&self) -> bool {
        self.mode.manifest && !self.mode.dry_run
    }
}

pub mod artifact;
pub mod clean;
pub mod config;
pub mod import;
pub mod patch;
pub mod platform;