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

Abierto
#43 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
tooling

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
38 min
PR fusionados (30 d)
96

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Rule-Of-Code/RoC

Todos los issues de Rule-Of-Code/RoC

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.