Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore (package): Specify Node version and document versions. #3352

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Commits on Oct 24, 2024

  1. chore (package): Specify Node version and document versions.

    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 committed Oct 24, 2024
    Configuration menu
    Copy the full SHA
    f9ecd85 View commit details
    Browse the repository at this point in the history