@appliance.sh/cli 1.8.0 → 1.10.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@appliance.sh/cli",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "Shell for installing, running, and developing applications on the Appliance platform",
   "repository": "https://github.com/appliance-sh/appliance.sh",
   "license": "MIT",
   "author": "Eliot Lim",
-  "type": "commonjs",
+  "type": "module",
   "main": "index.js",
   "bin": {
     "appliance": "dist/appliance.js"
@@ -17,11 +17,15 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@appliance.sh/sdk": "1.8.0",
+    "@appliance.sh/sdk": "1.10.0",
+    "@inquirer/prompts": "^7.10.1",
     "chalk": "^5.4.1",
-    "commander": "^14.0.0"
+    "commander": "^14.0.0",
+    "json-diff": "^1.0.6",
+    "random-word-slugs": "^0.1.7"
   },
   "devDependencies": {
+    "@types/json-diff": "^1.0.3",
     "@types/node": "^24.0.1"
   }
 }

package/src/appliance-configure.ts

@@ -1,4 +1,15 @@
 import { Command } from 'commander';
+import { extractApplianceFile, saveApplianceFile } from './utils/common.js';
+import {
+  promptForApplianceFramework,
+  promptForApplianceName,
+  promptForAppliancePort,
+  promptForApplianceType,
+} from './wizards/appliance.js';
+import * as diff from 'json-diff';
+
+import * as prompt from '@inquirer/prompts';
+import { ApplianceInput, ApplianceType } from '@appliance.sh/sdk';
 
 const program = new Command();
 
@@ -6,4 +17,71 @@ program
   .option('-f, --file <file>', 'appliance manifest file', 'appliance.json')
   .option('-d, --directory <directory>', 'appliance directory');
 
-program.parse(process.argv);
+const cmd = program.parse(process.argv);
+
+const applianceFileResult = extractApplianceFile(cmd);
+
+// If a file or directory was specified, but the file was not found, exit with an error.
+if (
+  ((cmd.getOptionValue('file') && cmd.getOptionValue('file') !== 'appliance.json') ||
+    cmd.getOptionValue('directory')) &&
+  !applianceFileResult.success
+) {
+  console.log('The specified file was not found.');
+  process.exit(1);
+}
+
+if (!applianceFileResult.success) {
+  console.log(`An error occurred while reading the specified file.`);
+  console.log(applianceFileResult.error);
+}
+
+let updatedApplianceFile = {
+  manifest: 'v1',
+  ...applianceFileResult.data,
+} as ApplianceInput;
+
+try {
+  const name = await promptForApplianceName(updatedApplianceFile);
+
+  updatedApplianceFile = {
+    ...updatedApplianceFile,
+    name,
+  };
+
+  const type = await promptForApplianceType(updatedApplianceFile);
+
+  if (type === ApplianceType.framework) {
+    const framework = await promptForApplianceFramework(updatedApplianceFile);
+    updatedApplianceFile = {
+      ...updatedApplianceFile,
+      type,
+      framework,
+    };
+  } else if (type === ApplianceType.container) {
+    const port = await promptForAppliancePort(updatedApplianceFile);
+
+    updatedApplianceFile = {
+      ...updatedApplianceFile,
+      type,
+      port,
+    };
+  } else {
+    updatedApplianceFile = {
+      ...updatedApplianceFile,
+      type,
+    };
+  }
+
+  console.log(diff.colorize(diff.diff(applianceFileResult.data, updatedApplianceFile)));
+
+  const saveChanges = await prompt.confirm({ message: 'Save changes?', default: true });
+  if (!saveChanges) {
+    console.log('Changes cancelled.');
+    process.exit(0);
+  }
+
+  saveApplianceFile(cmd.getOptionValue('file') || 'appliance.json', updatedApplianceFile);
+} catch (error) {
+  console.error(error);
+}

package/src/appliance.ts

@@ -2,13 +2,13 @@
 
 import { Command } from 'commander';
 
-import { VERSION } from '@appliance.sh/sdk';
+import * as sdk from '@appliance.sh/sdk';
 
 const program = new Command();
 
 program
   .name('appliance')
-  .version(VERSION)
+  .version(sdk.VERSION)
   .command('build', 'builds the appliance in the current working directory')
   .command('configure', 'configures the appliance in the current working directory')
   .command('install [appliance-names...]', 'install one or more appliances')

package/src/utils/common.ts

@@ -0,0 +1,51 @@
+import { Command } from 'commander';
+import path from 'path';
+import * as fs from 'node:fs';
+import { Appliance, applianceInput, ApplianceInput, Result } from '@appliance.sh/sdk';
+
+export function extractApplianceFile(cmd: Command): Result<ApplianceInput> {
+  let filePath;
+  if (cmd.getOptionValue('file')) {
+    filePath = path.resolve(process.cwd(), cmd.getOptionValue('file'));
+  } else if (cmd.getOptionValue('directory')) {
+    filePath = path.resolve(process.cwd(), cmd.getOptionValue('directory'), 'appliance.json');
+  }
+
+  // check if file exists
+  if (!filePath) {
+    return {
+      success: false,
+      error: { name: 'File Not Found', message: 'No appliance file found.' },
+    };
+  }
+
+  if (!filePath.endsWith('.json')) {
+    throw new Error('Appliance file must be a JSON file');
+  }
+
+  try {
+    const fileBuf = fs.readFileSync(filePath);
+    const result = applianceInput.safeParse(JSON.parse(fileBuf.toString()));
+
+    return result;
+  } catch (err) {
+    return {
+      success: false,
+      error: err as Error,
+    };
+  }
+}
+
+export function saveApplianceFile(filePath: string, appliance: Appliance) {
+  try {
+    fs.writeFileSync(filePath, JSON.stringify(appliance, null, 2));
+    return {
+      success: true,
+    };
+  } catch (err) {
+    return {
+      success: false,
+      error: err as Error,
+    };
+  }
+}

package/src/wizards/appliance.ts

@@ -0,0 +1,44 @@
+import * as prompts from '@inquirer/prompts';
+import { ApplianceFramework, ApplianceInput, ApplianceType } from '@appliance.sh/sdk';
+import * as slug from 'random-word-slugs';
+
+export const promptForApplianceName = (config?: Partial<ApplianceInput>) => {
+  const name = prompts.input({
+    message: `What's the name of your appliance?`,
+    default: config?.name ?? slug.generateSlug(2, { format: 'kebab' }),
+  });
+
+  return name;
+};
+
+export const promptForApplianceType = (config: Partial<ApplianceInput>) => {
+  const type = prompts.select<ApplianceType>({
+    message: `Choose a type:`,
+    choices: [ApplianceType.framework, ApplianceType.container],
+    default: config?.type ?? ApplianceType.framework,
+  });
+
+  return type;
+};
+
+export const promptForApplianceFramework = (config: Partial<ApplianceInput>) => {
+  const framework = prompts.select<ApplianceFramework>({
+    message: `Choose a framework:`,
+    choices: [ApplianceFramework.Auto, ApplianceFramework.Node, ApplianceFramework.Python],
+    default: (config.type === ApplianceType.framework ? config.framework : undefined) ?? ApplianceFramework.Auto,
+  });
+
+  return framework;
+};
+
+export const promptForAppliancePort = (config: Partial<ApplianceInput>) => {
+  const port = prompts.number<true>({
+    message: 'What port should the app listen on?',
+    min: 1,
+    max: 65535,
+    validate: (value) => !isNaN(parseInt(`${value}`)) || 'Please enter a valid port number',
+    default: (config.type === ApplianceType.container ? config.port : undefined) ?? 8080,
+  });
+
+  return port;
+};

package/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "target": "es2019",
     "outDir": "./dist",
     "declaration": true,
     "declarationDir": "./dist/types"