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

Đang mở
#425 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
node.js, typescript
Lĩnh vực
cli, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
38 phút
Pull request đã merge (30 ngày)
96

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Rule-Of-Code/RoC

Tất cả issue của Rule-Of-Code/RoC

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.