Introduction of checkstyle #7089
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
disabled checkstyle check running after `build` task changed severity of code violations to warning
…he code conventions
Efnilite
reviewed
Sep 18, 2024
Efnilite
approved these changes
Sep 18, 2024
Romitou
reviewed
Sep 18, 2024
Pesekjak
added
the
enhancement
Moderocky
approved these changes
Sep 18, 2024
sovdeeth
approved these changes
Sep 19, 2024
sovdeeth
added
the
patch-ready
Co-authored-by: Efy <35348263+Efnilite@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds checkstyle to the Skript project, ensuring adherence to the coding standards described in the code-conventions.md file.
Currently checkstyle does not run automatically after the build task and must be executed manually. This is intentional to avoid increasing build times.
Additionally I have added a GitHub actions workflow for checkstyle. The workflow is configured not to fail even when code violations are detected as the severity level is set to 'warning' rather than 'error'. This is because there are currently over 6,000 code violations in the project, and failing the check would block the CI pipeline.
Once all these issues are resolved the severity can be changed to 'error' but that will take some time 😬.
Target Minecraft Versions: any
Requirements: none
Related Issues: none