VSCode guide: Add Checkstyle setup tutorial #85
Closed
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
Some may want to set up Checkstyle on their Visual Studio Code environment to allow for any code style issues to be easily detected and fixed during development. Let's add a tutorial to help developers easily set up their Visual Studio Code environment for Checkstyle, and add a few images to make the tutorial more clear for developers.
mfjkri
reviewed
Sep 23, 2024
|
|
||
| 1. Open Visual Studio Code. | ||
| 2. If you haven't already downloaded the [Extension Pack for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) extension to import a Gradle project, download it using `Extensions -> Search 'Extension Pack for Java' -> Install`. This is required as the Checkstyle for Java extension is dependent on [Language Support for Java by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java), one of the extensions in this extension pack, to work properly. |
There was a problem hiding this comment.
Assuming that the section on importing a grade project will be added, should step 2 simply direct users to read and follow that section first?
There was a problem hiding this comment.
In the importing a Gradle project section, there are quite a few steps about setting up the JRE and JDK in VSCode which may not be relevant to the Checkstyle guide specifically, so I think that adding the instruction to download the specific extension if not done yet should be enough.
However, if that section is added, I still think it would be best to add a link to that section to allow interested users to add a Gradle toolbar to their project if they haven't done so already.
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.
Implementation of my proposal for Checkstyle plugin setup in the VS Code guide in #54.
Some may want to set up Checkstyle on their Visual Studio Code environment to allow for any code style issues to be easily detected and fixed during development.
Let's add a tutorial to help developers easily set up their Visual Studio Code environment for Checkstyle, and add a few images to make the tutorial more clear for developers.