Add DoNotUseIsOneAssertions rule #37
Conversation
nakulpathak3
force-pushed
the
nakul.doNotUseIsOne
branch
from
6806a47 to
ff7a853
Compare
|
PR to remove the inverse rule from backend - https://github.com/Faire/backend/pull/146826 |
| { DoNotUseIsOneAssertions(it) }, | ||
| ) { | ||
| @Test | ||
| fun `using isOne causes failure`() { |
There was a problem hiding this comment.
Add a test for calling isOne() with a receiver context that is not an assertion method?
| @@ -42,6 +43,7 @@ internal class FaireRulesProvider : RuleSetProvider { | |||
| DoNotUseHasSizeForEmptyListInAssert(config), | |||
| DoNotUseIsEqualToWhenArgumentIsOne(config), | |||
| DoNotUseIsEqualToWhenArgumentIsZero(config), | |||
| DoNotUseIsOneAssertions(config), | |||
There was a problem hiding this comment.
Because this rule directly contradicts DoNotUseIsEqualToWhenArgumentIsOne, do we have to worry about both rules being enabled by default? I think the official detekt team usually adds rules disabled by default.
There was a problem hiding this comment.
Is the way to have it disabled by default to just not add it to this file? I'm dropping that one for backend in this PR.
There was a problem hiding this comment.
Talked offline, we'll let users of these rules just update their config file when they update the version.
nakulpathak3
force-pushed
the
nakul.doNotUseIsOne
branch
from
76eca40 to
4539950
Compare
Following these steps from @Adriel-M to get my rule available in the backend repo - #37 To do a release you must: * [This PR] bump version here (after your change gets merged in): https://github.com/Faire/faire-detekt-rules/blob/main/gradle.properties * Run this workflow https://github.com/Faire/faire-detekt-rules/actions/workflows/release.yml (at this point, this is going to publish to maven central :nodders: ) * (optional but you should) git tag that commit to the same version in 1 * create a release here: https://github.com/Faire/faire-detekt-rules/releases * If you want to test out the rule on backend before actually creating a release, I did create this write up in our other repo: https://github.com/Faire/sqldelight-cockroachdb-dialect?tab=readme-ov-file#using-a-snapshot-release
Moving it over here as per https://github.com/Faire/backend/pull/144173#discussion_r1586541528.
JIRA Ticket: https://fairewholesale.atlassian.net/browse/FD-208736