Files
penpot/plugins
Andrey Antukh aadb6255e8 🐛 Deliver the repaired save in the response and keep it convergent
A repaired save could leave the client that saved with a different
state than the server: the websocket repair message could arrive before
the HTTP response, while the save was still queued, and the client undid
and re-applied the pending commit around it (R;U instead of U;R).

The repair changes now travel in the update-file response. The saver
applies them once its commit is acknowledged, and the file channel
hides the repair message from the saver with :origin-session-id. The
commits queued behind the acknowledged one are undone, the repair is
applied and they are replayed, so the local order (C1;R;C2) matches the
server's. The search index receives the repair and the pending commits
through the same helper as the normal commit path.

The notifications are published after the transaction commits, so a
save that rolls back does not notify. The snapshot that a repair leaves
keeps the file as it was before any change or repair.

The pin of a plugin version treats a false answer as a failure, in the
plugin and in the workspace, and so do rename and remove. The workspace
shows a toast when the pin fails.

The schema of the update-file result describes the real response, and
the test helper runs the deferred hooks like the HTTP layer. A retry of
a save whose response was lost can compute a second repair; the
limitation is documented.

Closes #12416

AI-assisted-by: deepseek-v4.1-flash
2026-11-05 12:05:16 +00:00
..
2025-12-30 14:56:15 +01:00
2026-11-03 23:34:16 +01:00
2026-10-29 15:43:06 +01:00
2026-07-08 12:57:45 +02:00
2025-12-30 14:56:15 +01:00
2025-12-30 14:56:15 +01:00
2026-02-10 08:29:24 +01:00
2025-12-30 14:56:15 +01:00
2025-12-30 14:56:15 +01:00
2026-10-29 15:43:06 +01:00
2026-10-29 15:43:06 +01:00
2025-12-30 14:56:15 +01:00

Penpot Plugins

What can you find here?

We've been working in an MVP to allow users to develop their own plugins and use the existing ones.

There are 2 important folders to keep an eye on: apps and libs.

In the libs folder you'll find:

  • plugins-runtime: here you'll find the code that initializes the plugin and sets a few listeners to know when the penpot page/file/selection changes. It has its own README.
  • plugins-styles: basic css library with penpot styles in case you need help for styling your plugins.

In the apps folder you'll find some examples that use the libraries mentioned above.

pnpm run start:styles-example

Open in your browser: http://localhost:4202/

Run Penpot sample plugins

This guide will help you launch a Penpot plugin from the penpot-plugins repository. Before proceeding, ensure that you have Penpot running locally by following the setup instructions.

In the terminal, navigate to the penpot-plugins repository and run pnpm -r install to install the required dependencies. Then, run pnpm run start to launch the plugins runtime.

After installing the dependencies, choose a plugin to launch. You can either run one of the provided examples or create your own (see "Creating a plugin from scratch" below). To launch a plugin, Open a new terminal tab and run the appropriate startup script for the chosen plugin.

For instance, to launch the Contrast plugin, use the following command:

// for the contrast plugin
pnpm run start:plugin:contrast

Finally, open in your browser the specific port. In this specific example would be http://localhost:4302

A table listing the available plugins and their corresponding startup commands is provided below.

Sample plugins

Plugin Description PORT Start command Manifest URL
poc-state-plugin Sandbox plugin to test new plugins api functionality 4202 pnpm run start:plugin:poc-state http://localhost:4202/assets/manifest.json
contrast-plugin Sample plugin that gives you color contrast information 4202 pnpm run start:plugin:contrast http://localhost:4202/assets/manifest.json
icons-plugin Tool to add icons from Feather 4202 pnpm run start:plugin:icons http://localhost:4202/assets/manifest.json
lorem-ipsum-plugin Generate Lorem ipsum text 4202 pnpm run start:plugin:loremipsum http://localhost:4202/assets/manifest.json
create-palette-plugin Creates a board with all the palette colors 4202 pnpm run start:plugin:palette http://localhost:4202/assets/manifest.json
table-plugin Create or import table 4202 pnpm run start:table-plugin http://localhost:4202/assets/manifest.json
rename-layers-plugin Rename layers in bulk 4202 pnpm run start:plugin:renamelayers http://localhost:4202/assets/manifest.json
colors-to-tokens-plugin Generate tokens JSON file 4202 pnpm run start:plugin:colors-to-tokens http://localhost:4202/assets/manifest.json
poc-tokens-plugin Sandbox plugin to test tokens functionality 4202 pnpm run start:plugin:poc-tokens http://localhost:4202/assets/manifest.json

Web Apps

App Description PORT Start command URL
plugins-runtime Runtime for the plugins subsystem 4200 pnpm run start:app:runtime
example-styles Showcase of some of the Penpot styles that can be used in plugins 4201 pnpm run start:app:styles-example http://localhost:4201/

Creating a plugin from scratch

If you want to create a new plugin, read the following README

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.

Copyright (c) KALEIDOS SUBSIDIARY SL

Penpot is a Kaleidos’ open source project