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

CONTRIBUTING.md missing YARN dependency #4179

Closed
muxahuk opened this issue Nov 7, 2020 · 5 comments · Fixed by #4227
Closed

CONTRIBUTING.md missing YARN dependency #4179

muxahuk opened this issue Nov 7, 2020 · 5 comments · Fixed by #4227
Labels
good first issue Always wanted to get involved in an open source project but don’t know where to begin? Welcome! tech/typescript Issue for tech TypeScript.

Comments

@muxahuk
Copy link
Contributor

muxahuk commented Nov 7, 2020

Bug description

When i was copying repo to contribute i encountered that in order to build "client" package i had to install YARN globally, although in the CONTRIBUTING.md it is not mentioned.
Here's the usage place that was failing for me before i installed YARN:

await execa.command(`yarn pack -f ${archivePath}`, {

How to reproduce

  1. Consider clean npm install (no yarn is installed)
  2. Follow CONTRIBUTING.md guide for "client"

Expected behavior

  1. YARN is mentioned in CONTRIBUTING.md
    or
  2. YARN is not mentioned in CONTRIBUTING.md, but then "client" should be able to build and i can contribute without having YARN

Environment & setup

  • OS: Ubuntu 20.04.1 LTS
  • Node.js version: v15.1.0
  • NPM version: 7.0.9
  • Prisma version: git master branch
@muxahuk muxahuk changed the title CONTRIBUTING.md missing YARN dependecny CONTRIBUTING.md missing YARN dependency Nov 7, 2020
@pantharshit00 pantharshit00 added good first issue Always wanted to get involved in an open source project but don’t know where to begin? Welcome! kind/docs labels Nov 9, 2020
muxahuk added a commit to muxahuk/prisma that referenced this issue Nov 11, 2020
fixes prisma#4179 by adding a check if yarn is available and if not uses npm pack instead
@Jolg42
Copy link
Member

Jolg42 commented Nov 11, 2020

Nice catch! Thanks for reporting it 😃

@muxahuk
Copy link
Contributor Author

muxahuk commented Nov 11, 2020

@Jolg42 bdw. i haven't found any minimal requirements in the docs. To know what is the minimal node version that prisma supports. in tthe client and cli packages in package.json they mention >=10 node version. But when i installed 10.0.0 pnpm said it cannot be installed and requires minimum 10.13.0 to use it..

What is the official minimal node and npm supported version? should it be mentioned somewhere in the docs? or if i'm blind can u please link to the requirements?:)

@Jolg42
Copy link
Member

Jolg42 commented Nov 11, 2020

@muxahuk So in the docs it's indeed mentioned sometimes but not always that Node.js 10 minimum is required, this issue tracks the progress of making it clearer.

I am not aware of any error mentioning version 10.13.0 minimum, could you paste the error you encountered? It will be good to clarify what is the minimum version, it's possible that a recent feature we shipped requires a certain version of Node 10 🤔) or a specific dev dependency?

Recommended versions that are 100% confirmed to work are latest v12 or v14 (latest v10 works too but it is only in maintenance for a few more months so better to go with 12 minimum.)

@Jolg42
Copy link
Member

Jolg42 commented Nov 11, 2020

I think this is the error you encountered https://github.com/pnpm/pnpm/blob/86d21759da65326d24f77815a1af25be40e6013e/packages/pnpm/bin/pnpm.js#L5

So indeed to install the latest pnpm version you would need Node 10.13.0 locally.

We will need to update the CONTRIBUTING.md with that version then. Thanks!

@Jolg42 Jolg42 added the tech/typescript Issue for tech TypeScript. label Nov 11, 2020
@muxahuk
Copy link
Contributor Author

muxahuk commented Nov 11, 2020

I think this is the error you encountered https://github.com/pnpm/pnpm/blob/86d21759da65326d24f77815a1af25be40e6013e/packages/pnpm/bin/pnpm.js#L5

yep, that's the error.

After i done changes for the related MR i realized that fs.promises might not be supported in older versions of node and was trying to find minimal requirements. After installing node v10 - got error from pnpm and installed 10.13. So i changed the MR to use more common approach for node v10 - promisify..

Thanks for clarifying and adding references.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Always wanted to get involved in an open source project but don’t know where to begin? Welcome! tech/typescript Issue for tech TypeScript.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants