qzx diagnoseProject

Exemplo de saída observada

Capturado com QZX 0.2.2.0.9 no Windows 11; código de saída 0. Valores dependentes do host e a duração podem variar.

Comando do exemplo: qzx diagnoseProject ../artifacts/qzx-evidence/project-doctor --json

{
    "success": true,
    "message": "Project diagnosis completed with 1 observed issue. 2 configured validation workflows were discovered but not executed; run the suggested commands before treating the project as release-ready.",
    "details": {
        "path": "C:\\Team Dropbox\\Valis Idealis\\Ale\\Programacion\\QZX - Quick Zap Exchange\\artifacts\\qzx-evidence\\project-doctor",
        "technologies": [
            "Python"
        ],
        "dependencies": {
            "manifest_count": 1,
            "manifests_found": [
                "pyproject.toml"
            ],
            "total_declaration_count": 1,
            "unique_declared_package_count": 1,
            "unique_packages": [
                "httpx"
            ],
            "parse_errors": [],
            "manifests": [
                {
                    "path": "pyproject.toml",
                    "ecosystem": "python",
                    "status": "parsed",
                    "declaration_count": 1,
                    "group_counts": {
                        "runtime": 1
                    },
                    "packages": [
                        "httpx"
                    ]
                }
            ],
            "counting_note": "Declaration totals include repeated packages across manifests and dependency groups; unique_declared_package_count deduplicates normalized package names."
        },
        "environment": {
            "local_files": [],
            "template_files": [],
            "local_configuration_present": false,
            "template_present": false,
            "values_inspected": false,
            "note": "Only environment filenames are reported; diagnoseProject never reads or returns environment values."
        },
        "validation": {
            "execution_policy": "discovery_only",
            "execution_note": "diagnoseProject never executes project-owned tests, linters, type checkers, builds, package scripts, hooks, or installers.",
            "tests": {
                "configured": true,
                "status": "configured_not_run",
                "tools": [
                    "pytest"
                ],
                "configs": [
                    "tests",
                    "pyproject.toml [tool.pytest]"
                ],
                "commands": [
                    "python -m pytest"
                ]
            },
            "lint": {
                "configured": true,
                "status": "configured_not_run",
                "tools": [
                    "ruff"
                ],
                "configs": [
                    "pyproject.toml [tool.ruff]"
                ],
                "commands": [
                    "python -m ruff check ."
                ]
            },
            "type_checking": {
                "configured": false,
                "status": "not_configured",
                "tools": [],
                "configs": [],
                "commands": []
            },
            "build": {
                "configured": false,
                "status": "not_configured",
                "tools": [],
                "configs": [],
                "commands": []
            }
        },
        "version_control": {
            "status": "not_repository",
            "reason": "Git did not identify a repository for this path."
        },
        "source_analysis": {
            "unused_code": {
                "status": "passed",
                "candidate_symbols_count": 0,
                "candidate_symbols": [],
                "interpretation": "Candidates have no statically visible references; review dynamic uses before removal."
            },
            "circular_imports": {
                "status": "passed",
                "cycles_count": 0,
                "cycles": []
            }
        },
        "file_scan": {
            "scanned_file_count": 3,
            "maximum_file_count": 5000,
            "scan_complete": true,
            "error_count": 0,
            "large_file_threshold_bytes": 1048576,
            "large_file_threshold_formatted": "1.00 MB",
            "large_file_count": 0,
            "large_files": []
        },
        "summary": {
            "status": "review",
            "issue_count": 1,
            "informational_count": 0,
            "issue_counts_by_severity": {
                "high": 0,
                "medium": 0,
                "low": 1,
                "info": 0
            },
            "issues": [
                {
                    "code": "git_not_detected",
                    "severity": "low",
                    "title": "Git repository not detected",
                    "description": "The inspected path is not inside a Git working tree.",
                    "remediation": "Use version control for maintained source projects or confirm that this directory is intentionally unversioned."
                }
            ],
            "verification": {
                "level": "partial",
                "release_readiness": "not_assessed",
                "verified_areas": [
                    "technology and manifest discovery",
                    "dependency declaration inventory",
                    "Git working-tree state when Git is available",
                    "static unused-code candidates",
                    "static circular-import analysis",
                    "bounded large-file scan"
                ],
                "configured_but_not_run": [
                    "tests",
                    "lint"
                ],
                "suggested_commands": [
                    "python -m pytest",
                    "python -m ruff check ."
                ],
                "reason": "The command performs read-only inspection and never executes project-owned validation or build scripts."
            }
        }
    },
    "report": "PROJECT BRIEFING\nPath: C:\\Team Dropbox\\Valis Idealis\\Ale\\Programacion\\QZX - Quick Zap Exchange\\artifacts\\qzx-evidence\\project-doctor\nTechnologies: Python\nDependencies: 1 unique declared package in 1 manifest\nGit: repository not detected\nFile scan: 3 files; complete; 0 larger than 1.00 MB\n\nFINDINGS - Review recommended\n1 issues; 0 informational observations\n1. [LOW] Git repository not detected\n   Next: Use version control for maintained source projects or confirm that this\n   directory is intentionally unversioned.\n\nVALIDATION - DISCOVERED, NOT RUN\nTests: configured, not run\nLint: configured, not run\nType checks: not detected\nBuild: not detected\n\nReview the project scripts before running these commands.\nRun from: C:\\Team Dropbox\\Valis Idealis\\Ale\\Programacion\\QZX - Quick Zap Exchange\\artifacts\\qzx-evidence\\project-doctor\n  python -m pytest\n  python -m ruff check .\n\nRelease readiness: NOT ASSESSED. Inspection is not a test run.\nUse --json for the full structured evidence and finding descriptions.",
    "meta": {
        "command": "diagnoseProject",
        "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": 138.716,
        "schema_version": 1
    }
}

{
    "$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
        },
        "details": {
            "type": "object",
            "properties": {
                "path": [],
                "technologies": [],
                "dependencies": [],
                "environment": [],
                "validation": [],
                "version_control": [],
                "source_analysis": [],
                "file_scan": [],
                "summary": []
            },
            "additionalProperties": true
        },
        "error": {
            "type": "string"
        },
        "report": []
    },
    "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.

{
    "success": false,
    "error": "Path '../artifacts/qzx-evidence/missing-golden-core-path' does not exist.",
    "message": "Cannot diagnose the project because '../artifacts/qzx-evidence/missing-golden-core-path' does not exist.",
    "meta": {
        "command": "diagnoseProject",
        "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": 3.356,
        "schema_version": 1
    }
}

Comando capturado: qzx diagnoseProject ../artifacts/qzx-evidence/missing-golden-core-path --json

Fluxo de evidência: capturada e validada por digest.