Add an editor config, a mvn goal and a ci action to check code conventions

nlbdev / nordic-epub3-dtbook-migrator

Tools for converting between a strict subset of DTBook and EPUB3.

http://nlbdev.github.io/nordic-epub3-dtbook-migrator/

GNU Lesser General Public License v2.1

8 stars 7 forks source link

Add an editor config, a mvn goal and a ci action to check code conventions #507

Closed egli closed 2 years ago

egli commented 2 years ago

This PR adds a cross editor config file, a Maven goal that uses the config to check the source code and finally a github action to check every commit for these conventions via maven.

Should fix at least in part #476.

When running the mvn goal quite a few files have problems. These can easily be fixed with mvn editorconfig:format. But I think such a global change should go in a separate PR.

egli commented 2 years ago

Just FYI to see what the kind of code convention problems are check the output of the github action.

josteinaj commented 2 years ago

Looks great, thanks @egli!

josteinaj commented 2 years ago

I'm not sure how to change the base branch of a PR, but I merged it into guidelines-revision here: 502ff18092e5af5b65d3d798e8ecce065ea10e9e