Module cmd

Command Line Interface Module

This module provides a secure and robust command-line interface (CLI) for the Shokunin Static Site Generator. It handles argument parsing, configuration management, and validation of user inputs to ensure that the static site generator operates reliably and securely.

Key Features

• Safe path handling (including symbolic link checks and canonicalization)
• Input validation (URL, language, environment variables)
• Secure configuration with size-limited config files
• Builder pattern for convenient configuration construction
• Error handling via CliError

Example Usage

use ssg::cmd::{Cli, ShokuninConfig};

fn main() -> anyhow::Result<()> {
    let matches = Cli::build().get_matches();

    // Attempt to load configuration from command-line arguments
    let mut config = ShokuninConfig::from_matches(&matches)?;

    println!("Configuration loaded: {:?}", config);
    // Continue with application logic...
    Ok(())
}

Structs

Cli

A simple CLI struct for building the Shokunin command.

LanguageCode

Type-safe representation of a language code.

ShokuninConfig

Core configuration for the static site generator.

ShokuninConfigBuilder

Builder for ShokuninConfig.

Enums

CliError

Possible errors that can occur during CLI operations.

Constants

DEFAULT_HOST

Default host for the local development server.

DEFAULT_PORT

Default port for the local development server.

DEFAULT_SITE_NAME

Default site name for the configuration.

DEFAULT_SITE_TITLE

Default site title for the configuration.

MAX_CONFIG_SIZE

Maximum allowed size in bytes for config files.

RESERVED_NAMES

Reserved names that cannot be used as paths on Windows systems.

Statics

DEFAULT_CONFIG

A static default configuration for the Shokunin site.

Functions

validate_url

Validates a URL for security and format.