mirror of
https://github.com/penpot/penpot-plugins.git
synced 2025-01-06 14:50:21 -05:00
153 lines
4 KiB
Markdown
153 lines
4 KiB
Markdown
# Creating a Plugin
|
|
|
|
This guide walks you through the steps to create an Angular plugin for our platform. You'll start by setting up the basic structure, configuring necessary files, and then running a local server to preview your plugin.
|
|
|
|
If you prefer to create the plugin without a specific framework there's also [Creating a Plugin](./create-plugin.md).
|
|
|
|
Keep in mind that this guide is for creating a plugin **inside `penpot-plugins` monorepo**. If you want to create a plugin outside our environment you can check the [Penpot Plugin Starter Template](https://github.com/penpot/penpot-plugin-starter-template) or the documentation at [Create a Plugin](https://help.penpot.app/plugins/create-a-plugin/).
|
|
|
|
Let's dive in.
|
|
|
|
### Step 1: Initialize the Plugin
|
|
|
|
First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin:
|
|
|
|
```sh
|
|
npx nx g @nx/angular:app example-plugin --directory=apps/example-plugin --bundler=esbuild
|
|
```
|
|
|
|
### Step 2: Configure the Manifest
|
|
|
|
Next, create a `manifest.json` file inside the `/src/assets` directory. This file is crucial as it defines key properties of your plugin, including permissions and the entry point script.
|
|
|
|
```json
|
|
{
|
|
"name": "Example plugin",
|
|
"host": "http://localhost:4200",
|
|
"code": "/assets/plugin.js",
|
|
"icon": "/assets/icon.png",
|
|
"permissions": [
|
|
"content:write",
|
|
"library:write",
|
|
"user:read",
|
|
"comment:read",
|
|
"allow:downloads"
|
|
]
|
|
}
|
|
```
|
|
|
|
### Step 3: Update Project Configuration
|
|
|
|
Now, add the plugin tag.
|
|
|
|
```typescript
|
|
"tags": ["type:plugin"],
|
|
```
|
|
|
|
Also, update `targets.build` with the following code to allow the use of Penpot styles and build the plugin code.
|
|
|
|
```json
|
|
"options": {
|
|
"styles": [
|
|
"libs/plugins-styles/src/lib/styles.css",
|
|
"apps/example-plugin/src/styles.css"
|
|
],
|
|
"optimization": {
|
|
"scripts": true,
|
|
"styles": true,
|
|
"fonts": false
|
|
}
|
|
},
|
|
"dependsOn": ["buildPlugin"]
|
|
```
|
|
|
|
Add the default port to the `serve.configurations.development` task:
|
|
|
|
```json
|
|
"development": {
|
|
// ...
|
|
"port": 4302,
|
|
}
|
|
```
|
|
|
|
For choosing the port go check the Sample Plugins table at the [README](../README.md) so your plugin doesn't use a duplicate port. We're using the range 4300-4399.
|
|
|
|
### Step 4: Modify TypeScript Configuration
|
|
|
|
Create ``tsconfig.plugin.json` next to the `tsconfig.json`:
|
|
|
|
```json
|
|
{
|
|
"extends": "./tsconfig.json",
|
|
"compilerOptions": {
|
|
"types": []
|
|
},
|
|
"files": ["src/plugin.ts"],
|
|
"include": ["../../libs/plugin-types/index.d.ts"]
|
|
}
|
|
```
|
|
|
|
Add the reference to the main tsconfig.json:
|
|
|
|
```json
|
|
"references": [
|
|
{
|
|
"path": "./tsconfig.plugin.json"
|
|
}
|
|
],
|
|
```
|
|
|
|
### Step 5: Add TS parser to eslint
|
|
|
|
Add these options to the end of the `eslint.config.js` file to allow linting with type information:
|
|
|
|
```js
|
|
{
|
|
languageOptions: {
|
|
parserOptions: {
|
|
project: './tsconfig.*?.json',
|
|
tsconfigRootDir: import.meta.dirname,
|
|
},
|
|
},
|
|
},
|
|
```
|
|
|
|
### Strep 6: Hello world plugin code
|
|
|
|
Create the file `apps/example-plugin/src/plugin.ts` with the following code:
|
|
|
|
```ts
|
|
console.log('Hello Plugin');
|
|
```
|
|
|
|
### Step 7: Run the plugin
|
|
|
|
Run this command:
|
|
|
|
```sh
|
|
npx nx run example-plugin:init
|
|
```
|
|
|
|
This will run two tasks: `serve`, the usual Angular server, and `buildPlugin`, which will compile the `plugin.ts` file.
|
|
|
|
### Step 8: Load the Plugin in Penpot
|
|
|
|
To load your plugin into Penpot you can use the shortcut `Ctrl + Alt + P` to directly open the Plugin manager modal. There you need to provide the plugin's manifest URL (example: `http://plugin.example/manifest.json`) for the installation. If there's no issues the plugin will be installed and then you would be able to open it whenever you like.
|
|
|
|
You can also open the Plugin manager modal via:
|
|
|
|
- Menu
|
|
|
|
|
|
|
|
### Step 9: Build plugin
|
|
|
|
```
|
|
npx nx run example-plugin:build
|
|
```
|
|
|
|
### Learn More About Plugin Development
|
|
|
|
For more detailed information on plugin development, check out our guides:
|
|
|
|
- [Plugin Usage Documentation](,/plugin-usage.md)
|