saveourtool/diktat

Optional rule: require should have a message unless it's inside code from tests

Open

#838 aperta il 22 apr 2021

Vedi su GitHub
 (1 commento) (0 reazioni) (1 assegnatario)Kotlin (40 fork)github user discovery
enhancementgood first issue

Metriche repository

Star
 (571 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Preconditions from Kotlin stdlib (require, requireNotNull) accept an optional message parameter. If it's not set, failed precondition results in exceptions like Requirement failed at class:line:col. This is not useful and confusing. Unless require or requireNotNull is used in tests, it should be provided with exception message.

require(a.condition())
requireNotNull(b)

should be something like

require(a.condition()) { "Condition is not met for $a" }
requireNotNull(b) { "b is not set" }

Sure, we can't suggest exact text of these messages, so the possible inspection should only warn.

Guida contributor

Direzione di ricerca
Implementa una regola per rilevare chiamate a require e requireNotNull senza argomento messaggio, escludendo il codice di test. La regola dovrebbe avvertire della mancanza del messaggio.
Tech stack
kotlin
Dominio
tooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
Kotlin
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70