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.

Sign up for GitHub

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

Jump to bottom

[Bug]: wrong peerDependencies resolving #5670

Closed
1 task done
chuuddo opened this issue Sep 26, 2024 · 7 comments
Closed
1 task done

[Bug]: wrong peerDependencies resolving #5670

chuuddo opened this issue Sep 26, 2024 · 7 comments
Labels
Category: Open Source The issue or pull reuqest is related to the open source packages of Tiptap. Type: Bug The issue or pullrequest is related to a bug

Comments

@chuuddo
Copy link

chuuddo commented Sep 26, 2024

Affected Packages

core, extension-heading, extension-link, extension-list-item, pm, starter-kit, vue-3

Version(s)

2.6.6

Bug Description

Installing these packages results in the message from npm "warn ERESOLVE overriding peer dependency"

npm i @tiptap/core@2.6.6 @tiptap/extension-heading@2.6.6 @tiptap/extension-link@2.6.6 @tiptap/extension-list-item@2.6.6 @tiptap/pm@2.6.6 @tiptap/starter-kit@2.6.6 @tiptap/vue-3@2.6.6 --save-exact

npm ls @tiptap/core
test-tiptap-install@1.0.0 /Users/ichudin/dev/test-tiptap-install
├── @tiptap/core@2.6.6
├─┬ @tiptap/extension-heading@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/extension-link@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/extension-list-item@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/starter-kit@2.6.6
│ ├── @tiptap/core@2.7.4
│ ├─┬ @tiptap/extension-blockquote@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-bold@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-bullet-list@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-code-block@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-code@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-document@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-dropcursor@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-gapcursor@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-hard-break@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-history@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-horizontal-rule@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-italic@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-ordered-list@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-paragraph@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-strike@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ └─┬ @tiptap/extension-text@2.7.4
│   └── @tiptap/core@2.7.4 deduped
└─┬ @tiptap/vue-3@2.6.6
  ├── @tiptap/core@2.6.6 deduped
  ├─┬ @tiptap/extension-bubble-menu@2.7.4
  │ └── @tiptap/core@2.6.6 deduped invalid: "^2.7.0" from node_modules/@tiptap/vue-3/node_modules/@tiptap/extension-bubble-menu
  └─┬ @tiptap/extension-floating-menu@2.7.4
    └── @tiptap/core@2.6.6 deduped invalid: "^2.7.0" from node_modules/@tiptap/vue-3/node_modules/@tiptap/extension-bubble-menu, "^2.7.0" from node_modules/@tiptap/vue-3/node_modules/@tiptap/extension-floating-menu

npm error code ELSPROBLEMS
npm error invalid: @tiptap/core@2.6.6 /Users/ichudin/dev/test-tiptap-install/node_modules/@tiptap/core

npm ls @tiptap/pm
test-tiptap-install@1.0.0 /Users/ichudin/dev/test-tiptap-install
├─┬ @tiptap/core@2.6.6
│ └── @tiptap/pm@2.6.6 deduped
├─┬ @tiptap/extension-link@2.6.6
│ └── @tiptap/pm@2.6.6 deduped
├── @tiptap/pm@2.6.6
├─┬ @tiptap/starter-kit@2.6.6
│ ├─┬ @tiptap/core@2.7.4
│ │ └── @tiptap/pm@2.7.4 deduped
│ ├─┬ @tiptap/extension-code-block@2.7.4
│ │ └── @tiptap/pm@2.7.4 deduped
│ ├─┬ @tiptap/extension-dropcursor@2.7.4
│ │ └── @tiptap/pm@2.7.4 deduped
│ ├─┬ @tiptap/extension-gapcursor@2.7.4
│ │ └── @tiptap/pm@2.7.4 deduped
│ ├─┬ @tiptap/extension-history@2.7.4
│ │ └── @tiptap/pm@2.7.4 deduped
│ ├─┬ @tiptap/extension-horizontal-rule@2.7.4
│ │ └── @tiptap/pm@2.7.4 deduped
│ └── @tiptap/pm@2.7.4
└─┬ @tiptap/vue-3@2.6.6
  ├─┬ @tiptap/extension-bubble-menu@2.7.4
  │ └── @tiptap/pm@2.6.6 deduped invalid: "^2.7.0" from node_modules/@tiptap/vue-3/node_modules/@tiptap/extension-bubble-menu
  ├─┬ @tiptap/extension-floating-menu@2.7.4
  │ └── @tiptap/pm@2.6.6 deduped invalid: "^2.7.0" from node_modules/@tiptap/vue-3/node_modules/@tiptap/extension-bubble-menu, "^2.7.0" from node_modules/@tiptap/vue-3/node_modules/@tiptap/extension-floating-menu
  └── @tiptap/pm@2.6.6 deduped

npm error code ELSPROBLEMS
npm error invalid: @tiptap/pm@2.6.6 /Users/ichudin/dev/test-tiptap-install/node_modules/@tiptap/pm

Browser Used

Other

Code Example URL

No response

Expected Behavior

Expected that only one version(2.6.6) will be installed for @tiptap/core and @tiptap/pm.

Additional Context (Optional)

npm -v && node -v
10.8.3
v20.11.0

Dependency Updates

  • Yes, I've updated all my dependencies.
@chuuddo chuuddo added Category: Open Source The issue or pull reuqest is related to the open source packages of Tiptap. Type: Bug The issue or pullrequest is related to a bug labels Sep 26, 2024
@nperez0111
Copy link
Contributor

So because each package has peer deps, if you do not specify every package in your package.json to be at a specific version this can happen. Like for example you are not using the bubble menu, but it is a peer dep of vue so it is resolving to a later version.
The good thing is that all the packages should be interoperable, so it really isn't too much of a big deal in practice. But, to resolve them, you either need all the packages specified or for everything to be updated to the latest versions.

In Tiptap v3 we plan to drastically reduce the number of packages so that this would be much less of an issue for people

@chuuddo
Copy link
Author

chuuddo commented Sep 26, 2024

What about @tiptap/starter-kit? This package does not have any peerDependencies.

npm i @tiptap/core@2.6.6 @tiptap/extension-heading@2.6.6 @tiptap/extension-link@2.6.6 @tiptap/extension-list-item@2.6.6 @tiptap/pm@2.6.6 @tiptap/starter-kit@2.6.6 @tiptap/vue-3@2.6.6 @tiptap/extension-bubble-menu@2.6.6 @tiptap/extension-floating-menu@2.6.6 --save-exact

npm ls @tiptap/core
test-tiptap-install@1.0.0 /Users/ichudin/dev/test-tiptap-install
├── @tiptap/core@2.6.6
├─┬ @tiptap/extension-bubble-menu@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/extension-floating-menu@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/extension-heading@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/extension-link@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/extension-list-item@2.6.6
│ └── @tiptap/core@2.6.6 deduped
├─┬ @tiptap/starter-kit@2.6.6
│ ├── @tiptap/core@2.7.4
│ ├─┬ @tiptap/extension-blockquote@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-bold@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-bullet-list@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-code-block@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-code@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-document@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-dropcursor@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-gapcursor@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-hard-break@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-history@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-horizontal-rule@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-italic@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-ordered-list@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-paragraph@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ ├─┬ @tiptap/extension-strike@2.7.4
│ │ └── @tiptap/core@2.7.4 deduped
│ └─┬ @tiptap/extension-text@2.7.4
│   └── @tiptap/core@2.7.4 deduped
└─┬ @tiptap/vue-3@2.6.6
  └── @tiptap/core@2.6.6 deduped

@nperez0111
Copy link
Contributor

Ah, it specifies them as dependencies not peer deps:

tiptap/packages/starter-kit/package.json

Lines 31 to 52 in 6834a7f

"dependencies": {
"@tiptap/core": "^2.7.4",
"@tiptap/extension-blockquote": "^2.7.4",
"@tiptap/extension-bold": "^2.7.4",
"@tiptap/extension-bullet-list": "^2.7.4",
"@tiptap/extension-code": "^2.7.4",
"@tiptap/extension-code-block": "^2.7.4",
"@tiptap/extension-document": "^2.7.4",
"@tiptap/extension-dropcursor": "^2.7.4",
"@tiptap/extension-gapcursor": "^2.7.4",
"@tiptap/extension-hard-break": "^2.7.4",
"@tiptap/extension-heading": "^2.7.4",
"@tiptap/extension-history": "^2.7.4",
"@tiptap/extension-horizontal-rule": "^2.7.4",
"@tiptap/extension-italic": "^2.7.4",
"@tiptap/extension-list-item": "^2.7.4",
"@tiptap/extension-ordered-list": "^2.7.4",
"@tiptap/extension-paragraph": "^2.7.4",
"@tiptap/extension-strike": "^2.7.4",
"@tiptap/extension-text": "^2.7.4",
"@tiptap/pm": "^2.7.4"
},

This isn't really a problem with Tiptap, it is how NPM resolution works

@chuuddo
Copy link
Author

chuuddo commented Sep 26, 2024 •
edited
Loading

i think in this package dependencies should be without ^, except core and pm, they should be moved to peerDependencies

@nperez0111
Copy link
Contributor

I agree that core & pm should be peer deps in starter-kit.

But, starter-kit should not enforce exact dependencies (which is what removing ^ would do).

I could see an argument for allowing any version within the major version like 2.x

@chuuddo
Copy link
Author

chuuddo commented Sep 26, 2024

For example Storybook lock version in a similar package https://github.com/storybookjs/storybook/blob/next/code/addons/essentials/package.json#L91-L99

@nperez0111
Copy link
Contributor

nperez0111 commented Sep 26, 2024 •
edited
Loading

They are using yarn so it is not really comparable.

Just fwiw, even if we change the versioning, you are still going to have this problem, you will need to update versions to get the change that is made. And like I said, we are reducing the number of packages with v3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Category: Open Source The issue or pull reuqest is related to the open source packages of Tiptap. Type: Bug The issue or pullrequest is related to a bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@chuuddo @nperez0111