pengembangan · Referensi perintah

`qzx formatCode`

Apa fungsinya

Mendeteksi bahasa dan menjalankan formatter yang sesuai pada file kode sumber.

Kematangan perintah: Alpha

Tersedia untuk penggunaan nyata dan umpan balik sementara antarmuka serta perilakunya masih dapat berkembang. Ini adalah evaluasi saat ini untuk checkout pengembangan. Setiap tag rilis immutable di masa mendatang akan mempertahankan evaluasi persis yang disertakan dalam versi tersebut. Tersedia di PyPI 0.2.2.0.9. Dokumentasi ini sesuai dengan checkout alpha 0.2.2.0.9.

Perilaku dan perlindungan bawaan

Mode nyata menerapkan perubahan yang Anda minta

Pratinjau tersedia

Menggunakan alat native saat diperlukan

Berfungsi tanpa menggunakan jaringan

Menggunakan izin Anda saat ini; hasil dapat bervariasi

Simulasi hanya memeriksa hasil formatter dan tidak memerlukan cadangan. Formatting nyata hanya memanggil alat yang terpasang secara lokal setelah membuat cadangan yang dapat dipulihkan dari file atau direktori yang dipilih.

QZX membuat arsip pemulihan sebelum perubahan nyata; gunakan --dangerously-bypass-approvals-and-sandbox/--yolo hanya jika Anda sengaja memilih untuk melewatinya.

Klasifikasi keamanan ini ditinjau oleh OpenAI GPT-5.6 Pro terhadap digest implementasi sha256:8e1da26751942fe10264195b83fc29c5259e48eab9c7b2cf70717a0ed2ac665f pada 2026-08-25.

Sintaks persis

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

Parameter

Geser atau gunakan bilah horizontal untuk melihat semua kolom.

Nama	Tipe	Wajib	Default	Deskripsi
path	str	Ya	Tidak dideklarasikan	File atau direktori yang akan diformat
language	str	Tidak	""	Memaksa bahasa tertentu (python, javascript, typescript, rust, go, php, c, atau cpp). Secara default dideteksi otomatis.
dry_run	bool	Tidak	false	Memeriksa apakah file akan berubah tanpa menuliskannya (true/false)

Contoh input

qzx formatCode src/

Format semua file sumber yang didukung di src/

qzx formatCode src/main.py

Format satu file Python dengan black

qzx formatCode src/ python

Format hanya file Python di src/

qzx formatCode src/ --dry-run

Simulasikan formatting untuk melihat file mana yang akan berubah

Untuk mendapatkan payload terstruktur lengkap, tambahkan --json: qzx formatCode <path> [language] [dry_run] --json

Contoh output representatif

JSON ilustratif ini berasal dari kontrak hasil yang didukung implementasi saat ini. Ini menunjukkan apa yang dapat dikembalikan perintah tanpa mengklaim sebagai eksekusi yang direkam; nilainya bervariasi menurut input, mesin, izin, dan alat opsional.

Perintah contoh: 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": []
}

Lihat kontrak hasil 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
}

Kesalahan dan batasan

Kontrak publik mensyaratkan success=false dan message yang deskriptif saat gagal. Katalog ini belum mendeklarasikan taksonomi kesalahan khusus untuk setiap perintah; periksa hasil dan jangan menyimpulkan kode yang tidak ada.

QZX masih dalam tahap alpha. Dependency opsional, izin, dan kemampuan host dapat mengubah hasil.

Alur bukti: memerlukan lingkungan privileged yang terkontrol.

Bukti dan asal-usul

Implementasi: src/qzx/commands/development/format_code.py
Pengujian: tests/test_development_commands/test_format_code.py
Kanal dokumentasi: Dokumentasi pengembangan 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Ketersediaan: 0.2.2.0.9 atau lebih lama

Lanjut jelajahi

Perintah ini juga termasuk kategori pengembangan. Bandingkan untuk memilih operasi yang paling sesuai bagi tugas Anda.

Jelajahi semua perintah QZX