lumia-plugin 0.1.10 → 0.1.12

package/examples/base-plugin/GETTING_STARTED.md

@@ -18,7 +18,7 @@ your-plugin/
 
 This file defines your plugin's metadata and capabilities:
 
-- **id**: Unique identifier (kebab-case, e.g., "my-awesome-plugin")
+- **id**: Unique identifier using letters, numbers, or underscores (e.g., "my_awesome_plugin")
 - **name**: Display name shown to users
 - **description**: Short description for the plugin marketplace
 - **main**: Entry point file (usually "main.js")
@@ -116,7 +116,7 @@ Variables let other Lumia features access your plugin's data:
 {
   "name": "my_variable",
   "key": "myVariable",
-  "origin": "your-plugin-id",
+  "origin": "your_plugin_id",
   "type": "string",
   "example": "Sample value"
 }

package/examples/base-plugin/README.md

@@ -11,7 +11,7 @@ This template demonstrates a handful of common Lumia Stream plugin capabilities:
 Use the CLI to copy and customise the template:
 
 ```
-npx lumia-plugin create my-plugin
+npx lumia-plugin create my_plugin
 ```
 
 After scaffolding you can tailor the manifest, code, and README to match your idea.

package/examples/base-plugin/main.js

@@ -66,7 +66,7 @@ class ShowcasePluginTemplate extends Plugin {
 	}
 
 	_tag() {
-		return `[${this.manifest?.id ?? "showcase-plugin"}]`;
+		return `[${this.manifest?.id ?? "showcase_plugin"}]`;
 	}
 
 	_currentMessage() {

package/examples/base-plugin/manifest.json

@@ -1,5 +1,5 @@
 {
-	"id": "showcase-plugin",
+	"id": "showcase_plugin",
 	"name": "Showcase Plugin",
 	"version": "1.0.0",
 	"author": "LumiaStream",
@@ -7,13 +7,11 @@
 	"website": "",
 	"repository": "",
 	"description": "Sample plugin that demonstrates Lumia Stream logging, variables, alerts, and settings.",
-	"longDescription": "",
 	"license": "MIT",
 	"lumiaVersion": "^9.0.0",
-	"keywords": ["sample", "demo", "lumia"],
+	"keywords": "sample, demo, lumia",
 	"category": "examples",
 	"icon": "",
-	"screenshots": [],
 	"changelog": "",
 	"config": {
 		"settings": [
@@ -108,7 +106,7 @@
 			{
 				"name": "last_message",
 				"system": false,
-				"origin": "showcase-plugin",
+				"origin": "showcase_plugin",
 				"allowedPlaces": ["automations", "overlays"],
 				"description": "Stores the most recent message handled by the plugin.",
 				"value": "",
@@ -117,7 +115,7 @@
 			{
 				"name": "last_alert_color",
 				"system": false,
-				"origin": "showcase-plugin",
+				"origin": "showcase_plugin",
 				"allowedPlaces": ["automations", "overlays"],
 				"description": "Tracks the color used by the latest sample alert.",
 				"value": "",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "lumia-plugin",
-	"version": "0.1.10",
+	"version": "0.1.12",
 	"description": "Command-line tools for creating, building, and validating Lumia Stream plugins.",
 	"bin": {
 		"lumia-plugin": "scripts/cli.js"
@@ -20,7 +20,7 @@
 	"author": "Lumia Stream",
 	"license": "MIT",
 	"dependencies": {
-		"@lumiastream/plugin": "^0.1.10",
+		"@lumiastream/plugin": "^0.1.12",
 		"jszip": "3.10.1"
 	}
 }

package/scripts/cli.js

@@ -24,9 +24,9 @@ Commands:
   validate [file]        Validate a .lumiaplugin package
 
 Examples:
-  lumia-plugin create my-plugin
-  lumia-plugin build ./my-plugin
-  lumia-plugin validate my-plugin.lumiaplugin
+  lumia-plugin create my_plugin
+  lumia-plugin build ./my_plugin
+  lumia-plugin validate my_plugin.lumiaplugin
 `);
 	process.exit(command ? 1 : 0);
 }

package/scripts/create-plugin.js

@@ -4,19 +4,19 @@ const fs = require("fs");
 
 const TEMPLATE_DIR = path.resolve(__dirname, "..", "examples", "base-plugin");
 
-function toKebabCase(value) {
-	return (
-		value
-			.trim()
-			.toLowerCase()
-			.replace(/[^a-z0-9]+/g, "-")
-			.replace(/^-+|-+$/g, "") || "my-plugin"
-	);
+function toSafeId(value) {
+	const cleaned = value
+		.trim()
+		.toLowerCase()
+		.replace(/[^a-z0-9]+/g, "_")
+		.replace(/^_+|_+$/g, "");
+	const safe = cleaned.replace(/__+/g, "_");
+	return safe || "my_plugin";
 }
 
 function toDisplayName(id) {
 	return id
-		.split("-")
+		.split(/[_-]+/)
 		.filter(Boolean)
 		.map((part) => part.charAt(0).toUpperCase() + part.slice(1))
 		.join(" ");
@@ -24,7 +24,7 @@ function toDisplayName(id) {
 
 function printHelp() {
 	console.log(
-		`Scaffold a new Lumia Stream plugin directory using the showcase template.\n\nUsage: npx lumia-plugin create [target-directory]\n\nExamples:\n  npx lumia-plugin create ./plugins/my-plugin\n  npx lumia-plugin create my-awesome-plugin\n`
+		`Scaffold a new Lumia Stream plugin directory using the showcase template.\n\nUsage: npx lumia-plugin create [target-directory]\n\nExamples:\n  npx lumia-plugin create ./plugins/my_plugin\n  npx lumia-plugin create my_awesome_plugin\n`
 	);
 }
 
@@ -81,18 +81,12 @@ async function updateManifest(manifestPath, pluginId, displayName) {
 	manifest.description = manifest.description?.trim()
 		? manifest.description
 		: `Describe what ${displayName} does.`;
-	manifest.longDescription = manifest.longDescription || "";
 	manifest.repository = manifest.repository || "";
 	manifest.website = manifest.website || "";
 	manifest.email = manifest.email || "";
 	manifest.icon = manifest.icon || "";
-	manifest.screenshots = ensureArray(manifest.screenshots);
 	manifest.changelog = manifest.changelog || "";
-	manifest.keywords = ensureArray(manifest.keywords);
-
-	if (!manifest.keywords.includes(pluginId)) {
-		manifest.keywords.push(pluginId);
-	}
+	manifest.keywords = manifest.keywords || "";
 
 	if (!manifest.main) {
 		manifest.main = "main.js";
@@ -149,7 +143,7 @@ async function updateMain(mainPath, pluginId, className, displayName) {
 		`Hello from ${displayName}!`
 	);
 	source = source.replace(/Showcase Plugin/g, displayName);
-	source = source.replace(/showcase-plugin/g, pluginId);
+	source = source.replace(/showcase[-_]plugin/g, pluginId);
 	await fs.promises.writeFile(mainPath, source);
 }
 
@@ -192,8 +186,8 @@ async function main() {
 		process.exit(1);
 	}
 
-	const targetDir = path.resolve(args[0] || "my-plugin");
-	const pluginId = toKebabCase(path.basename(targetDir));
+	const targetDir = path.resolve(args[0] || "my_plugin");
+	const pluginId = toSafeId(path.basename(targetDir));
 	const displayName = toDisplayName(pluginId) || "My Plugin";
 	const className = displayName.replace(/[^a-zA-Z0-9]/g, "") || "MyPlugin";