Commandes personnalisées pour inline-enum-type-name-override

Vue d'ensemble

Le CLI inline-enum-type-name-override supporte les commandes personnalisées écrites par l'utilisateur qui sont compilées dans le binaire aux côtés des commandes API auto-générées. Les commandes personnalisées reçoivent un client SDK entièrement configuré qui hérite de l'authentification, des tentatives, du TLS, de l'URL de base et des en-têtes globaux du CLI — aucune configuration requise.

Architecture

cli/inline-enum-type-name-override/custom.rs    ← Vos gestionnaires de commandes (protégés par .fernignore)
cli/inline-enum-type-name-override/sdk.rs       ← Pont généré : client() + block_on()
cli/inline-enum-type-name-override/main.rs      ← Point d'entrée généré (appelle custom::register)
inline-enum-type-name-override-sdk/             ← Crate SDK typé co-généré
inline-enum-type-name-override-types/           ← Crate de modèles typés co-généré

Ajouter une commande personnalisée

1. Éditer cli/inline-enum-type-name-override/custom.rs

Ce fichier est protégé par .fernignore — fern generate ne le réécrirait jamais. Enregistrez les commandes dans la fonction register() :

use inline_enum_type_name_override_sdk::api::*;

pub fn register(app: CliApp) -> CliApp {
    let app = app.command(
        clap::Command::new("load")
            .about("Run reporting load")
        ,
        |matches, ctx| {
            let client = super::sdk::client(ctx);
            let result = super::sdk::block_on(
                client.reporting.load(),
            )?;
            println!("{}", serde_json::to_string_pretty(&result).unwrap());
            Ok(())
        },
    );
    app
}

Ensuite, compilez et testez :

cargo build
inline-enum-type-name-override load

2. Clients SDK disponibles

L'appel super::sdk::client(ctx) retourne un inline_enum_type_name_override_sdk::api::Client avec les sous-clients suivants :

3. Motifs clés

Obtenir le client SDK (partage d'exécution, entièrement authentifié) :

let client = super::sdk::client(ctx);

Exécuter un appel SDK asynchrone depuis un gestionnaire synchrone :

let result = super::sdk::block_on(
    client.some_resource.some_method(args),
)?;

Utiliser les modèles typés pour la sérialisation requête/réponse :

use inline_enum_type_name_override_sdk::api::*;

Sécurité de la régénération

Après avoir exécuté fern generate, votre custom.rs est préservé. Tout le code généré (SDK, types, glue, main.rs) est mis à jour pour correspondre à la dernière spécification API. Si la surface du SDK change (méthodes renommées, nouveaux sous-clients), mettez à jour votre custom.rs en conséquence.

Compilation et test

# Compiler le CLI (inclut les commandes personnalisées)
cargo build

# Exécuter votre commande personnalisée
inline-enum-type-name-override <your-command> [args]

# Exécuter avec sortie détaillée pour déboguer
RUST_LOG=debug inline-enum-type-name-override <your-command> [args]