using HTML description #31
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
Contributor
guwirth
commented
Mar 13, 2024
guwirth
commented
- The html descriptions for the rules of repository must be stored in the path '/org/sonar/l10n/cxx/rules/mycxx'. If the return value of 'repositoryKey' is changed, the storage location in 'resources' must also be adjusted.
- The html descriptions for the rules of repository must be stored in the path '/org/sonar/l10n/cxx/rules/mycxx'. If the return value of 'repositoryKey' is changed, the storage location in 'resources' must also be adjusted.
smileQiny
reviewed
Mar 19, 2024
| name = "Using namespace directives are not allowed", | ||
| tags = {Tag.CONVENTION} | ||
| // second possibility to add a rule description: | ||
| //,description = "Using namespace directives are not allowed." |
There was a problem hiding this comment.
The description here can be retained. If we use the addHtmlDescription method, we can override the description. If you do not use the addHtmlDescription method, we can use this description as basic description.
There was a problem hiding this comment.
Unfortunately I haven't tried what happens when both are in? Does the html description overwrite the description?
There was a problem hiding this comment.
I tested this part of the code and it worked fine.
test version :
cxx: master (c753dd71932baabd7dcbe57e3a7985a48d733a60)
plugin: master (d221e45)
This design idea comes from the Sonar official rules custom plug-in demo.
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.