build: migrate to pnpm #5978

nperez0111 · 2025-01-02T12:17:42Z

Changes Overview

This PR, migrates us to use pnpm for installs, revamps our pipelines to actually hit caches, updates our packages to export CJS types correctly, and a number of small cross-cutting changes.

I've also implemented prettier formatting into the repo merging in this PR: #5796

AI summary

This pull request includes significant updates to the build and publish workflows, the transition from npm to pnpm, and various dependency updates. The most important changes are as follows:

Workflow Improvements:

Added PNPM_VERSION environment variable and updated workflows to use pnpm for installing dependencies and running scripts. (.github/workflows/build.yml, .github/workflows/publish.yml) [1] [2]
Modified caching strategies to use pnpm and turbo cache for improved build performance. (.github/workflows/build.yml, .github/workflows/publish.yml) [1] [2] [3] [4]

Dependency and Script Updates:

Updated various dependencies and scripts to ensure compatibility with pnpm, including updates to package.json files and the addition of new dependencies. (demos/package.json, package.json, packages/core/package.json, packages/extension-blockquote/package.json, packages/extension-bold/package.json, packages/extension-bubble-menu/package.json) [1] [2] [3] [4] [5] [6]

Configuration Changes:

Added link-workspace-packages and prefer-workspace-packages settings to .npmrc for better workspace management. (.npmrc)
Updated lint-staged configuration and moved it from .lintstagedrc.js to package.json. (.lintstagedrc.js, package.json) [1] [2]

Codebase Enhancements:

Added linting scripts to individual package package.json files to ensure code quality. (packages/core/package.json, packages/extension-blockquote/package.json, packages/extension-bold/package.json, packages/extension-bubble-menu/package.json) [1] [2] [3] [4]
Improved type definitions in the exports field for better module resolution. (packages/core/package.json, packages/extension-blockquote/package.json, packages/extension-bold/package.json, packages/extension-bubble-menu/package.json) [1] [2] [3] [4]

Miscellaneous:

Removed unnecessary imports and updated paths in demos/vite.config.ts. (demos/vite.config.ts)
Updated the findParentNode function to improve type safety in packages/core/src/helpers/findParentNode.ts. (packages/core/src/helpers/findParentNode.ts)

Implementation Approach

Testing Done

Verification Steps

Additional Notes

Checklist

I have created a changeset for this PR if necessary.
My changes do not break the library.
I have added tests where applicable.
I have followed the project guidelines.
I have fixed any lint issues.

Related Issues

changeset-bot · 2025-01-02T12:17:47Z

⚠️ No Changeset found

Latest commit: 1c999d9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 56 packages

Name	Type
@tiptap/core	Patch
@tiptap/extension-font-size	Patch
@tiptap/extension-blockquote	Patch
@tiptap/extension-bold	Patch
@tiptap/extension-bubble-menu	Patch
@tiptap/extension-bullet-list	Patch
@tiptap/extension-character-count	Patch
@tiptap/extension-code-block-lowlight	Patch
@tiptap/extension-code-block	Patch
@tiptap/extension-code	Patch
@tiptap/extension-collaboration-cursor	Patch
@tiptap/extension-collaboration	Patch
@tiptap/extension-color	Patch
@tiptap/extension-document	Patch
@tiptap/extension-dropcursor	Patch
@tiptap/extension-floating-menu	Patch
@tiptap/extension-focus	Patch
@tiptap/extension-font-family	Patch
@tiptap/extension-gapcursor	Patch
@tiptap/extension-hard-break	Patch
@tiptap/extension-heading	Patch
@tiptap/extension-highlight	Patch
@tiptap/extension-history	Patch
@tiptap/extension-horizontal-rule	Patch
@tiptap/extension-image	Patch
@tiptap/extension-italic	Patch
@tiptap/extension-link	Patch
@tiptap/extension-list-item	Patch
@tiptap/extension-list-keymap	Patch
@tiptap/extension-mention	Patch
@tiptap/extension-ordered-list	Patch
@tiptap/extension-paragraph	Patch
@tiptap/extension-placeholder	Patch
@tiptap/extension-strike	Patch
@tiptap/extension-subscript	Patch
@tiptap/extension-superscript	Patch
@tiptap/extension-table-cell	Patch
@tiptap/extension-table-header	Patch
@tiptap/extension-table-row	Patch
@tiptap/extension-table	Patch
@tiptap/extension-task-item	Patch
@tiptap/extension-task-list	Patch
@tiptap/extension-text-align	Patch
@tiptap/extension-text-style	Patch
@tiptap/extension-text	Patch
@tiptap/extension-typography	Patch
@tiptap/extension-underline	Patch
@tiptap/extension-utils	Patch
@tiptap/extension-youtube	Patch
@tiptap/html	Patch
@tiptap/pm	Patch
@tiptap/react	Patch
@tiptap/starter-kit	Patch
@tiptap/suggestion	Patch
@tiptap/vue-2	Patch
@tiptap/vue-3	Patch

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify · 2025-01-02T12:18:00Z

✅ Deploy Preview for tiptap-embed ready!

Name	Link
🔨 Latest commit	`1c999d9`
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/677b955fae494700081049c6
😎 Deploy Preview	https://deploy-preview-5978--tiptap-embed.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pkg-pr-new · 2025-01-02T16:39:15Z

Open in Stackblitz

@tiptap/core

npm i https://pkg.pr.new/@tiptap/core@5978

@tiptap/extension-blockquote

npm i https://pkg.pr.new/@tiptap/extension-blockquote@5978

@tiptap/extension-bubble-menu

npm i https://pkg.pr.new/@tiptap/extension-bubble-menu@5978

@tiptap/extension-bullet-list

npm i https://pkg.pr.new/@tiptap/extension-bullet-list@5978

@tiptap/extension-bold

npm i https://pkg.pr.new/@tiptap/extension-bold@5978

@tiptap/extension-character-count

npm i https://pkg.pr.new/@tiptap/extension-character-count@5978

@tiptap/extension-code

npm i https://pkg.pr.new/@tiptap/extension-code@5978

@tiptap/extension-code-block

npm i https://pkg.pr.new/@tiptap/extension-code-block@5978

@tiptap/extension-code-block-lowlight

npm i https://pkg.pr.new/@tiptap/extension-code-block-lowlight@5978

@tiptap/extension-collaboration

npm i https://pkg.pr.new/@tiptap/extension-collaboration@5978

@tiptap/extension-collaboration-cursor

npm i https://pkg.pr.new/@tiptap/extension-collaboration-cursor@5978

@tiptap/extension-color

npm i https://pkg.pr.new/@tiptap/extension-color@5978

@tiptap/extension-document

npm i https://pkg.pr.new/@tiptap/extension-document@5978

@tiptap/extension-dropcursor

npm i https://pkg.pr.new/@tiptap/extension-dropcursor@5978

@tiptap/extension-floating-menu

npm i https://pkg.pr.new/@tiptap/extension-floating-menu@5978

@tiptap/extension-focus

npm i https://pkg.pr.new/@tiptap/extension-focus@5978

@tiptap/extension-font-family

npm i https://pkg.pr.new/@tiptap/extension-font-family@5978

@tiptap/extension-font-size

npm i https://pkg.pr.new/@tiptap/extension-font-size@5978

@tiptap/extension-gapcursor

npm i https://pkg.pr.new/@tiptap/extension-gapcursor@5978

@tiptap/extension-hard-break

npm i https://pkg.pr.new/@tiptap/extension-hard-break@5978

@tiptap/extension-heading

npm i https://pkg.pr.new/@tiptap/extension-heading@5978

@tiptap/extension-highlight

npm i https://pkg.pr.new/@tiptap/extension-highlight@5978

@tiptap/extension-history

npm i https://pkg.pr.new/@tiptap/extension-history@5978

@tiptap/extension-horizontal-rule

npm i https://pkg.pr.new/@tiptap/extension-horizontal-rule@5978

@tiptap/extension-image

npm i https://pkg.pr.new/@tiptap/extension-image@5978

@tiptap/extension-italic

npm i https://pkg.pr.new/@tiptap/extension-italic@5978

@tiptap/extension-link

npm i https://pkg.pr.new/@tiptap/extension-link@5978

@tiptap/extension-list-keymap

npm i https://pkg.pr.new/@tiptap/extension-list-keymap@5978

@tiptap/extension-list-item

npm i https://pkg.pr.new/@tiptap/extension-list-item@5978

@tiptap/extension-mention

npm i https://pkg.pr.new/@tiptap/extension-mention@5978

@tiptap/extension-ordered-list

npm i https://pkg.pr.new/@tiptap/extension-ordered-list@5978

@tiptap/extension-paragraph

npm i https://pkg.pr.new/@tiptap/extension-paragraph@5978

@tiptap/extension-placeholder

npm i https://pkg.pr.new/@tiptap/extension-placeholder@5978

@tiptap/extension-strike

npm i https://pkg.pr.new/@tiptap/extension-strike@5978

@tiptap/extension-subscript

npm i https://pkg.pr.new/@tiptap/extension-subscript@5978

@tiptap/extension-superscript

npm i https://pkg.pr.new/@tiptap/extension-superscript@5978

@tiptap/extension-table

npm i https://pkg.pr.new/@tiptap/extension-table@5978

@tiptap/extension-table-cell

npm i https://pkg.pr.new/@tiptap/extension-table-cell@5978

@tiptap/extension-table-header

npm i https://pkg.pr.new/@tiptap/extension-table-header@5978

@tiptap/extension-table-row

npm i https://pkg.pr.new/@tiptap/extension-table-row@5978

@tiptap/extension-task-item

npm i https://pkg.pr.new/@tiptap/extension-task-item@5978

@tiptap/extension-task-list

npm i https://pkg.pr.new/@tiptap/extension-task-list@5978

@tiptap/extension-text

npm i https://pkg.pr.new/@tiptap/extension-text@5978

@tiptap/extension-text-align

npm i https://pkg.pr.new/@tiptap/extension-text-align@5978

@tiptap/extension-text-style

npm i https://pkg.pr.new/@tiptap/extension-text-style@5978

@tiptap/extension-typography

npm i https://pkg.pr.new/@tiptap/extension-typography@5978

@tiptap/extension-underline

npm i https://pkg.pr.new/@tiptap/extension-underline@5978

@tiptap/extension-youtube

npm i https://pkg.pr.new/@tiptap/extension-youtube@5978

@tiptap/html

npm i https://pkg.pr.new/@tiptap/html@5978

@tiptap/pm

npm i https://pkg.pr.new/@tiptap/pm@5978

@tiptap/react

npm i https://pkg.pr.new/@tiptap/react@5978

@tiptap/starter-kit

npm i https://pkg.pr.new/@tiptap/starter-kit@5978

@tiptap/suggestion

npm i https://pkg.pr.new/@tiptap/suggestion@5978

@tiptap/vue-2

npm i https://pkg.pr.new/@tiptap/vue-2@5978

@tiptap/vue-3

npm i https://pkg.pr.new/@tiptap/vue-3@5978

commit: 2d0cacd

bdbch

Overall it looked fine to me - just a few small questions.

bdbch · 2025-01-06T04:13:16Z

demos/package.json

@@ -15,11 +15,11 @@
    "@shikijs/core": "1.10.3",
    "d3": "^7.9.0",
    "fast-glob": "^3.3.2",
-    "highlight.js": "^11.10.0",


I guess those version bumps were necessary because pnpm won't load the correct dependencies? Seems like only minors/patches were updated - however we had a bad time in the past with packages only upgrading a minor but still breaking something. 😃

Do we have a fast way to make sure those package upgrades are not breaking anything?

I think I just bumped these while regenerating the lockfile (moving from package-lock to pnpm-lock).

I mean the tests ran against all of these and it seems to be working. I know our testing isn't super comprehensive, but we should trust them a bit haha

Ah, here was the issue: https://github.com/ueberdosis/tiptap/actions/runs/12629042554/job/35186222134?pr=5978#step:8:1377

Because the type is re-exported, it needs to be present in node_modules (as opposed to the root workspace). This is actually valid though, it is a hard-dep on the current types exported.

bdbch · 2025-01-06T04:14:50Z

packages/extension-bubble-menu/package.json

@@ -33,13 +33,14 @@
    "directory": "packages/extension-bubble-menu"
  },
  "sideEffects": false,
+  "dependencies": {


Is there a reason why we include floating-ui in the deps now instead of letting users manage it themselves?

My bad, I think I was running into dep resolution problems & this is something I tried that did nothing. Updating.

Though technically, this is mostly equivalent, since the dep is declared as a range.

nperez0111 added 17 commits January 2, 2025 20:11

build: switch to pnpm

75b3836

build: get project building again with pnpm

d429147

build: ci running again

f228e67

build: get demos working again

b473888

chore: build all packages

172f912

build: get packages building again

fe91a39

chore: update build

1179c02

chore: always install

0a49431

build: set pnpm to resolve locally first

53c9d58

build: get builds working

fd15347

build: replace globby with tinyglobby

c552fe3

chore: bump setup-node version

075f1e8

chore: cypress tests work again

3337055

test: specifically resolve pm packages

15e7251

build: optimize the caches

214aa24

build: re-enable commands tests

a41a7e1

build: rm logging of http reqs

2234d48

nperez0111 force-pushed the pnpm branch from e8ae7a5 to 2234d48 Compare January 2, 2025 19:11

nperez0111 added 9 commits January 2, 2025 20:31

build: try serializing pipeline

a8e4a51

build: serialize

1df3450

build: pull from right cache

89cc3ca

build: release at end

ffba16d

build: lint using turbo

99d64c5

build: use turbo to lint

61a0e38

build: export types properly

4a20700

chore: rm dupe

b5fbedc

build: always try to pull from same cache

ba3b9a2

nperez0111 added 2 commits January 2, 2025 21:30

build: split the cache

c6c2b93

chore: use pnpm to exec

2d0cacd

nperez0111 requested a review from bdbch January 3, 2025 08:37

nperez0111 mentioned this pull request Jan 3, 2025

switch from npm to bun for faster dependency resolving #5473

Closed

5 tasks

nperez0111 added 2 commits January 3, 2025 09:52

build: use prettier for linting

1646d1d

chore: reformat all files

6dacc65

nperez0111 mentioned this pull request Jan 3, 2025

build: use prettier for linting #5796

Closed

5 tasks

bdbch approved these changes Jan 6, 2025

View reviewed changes

nperez0111 added 7 commits January 6, 2025 09:11

Merge branch 'next' into pnpm

598fc79

chore: move floating-ui back to peer dep

24bc91d

chore: rm peer dep

c0eff4d

chore: export types for extension-utils properly

1c612fd

fix: make floating-ui a dep that accepts a wide range

40b0ef0

chore: rm devDep

d9862e8

chore: put back peerdep

1c999d9

nperez0111 merged commit 7b4e6f5 into next Jan 6, 2025
10 of 13 checks passed

nperez0111 deleted the pnpm branch January 6, 2025 08:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: migrate to pnpm #5978

build: migrate to pnpm #5978

nperez0111 commented Jan 2, 2025 •

edited

Loading

changeset-bot bot commented Jan 2, 2025 •

edited

Loading

netlify bot commented Jan 2, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 2, 2025 •

edited

Loading

bdbch left a comment

bdbch Jan 6, 2025

nperez0111 Jan 6, 2025

nperez0111 Jan 6, 2025

bdbch Jan 6, 2025

nperez0111 Jan 6, 2025

build: migrate to pnpm #5978

build: migrate to pnpm #5978

Conversation

nperez0111 commented Jan 2, 2025 • edited Loading

Changes Overview

AI summary

Workflow Improvements:

Dependency and Script Updates:

Configuration Changes:

Codebase Enhancements:

Miscellaneous:

Implementation Approach

Testing Done

Verification Steps

Additional Notes

Checklist

Related Issues

changeset-bot bot commented Jan 2, 2025 • edited Loading

⚠️ No Changeset found

netlify bot commented Jan 2, 2025 • edited Loading

✅ Deploy Preview for tiptap-embed ready!

pkg-pr-new bot commented Jan 2, 2025 • edited Loading

bdbch left a comment

Choose a reason for hiding this comment

bdbch Jan 6, 2025

Choose a reason for hiding this comment

nperez0111 Jan 6, 2025

Choose a reason for hiding this comment

nperez0111 Jan 6, 2025

Choose a reason for hiding this comment

bdbch Jan 6, 2025

Choose a reason for hiding this comment

nperez0111 Jan 6, 2025

Choose a reason for hiding this comment

nperez0111 commented Jan 2, 2025 •

edited

Loading

changeset-bot bot commented Jan 2, 2025 •

edited

Loading

netlify bot commented Jan 2, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 2, 2025 •

edited

Loading