feat: add custom refs plugin rules: no-refs-siblings and no-circular-refs#25
Draft
tatomyr wants to merge 1 commit into
Draft
feat: add custom refs plugin rules: no-refs-siblings and no-circular-refs#25tatomyr wants to merge 1 commit into
tatomyr wants to merge 1 commit into
Conversation
lornajane
reviewed
Jan 26, 2024
| Dealing with $refs might be quite a challenge sometimes. | ||
| This plugin introduces a few rules that could give insights into how the $refs are used. | ||
|
|
||
| ### No $refs siblings |
Contributor
There was a problem hiding this comment.
Maybe no unexpected $refs siblings? Because we do still allow the valid ones like description.
Contributor
|
I tried to test this and it didn't do what I expected. Did I find an edge case, or do I not understand what a circular reference is? My (I edited the |
Contributor
Author
|
@lornajane there's a typo in |
Member
|
(I converted it to a draft because I come to check this PR every week and forget it is still in progress. 🧠 ) |
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
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.
Created two rules in the scope of investigating issues Redocly/redocly-cli#1329 and
Redocly/redoc#2474.
Also related: Redocly/redocly-cli#644