Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apidom-reference: switch parser adapters to optional dependencies #2590

Closed
char0n opened this issue Feb 27, 2023 · 0 comments
Closed

apidom-reference: switch parser adapters to optional dependencies #2590

char0n opened this issue Feb 27, 2023 · 0 comments
Assignees
Labels

Comments

@char0n
Copy link
Member

char0n commented Feb 27, 2023

The goal of this issue is to switch parser adapter dependencies to optional ones.

Why we're doing this?

apidom-reference package is in essence a framework. We can use this framework with two configurations:

image

When using empty configuration approach, options object is not configured with parsers, resolvers or strategies. This is suitable for creating web bundles and gives you total control of the contents of your bundles.

image

Saturated configuration is suitable for Node.js environments. options object is pre-configured with all the parsers, resolvers and strategies.


If we switch all parser adapter dependencies to optional, it means that during installation, these dependencies may fail to install, but these failures will not fail overall apidom-reference installation. One can still use empty configuration approach and provide apidom-reference with his/hers own implementations of parser adapters.

@char0n char0n self-assigned this Feb 27, 2023
@char0n char0n added enhancement New feature or request ApiDOM dependencies labels Feb 27, 2023
char0n added a commit that referenced this issue Feb 27, 2023
When parser adapters (or other ApiDOM deps) fail to
install, one can still use empty configuration.

Refs #2590
char0n added a commit that referenced this issue Feb 27, 2023
When parser adapters (or other ApiDOM deps) fail to
install, one can still use empty configuration.

Refs #2590
@char0n char0n closed this as completed Feb 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant