iceoryx2-cli 0.9.0

CLI tools for iceoryx2
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

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

use colored::*;

#[derive(Default)]
pub struct HelpTemplate {
    has_positionals: bool,
    has_subcommands: bool,
    show_external_command_hint: bool,
}

pub fn help_template() -> HelpTemplate {
    HelpTemplate::default()
}

impl HelpTemplate {
    pub fn with_positionals(mut self) -> Self {
        self.has_positionals = true;
        self
    }

    pub fn with_subcommands(mut self) -> Self {
        self.has_subcommands = true;
        self
    }

    pub fn with_external_command_hint(mut self) -> Self {
        self.has_subcommands = true;
        self.show_external_command_hint = true;
        self
    }

    pub fn build(self) -> String {
        let mut template = format!(
            "{{about}}\n\n\
             {} {{usage}}\n\n",
            "Usage:".bright_green().bold(),
        );

        if self.has_positionals {
            template.push_str("{positionals}\n\n");
        }

        template.push_str(&format!(
            "{}\n\
             {{options}}",
            "Options:".bright_green().bold(),
        ));

        if self.has_subcommands {
            template.push_str(&format!(
                "\n\n\
                 {}\n\
                 {{subcommands}}",
                "Commands:".bright_green().bold(),
            ));

            if self.show_external_command_hint {
                template.push_str(&format!(
                    "\n\
                     {}{}",
                    "  ...            ".bold(),
                    "See external installed commands with --list",
                ));
            }
        }

        template
    }
}