desarrollo · Referencia de comando

`qzx formatCode`

Qué hace

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

Comando canónico: formatCode

Alias aceptados: fmtCode, codeFmt, formatSource

Distingue mayúsculas: no

Incluido en el paquete publicado

Disponible en PyPI 0.2.2.0.2. La documentación corresponde al checkout alpha 0.2.2.0.2.

Seguridad y efectos

Puede modificar estado

Parámetro dry-run documentado

Puede invocar programas nativos

Sin uso de red documentado

No requiere elevación de forma inherente

Esta clasificación de seguridad se revisó contra el digest de implementación sha256:f93b0c96991a38102376c1638c2839eed6745ba69a8bcd1a9f35e27656140159 el 2026-07-25.

Sintaxis exacta

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

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
path	str	Sí	No declarado	File or directory to format
language	str	No	""	Force a specific language (python, javascript, typescript, rust, go, php, c, cpp). Auto-detected by default.
dry_run	str	No	"false"	Check if files would be changed without writing (true/false)

Ejemplos de entrada

qzx formatCode src/

Format all supported source files in src/

qzx formatCode src/main.py

Format a single Python file with black

qzx formatCode src/ python

Format only Python files in src/

qzx formatCode src/ "" true

Dry-run format to see which files would change

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.",
    "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"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "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 destino desechable aislado.

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.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Disponibilidad: 0.2.2.0.2 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