Development

Prerequisites

• Install pnpm globally:

  npm install --global pnpm
  

Typical Build Process

pnpm install
pnpm -r build

Testing

To run tests use:

pnpm run jest

Update Process

If updating CKEditor 5, it is best done in three steps:

pnpm update:latest:third-party
pnpm update:latest:ckeditor5-dev
pnpm update:latest:ckeditor5

The first one will trigger an update of all other third-party packages.

The second one will trigger an update of the CKEditor 5 Development Tooling.

The third one will perform the update of the main CKEditor 5 packages.

Peer Dependencies: Note, that pnpm update will not update the peerDependencies. This has to be done in a manual adjustment afterwards.

Troubleshooting

• Remove node_modules:

  In case of problems, you may want to try to remove all node_modules folders and re-install artifacts again via pnpm install. Removing node_modules can be triggered by:

  pnpm clean:node_modules