Updating the website to the (upoming) jackpot30 20.0 #11
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
jtulach
approved these changes
Jan 22, 2024
| <artifactId>jackpot30-maven-plugin</artifactId> | ||
| <version>20.0</version> | ||
| <configuration> | ||
| <hint>SizeReplaceableByIsEmpty</hint> |
There was a problem hiding this comment.
Having a list of available values somewhere would be benefitial.
Having such list in a documentation would help people understand the value of Jackpot without trying it out manually.
| Supported configuration options are: | ||
|
|
||
| - `hint`: the hint or hints that should be invoked. Can either be a comma-separated list of `@SuppressWarnings` keys of hints to invoke, or the display name of the hint to invoke, | ||
| - `configuration`: a configuration file (from NetBeans) specifying which hints should be run, |
There was a problem hiding this comment.
Description how to obtain such configuration file is needed, otherwise it is not clear at all how to get it.
|
|
||
| Supported goals are: | ||
|
|
||
| - `jackpot30:analyze`: run the hints, and print warnings produce by them possible failing the build, as specified, |
There was a problem hiding this comment.
Suggested change
| - `jackpot30:analyze`: run the hints, and print warnings produce by them possible failing the build, as specified, | |
| - `jackpot30:analyze`: run the hints, and print warnings produce by them possibly failing the build, as specified, |
|
|
||
| - `jackpot30:analyze`: run the hints, and print warnings produce by them possible failing the build, as specified, | ||
| - `jackpot30:apply`: run the hints, and apply the primary proposed changes on each place where the hint would produce a warning. Please note this will be applied directly into the working copy of the files, | ||
| - `jackpot30:list`: list the support standard and custom Java hints. |
There was a problem hiding this comment.
Can you give example how to check for @NotNull and co. annotations in a project?
|
@jlahoda this is the right place. Feel free to merge. |
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.
A variant of:
apache/netbeans-website#689
for this repository. Not sure which is the correct one, but this one was pointed out by @mbien
This adds (some) description of how to run the standard Java hints using Jackpot in Maven. This is a preliminary PR so far, as it depends on features added here:
apache/netbeans-jackpot30#36
and also on a release of Jackpot v version 20.0.