Support imports #43
Merged
Support imports #43
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
Adds async versions of readAVSC and avdlToAVSC in order to support importing other schemas from within AVDL files.
Async versions are preferred as otherwise imports will fail.
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.
This allows you to share types across multiple protocols without having to duplicate them in each file. Imports are relative to the current schema (the paths are essentially just passed to
fs.readFile), so you could imagine referencing shared types from NPM packages by doing something likeimport idl '../../node_modules/@company/schemas/metadata.avdl'.The main gist of it is that the async version of
avdlToAVSCusesassembleProtocolinstead ofreadProtocol. This is becausereadProtocoldoesn't support imports.See the tests or documentation for examples.
I had some problems with vscode not getting the types for
avsc, as I wanted to augment the module with a type for the error thatassembleProtocolcan give you in the callback. I think it works now, but it was weird.