Detekt custom rule template

This repository is a template. You can use it to generate your own repository to write and share your custom rules.

How to use it

1. Create a new repository using this one as a template. Click here
2. Edit MyRule to fit your use case
3. Share your rule! You can upload your rule to Maven Central if you want. If you don’t want to do
   all the steps that Maven Central requires you can just share your rule using jitpack.
4. Extra: you can remove all this README and explain what your rule does and how to configure it.

Documentation

You can find the documentation about how to write custom rules here.

Note

Remember that, by default, all the rules aren’t enable. To activate the rule you need to write something like this in your
yaml configuration:

MyRuleSet:
  MyRule:
    active: true

GitHub

View Github