desarrollo · Referencia de comando

`qzx formatCode`

Qué hace

Detecta el lenguaje y ejecuta el formateador correspondiente sobre archivos de código fuente.

Madurez del comando: Alpha

Disponible para uso real y retroalimentación mientras su interfaz y comportamiento todavía pueden evolucionar. Esta es la evaluación actual del checkout de desarrollo. Cada futuro tag inmutable de release conservará la evaluación exacta incluida en esa versión. Disponible en PyPI 0.2.2.0.8. La documentación corresponde al checkout alpha 0.2.2.0.8.

Comportamiento y protecciones integradas

El modo real aplica los cambios que solicites

Vista previa disponible

Usa una herramienta nativa cuando hace falta

Funciona sin usar la red

Usa tus permisos actuales; el resultado puede variar

La simulación solo comprueba el resultado de los formateadores y no necesita respaldo. El formateo real invoca herramientas instaladas localmente únicamente después de crear un respaldo recuperable del archivo o directorio seleccionado.

QZX crea un archivo de recuperación antes de los cambios reales; usa --dangerously-bypass-approvals-and-sandbox/--yolo solo cuando decidas omitirlo deliberadamente.

Esta clasificación de seguridad fue revisada por OpenAI GPT-5.6 Pro contra el digest de implementación sha256:8e1da26751942fe10264195b83fc29c5259e48eab9c7b2cf70717a0ed2ac665f el 2026-08-25.

Sintaxis exacta

qzx formatCode <path> [language] [dry_run] --json

Parámetros

Desliza o usa la barra horizontal para ver todas las columnas.

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
path	str	Sí	No declarado	Archivo o directorio que se formateará
language	str	No	""	Fuerza un lenguaje específico (python, javascript, typescript, rust, go, php, c o cpp). De forma predeterminada se detecta automáticamente.
dry_run	bool	No	false	Comprueba si los archivos cambiarían sin escribirlos (true/false)

Ejemplos de entrada

qzx formatCode src/

Formatear todos los archivos fuente compatibles de src/

qzx formatCode src/main.py

Formatear un solo archivo Python con black

qzx formatCode src/ python

Formatear únicamente los archivos Python de src/

qzx formatCode src/ --dry-run

Simular el formateo para ver qué archivos cambiarían

Para obtener la carga estructurada completa, añade --json: qzx formatCode <path> [language] [dry_run] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: qzx formatCode src/ --json

{
    "success": true,
    "message": "Formats source code files by auto-detecting language and invoking the right formatter. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "formatCode",
        "command_maturity": {
            "stage": "alpha",
            "label": "Alpha",
            "sequence": 2,
            "public_executable": true,
            "stability": "interface_may_change",
            "summary": "Available for real use and feedback while its interface and behavior can still evolve.",
            "promotion_review_required": false,
            "assessment_scope": "development_checkout"
        },
        "duration_ms": 0,
        "schema_version": 1
    },
    "all_succeeded": true,
    "dry_run": true,
    "failed": [
        "Example value"
    ],
    "failed_count": 3,
    "formatted": [
        "Example value"
    ],
    "formatted_count": 3,
    "path": "C:\\project\\example.txt",
    "skipped": [
        "Example value"
    ],
    "skipped_count": 3,
    "total_files": 3,
    "unavailable_tools": []
}

Ver el contrato de resultado JSON

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "meta": {
            "type": "object",
            "required": [
                "command",
                "command_maturity",
                "duration_ms",
                "schema_version"
            ],
            "properties": {
                "command": {
                    "type": "string"
                },
                "command_maturity": {
                    "type": "object",
                    "required": [
                        "stage",
                        "label",
                        "sequence",
                        "public_executable",
                        "stability",
                        "summary",
                        "promotion_review_required",
                        "assessment_scope"
                    ],
                    "properties": {
                        "stage": {
                            "type": "string"
                        },
                        "label": {
                            "type": "string"
                        },
                        "sequence": {
                            "type": "integer"
                        },
                        "public_executable": {
                            "type": "boolean"
                        },
                        "stability": {
                            "type": "string"
                        },
                        "summary": {
                            "type": "string"
                        },
                        "promotion_review_required": {
                            "type": "boolean"
                        },
                        "assessment_scope": {
                            "type": "string"
                        },
                        "note": {
                            "type": "string"
                        },
                        "review": {
                            "type": "object",
                            "required": [
                                "reviewed_on",
                                "rationale",
                                "evidence"
                            ],
                            "properties": {
                                "reviewed_on": {
                                    "type": "string",
                                    "format": "date"
                                },
                                "rationale": {
                                    "type": "string"
                                },
                                "evidence": {
                                    "type": "array",
                                    "minItems": 1,
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "replacement": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": true
                },
                "duration_ms": {
                    "type": "number"
                },
                "schema_version": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "all_succeeded": {
            "type": "boolean"
        },
        "dry_run": [],
        "error": {
            "type": "string"
        },
        "failed": {
            "type": "array"
        },
        "failed_count": {
            "type": "integer"
        },
        "formatted": {
            "type": "array"
        },
        "formatted_count": {
            "type": "integer"
        },
        "path": [],
        "skipped": {
            "type": "array"
        },
        "skipped_count": {
            "type": "integer"
        },
        "total_files": {
            "type": "integer"
        },
        "unavailable_tools": {
            "type": "array"
        }
    },
    "additionalProperties": true
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: requiere un entorno privilegiado controlado.

Evidencia y procedencia

Implementación: src/qzx/commands/development/format_code.py
Pruebas: tests/test_development_commands/test_format_code.py
Canal de documentación: Documentación de desarrollo 0.2.2.0.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
Disponibilidad: 0.2.2.0.8 o anterior

Sigue explorando

Estos comandos también pertenecen a la categoría de desarrollo. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX