chore(specs): add eslint rule to avoid cross-references #3413
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
No code generatedIf you believe code should've been generated, please, report the issue. 📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
shortcuts
reviewed
Jul 24, 2024
eslint/src/rules/refCommon.ts
Outdated
| export const refCommon: Rule.RuleModule = { | ||
| meta: { | ||
| docs: { | ||
| description: 'the $ref must target the current spec, or the common spec', |
There was a problem hiding this comment.
Maybe make it more informative? E.g. "if you intended to use a model from an other spec, move it to the common folder" or something
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.
🧭 What and Why
Suggested by @shortcuts, cross-reference are forbidden because they break our caching and generation strategy, we can add a custom rule to assert that.
The rule needs the list of clients because we allow everything inside each spec, just not with another spec.