refactor!: convert to esm

Author: wdavidw

README.md

@@ -24,26 +24,26 @@ Or
 
 Like in the native NodeJS API, the callback is not required in case you wish to work with the returned child stream. The "sshOrNull" and "command" arguments are also facultative because they could be provided respectively as the "ssh" and "command" property of the options object.
 
-Valid `options` properties are:   
-
-- `ssh`   
-  SSH connection if the command must run remotely   
-- `command`   
-  Command to run unless provided as first argument   
-- `cwd`   
-  Current working directory   
-- `end`   
-  Close the SSH connection on exit, default to true if an ssh connection instance is provided.   
-- `env`   
-  An environment to use for the execution of the command.   
-- `pty`   
-  Set to true to allocate a pseudo-tty with defaults, or an object containing specific pseudo-tty settings. Apply only to SSH remote commands.   
-- `cwd`   
-  Apply only to local commands.   
-- `uid`   
-  Apply only to local commands.   
-- `gid`   
-  Apply only to local commands.   
+Valid `options` properties are:
+
+- `ssh`  
+  SSH connection if the command must run remotely
+- `command`  
+  Command to run unless provided as first argument
+- `cwd`  
+  Current working directory
+- `end`  
+  Close the SSH connection on exit, default to true if an ssh connection instance is provided.
+- `env`  
+  An environment to use for the execution of the command.
+- `pty`  
+  Set to true to allocate a pseudo-tty with defaults, or an object containing specific pseudo-tty settings. Apply only to SSH remote commands.
+- `cwd`  
+  Apply only to local commands.
+- `uid`  
+  Apply only to local commands.
+- `gid`  
+  Apply only to local commands.
 
 See the [ssh2] and [ssh2-connect] modules on how to create a new SSH connection.
 
@@ -66,10 +66,10 @@ If the exit code is not `0`, the thrown error object contains the `stdout`, `std
 A command, a configuration object and a callback:
 
 ```js
-connect = require('ssh2-connect');
-exec = require('ssh2-exec');
-connect({host: localhost}, function(err, ssh){
-  exec('ls -la', {ssh: ssh}, (err, stdout, stderr, code){
+import { connect } from "ssh2-connect";
+import { exec } from "ssh2-exec";
+connect({ host: localhost }, (err, ssh) => {
+  exec("ls -la", { ssh: ssh }, (err, stdout, stderr, code) => {
     console.info(stdout, stderr, code);
   });
 });
@@ -78,25 +78,28 @@ connect({host: localhost}, function(err, ssh){
 A configuration object with a ssh2 connection and working a the return child object:
 
 ```js
-connect = require('ssh2-connect');
-exec = require('ssh2-exec');
-connect({host: localhost}, function(err, ssh){
-  child = exec({
-    command: 'ls -la',
-    ssh: ssh
-  }, function(err, stdout, stderr, code){
-    console.info(stdout);
-  });
-  child.stdout.on('data', function(data){
+import { connect } from "ssh2-connect";
+import { exec } from "ssh2-exec";
+connect({ host: localhost }, function (err, ssh) {
+  child = exec(
+    {
+      command: "ls -la",
+      ssh: ssh,
+    },
+    function (err, stdout, stderr, code) {
+      console.info(stdout);
+    },
+  );
+  child.stdout.on("data", function (data) {
     console.info(data);
   });
-  child.stderr.on('data', function(data){
+  child.stderr.on("data", function (data) {
     console.error(data);
   });
-  child.on('exit', function(code){
-    console.info('Exit', code);
+  child.on("exit", function (code) {
+    console.info("Exit", code);
   });
-})
+});
 ```
 
 ## Development

commitlint.config.js

@@ -1,20 +1,3 @@
-module.exports = {
+export default {
   extends: ["@commitlint/config-conventional"],
-  rules: {
-    "type-enum": [
-      2,
-      "always",
-      [
-        "build",
-        "chore",
-        "ci",
-        "docs",
-        "feat",
-        "fix",
-        "refactor",
-        "revert",
-        "test",
-      ],
-    ],
-  },
 };

lib/index.js

@@ -1,6 +1,6 @@
-const { exec, spawn } = require("node:child_process");
-const { EventEmitter } = require("node:events");
-const stream = require("node:stream");
+import * as process from "node:child_process";
+import { EventEmitter } from "node:events";
+import stream from "node:stream";
 
 // Utilities
 const is_ssh_connection = function (obj) {
@@ -10,7 +10,7 @@ const is_object = function (obj) {
   return obj && typeof obj === "object" && !Array.isArray(obj);
 };
 
-const local = (module.exports.local = function (options, callback) {
+export const local = function (options, callback) {
   const commandOptions = {};
   commandOptions.env = options.env || process.env;
   commandOptions.cwd = options.cwd || null;
@@ -24,7 +24,7 @@ const local = (module.exports.local = function (options, callback) {
     commandOptions.stdio = options.stdio;
   }
   if (callback) {
-    return exec(
+    return process.exec(
       options.command,
       commandOptions,
       function (err, stdout, stderr, ...args) {
@@ -55,71 +55,17 @@ const local = (module.exports.local = function (options, callback) {
       },
     );
   } else {
-    return spawn(
+    return process.spawn(
       options.command,
       [],
       Object.assign(commandOptions, {
         shell: options.shell || true,
       }),
     );
   }
-});
-
-module.exports = function (...args) {
-  let callback;
-  const options = {};
-  for (const i in args) {
-    const arg = args[i];
-    if (arg == null) {
-      if (options.ssh != null) {
-        throw Error(
-          `Invalid Argument: argument ${i} cannot be null, the connection is already set`,
-        );
-      }
-      options.ssh = arg;
-    } else if (is_ssh_connection(arg)) {
-      if (options.ssh != null) {
-        throw Error(
-          `Invalid Argument: argument ${i} cannot be an SSH connection, the connection is already set`,
-        );
-      }
-      options.ssh = arg;
-    } else if (is_object(arg)) {
-      if (arg.cmd) {
-        arg.command = arg.cmd;
-        console.warn("Option `cmd` is deprecated in favor of `command`");
-      }
-      for (const k in arg) {
-        options[k] = arg[k];
-      }
-    } else if (typeof arg === "string") {
-      if (options.command != null) {
-        throw Error(
-          `Invalid Argument: argument ${i} cannot be a string, a command already exists`,
-        );
-      }
-      options.command = arg;
-    } else if (typeof arg === "function") {
-      if (callback) {
-        throw Error(
-          `Invalid Argument: argument ${i} cannot be a function, a callback already exists`,
-        );
-      }
-      callback = arg;
-    } else {
-      throw Error(
-        `Invalid arguments: argument ${i} is invalid, got ${JSON.stringify(arg)}`,
-      );
-    }
-  }
-  if (options.ssh) {
-    return remote(options, callback);
-  } else {
-    return local(options, callback);
-  }
 };
 
-const remote = (module.exports.remote = function (options, callback) {
+export const remote = function (options, callback) {
   const child = new EventEmitter();
   child.stdout = new stream.Readable();
   child.stdout._read = function (_size) {};
@@ -133,7 +79,8 @@ const remote = (module.exports.remote = function (options, callback) {
       child.stream.signal(signal);
     }
   };
-  let stdout = (stderr = "");
+  let stdout = "";
+  let stderr = "";
   if (options.cwd) {
     options.command = `cd ${options.cwd}; ${options.command}`;
   }
@@ -167,8 +114,11 @@ const remote = (module.exports.remote = function (options, callback) {
         stdout += data;
       }
     });
-    let code = (signal = null);
-    let exitCalled = (stdoutCalled = stderrCalled = false);
+    let code = null;
+    let signal = null;
+    let exitCalled = false;
+    let stdoutCalled = false;
+    let stderrCalled = false;
     const exit = function () {
       if (!(exitCalled && stdoutCalled && stderrCalled)) {
         return;
@@ -227,4 +177,58 @@ const remote = (module.exports.remote = function (options, callback) {
     });
   });
   return child;
-});
+};
+
+export const exec = function (...args) {
+  let callback;
+  const options = {};
+  for (const i in args) {
+    const arg = args[i];
+    if (arg == null) {
+      if (options.ssh != null) {
+        throw Error(
+          `Invalid Argument: argument ${i} cannot be null, the connection is already set`,
+        );
+      }
+      options.ssh = arg;
+    } else if (is_ssh_connection(arg)) {
+      if (options.ssh != null) {
+        throw Error(
+          `Invalid Argument: argument ${i} cannot be an SSH connection, the connection is already set`,
+        );
+      }
+      options.ssh = arg;
+    } else if (is_object(arg)) {
+      if (arg.cmd) {
+        arg.command = arg.cmd;
+        console.warn("Option `cmd` is deprecated in favor of `command`");
+      }
+      for (const k in arg) {
+        options[k] = arg[k];
+      }
+    } else if (typeof arg === "string") {
+      if (options.command != null) {
+        throw Error(
+          `Invalid Argument: argument ${i} cannot be a string, a command already exists`,
+        );
+      }
+      options.command = arg;
+    } else if (typeof arg === "function") {
+      if (callback) {
+        throw Error(
+          `Invalid Argument: argument ${i} cannot be a function, a callback already exists`,
+        );
+      }
+      callback = arg;
+    } else {
+      throw Error(
+        `Invalid arguments: argument ${i} is invalid, got ${JSON.stringify(arg)}`,
+      );
+    }
+  }
+  if (options.ssh) {
+    return remote(options, callback);
+  } else {
+    return local(options, callback);
+  }
+};

lib/promises.js

@@ -1,11 +1,11 @@
-const exec = require(".");
+import { exec as execCallback } from "./index.js";
 
-module.exports = function (...args) {
+export const exec = function (...args) {
   if (typeof args[args.length - 1] === "function") {
     throw Error("Last argument cannot be a callback function");
   }
   return new Promise(function (resolve, reject) {
-    exec(...args, function (err, stdout, stderr, code) {
+    execCallback(...args, function (err, stdout, stderr, code) {
       if (err) {
         err.stdout = stdout;
         err.stderr = stderr;

package.json

@@ -43,7 +43,7 @@
     "mocha": "^10.7.3",
     "mocha-they": "^0.1.3",
     "should": "^13.2.3",
-    "ssh2-connect": "^3.4.3",
+    "ssh2-connect": "^4.0.2",
     "standard-version": "^9.5.0"
   },
   "exports": {
@@ -60,5 +60,6 @@
     "release:major": "standard-version --release-as major",
     "postrelease": "git push --follow-tags origin master",
     "test": "mocha 'test/**/*.js'"
-  }
+  },
+  "type": "module"
 }

test/api.js

@@ -1,5 +1,7 @@
-const exec = require("../lib/index");
-const { connect, they } = require("./test");
+import { exec } from "../lib/index.js";
+import { connect, they } from "./test.js";
+
+const __filename = new URL("", import.meta.url).pathname;
 
 describe("exec.api", () => {
   they(

test/callback.js

@@ -1,5 +1,5 @@
-const exec = require('../lib/index');
-const { connect, they } = require('./test');
+import { exec } from "../lib/index.js";
+import { connect, they } from "./test.js";
 
 describe("exec.callback", () => {
   they(

test/child.js

@@ -1,5 +1,5 @@
-const exec = require("../lib/index");
-const { connect, they } = require("./test");
+import { exec } from "../lib/index.js";
+import { connect, they } from "./test.js";
 
 describe("exec.child", () => {
   they(

test/options.js

@@ -1,5 +1,5 @@
-const exec = require('../lib/index');
-const { connect, they } = require('./test');
+import { exec } from "../lib/index.js";
+import { connect, they } from "./test.js";
 
 describe("exec.options", () => {
   they(

test/promise.js

@@ -1,8 +1,8 @@
-const exec = require('../lib/promises');
-const { connect, they } = require('./test');
+import { exec } from "../lib/promises.js";
+import { connect, they } from "./test.js";
 
 describe("exec.promise", () => {
-  they(
+  they.only(
     "handle a successful command",
     connect(({ ssh }) => {
       return exec({