@lumiastream/plugin 0.5.0 → 0.5.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 +20 -148
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -171,7 +171,7 @@ Plugins execute in an isolated **Node.js** process (no browser DOM). Use Node-co
|
|
|
171
171
|
- `npm run sync:developer-docs` – sync core SDK docs and generated example pages into `../Developer-Docs/docs/plugin-sdk` (no manual copy/paste).
|
|
172
172
|
- `npm run sync:skills` – refresh Codex skill docs snapshot, Claude skill docs snapshot, and Cursor rules together.
|
|
173
173
|
- `npm run validate:skills` – validate Codex skill + Claude skill + Copilot instructions + Gemini instructions + Cursor rule version alignment.
|
|
174
|
-
- `npm run update:
|
|
174
|
+
- `npm run update:skills -- --target <plugin-path>` – pull latest skill files (Claude/Copilot/Gemini/Cursor, optional Codex) from `main`.
|
|
175
175
|
|
|
176
176
|
## CLI Helpers
|
|
177
177
|
|
|
@@ -183,187 +183,59 @@ The CLI is distributed separately via `lumia-plugin`. Use it with `npx` (require
|
|
|
183
183
|
|
|
184
184
|
## AI Editor Support (Codex + Claude + Copilot + Gemini CLI + Cursor)
|
|
185
185
|
|
|
186
|
-
This repository ships cross-tool guidance for all
|
|
186
|
+
This repository ships cross-tool guidance for all supported tools using this repo as source:
|
|
187
187
|
|
|
188
188
|
- [https://github.com/lumiastream/Plugin-SDK](https://github.com/lumiastream/Plugin-SDK)
|
|
189
189
|
|
|
190
|
-
###
|
|
190
|
+
### Easy Install (Recommended)
|
|
191
191
|
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
- `skills/lumia-plugin-codex-skill`
|
|
195
|
-
|
|
196
|
-
What it does:
|
|
197
|
-
|
|
198
|
-
- Guides Lumia plugin workflow (scaffold, implement, validate, package)
|
|
199
|
-
- Maps `manifest.json` capabilities to required/recommended runtime hooks
|
|
200
|
-
- Includes `plugin-audit.js` to detect manifest-to-hook mismatches
|
|
201
|
-
|
|
202
|
-
Install/download into Codex Desktop:
|
|
192
|
+
Install common project skill files (Claude + Copilot + Gemini + Cursor):
|
|
203
193
|
|
|
204
194
|
```bash
|
|
205
|
-
|
|
206
|
-
--repo lumiastream/Plugin-SDK \
|
|
207
|
-
--path skills/lumia-plugin-codex-skill
|
|
195
|
+
npx lumia-plugin skills --target /path/to/your-plugin
|
|
208
196
|
```
|
|
209
197
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
1. Download the repo zip: [Download Plugin-SDK zip](https://github.com/lumiastream/Plugin-SDK/archive/refs/heads/main.zip)
|
|
213
|
-
2. Extract it and copy `skills/lumia-plugin-codex-skill` to `$CODEX_HOME/skills/lumia-plugin-codex-skill`
|
|
214
|
-
3. Restart Codex Desktop
|
|
215
|
-
|
|
216
|
-
Use:
|
|
217
|
-
|
|
218
|
-
- Mention `$lumia-plugin-codex-skill` in your prompt
|
|
219
|
-
- Example: `Use $lumia-plugin-codex-skill to scaffold and validate a lights plugin with theme support`
|
|
220
|
-
|
|
221
|
-
Restart Codex Desktop after installation.
|
|
222
|
-
|
|
223
|
-
### Claude
|
|
224
|
-
|
|
225
|
-
Location:
|
|
226
|
-
|
|
227
|
-
- `skills/lumia-plugin-claude-skill/lumia-plugin-claude-skill.md`
|
|
228
|
-
|
|
229
|
-
What it does:
|
|
230
|
-
|
|
231
|
-
- Provides Lumia plugin workflow and capability contract guidance for Claude sessions
|
|
232
|
-
- Includes audit/validation guidance and references synced from SDK docs
|
|
233
|
-
|
|
234
|
-
Install/download into another project:
|
|
198
|
+
Install one specific tool:
|
|
235
199
|
|
|
236
200
|
```bash
|
|
237
|
-
|
|
238
|
-
|
|
201
|
+
npx lumia-plugin skills claude --target /path/to/your-plugin
|
|
202
|
+
npx lumia-plugin skills copilot --target /path/to/your-plugin
|
|
203
|
+
npx lumia-plugin skills gemini --target /path/to/your-plugin
|
|
204
|
+
npx lumia-plugin skills cursor --target /path/to/your-plugin
|
|
205
|
+
npx lumia-plugin skills codex
|
|
239
206
|
```
|
|
240
207
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
1. Open [Claude skill file](https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/skills/lumia-plugin-claude-skill/lumia-plugin-claude-skill.md)
|
|
244
|
-
2. Save it as `CLAUDE.md` in your plugin project root
|
|
245
|
-
|
|
246
|
-
Optional references bundle:
|
|
208
|
+
Optional Codex home override:
|
|
247
209
|
|
|
248
210
|
```bash
|
|
249
|
-
|
|
250
|
-
mkdir -p /path/to/your-plugin/.claude/lumia-plugin-references
|
|
251
|
-
cp -R /tmp/lumia-plugin-sdk/skills/lumia-plugin-claude-skill/references/* /path/to/your-plugin/.claude/lumia-plugin-references/
|
|
211
|
+
npx lumia-plugin skills codex --codex-home "$CODEX_HOME"
|
|
252
212
|
```
|
|
253
213
|
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
- Open your plugin project in Claude
|
|
257
|
-
- Ask Claude to follow `CLAUDE.md` while implementing or validating the plugin
|
|
258
|
-
|
|
259
|
-
### GitHub Copilot
|
|
260
|
-
|
|
261
|
-
Location:
|
|
262
|
-
|
|
263
|
-
- `.github/copilot-instructions.md`
|
|
264
|
-
|
|
265
|
-
What it does:
|
|
266
|
-
|
|
267
|
-
- Adds repository-wide Lumia plugin implementation and validation guidance for Copilot
|
|
268
|
-
- Includes workflow steps and manifest capability contract checks
|
|
269
|
-
|
|
270
|
-
Install/download into another project:
|
|
214
|
+
List available skill bundles:
|
|
271
215
|
|
|
272
216
|
```bash
|
|
273
|
-
|
|
274
|
-
curl -L https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/.github/copilot-instructions.md \
|
|
275
|
-
-o /path/to/your-plugin/.github/copilot-instructions.md
|
|
217
|
+
npx lumia-plugin skills list
|
|
276
218
|
```
|
|
277
219
|
|
|
278
|
-
Browser-only install (no curl):
|
|
279
|
-
|
|
280
|
-
1. Open [Copilot instructions file](https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/.github/copilot-instructions.md)
|
|
281
|
-
2. Save it as `.github/copilot-instructions.md` in your plugin project
|
|
282
|
-
|
|
283
|
-
Use:
|
|
284
|
-
|
|
285
|
-
- Open your plugin project in VS Code or GitHub with Copilot enabled
|
|
286
|
-
- Copilot Chat uses repository instructions automatically
|
|
287
|
-
|
|
288
|
-
### Gemini CLI
|
|
289
|
-
|
|
290
|
-
Location:
|
|
291
|
-
|
|
292
|
-
- `GEMINI.md`
|
|
293
|
-
|
|
294
|
-
What it does:
|
|
295
|
-
|
|
296
|
-
- Provides project guidance for Gemini CLI sessions targeting Lumia plugin development
|
|
297
|
-
- Includes workflow, capability contracts, and validation commands
|
|
298
|
-
|
|
299
|
-
Install/download into another project:
|
|
300
|
-
|
|
301
|
-
```bash
|
|
302
|
-
curl -L https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/GEMINI.md \
|
|
303
|
-
-o /path/to/your-plugin/GEMINI.md
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
Browser-only install (no curl):
|
|
307
|
-
|
|
308
|
-
1. Open [Gemini instructions file](https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/GEMINI.md)
|
|
309
|
-
2. Save it as `GEMINI.md` in your plugin project root
|
|
310
|
-
|
|
311
|
-
Use:
|
|
312
|
-
|
|
313
|
-
- Run Gemini CLI from your plugin project root
|
|
314
|
-
- Ask Gemini to follow `GEMINI.md` while implementing or validating plugin changes
|
|
315
|
-
|
|
316
|
-
### Cursor
|
|
317
|
-
|
|
318
|
-
Location:
|
|
319
|
-
|
|
320
|
-
- `.cursor/rules/lumia-plugin-workflow.mdc`
|
|
321
|
-
- `.cursor/rules/lumia-plugin-manifest-contracts.mdc`
|
|
322
|
-
|
|
323
|
-
What it does:
|
|
324
|
-
|
|
325
|
-
- Enforces Lumia plugin workflow steps while editing plugin files
|
|
326
|
-
- Applies capability contract checks when `manifest.json` and runtime hooks change
|
|
327
|
-
|
|
328
|
-
Install/download into another project:
|
|
329
|
-
|
|
330
|
-
```bash
|
|
331
|
-
mkdir -p /path/to/your-plugin/.cursor/rules
|
|
332
|
-
cp .cursor/rules/lumia-plugin-*.mdc /path/to/your-plugin/.cursor/rules/
|
|
333
|
-
mkdir -p /path/to/your-plugin/scripts
|
|
334
|
-
cp skills/lumia-plugin-codex-skill/scripts/plugin-audit.js /path/to/your-plugin/scripts/plugin-audit.js
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
Browser-only install (no curl):
|
|
338
|
-
|
|
339
|
-
1. Open [Cursor workflow rule](https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/.cursor/rules/lumia-plugin-workflow.mdc) and save as `.cursor/rules/lumia-plugin-workflow.mdc`
|
|
340
|
-
2. Open [Cursor manifest rule](https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/.cursor/rules/lumia-plugin-manifest-contracts.mdc) and save as `.cursor/rules/lumia-plugin-manifest-contracts.mdc`
|
|
341
|
-
3. Open [Audit script](https://raw.githubusercontent.com/lumiastream/Plugin-SDK/main/skills/lumia-plugin-codex-skill/scripts/plugin-audit.js) and save as `scripts/plugin-audit.js`
|
|
342
|
-
|
|
343
|
-
Use:
|
|
344
|
-
|
|
345
|
-
- Open the plugin project in Cursor
|
|
346
|
-
- Cursor applies matching rules automatically based on file globs
|
|
347
|
-
- Run `node scripts/plugin-audit.js <plugin-dir>` only if you copied the audit script
|
|
348
|
-
|
|
349
220
|
### Easy Updates (No Full Redownload)
|
|
350
221
|
|
|
351
|
-
|
|
222
|
+
Run the same command again to update to latest skill files:
|
|
352
223
|
|
|
353
224
|
```bash
|
|
354
|
-
|
|
225
|
+
npx lumia-plugin skills --target /path/to/your-plugin
|
|
355
226
|
```
|
|
356
227
|
|
|
357
228
|
Optional tool selection:
|
|
358
229
|
|
|
359
230
|
```bash
|
|
360
|
-
|
|
231
|
+
npx lumia-plugin skills --tools claude,copilot,gemini,cursor --target /path/to/your-plugin
|
|
361
232
|
```
|
|
362
233
|
|
|
363
234
|
Optional Codex skill update (for Codex Desktop install path):
|
|
364
235
|
|
|
365
236
|
```bash
|
|
366
|
-
|
|
237
|
+
npx lumia-plugin skills codex
|
|
238
|
+
npx lumia-plugin skills codex --codex-home "$CODEX_HOME"
|
|
367
239
|
```
|
|
368
240
|
|
|
369
241
|
### Automatic Sync on Publish
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lumiastream/plugin",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "Official Lumia Stream Plugin SDK for building Lumia Stream plugins.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -20,10 +20,10 @@
|
|
|
20
20
|
"sync:developer-docs": "node scripts/sync-developer-docs.js",
|
|
21
21
|
"sync:skills": "node scripts/sync-skills.js",
|
|
22
22
|
"validate:skills": "node scripts/validate-skills.js",
|
|
23
|
-
"update:
|
|
23
|
+
"update:skills": "node scripts/update-skills.js",
|
|
24
24
|
"sync-cli-version": "node scripts/sync-cli-version.js",
|
|
25
25
|
"publish-cli": "node scripts/publish-cli.js",
|
|
26
|
-
"prepublishOnly": "npm run build && npm run sync-cli-version && npm run sync:skills && npm run validate:skills",
|
|
26
|
+
"prepublishOnly": "npm run build && npm run sync-cli-version && npm run sync:skills && npm run validate:skills && npm run package-docs",
|
|
27
27
|
"postpublish": "npm run publish-cli"
|
|
28
28
|
},
|
|
29
29
|
"exports": {
|