typst/cli/src/args.rs

84 lines
2.5 KiB
Rust

use std::path::PathBuf;
use clap::{ArgAction, Parser, Subcommand};
/// typst creates PDF files from .typ files
#[derive(Debug, Clone, Parser)]
#[clap(name = "typst", version = crate::typst_version(), author)]
pub struct CliArguments {
/// Add additional directories to search for fonts
#[clap(long = "font-path", env = "TYPST_FONT_PATHS", value_name = "DIR", action = ArgAction::Append)]
pub font_paths: Vec<PathBuf>,
/// Configure the root for absolute paths
#[clap(long = "root", env = "TYPST_ROOT", value_name = "DIR")]
pub root: Option<PathBuf>,
/// The typst command to run
#[command(subcommand)]
pub command: Command,
/// Sets the level of verbosity: 0 = none, 1 = warning & error, 2 = info, 3 = debug, 4 = trace
#[clap(short, long, action = ArgAction::Count)]
pub verbosity: u8,
}
/// What to do.
#[derive(Debug, Clone, Subcommand)]
#[command()]
pub enum Command {
/// Compiles the input file into a PDF file
#[command(visible_alias = "c")]
Compile(CompileCommand),
/// Watches the input file and recompiles on changes
#[command(visible_alias = "w")]
Watch(CompileCommand),
/// List all discovered fonts in system and custom font paths
Fonts(FontsCommand),
}
impl Command {
/// Returns the compile command if this is a compile or watch command.
pub fn as_compile(&self) -> Option<&CompileCommand> {
match self {
Command::Compile(cmd) => Some(cmd),
Command::Watch(cmd) => Some(cmd),
Command::Fonts(_) => None,
}
}
/// Returns whether this is a watch command.
pub fn is_watch(&self) -> bool {
matches!(self, Command::Watch(_))
}
}
/// Compiles the input file into a PDF file
#[derive(Debug, Clone, Parser)]
pub struct CompileCommand {
/// Path to input Typst file
pub input: PathBuf,
/// Path to output PDF file
pub output: Option<PathBuf>,
/// Opens the output file after compilation using the default PDF viewer
#[arg(long = "open")]
pub open: Option<Option<String>>,
/// Produces a flamegraph of the compilation process and saves it to the
/// given file or to `flamegraph.svg` in the current working directory.
#[arg(long = "flamegraph", value_name = "OUTPUT_SVG")]
pub flamegraph: Option<Option<PathBuf>>,
}
/// List all discovered fonts in system and custom font paths
#[derive(Debug, Clone, Parser)]
pub struct FontsCommand {
/// Also list style variants of each font family
#[arg(long)]
pub variants: bool,
}