Laws report a count where they could report the artefacts (violationDetails is unused by 223 of 225 laws)

Đang mở
#43 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
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
tooling

Hướng nghiên cứu

Start by reading the LawResult definition and the console renderer’s handling of violationDetails, then inspect laws that already populate that channel and laws that count resolved files. For each suitable law, identify the evidence it actually has and report it without removing the aggregate violation line. Done when applicable laws expose useful per-violation evidence and the existing truncation and --verbose behavior still applies.

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

Mô tả

enhancement

Split out of #42, which fixed the part that needed no new plumbing: the
suggestions laws already compute are no longer discarded by the renderer.

This is the part that does need plumbing.

The state of it

LawResult has a violationDetails channel — { file, line, column, message } — and the console renderer already displays it under
📁 Affected files:, with truncation and a --verbose override.

Two law files out of 225 populate it.

So the mechanism for "this violation, at this path, on this line" exists,
is rendered, and is almost entirely unused. Laws report an aggregate string
instead: "21 source files lack corresponding test files", "115 magic numbers found". The count is derived from a list the law had in hand and
then let go of.

Why it matters

From the consumer report that prompted #42:

To answer "which 21 files", we wrote a script that walks the tree, pairs
sources with specs and categorises what is left. [...] it found 26 where
the law found 21, and we never learned where the difference lay.

We could not tell whether the 5-file discrepancy was our script being
wrong or the law counting something we could not see, so we could not
argue about the law's correctness on the evidence.

That last sentence is the cost. A law that cannot show its evidence cannot
be argued with, and a law that cannot be argued with gets parked. Our own
detectionLimits are the same idea applied to the law's design; this is
the same honesty applied to its output.

It is also the cheapest false-positive detector we could have. Several of
the defects closed in #41 would have been visible on sight if the law had
named the artefacts — jest.preset.js appearing in a list of "source files
lacking tests" needs no analysis at all.

Scope

  • Populate violationDetails wherever a law counts files it has already
    resolved. Not every law can: some are answering "does this project
    declare X" and have a config key rather than a path — those should carry
    the key and the paths searched.
  • Keep the aggregate violation line. It is the right summary; the detail
    belongs underneath it.
  • Truncation and --verbose are already handled by the renderer.

Deliberately not a single sweep: this is per-law work with a per-law
judgement about what the evidence actually is, and a mass edit that
populates the field with something vague would be worse than the current
honest silence.

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.