This repository has been archived by the owner on Nov 28, 2022. It is now read-only.
feat: adding support for storing our extensions in a x-readme
object
#1235
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's being changed?
This gives a beefy overhaul, and a couple breaking changes, to our
@readme/oas-extensions
to do a couple things:x-readme
object. This'll allow us to stop polluting the global namespace ofx-
extensions and keep our work contained.x-
prefix.x-readme
method the new default way for storing extensions. If you're doingoas[extension.NAME] = val
it'll no longer be accessible withextension.getExtension()
and will need to be updated to either dooas['x-readme'][extension.NAME]
oroas[
x-${extension.NAME}`].🧬 Testing
All tests have been updated to work with these new extension names, and full test coverage has been added to
@readme/oas-extensions
(there was zero before!) to maintain backwards compatibility with retrieving extensions asoas[x-${extension.NAME}]
.