ironic 0.2.4

A batteries-included, type-safe application framework for Rust
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

use std::path::PathBuf;

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

/// The Ironic command-line interface.
#[derive(Debug, Parser)]
#[command(name = "ironic", version, about)]
pub struct Cli {
    /// Command to execute.
    #[command(subcommand)]
    pub command: Command,
}

/// Supported MVP commands.
#[derive(Debug, Subcommand)]
pub enum Command {
    /// Creates a new application project.
    New(NewArgs),
    /// Runs the current project through Cargo.
    Start(CargoArgs),
    /// Runs the server in development mode with hot reload on file changes.
    Dev(CargoArgs),
    /// Builds the current project through Cargo.
    Build(CargoArgs),
    /// Tests the current project through Cargo.
    Test(CargoArgs),
    /// Generates application source files.
    #[command(alias = "g")]
    Generate(GenerateArgs),
    /// Checks the local Rust and project environment.
    Doctor,
    /// Checks crates.io for a newer version and shows update instructions.
    #[command(alias = "upgrade")]
    Update,
    /// Lists routes declared by controller macros.
    Routes(InspectArgs),
    /// Prints a Graphviz dependency graph from module and injectable declarations.
    Graph(InspectArgs),
}

/// Arguments for project creation.
#[derive(Debug, Args)]
pub struct NewArgs {
    /// Project name and destination directory, or `.` for the current directory.
    pub name: String,
    /// Uses local framework crates from a workspace checkout.
    #[arg(long, hide = true)]
    pub framework_workspace: Option<PathBuf>,
}

/// Arguments passed through to Cargo after `--`.
#[derive(Debug, Args)]
pub struct CargoArgs {
    /// Additional Cargo arguments.
    #[arg(last = true, allow_hyphen_values = true)]
    pub cargo_args: Vec<String>,
}

/// Arguments shared by source inspection commands.
#[derive(Debug, Args)]
pub struct InspectArgs {
    /// Project directory containing `src`.
    #[arg(default_value = ".")]
    pub path: PathBuf,
}

/// Generator selection and source name.
#[derive(Debug, Args)]
pub struct GenerateArgs {
    /// Artifact to generate.
    #[command(subcommand)]
    pub generator: Generator,
}

/// Supported source generators.
#[derive(Debug, Subcommand)]
pub enum Generator {
    /// Generates a module.
    #[command(alias = "mo")]
    Module(NameArgs),
    /// Generates a controller.
    #[command(alias = "co")]
    Controller(NameArgs),
    /// Generates a service.
    #[command(alias = "s")]
    Service(NameArgs),
    /// Generates a module, service, and controller vertical slice.
    #[command(alias = "res")]
    Resource(NameArgs),
    /// Generates a custom parameter decorator.
    #[command(alias = "d")]
    Decorator(NameArgs),
    /// Generates an exception filter.
    #[command(alias = "f")]
    Filter(NameArgs),
    /// Generates a WebSocket gateway.
    #[command(alias = "ga")]
    Gateway(NameArgs),
    /// Generates a guard.
    #[command(alias = "gu")]
    Guard(NameArgs),
    /// Generates an interceptor.
    #[command(alias = "itc")]
    Interceptor(NameArgs),
    /// Generates middleware.
    #[command(alias = "mi")]
    Middleware(NameArgs),
    /// Generates a pipe.
    #[command(alias = "pi")]
    Pipe(NameArgs),
    /// Generates an injectable provider.
    #[command(alias = "pr")]
    Provider(NameArgs),
}

/// A named generator target.
#[derive(Debug, Args)]
pub struct NameArgs {
    /// Resource or module name.
    pub name: String,
}