detekt/detekt

List currently active rules

Aperta

#5524 aperta il 9 nov 2022

Vedi su GitHubGuida contributor
 (9 commenti) (0 reazioni) (0 assegnatari)Kotlin (834 fork)batch import
featurehelp wanted

Metriche repository

Star
 (6942 stelle)
Metriche merge PR
 (Merge medio 4g 9h) (65 PR mergiate in 30 g)

Descrizione

When I run ./gradlew detekt, it lists only issues in my code.

I'd like to see a list of currently active rules, combining the default and my own configs. This would be an useful overview, since I disable many rules in my config, and it's hard to track which are actually enabled.

Bonus points for comparison with the default config, so I see which custom configs I could delete.

I'd like a table such as this in a report for example.

ruleset rule default config custom config
formatting AnnotationOnSeparateLine disabled -
formatting ChainWrapping enabled disabled
...

Guida contributor

Direzione di ricerca
Esplora il codebase di detekt per capire come vengono caricati e configurati i set di regole e come viene generato il report corrente. Implementa un nuovo report o un'opzione CLI che elenchi tutte le regole attive, unendo le configurazioni predefinite e personalizzate. Considera l'uso del provider di regole esistente e del merger di configurazioni. L'output dovrebbe essere una tabella o un formato strutturato. Confronta con la configurazione predefinita per evidenziare le personalizzazioni.
Tech stack
kotlin
Dominio
tooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
KotlinGradle
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50