Expose version property in public API #1479
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1479 +/- ##
=======================================
Coverage 64.71% 64.71%
=======================================
Files 3 3
Lines 1981 1981
Branches 687 687
=======================================
Hits 1282 1282
Misses 138 138
Partials 561 561 ☔ View full report in Codecov by Sentry. |
1 task
This value is already used in the conversion tooling and is useful in external contexts too, for example when specifying/detecting node-addon-api as an optional peer dependency. Also adds test expectations for all exported properties.
lovell
force-pushed
the
expose-version-property
branch
from
776991d
to
92dc899
Compare
legendecas
approved these changes
May 1, 2024
KevinEady
approved these changes
May 2, 2024
gabrielschulhof
approved these changes
May 3, 2024
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 PR contains a proposal to expose the package
versionproperty in the public API.The
versionvalue is already used by the conversion tooling and is additionally useful in external contexts too, for example when specifying/detectingnode-addon-apias an optional and/or peer dependency.This would bring
node-addon-apiin line withnode-gyp, which already exportsrequire('node-gyp').version. The change in the PR will allow me to improve the install-time detecting/logging fornode-addon-apiwithinsharp.It also adds a test with expectations for this property as well as all existing exported properties.