chore (package): Specify Node version and document versions. #3352
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
shaper
force-pushed
the
pr/tool-versions
branch
2 times, most recently
from
addb571
to
5e6ae5d
Compare
shaper
changed the title
shaper
force-pushed
the
pr/tool-versions
branch
from
5e6ae5d
to
1876d57
Compare
Developers can unintentionally install and build with Node or `pnpm` versions we don't officially support. Currently our CI runs with Node v18 and v20, and we're using `pnpm` v8. This change adds an `engines` field to the top level `package.json` file. This will output a warning on install/build if the engine version doesn't match the specified range. The `pnpm` version is already specified in `packageManager` to reflect the version we use in CI, although it is not enforced or warned if, for example, the developer is on v9. This change also updates the README to note supported Node engine versions and `pnpm` version used. We can consider for the future but choose not to pursue for now: - placing `engine-strict=true` in the top level `.npmrc` to hard-fail on incompatible engine versions - adding a preinstall/prebuild command that checks versions with more explicit failures, messaging, etc.
shaper
force-pushed
the
pr/tool-versions
branch
from
1876d57
to
f9ecd85
Compare
lgrammel
reviewed
Oct 24, 2024
| @@ -8,10 +8,15 @@ To learn more about how to use the AI SDK, check out our [API Reference](https:/ | |||
|
|
|||
| ## Installation | |||
|
|
|||
| You will need Node.js 18+ and pnpm installed on your local development machine. | |||
There was a problem hiding this comment.
This README is for using the AI SDK and should not be changed. We have a separate contribution guide ( CONTRIBUTING.md in root ) that should contain this information.
lgrammel
reviewed
Oct 24, 2024
|
|
||
| ```shell | ||
| npm install ai |
There was a problem hiding this comment.
NPM is fine for using the AI SDK ( as is pnpm, bun, etc) - only NPM here for illustration purposes.
lgrammel
reviewed
Oct 24, 2024
Comment on lines
+41
to
+43
| "engines": { | ||
| "node": "^18.0.0 || ^20.0.0" | ||
| }, |
There was a problem hiding this comment.
What effect does the engine spec have on the root level in the day-to-day usage for maintainers, i.e. when will the warning show up?
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.
Developers can unintentionally install and build with Node or
pnpmversions we don't officially support. Currently our CI runs with Node
v18 and v20, and we're using
pnpmv8.This change adds an
enginesfield to the top levelpackage.jsonfile. This will output a warning on install/build if the engine
version doesn't match the specified range.
The
pnpmversion is already specified inpackageManagerto reflectthe version we use in CI, although it is not enforced or warned if,
for example, the developer is on v9.
This change also updates the README to note supported Node engine
versions and
pnpmversion used.We can consider for the future but choose not to pursue for now:
engine-strict=truein the top level.npmrctohard-fail on incompatible engine versions
more explicit failures, messaging, etc.