oxvg 0.0.7

Vector image toolchain.
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

//! Traits and types for handling the command line arguments for OXVG.
use std::future::Future;

use clap::{Parser, Subcommand};

use crate::{
    commands::{Action, Format, JSX, Lint, Optimise},
    config::Config,
};

/// A type for a runnable command.
pub trait RunCommand {
    /// Runs the command with the specified config.
    ///
    /// # Errors
    ///
    /// If any part of the lifecycle fails
    /// * Fails to read or parse any files
    /// * Fails to write or serialize to any files
    fn run(self, config: Config) -> impl Future<Output = anyhow::Result<()>> + Send;
}

#[derive(Parser)]
#[clap(
    bin_name = "oxvg",
    name = "oxvg",
    author,
    version,
    about = "Your versatile vector-graphics toolchain",
    long_about = None
)]
/// Args that can be provided when running OXVG via the command line.
pub struct Args {
    #[clap(subcommand)]
    /// The subcommands for OXVG
    pub command: Command,
}

#[derive(Subcommand)]
/// The subcommands for OXVG
pub enum Command {
    /// Optimise SVG documents
    #[clap(alias = "optimize")]
    Optimise(Optimise),
    /// Format SVG documents
    ///
    /// This is an alias for `oxvg optimise --extends none` with default options sensible
    /// for formatting
    Format(Format),
    /// Lint SVG documents
    #[command(subcommand)]
    Lint(Lint),
    /// Transform SVG documents
    #[clap(alias = "actions")]
    Action(Action),
    /// Convert SVG documents to JSX
    JSX(JSX),
    #[cfg(feature = "visual-regression")]
    /// Visual regression testing for OXVG outputs
    VisualRegression(crate::commands::VisualRegression),
    #[cfg(feature = "render")]
    /// Render SVG documents
    Render(crate::commands::Render),
}