feat!: expose build info through readBuildInfo() - #18
Merged
Merged
Conversation
Hosts parsed dist/build-info.json themselves and could not import the package entry for SHELLCHECK_VERSION without bundling the runner. The new ./build-info subpath returns the typed build info and imports nothing but node:fs. BREAKING CHANGE: the ./build-info.json subpath export is removed; use readBuildInfo() from ./build-info or ./node instead.
|
🎉 This PR is included in version 0.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Hosts can now read the build info as a typed value instead of parsing
build-info.json. The new./build-infosubpath imports onlynode:fs, so a Host can read it without pulling the runner into its bundle.Changes
./build-infosubpath exportingreadBuildInfo(): BuildInfo. It reads thebuild-info.jsonthat ships next toshellcheck.wasmsynchronously and caches the result. It throws if the file is missing../nodere-exportsreadBuildInfoandBuildInfo../build-info.jsonsubpath export is removed. The file still ships indist/.SHELLCHECK_VERSIONis unchanged.CONTEXT.mdgains a Build info term.dist/build-info.js(onlynode:fs), andreadBuildInfo()matching the shipped JSON andSHELLCHECK_VERSION.Follow-up
src/runtime/wasm/build-info.tsshould callreadBuildInfo()from@vscode-shellcheck/shellcheck-wasm/build-infoonce this ships (planned as 0.2.0).