-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
add engine requirements to create-turbo/package.json
, fix examples/with-pnpm
#199
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/vercel/turbo-site/7HwreGk5ApUjgb62JgRRbmnkJaCs |
Hey, thanks for taking the time to review this. I have removed the Node and NPM version requirements from the docs as you requested. Also, I added the minimum PNPM version to the Please let me know what needs to be changed. Thanks! |
create-turbo/package.json
, fix examples/with-pnpm
Thanks! |
Hey, didn't know what was best for this, but I thought this PR could be a good starting point.
Currently, the docs do not list out what node version or npm version is necessary to run turborepo and some users have run into issues with it: #184
This PR adds the engine versions to the base package.json for the template in
create-turbo
and also updates the documentation to specify which versions of node and npm are needed. Adds an.npmrc
to enforce the npm version if using npm. I tested different combinations of npm and node versions and concluded turborepo works with node >= v14 and npm >= v7. I didn't try different pnpm versions, but could test that as well if you would like.Also, maybe it would be good to have
create-turbo
and theturbo
cli check the node and npm version and display an error when the user trys to run commands. If that is a good idea, that is something else this PR could include. As an aside, building and runningcreate-turbo
locally works fine but jest was presenting errors.Thanks for your time!