@cjser/inquirer__external-editor 3.0.2-cjser.2 → 3.0.4-cjser.2

package/README.md

@@ -77,6 +77,19 @@ try {
 }
 ```
 
+### Windows editor commands
+
+On Windows, prefer setting `$VISUAL` or `$EDITOR` to the editor executable
+rather than a `.cmd` or `.bat` shim. This package launches the editor directly
+instead of through a shell so editor arguments and temporary file paths are not
+interpreted as shell commands.
+
+For example, use `Code.exe` with `--wait` instead of `code.cmd`:
+
+```powershell
+setx VISUAL '"C:\Program Files\Microsoft VS Code\Code.exe" --wait'
+```
+
 #### API
 
 **Convenience Functions**

package/dist/index.d.ts

@@ -23,11 +23,13 @@ export declare class ExternalEditor {
     lastExitStatus: number;
     private text;
     private tempFile;
+    private tempDir;
     private fileOptions;
     constructor(text?: string, fileOptions?: FileOptions);
     run(): string;
     runAsync(callback?: StringCallback): Promise<string>;
     private cleanup;
     private createTempFile;
+    private editorArgs;
     private readTemporaryFile;
 }

package/dist/index.js

@@ -1,6 +1,6 @@
 import { detect } from 'chardet';
 import { spawn, spawnSync } from 'node:child_process';
-import { readFileSync, unlinkSync, writeFileSync } from 'node:fs';
+import { mkdtempSync, readFileSync, rmSync, writeFileSync, } from 'node:fs';
 import path from 'node:path';
 import os from 'node:os';
 import { randomUUID } from 'node:crypto';
@@ -26,6 +26,7 @@ export class ExternalEditor {
     lastExitStatus = 0;
     text = '';
     tempFile = '';
+    tempDir = '';
     fileOptions = {};
     constructor(text = '', fileOptions = {}) {
         this.text = text;
@@ -38,7 +39,13 @@ export class ExternalEditor {
         this.createTempFile();
         try {
             try {
-                const editorProcess = spawnSync(this.editor.bin, this.editor.args.concat([this.tempFile]), { stdio: 'inherit' });
+                const editorProcess = spawnSync(this.editor.bin, this.editorArgs(), {
+                    shell: false,
+                    stdio: 'inherit',
+                });
+                if (editorProcess.error) {
+                    throw editorProcess.error;
+                }
                 this.lastExitStatus = editorProcess.status ?? 0;
             }
             catch (launchError) {
@@ -55,9 +62,15 @@ export class ExternalEditor {
         this.createTempFile();
         const promise = new Promise((resolve, reject) => {
             try {
-                const editorProcess = spawn(this.editor.bin, this.editor.args.concat([this.tempFile]), { stdio: 'inherit' });
-                editorProcess.on('exit', (code) => {
-                    this.lastExitStatus = code;
+                const editorProcess = spawn(this.editor.bin, this.editorArgs(), {
+                    shell: false,
+                    stdio: 'inherit',
+                });
+                editorProcess.once('error', (launchError) => {
+                    reject(new LaunchEditorError(launchError));
+                });
+                editorProcess.once('exit', (code) => {
+                    this.lastExitStatus = code ?? 0;
                     resolve();
                 });
             }
@@ -78,11 +91,12 @@ export class ExternalEditor {
         return promise;
     }
     cleanup() {
-        if (!this.tempFile)
+        if (!this.tempDir)
             return;
         try {
-            unlinkSync(this.tempFile);
+            rmSync(this.tempDir, { force: true, recursive: true });
             this.tempFile = '';
+            this.tempDir = '';
         }
         catch (removeFileError) {
             throw new RemoveFileError(removeFileError);
@@ -90,17 +104,13 @@ export class ExternalEditor {
     }
     createTempFile() {
         try {
-            const baseDir = this.fileOptions.dir ?? os.tmpdir();
+            const baseDir = path.resolve(this.fileOptions.dir ?? os.tmpdir());
+            this.tempDir = mkdtempSync(path.join(baseDir, 'inquirer-editor-'));
             const id = randomUUID();
             const prefix = sanitizeAffix(this.fileOptions.prefix);
             const postfix = sanitizeAffix(this.fileOptions.postfix);
             const filename = `${prefix}${id}${postfix}`;
-            const candidate = path.resolve(baseDir, filename);
-            const baseResolved = path.resolve(baseDir) + path.sep;
-            if (!candidate.startsWith(baseResolved)) {
-                throw new Error('Resolved temporary file escaped the base directory');
-            }
-            this.tempFile = candidate;
+            this.tempFile = path.join(this.tempDir, filename);
             const opt = { encoding: 'utf8', flag: 'wx' };
             if (Object.prototype.hasOwnProperty.call(this.fileOptions, 'mode')) {
                 opt.mode = this.fileOptions.mode;
@@ -111,6 +121,9 @@ export class ExternalEditor {
             throw new CreateFileError(createFileError);
         }
     }
+    editorArgs() {
+        return [...this.editor.args, this.tempFile];
+    }
     readTemporaryFile() {
         try {
             const tempFileBuffer = readFileSync(this.tempFile);

package/dist-cjser/index.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/@cjser/inquirer__external-editor.tmp-25-1780163567980/dist/index.js
+// packages/@cjser/inquirer__external-editor.tmp-25-1788288342955/dist/index.js
 var index_exports = {};
 __export(index_exports, {
   CreateFileError: () => CreateFileError,
@@ -46,7 +46,7 @@ var import_node_os = __toESM(require("node:os"), 1);
 var import_node_crypto = require("node:crypto");
 var import_iconv_lite = __toESM(require("iconv-lite"), 1);
 
-// packages/@cjser/inquirer__external-editor.tmp-25-1780163567980/dist/errors.js
+// packages/@cjser/inquirer__external-editor.tmp-25-1788288342955/dist/errors.js
 var CreateFileError = class extends Error {
   name = "CreateFileError";
   originalError;
@@ -80,7 +80,7 @@ var RemoveFileError = class extends Error {
   }
 };
 
-// packages/@cjser/inquirer__external-editor.tmp-25-1780163567980/dist/parse-editor-command.js
+// packages/@cjser/inquirer__external-editor.tmp-25-1788288342955/dist/parse-editor-command.js
 function parseEditorCommand(editor) {
   let bin;
   let rest;
@@ -106,7 +106,7 @@ function parseEditorCommand(editor) {
   return { bin, args: rest ? rest.split(/\s+/) : [] };
 }
 
-// packages/@cjser/inquirer__external-editor.tmp-25-1780163567980/dist/index.js
+// packages/@cjser/inquirer__external-editor.tmp-25-1788288342955/dist/index.js
 function edit(text = "", fileOptions) {
   return new ExternalEditor(text, fileOptions).run();
 }
@@ -125,6 +125,7 @@ var ExternalEditor = class {
   lastExitStatus = 0;
   text = "";
   tempFile = "";
+  tempDir = "";
   fileOptions = {};
   constructor(text = "", fileOptions = {}) {
     this.text = text;
@@ -135,7 +136,13 @@ var ExternalEditor = class {
     this.createTempFile();
     try {
       try {
-        const editorProcess = (0, import_node_child_process.spawnSync)(this.editor.bin, this.editor.args.concat([this.tempFile]), { stdio: "inherit" });
+        const editorProcess = (0, import_node_child_process.spawnSync)(this.editor.bin, this.editorArgs(), {
+          shell: false,
+          stdio: "inherit"
+        });
+        if (editorProcess.error) {
+          throw editorProcess.error;
+        }
         this.lastExitStatus = editorProcess.status ?? 0;
       } catch (launchError) {
         throw new LaunchEditorError(launchError);
@@ -150,9 +157,15 @@ var ExternalEditor = class {
     this.createTempFile();
     const promise = new Promise((resolve, reject) => {
       try {
-        const editorProcess = (0, import_node_child_process.spawn)(this.editor.bin, this.editor.args.concat([this.tempFile]), { stdio: "inherit" });
-        editorProcess.on("exit", (code) => {
-          this.lastExitStatus = code;
+        const editorProcess = (0, import_node_child_process.spawn)(this.editor.bin, this.editorArgs(), {
+          shell: false,
+          stdio: "inherit"
+        });
+        editorProcess.once("error", (launchError) => {
+          reject(new LaunchEditorError(launchError));
+        });
+        editorProcess.once("exit", (code) => {
+          this.lastExitStatus = code ?? 0;
           resolve();
         });
       } catch (launchError) {
@@ -170,28 +183,25 @@ var ExternalEditor = class {
     return promise;
   }
   cleanup() {
-    if (!this.tempFile)
+    if (!this.tempDir)
       return;
     try {
-      (0, import_node_fs.unlinkSync)(this.tempFile);
+      (0, import_node_fs.rmSync)(this.tempDir, { force: true, recursive: true });
       this.tempFile = "";
+      this.tempDir = "";
     } catch (removeFileError) {
       throw new RemoveFileError(removeFileError);
     }
   }
   createTempFile() {
     try {
-      const baseDir = this.fileOptions.dir ?? import_node_os.default.tmpdir();
+      const baseDir = import_node_path.default.resolve(this.fileOptions.dir ?? import_node_os.default.tmpdir());
+      this.tempDir = (0, import_node_fs.mkdtempSync)(import_node_path.default.join(baseDir, "inquirer-editor-"));
       const id = (0, import_node_crypto.randomUUID)();
       const prefix = sanitizeAffix(this.fileOptions.prefix);
       const postfix = sanitizeAffix(this.fileOptions.postfix);
       const filename = `${prefix}${id}${postfix}`;
-      const candidate = import_node_path.default.resolve(baseDir, filename);
-      const baseResolved = import_node_path.default.resolve(baseDir) + import_node_path.default.sep;
-      if (!candidate.startsWith(baseResolved)) {
-        throw new Error("Resolved temporary file escaped the base directory");
-      }
-      this.tempFile = candidate;
+      this.tempFile = import_node_path.default.join(this.tempDir, filename);
       const opt = { encoding: "utf8", flag: "wx" };
       if (Object.prototype.hasOwnProperty.call(this.fileOptions, "mode")) {
         opt.mode = this.fileOptions.mode;
@@ -201,6 +211,9 @@ var ExternalEditor = class {
       throw new CreateFileError(createFileError);
     }
   }
+  editorArgs() {
+    return [...this.editor.args, this.tempFile];
+  }
   readTemporaryFile() {
     try {
       const tempFileBuffer = (0, import_node_fs.readFileSync)(this.tempFile);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cjser/inquirer__external-editor",
-  "version": "3.0.2-cjser.2",
+  "version": "3.0.4-cjser.2",
   "description": "Edit a string with the users preferred text editor using $VISUAL or $ENVIRONMENT",
   "keywords": [
     "answer",
@@ -78,8 +78,9 @@
     "iconv-lite": "^0.7.2"
   },
   "devDependencies": {
+    "@repo/tsconfig": "0.0.0",
     "@types/chardet": "^1.0.0",
-    "@types/node": "^25.5.2",
+    "@types/node": "^26.1.1",
     "typescript": "^6.0.2"
   },
   "peerDependencies": {
@@ -95,13 +96,13 @@
   },
   "main": "./dist-cjser/index.cjs",
   "types": "./dist/index.d.ts",
-  "gitHead": "b43359d803733b1a7c4638addcc270987fb894c3",
+  "gitHead": "999706755afbdcae271f62decbd9bcd05560905b",
   "cjser": {
-    "sourceVersion": "3.0.2",
+    "sourceVersion": "3.0.4",
     "cjserVersion": 2,
     "original": {
       "name": "@inquirer/external-editor",
-      "version": "3.0.2",
+      "version": "3.0.4",
       "main": "./dist/index.js",
       "exports": {
         ".": {

package/dist/errors/CreateFileError.d.ts

@@ -1,10 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export declare class CreateFileError extends Error {
-    originalError: Error;
-    constructor(originalError: Error);
-}

package/dist/errors/CreateFileError.js

@@ -1,13 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export class CreateFileError extends Error {
-    originalError;
-    constructor(originalError) {
-        super(`Failed to create temporary file. ${originalError.message}`);
-        this.originalError = originalError;
-    }
-}

package/dist/errors/LaunchEditorError.d.ts

@@ -1,10 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export declare class LaunchEditorError extends Error {
-    originalError: Error;
-    constructor(originalError: Error);
-}

package/dist/errors/LaunchEditorError.js

@@ -1,13 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export class LaunchEditorError extends Error {
-    originalError;
-    constructor(originalError) {
-        super(`Failed to launch editor. ${originalError.message}`);
-        this.originalError = originalError;
-    }
-}

package/dist/errors/ReadFileError.d.ts

@@ -1,10 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export declare class ReadFileError extends Error {
-    originalError: Error;
-    constructor(originalError: Error);
-}

package/dist/errors/ReadFileError.js

@@ -1,13 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export class ReadFileError extends Error {
-    originalError;
-    constructor(originalError) {
-        super(`Failed to read temporary file. ${originalError.message}`);
-        this.originalError = originalError;
-    }
-}

package/dist/errors/RemoveFileError.d.ts

@@ -1,10 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export declare class RemoveFileError extends Error {
-    originalError: Error;
-    constructor(originalError: Error);
-}

package/dist/errors/RemoveFileError.js

@@ -1,13 +0,0 @@
-/***
- * Node External Editor
- *
- * Kevin Gravier <kevin@mrkmg.com>
- * MIT 2018
- */
-export class RemoveFileError extends Error {
-    originalError;
-    constructor(originalError) {
-        super(`Failed to remove temporary file. ${originalError.message}`);
-        this.originalError = originalError;
-    }
-}