biome icon indicating copy to clipboard operation
biome copied to clipboard

📎 Implement `biome lint --summary`

Open Conaclos opened this issue 10 months ago • 20 comments

Description

See rome#4747 for some context.

biome lint --summary should print a summary which allows figuring out which rule raised diagnostics and how many.

$ biome lint --summary src

Rule name                          Diagnostics
nursery/useNamingConvention        2509
style/useSingleCaseStatement       2000
...

Checked 657 file(s) in 3s
Skipped 2 file(s)

The summary should avoid unnecessary works (no need to call diagnostic and action on the rules).

We could suggest using --summary when the number of diagnostics exceeds max-diagnostics:

$ rome lint src
...
src/services/types.ts:1121:5 lint/nursery/useNamingConvention ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This property name should be in camelCase.
  
  > 1121 │     InsertSpaceAfterConstructor?: boolean;
         │     ^^^^^^^^^^^^^^^^^^^^^^^^^^
  
  ℹ The name could be renamed to `insertSpaceAfterConstructor`.


The number of diagnostics exceeds the number allowed by Biome.
Diagnostics not shown: 7564.
Checked 657 file(s) in 3s
Skipped 2 file(s)

Run `biome lint --summary src` to print a summary of the rules that emitted diagnistics.

Conaclos avatar Aug 23 '23 21:08 Conaclos