#164 - Introduce checkstyle

dkpro / dkpro-jwpl

DKPro JWPL (DKPro Java Wikipedia Library) is a free, Java-based application programming interface that facilitates access to all information in Wikipedia.

https://dkpro.github.io/dkpro-jwpl

Apache License 2.0

82 stars 34 forks source link

#164 - Introduce checkstyle #263

Closed reckart closed 11 months ago

reckart commented 11 months ago

What's in the PR

[x] Added checkstyle profile using the rules from DKPro Core
[x] Add style configuration
[x] Format code so checkstyle is happy

How to test manually

No specific test procedure

Automatic testing

[ ] PR includes unit tests

Documentation

[ ] PR updates documentation

reckart commented 11 months ago

@mawiesne @rzo1 Next step here would be to auto-format the code. I tend these days to have a script in my projects that copies an Eclipse formatter configuration into every one of the modules because that's the only sensible way I found to share these configurations in a module-specific way rather than forcing users to install a global style in their Eclipse. What IDEs are you using?

rzo1 commented 11 months ago

IntelliJ IDEA (similar for Martin)

reckart commented 11 months ago

Would it be working for you to configure IntelliJ as follows: https://build.ukp.informatik.tu-darmstadt.de/view/INCEpTION/job/INCEpTION%20main/de.tudarmstadt.ukp.inception.app$inception-app-webapp/doclinks/3/#_checkstyle_and_formatting

reckart commented 11 months ago

@mawiesne do you also give a thumbs up for auto-formatting? This is a hammer action which would cause conflicts if you still have any pending changes lying around.

rzo1 commented 11 months ago

Think we can import it ( we are doing it for OpenNLP in a similar way)

mawiesne commented 11 months ago

Go for it, no changes open from my side. @reckart

reckart commented 11 months ago

Ok, here is the big one :)