Add static code analysis to build tooling

edalex-ian commented 5 years ago

As part of the 2019/2 CDM it was agreed to incorporate static code analysis tools into the oEQ build tooling - in place of the previous Code Climate.

To that end, this 'issue' acts as the starting point for that. The intention is that we add the following tools into the SBT process. And have it such that the various CI setups can call it (arguably very early on - fail quick) and return false/non-zero if checks fail.

The tools currently to integrate are:

[x] checkstyle for Java
[ ] Scalastyle for Scala
[ ] One of the linters for JS
[ ] And if needs be, another linter for the Typescript (including TSX)
[ ] For bonus points, something for Purescript

It would be great if we ended up with a simple sbt codeCheck at the end of it all.

This is open to contributions for one and all. Probably best if we do one PR per checker...

(And we also have a current discussion going on around Code Styles. So it was interesting to note that out of the box checkstyle has "example configuration files [...] supporting the Sun Code Conventions, Google Java Style".)

edalex-ian commented 5 years ago

@edalex-joe is going to have a look at adding checkstyle.

edalex-ian commented 5 years ago

As can be seen above, @PenghaiZhang is currently progressing with Java static analysis.

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

edalex-ian commented 5 years ago

So we've got checkstyle in there nowadays. We still need to look at the others.

openequella / openEQUELLA

Add static code analysis to build tooling #744