@voltsproject/volt-cli 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# Volts CLI ⚡
+
+A tiny CLI tool for quickly creating new [Volts](https://gitlab.winningsoftware.co.uk/open-source/volts) projects.
+
+**Volts** is a pre-configured Electron stack
+
+## Installation
+
+```bash
+npm install -g @voltsproject/volts-cli
+```
+
+## Usage
+
+To create a new Volts project in your current directory:
+
+```bash
+volt new my-volts-app
+```

package/dist/bin/volt.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import process from 'node:process';
+import * as fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+import chalk from 'chalk';
+import { exec } from 'node:child_process';
+const program = new Command();
+const getPackageInformation = async () => {
+    const contents = fs.readFileSync(path.join(getDirname(), '../../package.json'));
+    return JSON.parse(contents.toString());
+};
+const getDirname = () => {
+    return path.dirname(fileURLToPath(import.meta.url));
+};
+const runShellCommand = (command) => {
+    exec(command, (error, stdout, stderr) => {
+        if (error) {
+            console.error(chalk.red(`Error: ${error.message}`));
+            return;
+        }
+        if (stderr) {
+            console.error(chalk.yellow(`stderr: ${stderr}`));
+        }
+        console.log(chalk.green(`stdout: ${stdout}`));
+    });
+};
+getPackageInformation().then((packageData) => {
+    program.version(packageData.version);
+    program.command('new')
+        .argument('<name>')
+        .action((name) => {
+        console.log(chalk.blue(`Creating a new project:`) + chalk.bold(` ${name}`));
+        runShellCommand(`git clone https://gitlab.winningsoftware.co.uk/open-source/volts.git ${name} && cd ${name} && rm -rf .git && npm install`);
+    });
+    program.parse(process.argv);
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@voltsproject/volt-cli",
+  "version": "0.1.0",
+  "description": "A simple CLI tool for creating Volts projects",
+  "bin": {
+    "volt": "dist/bin/volt.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "postinstall": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": {
+    "name": "Daniel Winning",
+    "email": "daniel@winningsoftware.co.uk"
+  },
+  "license": "MIT",
+  "type": "module",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@types/node": "^25.2.1"
+  }
+}

package/src/bin/volt.ts

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import process from 'node:process';
+import * as fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+import chalk from 'chalk';
+import { exec } from 'node:child_process';
+
+interface IPackage
+{
+    version: string;
+}
+
+const program: Command = new Command();
+
+const getPackageInformation: () => Promise<IPackage> = async (): Promise<IPackage> => {
+    const contents = fs.readFileSync(path.join(getDirname(), '../../package.json'));
+
+    return JSON.parse(contents.toString());
+}
+
+const getDirname = () => {
+    return path.dirname(fileURLToPath(import.meta.url));
+}
+
+const runShellCommand = (command: string): void => {
+    exec(command, (error, stdout, stderr) => {
+        if (error) {
+            console.error(chalk.red(`Error: ${error.message}`));
+            return;
+        }
+        if (stderr) {
+            console.error(chalk.yellow(`stderr: ${stderr}`));
+        }
+        console.log(chalk.green(`stdout: ${stdout}`));
+    });
+};
+
+getPackageInformation().then((packageData: IPackage) => {
+    program.version(packageData.version);
+
+    program.command('new')
+        .argument('<name>')
+        .action((name: string) => {
+            console.log(chalk.blue(`Creating a new project:`) + chalk.bold(` ${name}`));
+            runShellCommand(`git clone https://gitlab.winningsoftware.co.uk/open-source/volts.git ${name} && cd ${name} && rm -rf .git && npm install`);
+        });
+
+    program.parse(process.argv);
+});

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "module": "Node16",
+    "moduleResolution": "node16",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  }
+}