xp-command 1.3.1 → 1.4.0

package/README.md

@@ -146,9 +146,11 @@ The first time you run xp-command in a new aircraft, it automatically creates a
 - **macOS/Linux:** `~/.xp-command/<Aircraft Name>.yml`
 - **Windows:** `%USERPROFILE%\.xp-command\<Aircraft Name>.yml`
 
+You can run the command `config` to open the aircraft configuration file in your system’s default YAML editor.
+
 ### Customizing commands
 
-You can edit these YAML files to add aircraft-specific commands or modify existing ones. Note that for changes to take effect you'll need to restart xp-command.
+You can edit these YAML files to add aircraft-specific commands or modify existing ones.
 
 **Example**: Add a command to set heading with 10-degree increments:
 

package/bin/index.js

@@ -11,16 +11,23 @@ import {
 import chalk from "chalk";
 import { program } from "commander";
 import ora from "ora";
+import { homedir } from "os";
+import { join } from "path";
 
+import packageJson from "../package.json" with { type: "json" };
 import { getDatarefValues, initAPI, setDatarefValues } from "../src/api.js";
 import { copyToClipboard } from "../src/clipboard.js";
-import { getConfig } from "../src/config.js";
+import { editConfig, getConfig } from "../src/config.js";
 import { clearLine, hideCursor, showCursor } from "../src/console.js";
 import { isAPIError, isEconnRefused } from "../src/error.js";
 import history from "../src/history.js";
+import { Logger } from "../src/logger.js";
 import { sleep } from "../src/sleep.js";
 
-import packageJson from '../package.json' with { type: 'json' };
+const osHomedir = homedir();
+const logger = new Logger(join(osHomedir, ".xp-command", "log.txt"), {
+  clearOnStart: true,
+});
 
 const PREFIX = "🛩 ";
 
@@ -28,7 +35,7 @@ program
   .version(packageJson.version)
   .description(`${PREFIX} ${packageJson.name}\n${packageJson.description}`)
   .option("-p, --port <number>", "server port number")
-  .helpOption('-h, --help', 'display this help text');
+  .helpOption("-h, --help", "display this help text");
 
 /**
  * @param {string} command
@@ -42,6 +49,7 @@ const processCommand = async (command) => {
   try {
     config = await getConfig();
   } catch (error) {
+    logger.error(error);
     if (isEconnRefused(error) || isAPIError(error)) {
       spinner.fail(chalk.red(`${PREFIX} No connection - in aircraft?`));
       hideCursor();
@@ -51,9 +59,19 @@ const processCommand = async (command) => {
     }
   }
 
+  if (command?.toLowerCase() === "config") {
+    await editConfig();
+    spinner.succeed(chalk.green(`${PREFIX} config`));
+    hideCursor();
+    await sleep(1500);
+    clearLine();
+    return;
+  }
+
   /**
-   * @param {number|string} value
+   * @param {number|string|Array<number|string>} value
    * @param {import('../src/config.js').Transform} transform
+   * @return {number|string|Array<number|string>}
    */
   const getTransformedValue = (value, transform) => {
     if (Array.isArray(value)) return value.slice();
@@ -84,15 +102,20 @@ const processCommand = async (command) => {
         return [
           new RegExp(c.pattern),
           async () => {
+            /** @type {number|string|Array<number|string>}*/
             let value = await getDatarefValues(c.dataref);
             c.transform?.forEach((t) => {
               value = getTransformedValue(value, t);
             });
-            const asString = String(value)
+            const asString = String(value);
             await copyToClipboard(asString);
-            const lines = asString.split('\n')
-            const firstLine = lines[0]
-            spinner.succeed(chalk.green(`${PREFIX} ${lines.length > 1 ? firstLine + '...' : firstLine}`));
+            const lines = asString.split("\n");
+            const firstLine = lines[0];
+            spinner.succeed(
+              chalk.green(
+                `${PREFIX} ${lines.length > 1 ? firstLine + "..." : firstLine}`,
+              ),
+            );
             hideCursor();
             await sleep(1500);
             clearLine();
@@ -103,9 +126,9 @@ const processCommand = async (command) => {
           new RegExp(c.pattern),
           async (regExpResult) => {
             let value = String(regExpResult[1]);
-            
+
             if (isNaN(Number(value))) {
-              const base64 = Buffer.from(value, 'utf-8').toString('base64');
+              const base64 = Buffer.from(value, "utf-8").toString("base64");
               await setDatarefValues(c.dataref, base64);
             } else {
               c.transform?.forEach((t) => {
@@ -133,6 +156,7 @@ const processCommand = async (command) => {
 
         showCursor();
       } catch (error) {
+        logger.error(error);
         spinner.fail();
         hideCursor();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xp-command",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Quick cockpit commands for X-Plane 12 - set your radios, altimeter, autopilot, and more from the terminal while flying.",
   "keywords": [
     "xplane",

package/src/api.js

@@ -112,13 +112,18 @@ export const getDatarefValue = async (datarefNameWithOptionalIndex) => {
  */
 export const getDatarefValues = async (datarefNamesWithOptionalIndex) => {
   if (Array.isArray(datarefNamesWithOptionalIndex)) {
-    return Promise.all(datarefNamesWithOptionalIndex.map(dataref => getDatarefValue(dataref))).then(results => {
-      return results.map(v => String(v)).join('\n').trim()
-    })
+    return Promise.all(
+      datarefNamesWithOptionalIndex.map((dataref) => getDatarefValue(dataref)),
+    ).then((results) => {
+      return results
+        .map((v) => String(v))
+        .join("\n")
+        .trim();
+    });
   }
-  
-  return getDatarefValue(datarefNamesWithOptionalIndex)
-}
+
+  return getDatarefValue(datarefNamesWithOptionalIndex);
+};
 
 /**
  * @param {string} datarefNameWithOptionalIndex
@@ -154,14 +159,19 @@ export const setDatarefValue = async (datarefNameWithOptionalIndex, value) => {
 /**
  * @param {string|Array<string>} datarefNamesWithOptionalIndex
  * @param {number|string} value
- * @return {Promise<number|string>}
+ * @return {Promise<void>}
  */
-export const setDatarefValues = async (datarefNamesWithOptionalIndex, value) => {
+export const setDatarefValues = async (
+  datarefNamesWithOptionalIndex,
+  value,
+) => {
   if (Array.isArray(datarefNamesWithOptionalIndex)) {
-    return Promise.all(datarefNamesWithOptionalIndex.map(dataref => setDatarefValue(dataref, value))).then(results => {
-      return results[0]
-    })
+    await Promise.all(
+      datarefNamesWithOptionalIndex.map((dataref) =>
+        setDatarefValue(dataref, value),
+      ),
+    );
+  } else {
+    await setDatarefValue(datarefNamesWithOptionalIndex, value);
   }
-  
-  return setDatarefValue(datarefNamesWithOptionalIndex, value)
-}
+};

package/src/config.js

@@ -1,4 +1,7 @@
+import { exec as rawExec } from "node:child_process";
 import { copyFile, mkdir, readFile } from "node:fs/promises";
+import { platform } from "node:process";
+import { promisify } from "node:util";
 
 import yaml from "js-yaml";
 import { homedir } from "os";
@@ -8,6 +11,8 @@ import { fileURLToPath } from "url";
 
 import { getDatarefValue } from "./api.js";
 
+const exec = promisify(rawExec);
+
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
@@ -35,6 +40,15 @@ const __dirname = dirname(__filename);
 
 const osHomedir = homedir();
 
+const getAircraftConfigPath = async () => {
+  const aircraft = /** @type {string} */ (
+    await getDatarefValue("sim/aircraft/view/acf_ui_name")
+  )
+    .replaceAll(/[./\\]/g, " ")
+    .replace(/"/g, "");
+  return join(osHomedir, ".xp-command", `${aircraft}.yml`);
+};
+
 /**
  * @return {Promise<CommandConfig>}
  */
@@ -43,12 +57,7 @@ export const getConfig = async () => {
     recursive: true,
   });
 
-  /** @type {string} */
-  let aircraft;
-  aircraft = /** @type {string} */ (
-    await getDatarefValue("sim/aircraft/view/acf_ui_name")
-  );
-  const aircraftConfigPath = join(osHomedir, ".xp-command", `${aircraft}.yml`);
+  const aircraftConfigPath = await getAircraftConfigPath();
 
   let config;
   try {
@@ -67,3 +76,20 @@ export const getConfig = async () => {
 
   return /** @type {CommandConfig} */ (config);
 };
+
+export const editConfig = async () => {
+  const aircraftConfigPath = await getAircraftConfigPath();
+
+  const command =
+    platform === "win32"
+      ? `start "" "${aircraftConfigPath}"`
+      : platform === "darwin"
+        ? `open "${aircraftConfigPath}"`
+        : `xdg-open "${aircraftConfigPath}"`;
+
+  const { stderr } = await exec(command);
+
+  if (stderr) {
+    throw new Error(stderr);
+  }
+};

package/src/logger.js

@@ -0,0 +1,80 @@
+// logger.js
+import fs from "node:fs";
+import path from "node:path";
+
+/**
+ * @typedef {"debug" | "info" | "warn" | "error"} LogLevel
+ */
+
+/**
+ * @typedef {Object} LoggerOptions
+ * @property {boolean} [clearOnStart]
+ */
+
+export class Logger {
+  /**
+   * @param {string} filePath
+   * @param {LoggerOptions} [options]
+   */
+  constructor(filePath, options = {}) {
+    /** @private */
+    this.filePath = filePath;
+
+    /** @private */
+    this.options = options;
+
+    const dir = path.dirname(filePath);
+    if (!fs.existsSync(dir)) {
+      fs.mkdirSync(dir, { recursive: true });
+    }
+
+    if (options.clearOnStart && fs.existsSync(filePath)) {
+      // clear file on app start
+      fs.truncateSync(filePath, 0);
+    }
+
+    /**
+     * @private
+     * @type {fs.WriteStream}
+     */
+    this.stream = fs.createWriteStream(filePath, { flags: "a" });
+  }
+
+  /**
+   * @private
+   * @param {LogLevel} level
+   * @param {string} msg
+   */
+  write(level, msg) {
+    const line = `${new Date().toISOString()} [${level.toUpperCase()}] ${msg}\n`;
+    this.stream.write(line);
+  }
+
+  /**
+   * @param {string} msg
+   */
+  debug(msg) {
+    this.write("debug", msg);
+  }
+
+  /**
+   * @param {string} msg
+   */
+  info(msg) {
+    this.write("info", msg);
+  }
+
+  /**
+   * @param {string} msg
+   */
+  warn(msg) {
+    this.write("warn", msg);
+  }
+
+  /**
+   * @param {string} msg
+   */
+  error(msg) {
+    this.write("error", msg);
+  }
+}