desenvolvimento · Referência do comando

`qzx formatCode`

O que faz

Detecta a linguagem e executa o formatador correspondente nos arquivos de código-fonte.

Maturidade do comando: Alpha

Disponível para uso real e feedback enquanto a interface e o comportamento ainda podem evoluir. Esta é a avaliação atual do checkout de desenvolvimento. Cada tag de release imutável futuro preservará a avaliação exata incluída nessa versão. Disponível no PyPI 0.2.2.0.9. A documentação corresponde ao checkout alpha 0.2.2.0.9.

Comportamento e proteções integradas

O modo real aplica as alterações solicitadas

Prévia disponível

Usa uma ferramenta nativa quando necessário

Funciona sem usar a rede

Usa suas permissões atuais; o resultado pode variar

A simulação apenas verifica o resultado dos formatadores e não precisa de backup. A formatação real só invoca ferramentas instaladas localmente depois de criar um backup recuperável do arquivo ou diretório selecionado.

O QZX cria um arquivo de recuperação antes das alterações reais; use --dangerously-bypass-approvals-and-sandbox/--yolo somente quando decidir ignorá-lo deliberadamente.

Esta classificação de segurança foi revisada por OpenAI GPT-5.6 Pro em relação ao digest de implementação sha256:8e1da26751942fe10264195b83fc29c5259e48eab9c7b2cf70717a0ed2ac665f em 2026-08-25.

Sintaxe exata

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

Parâmetros

Deslize ou use a barra horizontal para ver todas as colunas.

Nome	Tipo	Obrigatório	Padrão	Descrição
path	str	Sim	Não declarado	Arquivo ou diretório que será formatado
language	str	Não	""	Força uma linguagem específica (python, javascript, typescript, rust, go, php, c ou cpp). Por padrão, é detectada automaticamente.
dry_run	bool	Não	false	Verifica se os arquivos mudariam sem gravá-los (true/false)

Exemplos de entrada

qzx formatCode src/

Formatar todos os arquivos-fonte compatíveis de src/

qzx formatCode src/main.py

Formatar um único arquivo Python com black

qzx formatCode src/ python

Formatar somente os arquivos Python de src/

qzx formatCode src/ --dry-run

Simular a formatação para ver quais arquivos mudariam

Para obter o payload estruturado completo, adicione --json: qzx formatCode <path> [language] [dry_run] --json

Exemplo de saída representativa

Este JSON ilustrativo deriva do contrato de resultado respaldado pela implementação atual. Mostra o que o comando pode retornar sem afirmar que seja uma execução gravada; os valores variam conforme entradas, máquina, permissões e ferramentas opcionais.

Comando do exemplo: 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 o 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
}

Erros e limites

O contrato público exige success=false e uma message descritiva em caso de falha. Este catálogo ainda não declara uma taxonomia de erros específica para cada comando; revise o resultado e não infira códigos inexistentes.

O QZX está em alpha. Dependências opcionais, permissões e recursos do host podem alterar o resultado.

Fluxo de evidência: requer um ambiente privilegiado controlado.

Evidência e procedência

Implementação: src/qzx/commands/development/format_code.py
Testes: tests/test_development_commands/test_format_code.py
Canal de documentação: Documentação de desenvolvimento 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Disponibilidade: 0.2.2.0.9 ou anterior

Continue explorando

Estes comandos também pertencem à categoria desenvolvimento. Compare-os para escolher a operação que melhor resolve sua tarefa.

Explorar todos os comandos do QZX