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

add engine requirements to create-turbo/package.json, fix examples/with-pnpm #199

Merged
merged 5 commits into from
Dec 13, 2021

Conversation

charkour
Copy link
Contributor

@charkour charkour commented Dec 12, 2021

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 the turbo 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 running create-turbo locally works fine but jest was presenting errors.

Thanks for your time!

@vercel
Copy link

vercel bot commented Dec 12, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/vercel/turbo-site/7HwreGk5ApUjgb62JgRRbmnkJaCs
✅ Preview: https://turbo-site-git-fork-charkour-main.vercel.sh

docs/pages/docs/getting-started.mdx Outdated Show resolved Hide resolved
@jaredpalmer jaredpalmer added area: docs Improvements or additions to documentation area: examples Improvements or additions to examples labels Dec 12, 2021
@charkour
Copy link
Contributor Author

charkour commented Dec 13, 2021

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 create-turbo/package.json. PNPM added workspaces in v3.7.0 according to their docs which I verified using the examples/with-pnpm project and installing different PNPM versions. The with-pnpm project was missing scripts which were defined in with-pnpm/readme.md and needed turbo dev configuration which I added.

Please let me know what needs to be changed. Thanks!

@charkour charkour changed the title update docs about engine versions, create npmrc add engine requirements to create-turbo/package.json, fix examples/with-pnpm Dec 13, 2021
@jaredpalmer jaredpalmer merged commit 155c5c3 into vercel:main Dec 13, 2021
@jaredpalmer
Copy link
Contributor

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation area: examples Improvements or additions to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants