chore(cli): Add @fern-api/source-resolver #5295
Merged
+554
−127
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
amckinney
commented
Nov 28, 2024
| context, | ||
| fdrApiDefinitionId, | ||
| includeOptionalRequestPropertyExamples, | ||
| sourceResolver = new NopSourceResolver() |
There was a problem hiding this comment.
@dsinghvi this will be fixed before merge - if everything else look good I'll make this a required property so that every caller needs to explicitly pass it in themselves. It's otherwise too easy for us to miss it.
There was a problem hiding this comment.
Changed to a required property in this commit.
amckinney
changed the title
dsinghvi
approved these changes
Nov 29, 2024
|
@amckinney is it easy to nest |
|
@dsinghvi sounds great to me! I'll handle this in a follow up commit so that the other PRs branched off this one don't need to be rebased. |
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.
Overview
This adds the new
@fern-api/source-resolverand@fern-api/cli-source-resolverpackages which are primarily used in the@fern-api/ir-generator.Rationale
The primary
SourceResolverimplementation requires access to the filesystem, so we abstract this interface away in a separate package, and require it as input togenerateIntermediateRepresentation.The implementation defined in
@fern-api/cli-source-resolveris explicitly provided in every node-compatible call-site (e.g. the CLI), whereas browser-compatible callers can provide theNopSourceResolver, and can still receive valid IR output.With this, the
@fern-api/ir-generatorno longer depends onfs/promises.