ci: Added pre-commit-hook

[Sloox]

Fixes #1305

Needs to be tested locally to actually see a change.
It requires a once off execution of the link Hook sh file.
Simply try git commit and it should run detekt.

[github-actions]

Timestamp: 2020-11-17 16:12:54
Buildscan url for ubuntu-workflow run 368470824
https://gradle.com/s/vfidhavlwb6wk

[codecov-io]

Codecov Report

Merging #1320 (072cf41) into master (f02fb4e) will decrease coverage by 0.02%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #1320      +/-   ##
============================================
- Coverage     79.64%   79.61%   -0.03%     
+ Complexity      736      735       -1     
============================================
  Files           237      237              
  Lines          4573     4573              
  Branches        792      792              
============================================
- Hits           3642     3641       -1     
- Misses          525      526       +1     
  Partials        406      406              

[jan-goral]

The linkHooks.sh was not executable so I have changed it using chmod +x.
After that, I have added empty lines to a random kotlin file and tested pre-commit

MacBook-Pro-jan-gogo:flank-review jan-gogo$ git commit -m 'Test pre-commit'
hint: The '.githooks//pre-commit' hook was ignored because it's not set as executable.
hint: You can disable this warning with `git config advice.ignoredHook false`.
[#1305-git-hooks 19bd8833] Test pre-commit
 1 file changed, 9 insertions(+)

So I have changed pre-commit to executable and tried test again.
This is what I get:

MacBook-Pro-jan-gogo:flank-review jan-gogo$ git commit -m 'Test pre-commit'
fatal: cannot run .githooks//pre-commit: No such file or directory

Strange

[Sloox]

The linkHooks.sh was not executable so I have changed it using chmod +x.
After that, I have added empty lines to a random kotlin file and tested pre-commit

MacBook-Pro-jan-gogo:flank-review jan-gogo$ git commit -m 'Test pre-commit'
hint: The '.githooks//pre-commit' hook was ignored because it's not set as executable.
hint: You can disable this warning with `git config advice.ignoredHook false`.
[#1305-git-hooks 19bd8833] Test pre-commit
 1 file changed, 9 insertions(+)

So I have changed pre-commit to executable and tried test again.
This is what I get:

MacBook-Pro-jan-gogo:flank-review jan-gogo$ git commit -m 'Test pre-commit'
fatal: cannot run .githooks//pre-commit: No such file or directory

Strange

Please retest it was a faulty shebang line.

[adamfilipow92]

Maybe we could add information about run linkHooks.sh before first commit to documentation in Environment setup section? It could help when for all new contributors. WDYT?

[piotradamczyk5]

One small issue on Mac

.githooks/linkHooks.sh: line 2: @echo: command not found
Changing git config for hooks to .githooks
Complete!

I fixed it

[piotradamczyk5]

set echo off?

fixed

[jan-goral]

I am not sure if pre-commit script will work on windows so linkHooks.bat probably is not necessary, but also I am not sure if any dev will use windows as the main os for development, so it's not a problem.

[Sloox]

I am not sure if pre-commit script will work on windows so linkHooks.bat probably is not necessary, but also I am not sure if any dev will use windows as the main os for development, so it's not a problem.

I use windows and it works correctly 👍