Configure UpdateForV10 tag with eslint-plugin-jsdoc #5683
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
We sometimes want to make breaking changes but have to wait until the next major version. To not forget about those, this commit introduces an UpdateForV10 JSDoc tag that can be used in any commment. There are a few benefits of using JSDoc instead of a simple TODO comment: * With the allowlist of tags in our eslint config, we can't make typos * We enforce a proper description to explain why the breaking change needs to be made Note that this tag has the same name as the Elasticsearch UpdateForV10 annotation, as we'll migrate to Elasticsearch in the future.
Contributor
| Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
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.
We sometimes want to make breaking changes but have to wait until the next major version. To not forget about those, this commit introduces an
UpdateForV10JSDoc tag that can be used in any comment. There are a few benefits of using JSDoc instead of a simple TODO comment:Note that this tag has the same name as the Elasticsearch UpdateForV10 annotation, which will prove useful when the Elasticsearch specification becomes part of the Elasticsearch repository in the future.
Since we're now using https://github.com/gajus/eslint-plugin-jsdoc, this pull request also applies a number of useful fixes.