hadiyarajesh / note-x

Notes and Reminders on steroid
Apache License 2.0
11 stars 10 forks source link

WorkerManager and Notification support for reminders added AND detekt and Ktlint support Added #66

Closed geetgobindsingh closed 2 years ago

geetgobindsingh commented 2 years ago

💡 Motivation, context, additional details, changes proposed

The motivation behind adding this PR is to enable the pre-push git-hooks for static analysis tools like detekt or Ktlint.

Q. Why are we keeping these to the local machine end rather than GitHub Actions?
Ans:- as we all know, we are using the free GitHub Actions that come with a free runner with low bandwidth. So, as of now, we are trying to keep this on the local machine side only. Maybe in future if we find some other good option or some increased bandwidth from the side of the Github Free program.

Anyone can use the command to check locally as well from the terminal.

./gradlew detekt or ./gradlew ktlintCheck

Use this ./gradlew ktlintFormat command for doing the formatting to *.kt file.

Screenshot_2022-08-31-22-33-55-87_3f76808b89d2117205aad87459958156

✏️ Checklist

📸 Reference Screenshots.