Feat: warn about unknown/misspelled doc tags #610
Merged
Conversation
This file contains hidden or 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
Since we export all unknown doc tags in doc cli, there's currently no way of knowing if the user added a custom doc tag, or misspelled an existing one. This PR attempts tp fix this by introducing functionality to define known custom doc tags in `.emmyrc.json`. It implements a diagnostic checker for unknown doc tags, completion suggestions for known tags, and quick-fix actions to add unknown tags to the config. Note: I didn't add translations, but left relevant TODOs in locale files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Since we export all unknown doc tags in doc cli, there's currently no way of knowing if the user added a custom doc tag, or misspelled an existing one.
This PR attempts to fix this by introducing functionality to define known custom doc tags in
.emmyrc.json.It implements a diagnostic checker for unknown doc tags, completion suggestions for known tags, and quick-fix actions to add unknown tags to the config.
Note: I didn't add translations, but left relevant TODOs in locale files.