Skip to content

ccproxy.cli.commands.config.schema_commands

ccproxy.cli.commands.config.schema_commands

Schema-related config commands for CCProxy API.

config_schema 

config_schema(
    output_dir=Option(
        None,
        "--output-dir",
        "-o",
        help="Output directory for schema files (default: current directory)",
    ),
)

Generate JSON Schema files and taplo configuration for TOML validation.

This command generates JSON Schema files that can be used by editors for configuration file validation, autocomplete, and syntax highlighting. Supports TOML, JSON, and YAML configuration files. Automatically generates taplo configuration for enhanced TOML editor support.

Examples:

ccproxy config schema # Generate schema files and taplo config in current directory ccproxy config schema --output-dir ./schemas # Generate in specific directory

Source code in ccproxy/cli/commands/config/schema_commands.py 
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
def config_schema(
    output_dir: Path | None = typer.Option(
        None,
        "--output-dir",
        "-o",
        help="Output directory for schema files (default: current directory)",
    ),
) -> None:
    """Generate JSON Schema files and taplo configuration for TOML validation.

    This command generates JSON Schema files that can be used by editors
    for configuration file validation, autocomplete, and syntax highlighting.
    Supports TOML, JSON, and YAML configuration files. Automatically generates
    taplo configuration for enhanced TOML editor support.

    Examples:
        ccproxy config schema                         # Generate schema files and taplo config in current directory
        ccproxy config schema --output-dir ./schemas # Generate in specific directory
    """
    toolkit = get_rich_toolkit()

    try:
        # Generate schema files
        if output_dir is None:
            output_dir = Path.cwd()

        toolkit.print(
            "Generating JSON Schema files for TOML configuration...", tag="info"
        )

        generated_files = generate_schema_files(output_dir)

        for file_path in generated_files:
            toolkit.print(f"Generated: {file_path}", tag="success")

        toolkit.print("Generating taplo configuration...", tag="info")
        taplo_config = generate_taplo_config(output_dir)
        toolkit.print(f"Generated: {taplo_config}", tag="success")

        toolkit.print_line()
        toolkit.print("Schema files generated successfully!", tag="success")
        toolkit.print_line()
        toolkit.print("To use in VS Code:", tag="info")
        toolkit.print("1. Install the 'Even Better TOML' extension", tag="info")
        toolkit.print(
            "2. The schema will be automatically applied to ccproxy TOML files",
            tag="info",
        )
        toolkit.print_line()
        toolkit.print("To use with taplo CLI:", tag="info")
        toolkit.print("  taplo check your-config.toml", tag="command")

    except Exception as e:
        toolkit.print(f"Error generating schema: {e}", tag="error")
        raise typer.Exit(1) from e

config_validate 

config_validate(
    config_file=Argument(
        ...,
        help="Configuration file to validate (TOML, JSON, or YAML)",
    ),
)

Validate a configuration file against the schema.

This command validates a configuration file (TOML, JSON, or YAML) against the JSON Schema to ensure it follows the correct structure and data types.

Examples:

ccproxy config validate config.toml # Validate a TOML config ccproxy config validate config.yaml # Validate a YAML config ccproxy config validate config.json # Validate a JSON config

Source code in ccproxy/cli/commands/config/schema_commands.py 
 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
def config_validate(
    config_file: Path = typer.Argument(
        ...,
        help="Configuration file to validate (TOML, JSON, or YAML)",
    ),
) -> None:
    """Validate a configuration file against the schema.

    This command validates a configuration file (TOML, JSON, or YAML) against
    the JSON Schema to ensure it follows the correct structure and data types.

    Examples:
        ccproxy config validate config.toml  # Validate a TOML config
        ccproxy config validate config.yaml  # Validate a YAML config
        ccproxy config validate config.json  # Validate a JSON config
    """
    toolkit = get_rich_toolkit()

    try:
        # Validate the config file
        if not config_file.exists():
            toolkit.print(f"Error: File {config_file} does not exist.", tag="error")
            raise typer.Exit(1)

        toolkit.print(f"Validating {config_file}...", tag="info")

        try:
            is_valid = validate_config_with_schema(config_file)
            if is_valid:
                toolkit.print(
                    "Configuration file is valid according to schema.", tag="success"
                )
            else:
                toolkit.print("Configuration file validation failed.", tag="error")
                raise typer.Exit(1)
        except ImportError as e:
            toolkit.print(f"Error: {e}", tag="error")
            toolkit.print(
                "Install check-jsonschema: pip install check-jsonschema", tag="error"
            )
            raise typer.Exit(1) from e
        except Exception as e:
            toolkit.print(f"Validation error: {e}", tag="error")
            raise typer.Exit(1) from e

    except Exception as e:
        toolkit.print(f"Error validating configuration: {e}", tag="error")
        raise typer.Exit(1) from e