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

オープン
#425 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
node.js, typescript
領域
cli, tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
TypeScript
スター
0
フォーク
0
平均マージ
38分
マージ済み PR(30日)
96

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Rule-Of-Code/RoC のほかの issue

Rule-Of-Code/RoC の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。