a package with a `bin` entry: console output is the product, not debug logging (M2)

Aperta
#425 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
node.js, typescript
Ambito
cli, tooling

Direzione di ricerca

Start with centralized-logging.ts around lines 21-39 and compare its TypeScript handling with the Python PY_ALLOWED behavior. Trace the package.json bin entry into the command layer and inspect the cited src/cli/*, audit-engine.ts, and hooks/installer.ts output. Keep library logging violations visible; done means CLI log/info/warn output is exempted while debug/trace remains counted and logging sink modules are recognized or configurable.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug

Found in the 8.0.0 self-audit triage: RoC 7.29.1 (npm, 5fc54afe) on a clean clone of develop at 2d2fa9a, with typescript resolvable (verdict compliance, 0 failed / 46 warnings). The bucket method and per-law tables are kept by QA; counts are from that run.

What happens

Absolute Zero Tolerance (console template, 15 of 20 false) and Centralized Logging (10 of 18 false) count every console.* call as stray logging. In a CLI, console.log/info/warn in the command layer and report renderer is the user interface: src/cli/*, the report rendering in audit-engine.ts (about 70 of its 84 calls), hooks/installer.ts progress output. The Python branch of Centralized Logging already exempts CLI entry points (PY_ALLOWED); the TypeScript branch does not (centralized-logging.ts:37-39). The logger allowlist accepts only files named logger.service.ts|main.ts (:21-22), so a project's own logging module (logging-utils.ts) is flagged too.

Real debt remains and should stay visible: library code that bypasses the project's logger (e.g. a cache write warning, [DEBUG] output in a discovery helper, a console.log inside a law service during an audit).

Suggested direction

When package.json declares bin, treat console.log/info/warn in the modules reachable from the bin entry's command layer as product output and keep counting console.debug/trace; recognise a logging sink module (logger., logging, log.ts) or make it configurable.

Lingua principale
TypeScript
Stelle
0
Fork
0
Merge medio
38m
PR unite (30g)
96

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Rule-Of-Code/RoC

Tutte le issue di Rule-Of-Code/RoC

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.