detekt-hint (Attention: Looking for developers)
Detection of design principle violations in Kotlin added as comments on pull requests.
Getting started |
🏁
Roadmap |
💭
Ask a question |
📖
Documentation
detekt-hint is a plugin for detekt that includes detection of violation of programming principles. Since such violations are hard to detect with low false-positive rates, detekt-hint will provide hints during QA, minimizing noise during development. The idea is that a higher false-positive rate can be accepted if the detection could be of high value, and is easy to ignore. Detections on the architectural level of code is therefore most likely to provide value.
Through integration with Danger comments are added to the PR. Getting feedback directly on the PR makes it easy to ignore possible false-positives. Comments also include context and tips, making it easier for the developer to make the correct decisions.
Contributions are very much welcome and if you like the project - help me out with a
Currently supported detections
Interface Segregation Principle
Single Responsibility Principle
Open-Closed Principle
Using detekt-hint
If you just want to analyze some code without bothering with the Danger integration (which really defeats the purpose of the tool) head to the command line section.
With Github Actions
- Configure a detekt-hint-config.yml to include detekt-hint rules and put it in a folder called "config" in your root project folder.
config/detekt-hint-config.yml
detekt-hint:
UseCompositionInsteadOfInheritance:
active: true
yourUniquePackageName: "io.github.mkohm"
LackOfCohesionMethods:
active: true
threshold: "0.8"
InterfaceSegregationPrinciple:
active: true
OpenClosedPrinciple:
active: true
Make sure you enter your unique package name in the configuration for the UseCompositionInsteadOfInheritance rule.
- Create a github action using the detekt-hint docker action.
.github/workflows/detekt-hint.yml
name: detekt hint
on:
pull_request:
branches:
- '*'
jobs:
gradle:
strategy:
matrix:
os: [ubuntu-latest]
jdk: [11]
runs-on: ${{ matrix.os }}
if: ${{ !contains(github.event.head_commit.message, 'detekt hint skip') }}
env:
JDK_VERSION: ${{ matrix.jdk }}
steps:
- name: Checkout Repo
uses: actions/checkout@v2
- name: Run detekt hint
uses: mkohm/[email protected]
with:
github-api-token: ${{ secrets.GITHUB_TOKEN }}
- Create a PR and see detekt-hint run as a separate action.
Having trouble? Please create an issue or contact me on the kotlinlang Slack (username: mkohm), and i will help you out.
With the command line
If you only want to do some analysis on your code without the power of Danger commenting on your PR you can use the tool from the command line. You must first clone detekt and detekt-hint repositories, and then build the required jars:
git clone https://github.com/Mkohm/detekt-hint && git clone https://github.com/arturbosch/detekt && cd detekt-hint && ./gradlew jar && cd ../detekt/ && ./gradlew build shadowJar && cd ..
Use the command line utility:
java -jar detekt/detekt-cli/build/libs/detekt-cli-[version]-all.jar --plugins detekt-hint/build/libs/detekt-hint-[version].jar --config detekt-hint/config/detekt.yml --classpath <your-classpath> --input <path-to-your-awesome-project>
For example:
java -jar detekt/detekt-cli/build/libs/detekt-cli-1.5.0-all.jar --plugins detekt-hint/build/libs/detekt-hint-0.0.2.jar --config detekt-hint/config/detekt.yml --classpath detekt-hint/ --input detekt-hint/
Remember to enter the latest detekt-cli version, the latest detekt-hint version and the path to your classpath and source code. Also, make sure that the detekt.yml you are using contains the unique package name in the configuration for the UseCompositionInsteadOfInheritance rule.
3 Dec 10, 2022
194 Dec 30, 2022
289 Jan 4, 2023
1 Jun 29, 2022
3 Oct 26, 2022
7 Sep 2, 2022
54 Dec 27, 2022
2 Jan 16, 2022
3 Jun 16, 2021
But i dont understand whats happening.
Thank you :)
0 Nov 26, 2021
58 Nov 1, 2022
2.8k Dec 30, 2022
1 Feb 14, 2022
0 Jan 20, 2022
419 Jan 7, 2023
26 Nov 3, 2022
5.5k Jan 4, 2023
14 Dec 19, 2022
2 Nov 22, 2022