feat: overlay linting, decorators, preprocessors, types extension support#1898
Merged
tatomyr merged 2 commits intoRedocly:mainfrom Mar 3, 2025
Merged
feat: overlay linting, decorators, preprocessors, types extension support#1898tatomyr merged 2 commits intoRedocly:mainfrom
tatomyr merged 2 commits intoRedocly:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 7abbfe2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
jeremyfiel
added a commit
to jeremyfiel/redocly-cli
that referenced
this pull request
Feb 10, 2025
* updated references to use defined NodeTypes. * update `any` to `unknown` * run prettier * rebase latest changes from main * refactor to match Redocly#1898 type definitions related Redocly#1246
jeremyfiel
changed the title
jeremyfiel
changed the title
jeremyfiel
added a commit
to jeremyfiel/redocly-cli
that referenced
this pull request
Feb 10, 2025
* updated references to use defined NodeTypes. * update `any` to `unknown` * run prettier * rebase latest changes from main * refactor to match Redocly#1898 type definitions related Redocly#1246
jeremyfiel
force-pushed
the
feat/overlay-linting
branch
2 times, most recently
from
b9f71e5 to
4810f51
Compare
Contributor
Author
|
docs to be added separately |
jeremyfiel
force-pushed
the
feat/overlay-linting
branch
from
4810f51 to
303d41b
Compare
jeremyfiel
added a commit
to jeremyfiel/redocly-cli
that referenced
this pull request
Feb 10, 2025
* updated references to use defined NodeTypes. * update `any` to `unknown` * run prettier * rebase latest changes from main * refactor to match Redocly#1898 type definitions related Redocly#1246
jeremyfiel
added a commit
to jeremyfiel/redocly-cli
that referenced
this pull request
Feb 11, 2025
* updated references to use defined NodeTypes. * update `any` to `unknown` * run prettier * rebase latest changes from main * refactor to match Redocly#1898 type definitions related Redocly#1246
jeremyfiel
added a commit
to jeremyfiel/redocly-cli
that referenced
this pull request
Feb 11, 2025
* updated references to use defined NodeTypes. * update `any` to `unknown` * run prettier * rebase latest changes from main * refactor to match Redocly#1898 type definitions related Redocly#1246
JLekawa
approved these changes
Feb 18, 2025
Collaborator
|
I have to check this locally. Will try to do it today. Meanwhile, I'm updating your branch. |
tatomyr
reviewed
Feb 26, 2025
Collaborator
tatomyr
left a comment
tatomyr
left a comment
There was a problem hiding this comment.
Looks like you're missing handling overlay rules in config/builtIn.ts and config/config-resolvers.ts. Could you add a test for linting/bundling and an example of the Overlay description in the resource/ folder?
jeremyfiel
force-pushed
the
feat/overlay-linting
branch
2 times, most recently
from
d4bbb56 to
19ec47f
Compare
* updated references to use defined NodeTypes. * update `any` to `unknown` * run prettier related Redocly#1246
jeremyfiel
force-pushed
the
feat/overlay-linting
branch
2 times, most recently
from
6fbb445 to
7c0e2cb
Compare
jeremyfiel
commented
Mar 1, 2025
| @@ -104,6 +108,7 @@ export class StyleguideConfig { | |||
| [SpecVersion.Async2]: { ...rawConfig.decorators, ...rawConfig.async2Decorators }, | |||
| [SpecVersion.Async3]: { ...rawConfig.decorators, ...rawConfig.async3Decorators }, | |||
| [SpecVersion.Arazzo1]: { ...rawConfig.arazzo1Decorators }, | |||
Contributor
Author
There was a problem hiding this comment.
should this line include ...rawConfig.decorators?
Collaborator
There was a problem hiding this comment.
Most likely yes. @DmitryAnansky what do you think?
Contributor
Author
There was a problem hiding this comment.
these can be added in an separate pr unrelated to Overlays.. I found this omission when updating this pr.
| @@ -95,6 +98,7 @@ export class StyleguideConfig { | |||
| [SpecVersion.Async2]: { ...rawConfig.preprocessors, ...rawConfig.async2Preprocessors }, | |||
| [SpecVersion.Async3]: { ...rawConfig.preprocessors, ...rawConfig.async3Preprocessors }, | |||
| [SpecVersion.Arazzo1]: { ...rawConfig.arazzo1Preprocessors }, | |||
Contributor
Author
There was a problem hiding this comment.
should this line include ...rawConfig.preprocessors?
tatomyr
reviewed
Mar 1, 2025
Collaborator
tatomyr
left a comment
tatomyr
left a comment
There was a problem hiding this comment.
Left a minor suggestion, otherwise looks good 🎉
* linting * preprocessors * decorators * type extensions
jeremyfiel
force-pushed
the
feat/overlay-linting
branch
from
7c0e2cb to
7abbfe2
Compare
tatomyr
approved these changes
Mar 3, 2025
Collaborator
tatomyr
left a comment
tatomyr
left a comment
There was a problem hiding this comment.
Thank you for your contribution @jeremyfiel 🎉. Looking forward to the docs updates!
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
3 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.
What/Why/How?
Added support for linting, preprocessors, decorators, and type extensions for Overlay v1 documents.
Reference
depends on #1775
Testing
Screenshots (optional)
Check yourself
Security