@elgato/cli 0.1.0-beta.0

package/package.json

@@ -0,0 +1,79 @@
+{
+	"name": "@elgato/cli",
+	"version": "0.1.0-beta.0",
+	"description": "The official CLI for building Node.js Stream Deck plugins.",
+	"bin": {
+		"streamdeck": "bin/streamdeck.mjs",
+		"sd": "bin/streamdeck.mjs"
+	},
+	"files": [
+		"bin/streamdeck.mjs",
+		"template"
+	],
+	"type": "module",
+	"engines": {
+		"node": "^20.1.0"
+	},
+	"scripts": {
+		"build": "rollup --config rollup.config.ts --configPlugin typescript",
+		"watch": "rollup --config rollup.config.ts --configPlugin typescript --watch",
+		"lint": "eslint . --ext .ts --max-warnings 0",
+		"lint:fix": "prettier --config .prettierrc \"./src/**/*.ts\" --write",
+		"preversion": "npm run build && npm run lint"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/elgatosf/cli.git"
+	},
+	"keywords": [
+		"elgato",
+		"stream-deck",
+		"plugin",
+		"cli",
+		"marketplace",
+		"maker"
+	],
+	"author": {
+		"name": "Elgato",
+		"url": "https://www.elgato.com"
+	},
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/elgatosf/cli/issues"
+	},
+	"homepage": "https://github.com/elgatosf/cli#readme",
+	"devDependencies": {
+		"@rollup/plugin-commonjs": "^25.0.4",
+		"@rollup/plugin-json": "^6.0.0",
+		"@rollup/plugin-node-resolve": "^15.2.1",
+		"@rollup/plugin-terser": "^0.4.3",
+		"@rollup/plugin-typescript": "^11.1.4",
+		"@trivago/prettier-plugin-sort-imports": "^4.2.0",
+		"@tsconfig/node20": "^20.1.2",
+		"@types/ejs": "^3.1.3",
+		"@types/inquirer": "^9.0.3",
+		"@types/lodash": "^4.14.199",
+		"@types/node": "20.1.7",
+		"@typescript-eslint/eslint-plugin": "^6.7.3",
+		"@typescript-eslint/parser": "^6.7.3",
+		"ajv": "^8.12.0",
+		"chalk": "^5.3.0",
+		"commander": "^11.0.0",
+		"dotenv": "^16.3.1",
+		"ejs": "^3.1.9",
+		"eslint": "^8.50.0",
+		"eslint-config-prettier": "^9.0.0",
+		"eslint-plugin-jsdoc": "^46.8.2",
+		"eslint-plugin-prettier": "^5.0.0",
+		"find-process": "^1.4.7",
+		"inquirer": "^9.2.11",
+		"is-interactive": "^2.0.0",
+		"lodash": "^4.17.21",
+		"log-symbols": "^5.1.0",
+		"prettier": "^3.0.3",
+		"rage-edit": "^1.2.0",
+		"rollup": "^3.29.4",
+		"tslib": "^2.6.2",
+		"typescript": "^5.2.2"
+	}
+}

package/template/.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Attach to Plugin",
+			"type": "node",
+			"request": "attach",
+			"processId": "${command:PickProcess}",
+			"outFiles": [
+				"${workspaceFolder}/bin/**/*.js"
+			],
+			"resolveSourceMapLocations": [
+				"${workspaceFolder}/**"
+			]
+		}
+	]
+}

package/template/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+	/* Prefer tabs over spaces for accessibility */
+	"editor.insertSpaces": false,
+	"editor.detectIndentation": false,
+	/* Explorer */
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		"*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
+		"package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml, rollup.config.mjs, tsconfig.json"
+	},
+	"files.exclude": {
+		"node_modules": true
+	}
+}

package/template/com.elgato.template.sdPlugin/manifest.json.ejs

@@ -0,0 +1,46 @@
+{
+	"Name": <%- JSON.stringify(name) %>,
+	"Version": "0.1.0",
+	"Author": <%- JSON.stringify(author) %>,
+	"Actions": [
+		{
+			"Name": "Counter",
+			"UUID": "<%- uuid %>.increment",
+			"Icon": "imgs/actions/counter/icon",
+			"Tooltip": "Displays a count, which increments by one on press.",
+			"Controllers": [
+				"Keypad"
+			],
+			"States": [
+				{
+					"Image": "imgs/actions/counter/key",
+					"TitleAlignment": "middle"
+				}
+			]
+		}
+	],
+	"Category": <%- JSON.stringify(name) %>,
+	"CategoryIcon": "imgs/plugin/category-icon",
+	"CodePath": "bin/plugin.js",
+	"Description": <%- JSON.stringify(description) %>,
+	"Icon": "imgs/plugin/marketplace",
+	"SDKVersion": 2,
+	"Software": {
+		"MinimumVersion": "6.3"
+	},
+	"OS": [
+		{
+			"Platform": "mac",
+			"MinimumVersion": "10.15"
+		},
+		{
+			"Platform": "windows",
+			"MinimumVersion": "10"
+		}
+	],
+	"Nodejs": {
+		"Version": "20",
+		"Debug": "enabled"
+	},
+	"UUID": <%- JSON.stringify(uuid) %>
+}

package/template/package.json.ejs

@@ -0,0 +1,20 @@
+{
+	"scripts": {
+		"build": "rollup -c",
+		"watch": "rollup -c -w"
+	},
+	"devDependencies": {
+		"@rollup/plugin-commonjs": "^25.0.4",
+		"@rollup/plugin-node-resolve": "^15.2.1",
+		"@rollup/plugin-terser": "^0.4.3",
+		"@rollup/plugin-typescript": "11.1.2",
+		"@tsconfig/node20": "^20.1.2",
+		"@types/node": "^20.5.6",
+		"rollup": "^3.28.1",
+		"tslib": "^2.6.2",
+		"typescript": "^5.2.2"
+	},
+	"dependencies": {
+		"@elgato/streamdeck": <%- JSON.stringify(streamDeckPackage) %>
+	}
+}

package/template/rollup.config.mjs

@@ -0,0 +1,71 @@
+import commonjs from "@rollup/plugin-commonjs";
+import nodeResolve from "@rollup/plugin-node-resolve";
+import terser from "@rollup/plugin-terser";
+import typescript from "@rollup/plugin-typescript";
+import fs from "node:fs";
+import path from "node:path";
+import url from "node:url";
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+const isWatching = !!process.env.ROLLUP_WATCH;
+const tsConfig = JSON.parse(fs.readFileSync(path.resolve(__dirname, "./tsconfig.json"), "utf8"));
+
+prepareOutDir(tsConfig.compilerOptions.outDir);
+
+/**
+ * @type {import('rollup').RollupOptions}
+ */
+const config = {
+	input: "src/plugin.ts",
+	output: {
+		dir: tsConfig.compilerOptions.outDir,
+		format: "cjs",
+		sourcemap: isWatching,
+		sourcemapPathTransform: (relativeSourcePath, sourcemapPath) => {
+			return url.pathToFileURL(path.resolve(path.dirname(sourcemapPath), relativeSourcePath)).href;
+		}
+	},
+	plugins: [
+		typescript({
+			sourceMap: isWatching,
+			inlineSources: isWatching,
+			mapRoot: isWatching ? "./" : undefined
+		}),
+		commonjs({
+			sourceMap: false
+		}),
+		nodeResolve({
+			browser: false,
+			exportConditions: ["node"],
+			preferBuiltins: true
+		}),
+		!isWatching &&
+			terser({
+				format: {
+					comments: false
+				}
+			})
+	]
+};
+
+export default config;
+
+/**
+ * Validates the output directory is situated within the current working directory; upon passing validation, the directory is cleaned before build.
+ * @param {string} outDir
+ */
+function prepareOutDir(outDir) {
+	if (outDir === undefined) {
+		throw new Error("outDir must be specified within the TypeScript config file.");
+	}
+
+	const relative = path.relative(__dirname, outDir);
+	if (relative && !relative.startsWith("..") && !path.isAbsolute(relative)) {
+		if (fs.existsSync(outDir)) {
+			fs.rmSync(outDir, { recursive: true });
+		}
+	} else {
+		throw new Error("outDir must be located within the current working directory. Please review the TypeScript config file.");
+	}
+}

package/template/src/actions/increment-counter.ts.ejs

@@ -0,0 +1,39 @@
+import { action, KeyDownEvent, SingletonAction, WillAppearEvent } from "@elgato/streamdeck";
+
+/**
+ * An example action class that displays a count that increments by one each time the button is pressed.
+ */
+@action({ UUID: "<%- uuid %>.increment" })
+export class IncrementCounter extends SingletonAction<CounterSettings> {
+	/**
+	 * The {@link SingletonAction.onWillAppear} event is useful for setting the visual representation of an action when it become visible. This could be due to the Stream Deck first
+	 * starting up, or the user navigating between pages / folders etc.. There is also an inverse of this event in the form of {@link streamDeck.client.onWillDisappear}. In this example,
+	 * we're setting the title to the "count" that is incremented in {@link IncrementCounter.onKeyDown}.
+	 */
+	onWillAppear(ev: WillAppearEvent<CounterSettings>): void | Promise<void> {
+		return ev.action.setTitle(`${ev.payload.settings.count ?? 0}`);
+	}
+
+	/**
+	 * Listens for the {@link SingletonAction.onKeyDown} event which is emitted by Stream Deck when an action is pressed. Stream Deck provides various events for tracking interaction
+	 * with devices including key down/up, dial rotations, and device connectivity, etc. When triggered, {@link ev} object contains information about the event including any payloads
+	 * and action information where applicable. In this example, our action will display a counter that increments by one each press. We track the current count on the action's persisted
+	 * settings using `setSettings` and `getSettings`.
+	 */
+	async onKeyDown(ev: KeyDownEvent<CounterSettings>): Promise<void> {
+		// Determine the current count from the settings.
+		let count = ev.payload.settings.count ?? 0;
+		count++;
+
+		// Update the current count in the action's settings, and change the title.
+		await ev.action.setSettings({ count });
+		await ev.action.setTitle(`${count}`);
+	}
+}
+
+/**
+ * Settings for {@link IncrementCounter}.
+ */
+type CounterSettings = {
+	count: number;
+};

package/template/src/plugin.ts

@@ -0,0 +1,12 @@
+import streamDeck, { LogLevel } from "@elgato/streamdeck";
+
+import { IncrementCounter } from "./actions/increment-counter";
+
+// We can enable "trace" logging so that all messages between the Stream Deck, and the plugin are recorded. When storing sensitive information
+streamDeck.logger.setLevel(LogLevel.TRACE);
+
+// Register the increment action.
+streamDeck.actions.registerAction(new IncrementCounter());
+
+// Finally, connect to the Stream Deck.
+streamDeck.connect();

package/template/tsconfig.json.ejs

@@ -0,0 +1,14 @@
+{
+	"extends": "@tsconfig/node20/tsconfig.json",
+	"compilerOptions": {
+		"module": "ESNext",
+		"moduleResolution": "Bundler",
+		"outDir": "<%- uuid %>.sdPlugin/bin"
+	},
+	"include": [
+		"src/**/*.ts"
+	],
+	"exclude": [
+		"node_modules"
+	]
+}