Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.13 KB

tool-hygiene.md

File metadata and controls

52 lines (40 loc) · 2.13 KB

Tool hygiene

Syntax hygiene signal

tool_hygiene_scorecard inclui uma camada report-only para higiene sintática quando fontes são fornecidas ao construtor do scorecard. A camada é language-agnostic por contrato e começa com regras JS/TS determinísticas.

Campos mínimos de evidência por achado:

  • patternId: regra estável, por exemplo js-ts-optional-chain-stack.
  • language: linguagem inferida ou declarada.
  • path e line: localização auditável.
  • severity: info, warn ou high.
  • snippet: trecho curto e estável.
  • decision: requires-rationale ou exception-recorded.
  • rationale: obrigatório quando uma exceção deliberada é aceita.

Padrões iniciais JS/TS:

  • js-ts-optional-chain-stack: cadeia longa de ?. que pode mascarar contrato de dados ausente.
  • js-ts-nested-ternary: ternário aninhado que aumenta custo cognitivo.
  • js-ts-fluent-chain-depth: cadeia fluente profunda que pode esconder etapas intermediárias relevantes.
  • js-ts-inline-dsl-template: DSL inline interpolada que exige justificativa de contrato/segurança.

Regra de revisão: achados não bloqueiam execução por si só; eles exigem decisão registrada. Exceções aceitáveis precisam declarar motivo de legibilidade de API pública, compatibilidade, performance ou contrato de segurança/teste.

Line budget configuration

line_budget_snapshot reads its scan scope from .pi/settings.json before falling back to the packaged default. This keeps the reusable primitive project-agnostic while letting this lab dogfood its own policy.

Path:

{
  "piStack": {
    "guardrailsCore": {
      "lineBudget": {
        "roots": ["packages/pi-stack"],
        "ignoredDirs": [".cache", ".pi-lens", "_site", "coverage", "dist", "node_modules"],
        "extensions": [".ts"],
        "ignoreDeclarationFiles": true,
        "thresholds": {
          "watch": 1000,
          "extract": 1400,
          "critical": 2000
        }
      }
    }
  }
}

The packet reports configSource, scanRoots, configWarnings, and thresholds so downstream projects can tell whether they are using project settings, user settings, or the default.