chore: use pnpm instead of npm #1567

nperez0111 · 2025-03-26T21:42:00Z

This PR introduces using pnpm instead of npm, pnpm is much better suited for:

monorepos
speed
running commands across packages (taking over part of lerna's role)

It also completely replaces lerna in favor of NX (which lerna was already based on). This gives us one tool to:

run commands and cache their results
release packages

This PR also renames several PNPM scripts, to be more standard. The goal should be for PNPM scripts to already have the most commonly used tasks that you might need within the repo. It should be possible to do everything you need from the root of the repo.

vercel · 2025-03-26T21:42:02Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
blocknote	🛑 Canceled (Inspect)		Apr 4, 2025 3:11pm
blocknote-website	✅ Ready (Inspect)	Visit Preview	Apr 4, 2025 3:11pm

nperez0111 · 2025-04-01T14:02:33Z

This is ready for review now @YousefED

YousefED

awesome!! looking forward to using this

.github/workflows/build.yml

YousefED · 2025-04-03T05:51:54Z

.github/workflows/build.yml

+      - name: Soft release
+        id: soft-release
+        run: pnpx pkg-pr-new publish './packages/*' # --compact enable compact after release


cool! when do you use it for testing?

YousefED · 2025-04-03T05:53:38Z

.github/workflows/publish.yaml

@@ -0,0 +1,61 @@
+# ./.github/workflows/publish.yml
+name: Publish


awesome! very curious about this!

YousefED · 2025-04-03T05:57:50Z

.npmrc

@@ -0,0 +1,4 @@
+link-workspace-packages=deep
+prefer-workspace-packages=true
+public-hoist-pattern[]=prosemirror-*


why do we need this?

Also; maybe cleaner to use pnpm-workspace.yaml (I could find the dashed options because the pnpm docs describe the yaml options which are camelCase :/ )

YousefED · 2025-04-03T06:15:36Z

packages/dev-scripts/examples/util.ts

@@ -1,4 +1,4 @@
-import glob from "fast-glob";
+import { globSync } from "tinyglobby";


what was the reason for this? curious

I was trying to figure out why the gen step went from 2 seconds to 45 seconds. Turns out that we were globbing through node_modules that pnpm put in each directory.
I thought that the globbing library may have been an issue with the performance. So I switched out the package for a lighter weight one, but I then found it going through the node_modules and had no way of filtering so I had to rewrite it. So, I kept this lib

YousefED · 2025-04-03T06:17:07Z

packages/react/src/hooks/useUIElementPositioning.ts

@@ -7,12 +7,21 @@ import {
 } from "@floating-ui/react";
 import { useEffect, useMemo } from "react";

+type UIElementPosition = {


I'm gessing a ts change or sth that made this necessary?

Yep, otherwise:

boolean, YousefED1 day ago I'm gessing a ts change or sth that made this necessary? The inferred type of 'useUIElementPositioning' cannot be named without a reference to '.pnpm/@[email protected][email protected][email protected][email protected]/node_modules/@floating-ui/react-dom'. This is likely not portable. A type annotation is necessary.

Triggered because I regenerated the node_modules so it upgraded TS

YousefED · 2025-04-03T06:18:09Z

packages/xl-docx-exporter/src/docx/__snapshots__/withCustomOptions/document.xml.rels

@@ -14,4 +14,5 @@
    <Relationship Id="FAKE-ID" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" Target="" TargetMode="External"/>
    <Relationship Id="FAKE-ID" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" Target="https://www.blocknotejs.org" TargetMode="External"/>
    <Relationship Id="FAKE-ID" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/e1037269513fbdc121e06bb1bc7cf37b9045c8fc.gif"/>
+    <Relationship Id="FAKE-ID" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" Target="fontTable.xml"/>


triggered by an upgrade?

Yep, upgrade of a patch version

YousefED · 2025-04-03T06:19:12Z

packages/xl-multi-column/package.json

@@ -65,7 +73,9 @@
    "typescript": "^5.3.3",
    "vite": "^5.3.4",
    "vite-plugin-eslint": "^1.8.1",
-    "vitest": "^2.0.3"
+    "vitest": "^2.0.3",
+    "react": "^19",


should this be ^18?

I put 19 to test against that, but 19 is stable now so it shouldn't matter which

YousefED · 2025-04-03T06:19:55Z

packages/xl-pdf-exporter/src/pdf/defaultSchema/index.ts

@@ -2,7 +2,11 @@ import { pdfBlockMappingForDefaultSchema } from "./blocks.js";
 import { pdfInlineContentMappingForDefaultSchema } from "./inlinecontent.js";
 import { pdfStyleMappingForDefaultSchema } from "./styles.js";

-export const pdfDefaultSchemaMappings = {
+export const pdfDefaultSchemaMappings: {


weird that this was needed, typescript issue?

YousefED · 2025-04-06T16:40:33Z

pnpm-workspace.yaml

+  - "examples/*/*"
+  - "playground"
+  - "docs"
+  - "shared"


@nperez0111 I'm not sure shared should be part of the workspace.

The way it is now, shared contains some code (utility functions) that's shared by different packages (mainly, the exporters). However, it's not bundled in it's own package. Rather, the functions are just included in the consuming packages

a) should we remove it here?
b) I tried to remove it, but then got an error in one of the exporters (TS errors in toMatchBinaryFileSnapshot)

The workspace defines where to install packages from. By default, pnpm installs packages "scoped" i.e. a project can only resolve the packages that it declares.

So, shared has dependency on image-meta (imageUtil) & @types/node (binarySnapshotUtil). So when you remove it from the workspace, it can no longer find those packages since they exist in the project they are used in, not in it's source path.

There are two ways to resolve this. Make shared into a workspace package (leveraging it only as an project, not a package), or install it's deps like I did.

Or, remove the shared project altogether & just keep the files into their respective projects, which I'm most partial to since it keeps things simple.

Or, remove the shared project altogether & just keep the files into their respective projects, which I'm most partial to since it keeps things simple.

I think for code duplication that's not ideal. I think specifically for test utilities we should actually move a lot more to the shared package (test cases and utilities that are shared across packages) - unless you have a better solution for this.

There are two ways to resolve this. Make shared into a workspace package (leveraging it only as an project, not a package), or install it's deps like I did.

I'm not sure I understand the difference between the two. Currently it's a workspace package right?

I think for code duplication that's not ideal. I think specifically for test utilities we should actually move a lot more to the shared package (test cases and utilities that are shared across packages) - unless you have a better solution for this.

I think test utilities should be in/reusing the existing test package:

BlockNote/tests/package.json

Line 2 in 7df528c

"name": "@blocknote/tests",

it's a package, so it is perfectly valid to import/export things from it.

So, the only one that I think is valid to live here is the image util, and even then, I don't see why this can't be either duplicated or exported from @blocknote/core (ideally their would actually be a @blocknote/core/exporter sub package for this reason)

I'm not sure I understand the difference between the two. Currently it's a workspace package right?

Sorry, I could've explained that better. The difference is:

workspace package: @blocknote/shared as a devDep to whatever uses it (so linking via pnpm workspaces)

tricking vite to resolve it like we are doing now:

BlockNote/packages/xl-docx-exporter/vite.config.ts

Lines 23 to 25 in 27494f6

? ({

"@shared": path.resolve(__dirname, "../../shared/"),

} as Record<string, string>)

In either of these cases, you still need anything shared depends to be installed to this directory (whether you consider it a package or not).

Thanks.

For (1), wouldn't it require us to publish that package to npm? (if we use functions from it in non-testing code)?

Nope, you can set it up where @blocknote/shared is declared as not "external" (i.e. vite/rollup should bundle it into the package that you are trying to build like docx-exporter). So, at build time the import would be resolved correctly within the repo & the consumer would not need (or even know about) that package.

Ah makes sense. I suppose that's cleaner than what we currently have, because dependencies are better managed right?

Should we go for that approach? Also happy to discuss whether the package is needed at all - I think easier to go over that on a call

chore: use pnpm instead of npm

2bac42e

vercel bot had a problem deploying to Preview – blocknote March 26, 2025 21:42 Failure

vercel bot had a problem deploying to Preview – blocknote-website March 26, 2025 21:43 Failure

build: update CI

12dfced

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 07:16 Failure

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 07:17 Failure

nperez0111 added 2 commits March 27, 2025 08:19

build: setup pnpm

ae4c0f1

chore: forgot this one

adae213

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 07:23 Failure

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 07:24 Failure

chore: rm no-audit

4fddc69

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 07:26 Failure

chore: rm bootstrap step

6a6e06f

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 07:28 Failure

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 07:28 Failure

chore: rm linting on examples

9df99a8

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 07:32 Failure

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 07:33 Failure

chore: only hoist prosemirror deps

1c7ea67

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 07:53 Failure

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 07:54 Failure

test: await test expectations

5ad3d23

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 08:08 Failure

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 08:08 Failure

fix: resolve type issues with not hoisting react

0000fb3

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 08:37 Failure

vercel bot had a problem deploying to Preview – blocknote March 27, 2025 08:38 Failure

chore: go back to react 18 types

13815cd

vercel bot had a problem deploying to Preview – blocknote-website March 27, 2025 08:50 Failure

chore: rm lint from example

a1eba33

vercel bot deployed to Preview – blocknote-website April 1, 2025 12:53 View deployment

vercel bot deployed to Preview – blocknote April 1, 2025 13:04 View deployment

fix: speedup file generation

928146e

vercel bot deployed to Preview – blocknote-website April 1, 2025 13:51 View deployment

nperez0111 added 2 commits April 1, 2025 15:59

chore: minimize output

55ad362

refactor: use type declaration

2ae4c71

nperez0111 requested a review from YousefED April 1, 2025 14:02

vercel bot deployed to Preview – blocknote-website April 1, 2025 14:09 View deployment

vercel bot deployed to Preview – blocknote April 1, 2025 14:19 View deployment

YousefED approved these changes Apr 3, 2025

View reviewed changes

nperez0111 added 3 commits April 4, 2025 15:10

chore: try without rebuild

b637e0b

Merge branch 'main' into pnpm

8ecfc6c

chore: bunch of cleanup

4e2491f

vercel bot deployed to Preview – blocknote April 4, 2025 13:56 View deployment

nperez0111 added 3 commits April 4, 2025 15:58

chore: use PLAYWRIGHT_CONFIG env var

29044b6

chore: change cache dir

fa31ada

chore: update cache location

ce9d478

vercel bot deployed to Preview – blocknote-website April 4, 2025 14:18 View deployment

nperez0111 added 2 commits April 4, 2025 16:23

chore: update nx cache dir

8a45fbd

chore: use nx legacy cache

067ba7b

nperez0111 force-pushed the pnpm branch from c0b8a45 to 067ba7b Compare April 4, 2025 14:41

nperez0111 added 2 commits April 4, 2025 16:47

test: run build again

285ba9c

chore: make into separate caches

f89bc8c

vercel bot deployed to Preview – blocknote April 4, 2025 15:04 View deployment

vercel bot deployed to Preview – blocknote-website April 4, 2025 15:11 View deployment

nperez0111 merged commit 7df528c into main Apr 4, 2025
8 checks passed

nperez0111 deleted the pnpm branch April 4, 2025 15:29

YousefED reviewed Apr 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: use pnpm instead of npm #1567

chore: use pnpm instead of npm #1567

nperez0111 commented Mar 26, 2025 •

edited

Loading

vercel bot commented Mar 26, 2025 •

edited

Loading

nperez0111 commented Apr 1, 2025

YousefED left a comment

YousefED Apr 3, 2025

YousefED Apr 3, 2025

YousefED Apr 3, 2025

YousefED Apr 3, 2025

nperez0111 Apr 4, 2025

YousefED Apr 3, 2025

nperez0111 Apr 4, 2025

YousefED Apr 3, 2025

nperez0111 Apr 4, 2025

YousefED Apr 3, 2025

nperez0111 Apr 4, 2025

YousefED Apr 3, 2025

YousefED Apr 6, 2025

nperez0111 Apr 7, 2025

nperez0111 Apr 7, 2025

YousefED Apr 7, 2025

nperez0111 Apr 7, 2025

YousefED Apr 7, 2025

nperez0111 Apr 7, 2025 •

edited

Loading

YousefED Apr 7, 2025

		@@ -0,0 +1,61 @@
		# ./.github/workflows/publish.yml
		name: Publish

		@@ -1,4 +1,4 @@
		import glob from "fast-glob";
		import { globSync } from "tinyglobby";

	? ({
	"@shared": path.resolve(__dirname, "../../shared/"),
	} as Record<string, string>)

chore: use pnpm instead of npm #1567

chore: use pnpm instead of npm #1567

Conversation

nperez0111 commented Mar 26, 2025 • edited Loading

vercel bot commented Mar 26, 2025 • edited Loading

nperez0111 commented Apr 1, 2025

YousefED left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nperez0111 Apr 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nperez0111 commented Mar 26, 2025 •

edited

Loading

vercel bot commented Mar 26, 2025 •

edited

Loading

nperez0111 Apr 7, 2025 •

edited

Loading