hedl-cli 2.0.0

HEDL command-line interface
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
122
123
124

// Dweve HEDL - Hierarchical Entity Data Language
//
// Copyright (c) 2025 Dweve IP B.V. and individual contributors.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file at the
// root of this repository or at: http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! CLI command definitions and argument parsing.
//!
//! This module contains all command-line interface structures for the HEDL CLI,
//! organized into logical categories for better maintainability.
//!
//! # Organization
//!
//! Commands are organized into the following modules:
//!
//! - `core`: Core commands (validate, format, lint, inspect, stats)
//! - `conversion`: Format conversion commands (JSON, YAML, XML, CSV, Parquet)
//! - `batch`: Batch processing commands (batch-validate, batch-format, batch-lint)
//! - `completion`: Shell completion generation
//!
//! # Design Principles
//!
//! - **Single Responsibility**: Each submodule handles one category of commands
//! - **Consistent API**: All commands follow the same argument patterns
//! - **Type Safety**: Strongly typed arguments with validation
//! - **Extensibility**: Easy to add new commands within existing categories

mod batch;
mod completion;
mod conversion;
mod core;

use clap::Subcommand;

pub use batch::BatchCommands;
pub use completion::CompletionCommands;
pub use conversion::ConversionCommands;
pub use core::CoreCommands;

/// Top-level CLI commands enum.
///
/// This is the main command dispatcher that delegates to specialized command
/// categories. Each variant represents a category of related commands.
///
/// # Architecture
///
/// The commands are organized hierarchically:
///
/// ```text
/// Commands
/// ├── Core (validate, format, lint, inspect, stats)
/// ├── Conversion (JSON, YAML, XML, CSV, Parquet)
/// ├── Batch (batch-validate, batch-format, batch-lint)
/// └── Completion (shell completion generation)
/// ```
///
/// # Examples
///
/// ```no_run
/// use clap::Parser;
/// use hedl_cli::cli::Commands;
///
/// #[derive(Parser)]
/// struct Cli {
///     #[command(subcommand)]
///     command: Commands,
/// }
/// ```
#[derive(Subcommand)]
pub enum Commands {
    /// Core commands (validate, format, lint, inspect, stats).
    #[command(flatten)]
    Core(CoreCommands),

    /// Conversion commands (JSON, YAML, XML, CSV, Parquet).
    #[command(flatten)]
    Conversion(ConversionCommands),

    /// Batch processing commands (batch-validate, batch-format, batch-lint).
    #[command(flatten)]
    Batch(BatchCommands),

    /// Shell completion generation.
    #[command(flatten)]
    Completion(CompletionCommands),
}

impl Commands {
    /// Execute the command with the provided arguments.
    ///
    /// This method dispatches to the appropriate command handler based on the
    /// command variant.
    ///
    /// # Returns
    ///
    /// Returns `Ok(())` on successful execution, or an error message on failure.
    ///
    /// # Errors
    ///
    /// Returns `Err` if:
    /// - File I/O fails
    /// - Parsing or validation fails
    /// - Conversion fails
    /// - Any other command-specific error occurs
    pub fn execute(self) -> Result<(), crate::error::CliError> {
        match self {
            Commands::Core(cmd) => cmd.execute(),
            Commands::Conversion(cmd) => cmd.execute(),
            Commands::Batch(cmd) => cmd.execute(),
            Commands::Completion(cmd) => cmd.execute(),
        }
    }
}