Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#164 - Introduce checkstyle #263

Merged
merged 14 commits into from
Oct 31, 2023
Merged

Conversation

reckart
Copy link
Member

@reckart reckart commented Oct 31, 2023

What's in the PR

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

How to test manually

  • No specific test procedure

Automatic testing

  • PR includes unit tests

Documentation

  • PR updates documentation

- Added checkstyle profile using the rules from DKPro Core
@reckart reckart added this to the 2.0.0 milestone Oct 31, 2023
@reckart reckart self-assigned this Oct 31, 2023
@reckart
Copy link
Member Author

reckart commented Oct 31, 2023

@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
Copy link
Contributor

rzo1 commented Oct 31, 2023

IntelliJ IDEA (similar for Martin)

- Add style config template and script to install it
@reckart
Copy link
Member Author

reckart commented Oct 31, 2023

- Change GH action to build up to the verify stage which includes checkstyle
@reckart
Copy link
Member Author

reckart commented Oct 31, 2023

@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
Copy link
Contributor

rzo1 commented Oct 31, 2023

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

@mawiesne
Copy link
Contributor

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

- Organize imports
- Auto-format dkpro-jwpl-api
- Auto-format dkpro-jwpl-datamachine
- Auto-format dkpro-jwpl-mwdumper
- Auto-format dkpro-jwpl-parser
- Auto-format dkpro-jwpl-revisionmachine
- Auto-format dkpro-jwpl-timemachine
- Auto-format dkpro-jwpl-tutorial
- Auto-format dkpro-jwpl-util
- Auto-format dkpro-jwpl-wikimachine
- Fix remaining checkstyle issues
- Use try-with-resources in some places
- Add re-generate hashcode/equals where only equals was implemented without hashcode
@reckart
Copy link
Member Author

reckart commented Oct 31, 2023

Ok, here is the big one :)

@reckart reckart merged commit 3a56be3 into master Oct 31, 2023
4 checks passed
@reckart reckart deleted the refactoring/164-Introduce-checkstyle branch October 31, 2023 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants