CLI-integratie

English | 中文 | 日本語 | 한국어 | Français | Deutsch | Español | Português | Svenska | Suomi | Nederlands

ConfigCommand biedt herbruikbare clap-subcommands:

• config-template
• config-schema
• config-validate
• completions
• install-completions
• uninstall-completions

Deze ingebouwde subcommands staan los van toepassingsspecifieke configuratie- overridevlaggen. Voeg configuratie-overridevlaggen als Figment-providers samen in het runtime-laadpad.

Configuratie-overridevlaggen blijven onderdeel van de CLI van de consumerende toepassing. Hun namen hoeven niet overeen te komen met gestippelde configuratiepaden. De toepassing kan bijvoorbeeld --server-port parsen en naar de geneste configuratiesleutel server.port mappen. Alleen vlaggen die de toepassing in CliOverrides mappt, beinvloeden configuratiewaarden.

Flatten het in een toepassingsopdrachtenenum:

1. Behoud het eigen Parser-type van de toepassing.
2. Behoud de eigen Subcommand-enum van de toepassing.
3. Voeg #[command(flatten)] Config(ConfigCommand) aan die enum toe.
4. Clap breidt de geflattende ConfigCommand-varianten uit naar hetzelfde opdracht niveau als de eigen varianten van de toepassing.
5. Match de variant Config(command) en geef die door aan handle_config_command.

use std::path::PathBuf;

use clap::{Parser, Subcommand};
use confique::Config;
use schemars::JsonSchema;
use rust_config_tree::{ConfigCommand, ConfigSchema, handle_config_command, load_config};

#[derive(Debug, Config, JsonSchema)]
struct AppConfig {
    #[config(default = [])]
    include: Vec<PathBuf>,
}

impl ConfigSchema for AppConfig {
    fn include_paths(layer: &<Self as Config>::Layer) -> Vec<PathBuf> {
        layer.include.clone().unwrap_or_default()
    }
}

#[derive(Debug, Parser)]
#[command(name = "demo")]
struct Cli {
    #[arg(long, default_value = "config.yaml")]
    config: PathBuf,

    #[command(subcommand)]
    command: Command,
}

#[derive(Debug, Subcommand)]
enum Command {
    Run,

    #[command(flatten)]
    Config(ConfigCommand),
}

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let cli = Cli::parse();

    match cli.command {
        Command::Run => {
            let config = load_config::<AppConfig>(&cli.config)?;
            println!("{config:#?}");
        }
        Command::Config(command) => {
            handle_config_command::<Cli, AppConfig>(command, &cli.config)?;
        }
    }

    Ok(())
}

Configuratiesjablonen

demo config-template

De opdracht schrijft sjablonen onder config/<root_config_name>/. Als --output een pad ontvangt, wordt alleen de bestandsnaam gebruikt. Als geen uitvoerbestandsnaam is opgegeven, schrijft de opdracht config/<root_config_name>/<root_config_name>.example.yaml. Voeg --schema schemas/myapp.schema.json toe om gegenereerde TOML-, YAML-, JSON- en JSON5-sjablonen te koppelen aan gegenereerde JSON Schemas. Gesplitste YAML-sjablonen koppelen het passende sectieschema. JSON- en JSON5-sjablonen krijgen een $schema-veld dat VS Code herkent. De opdracht schrijft ook het root- en de sectieschema’s naar het gekozen schemapad.

demo config-template --output app_config.example.toml --schema schemas/myapp.schema.json

Genereer root- en sectie-JSON Schemas:

demo config-schema

Zonder --output schrijft config-schema het rootschema naar config/<root_config_name>/<root_config_name>.schema.json.

Valideer de volledige runtimeconfiguratieboom:

demo config-validate

Gegenereerde editorschema’s vermijden bewust diagnostics voor verplichte velden in gesplitste bestanden. config-validate laadt includes, past defaults toe en voert uiteindelijke confique-validatie uit, inclusief validators die met #[config(validate = Self::validate)] zijn gedeclareerd. Gegenereerde *.schema.json-bestanden blijven voor IDE-completion en basale editorcontroles, niet voor veldwaardelegaliteit. Het print Configuration is ok wanneer de validatie slaagt.

Shellcompletions

Print completions naar stdout:

demo completions zsh

Installeer completions:

demo install-completions zsh

Verwijder completions:

demo uninstall-completions zsh

De installer ondersteunt Bash, Elvish, Fish, PowerShell en Zsh. Hij schrijft het completionbestand onder de home-directory van de gebruiker en werkt het shellstartbestand bij voor shells die dat vereisen.

Voordat een bestaand shellstartbestand zoals ~/.zshrc, ~/.bashrc, een Elvish rc-bestand of een PowerShell-profiel wordt gewijzigd, schrijft de opdracht een backup naast het originele bestand:

<rc-file>.backup.by.<program-name>.<timestamp>