@ericsanchezok/synergy-plugin 2.2.0 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,19 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
Plugins extend the Synergy server runtime and can also contribute Web UI surfaces through `plugin.json`. The current API is intentionally strict: a plugin module exports an object descriptor with a canonical `id` and an `init()` method. The descriptor id, `plugin.json.name`, registry id, lockfile key, and approval key must all be the same canonical plugin id.
|
|
6
6
|
|
|
7
|
-
Plugin authors should use
|
|
7
|
+
Plugin authors should use `@ericsanchezok/synergy-plugin-kit` and this SDK from a standalone plugin project. Cloning the Synergy source repository is only needed when changing or debugging the plugin platform itself.
|
|
8
8
|
|
|
9
9
|
## Recommended Flow
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
synergy
|
|
12
|
+
bunx @ericsanchezok/synergy-plugin-kit create my-plugin --template tool-ui
|
|
13
13
|
cd my-plugin
|
|
14
14
|
bun install
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
bun run validate
|
|
16
|
+
bun run build
|
|
17
|
+
bun run pack
|
|
18
|
+
bun run sign my-plugin-0.1.0.synergy-plugin.tgz
|
|
19
|
+
bun run publish:market
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
During local development you can also install directly:
|
|
@@ -124,7 +124,7 @@ Each distributable plugin has a root `plugin.json`:
|
|
|
124
124
|
}
|
|
125
125
|
```
|
|
126
126
|
|
|
127
|
-
`contributes.ui.entry` is a runtime-loadable JavaScript asset. Source files such as `src/ui.tsx` are only build inputs. `synergy
|
|
127
|
+
`contributes.ui.entry` is a runtime-loadable JavaScript asset. Source files such as `src/ui.tsx` are only build inputs. `synergy-plugin build` uses the conventional UI source path and writes the compiled bundle to the declared entry.
|
|
128
128
|
|
|
129
129
|
## UI Types
|
|
130
130
|
|
|
@@ -148,7 +148,7 @@ Worker and process plugins are started through Synergy's plugin runner. The runn
|
|
|
148
148
|
|
|
149
149
|
## Packaging
|
|
150
150
|
|
|
151
|
-
`synergy
|
|
151
|
+
`synergy-plugin build` writes a distributable `dist/` directory:
|
|
152
152
|
|
|
153
153
|
- `dist/plugin.json`
|
|
154
154
|
- `dist/runtime/index.js`
|
|
@@ -157,7 +157,9 @@ Worker and process plugins are started through Synergy's plugin runner. The runn
|
|
|
157
157
|
- `dist/permissions.summary.json`
|
|
158
158
|
- `dist/integrity.json`
|
|
159
159
|
|
|
160
|
-
`synergy
|
|
160
|
+
`synergy-plugin pack` archives `dist/` into `<name>-<version>.synergy-plugin.tgz`. `synergy-plugin sign` writes `<tarball>.sig`. `synergy-plugin publish-market` prepares the official marketplace submission by uploading or checking GitHub Release assets, writing a `SII-Holos/synergy-plugins` entry, running registry validation, and opening a PR when `gh` is available.
|
|
161
|
+
|
|
162
|
+
For local marketplace UX testing, the Synergy runtime still provides `synergy plugin publish <tarball>` to publish into the local development registry.
|
|
161
163
|
|
|
162
164
|
## Exports
|
|
163
165
|
|