Skip to content
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

Merged
merged 1 commit into from
Mar 23, 2021

Conversation

erunion
Copy link
Member

@erunion erunion commented Mar 23, 2021

☁️   CI App

🧰 What's being changed?

This gives a beefy overhaul, and a couple breaking changes, to our @readme/oas-extensions to do a couple things:

  • Adding support for retrieving our custom extensions from an x-readme object. This'll allow us to stop polluting the global namespace of x- extensions and keep our work contained.
  • Changes the names of our extension exports to no longer contain an x- prefix.
    • This was done to make the x-readme method the new default way for storing extensions. If you're doing oas[extension.NAME] = val it'll no longer be accessible with extension.getExtension() and will need to be updated to either do oas['x-readme'][extension.NAME] or oas[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 as oas[x-${extension.NAME}].

@erunion erunion added type:enhancement A potential new feature to be added, or an improvement we could make type:refactor Issues about tackling technical debt labels Mar 23, 2021
@erunion erunion requested review from Dashron and ilias-t March 23, 2021 18:46
@erunion erunion temporarily deployed to explorer-pr-1235 March 23, 2021 18:46 Inactive
@erunion erunion merged commit 203390d into next Mar 23, 2021
@erunion erunion deleted the feat/x-readme-extension-prefix branch March 23, 2021 23:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type:enhancement A potential new feature to be added, or an improvement we could make type:refactor Issues about tackling technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants