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

Node version collision problem of dependencies #897

Open
minai621 opened this issue Sep 7, 2024 · 5 comments
Open

Node version collision problem of dependencies #897

minai621 opened this issue Sep 7, 2024 · 5 comments

Comments

@minai621
Copy link

minai621 commented Sep 7, 2024

What happened:

While trying to clone the yorkie-js-sdk and install its dependencies, I encountered an issue with the required Node version for the dependencies "typescript-transform-paths" and "eslint-plugin-jsdoc". The specific versions of these dependencies require a Node version that causes compatibility issues.

The details are as follows
image

{workspace}/package.json
image

// in sdk
"typescript-transform-paths": "^3.3.1",

// in workspace
"eslint-plugin-jsdoc": "^39.3.3",

What you expected to happen:
The dependencies should be installed without any issues regarding Node version compatibility.

How to reproduce it (as minimally and precisely as possible):

  1. Clone the yorkie-js-sdk repository.
  2. Run npm install to install dependencies.
  3. Observe the node version compatibility error related to "typescript-transform-paths" and "eslint-plugin-jsdoc".

Anything else we need to know?:
Potential solutions might involve aligning the node version requirements across dependencies or updating the dependencies to versions compatible with the currently supported node version.

  • typescript-transform-paths removing the caret (^) and locking it to version "3.3.1", the dependencies work properly with node version 18.

Environment:

  • Operating system: macos sonoma 14.4.1
  • Browser and version:
  • Yorkie version (use yorkie version):
  • Yorkie JS SDK version: 0.5.0
@minai621
Copy link
Author

minai621 commented Sep 7, 2024

If locking the version of "typescript-transform-paths" to "3.3.1" resolves the issue, I will fix this issue.

Please confirm if removing the caret (^) from the "typescript-transform-paths" version is the appropriate solution to ensure compatibility with Node 18.

@gwbaik9717
Copy link
Contributor

gwbaik9717 commented Sep 7, 2024

Could you please provide the version of pnpm installed in your environment? I've confirmed that similar error occurs with pnpm version 8. It should be later than version 9.6.

Screenshot 2024-09-07 at 8 28 44 PM

@minai621
Copy link
Author

minai621 commented Sep 7, 2024

Could you please provide the version of pnpm installed in your environment? I've confirmed that similar error occurs with pnpm version 8. It should be later than version 9.6.

Screenshot 2024-09-07 at 8 28 44 PM

Currently using the 8.15.6 version.
I definitely upgraded to version 9, so there's no problem.
I think adding "engines" in the package.json

{
  "engines": {
    "pnpm": ">= 9.0.0"
  }
}

can solve the problem.

@gwbaik9717
Copy link
Contributor

I agree, it will be nice to have a safety measure in place.

@su-ram
Copy link
Contributor

su-ram commented Sep 14, 2024

{
  "engines": {
    "pnpm": ">= 9.0.0"
  }
}

can solve the problem.

It helps the similar error for me. Thanks.

Also noticed eslint-plugin-jsdoc changed to eslint-plugin-tsdoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

3 participants