Adding custom rules to my own project

[vorobeij]

Hello,

I am wandering, can I add custom rules in my project without adding them to diktat repository?
I can do it with pure ktlint, but dikat has an amazing test framework. Can I add packages diktat-common and diktat-test-framework as gradle dependency to create my own rules?

Something like this (pseudocode):
app's build.gradle

apply diktat
apply ktlint

module's build.gradle

use ktlint rules from lint-rules module

Project structure
app
-module1
-module2
-lint-rules
--config.yaml
--src with my rules and tests for them

[orchestr7]

1. Of course you can use it as dependencies, our test-framework and common module are separate packages. See: https://mvnrepository.com/artifact/org.cqfn.diktat/diktat-test-framework

2. Also - keep in mind that you can simply write your own ruleset (as diktat) and pass it to ktlint together with diktat ruleset. Ktlint supports multiple rulesets. We have even added special functionality to disable standard ktlint ruleset. See: Adding new option disable-standard-rules pinterest/ktlint#977
   You will just need to run ktlint --disabled_rules=standard -R yourRuleSet.jar, diktat.jar (or do the same using the ktlint gradle plugin)

[petertrr]

Hi, @SJOwl !
Yes, you can use diktat-test-framework as a dependency for testing your rules. It's a pretty generic framework that doesn't even depend on ktlint, so you'll need something like our FixTestBase: basically, there are two things:

• TestComparatorUnit is set up to run ktlint's format method
• TestComparatorUnit.compareFilesFromResources is called to run and compare output

Alternatively, you can include your rules in diktat itself: diktat uses the same rules format as ktlint, so providing a jar with your rules as a classpath dependency for diktat-gradle-plugin should be enough. To do so you can include it in diktat configuration that is created when applying diktat plugin, like that (I'm more familiar with gradle kotlin DSL than groovy, so there might be some errors):

apply 'org.cqfn.diktat.diktat-gradle-plugin'

configurations.getByName("diktat").dependencies.add("your lint-rules")

[orchestr7]

Also - the code you are providing is simply not compiling. There are no static analysers in the world that fix compilation issues :) This is why it is not fixed and you have exceptions

[lyharrietbui]

@akuleshov7 That's right. My bad. When I do ./gradlew :spotlessApply, it actually fix the violation it is supposed to fix. I just need to fix a different error first that couldn't be fixed automatically

[lyharrietbui]

@akuleshov7 After reviewing the use case with my team, we think that the current multi if-else feature is sufficient for the time being. I am still interested in having a PR up but I am not sure when it would be yet but I don't think your release should get hung up by the PR!

[orchestr7]

@akuleshov7 After reviewing the use case with my team, we think that the current multi if-else feature is sufficient for the time being. I am still interested in having a PR up but I am not sure when it would be yet but I don't think your release should get hung up by the PR!

sure, np

[lyharrietbui]

@akuleshov7 In the dicktat-analysis.yml file, there is a version of kotlin specified kotlinVersion: 1.5 in DIKTAT_COMMON. is DIKTAT_COMMON also a rule that can be enabled and disabled?. Can this be interpolated? Does this break if a service is using a lower or higher version of kotlin? I was testing with a service using higher kotlin version and it seems to work. I want to make sure if we need to match the version number.