feat: remove shelljs

Author: ZhiXiao-Lin

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nerdctl",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Node wrapper for nerdctl",
@@ -26,7 +26,6 @@
     "change-case": "^4.1.2",
     "lodash": "^4.17.21",
     "node-fetch": "2",
-    "shelljs": "^0.8.5",
     "ts-node-dev": "^1.1.8",
     "yaml": "^2.0.0"
   },
@@ -36,7 +35,6 @@
     "@types/lodash": "^4.14.181",
     "@types/node": "^17.0.23",
     "@types/node-fetch": "^2.6.1",
-    "@types/shelljs": "^0.8.11",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "3.3.0",
     "dotenv": "^16.0.0",
@@ -50,9 +48,7 @@
     "typedoc-plugin-missing-exports": "^0.22.6",
     "typescript": "^4.6.3"
   },
-  "peerDependencies": {
-    "shelljs": "^0.8.5"
-  },
+  "peerDependencies": {},
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"

src/index.ts

@@ -19,3 +19,22 @@ export function factory(vm?: string, instance?: string): BaseBackend {
       throw new Error(`OS "${platform}" is not supported.`);
   }
 }
+
+// async function test() {
+//   const vm = factory();
+//   await vm.checkVM();
+
+//   const IMAGE = "hello-world";
+
+//   await vm.pullImage(IMAGE, (data) => {
+//     console.log(data);
+//   });
+
+//   await vm.run(IMAGE, { rm: true }, (data) => {
+//     console.log(data);
+//   });
+
+//   console.log(vm.removeImage(IMAGE));
+// }
+
+// test();

src/vms/base.ts

@@ -1,14 +1,13 @@
 import { Architecture, ProcessCallback } from "@/types";
-import { ExecOptions, ShellString, exec, which } from "shelljs";
 import { ImageResult, RemoveImageCommandFlags } from "@/types/images";
 import {
   LogsCommandFlags,
   RemoveCommandFlags,
   RunCommandFlags,
   StopCommandFlags,
 } from "@/types/container";
+import { exec, execSync } from "child_process";
 
-import { ChildProcess } from "child_process";
 import { GlobalFlags } from "@/types/global";
 import { LoginCommandFlags } from "@/types/registry";
 import { paramCase } from "change-case";
@@ -44,7 +43,7 @@ export default abstract class BaseBackend {
     command: string,
     callback?: ProcessCallback
   ): Promise<boolean> {
-    const child = (await this.exec(command)) as ChildProcess;
+    const child = exec(command);
 
     return await new Promise((resolve) => {
       child?.stdout?.on("data", (data) => {
@@ -62,22 +61,12 @@ export default abstract class BaseBackend {
     });
   }
 
-  protected async execSync(
-    command: string,
-    options?: Omit<ExecOptions, "async">
-  ): Promise<ShellString> {
-    return exec(command, {
-      silent: true,
-      async: false,
-      ...options,
-    }) as ShellString;
+  protected execSync(command: string): string {
+    return execSync(command).toString();
   }
 
-  protected async exec(
-    command: string,
-    options?: Omit<ExecOptions, "async">
-  ): Promise<ChildProcess> {
-    return exec(command, { silent: true, async: true, ...options });
+  protected which(command: string) {
+    return this.execSync(`which ${command}`);
   }
 
   protected mergeFlags(flags?: GlobalFlags): string {
@@ -111,7 +100,7 @@ export default abstract class BaseBackend {
 
   //#region VMs
   async checkVM(): Promise<boolean> {
-    return !!which(this.vm);
+    return !!this.which(this.vm);
   }
   async checkInstance(): Promise<boolean> {
     return true;
@@ -125,21 +114,18 @@ export default abstract class BaseBackend {
   //#endregion
 
   //#region registry
-  async login(
-    flags?: LoginCommandFlags,
-    server?: string
-  ): Promise<ShellString> {
+  login(flags?: LoginCommandFlags, server?: string): string {
     const command = `${this.container} login ${this.mergeFlags(
       flags
     )} ${server}`;
 
-    return await this.execSync(command);
+    return this.execSync(command);
   }
 
-  async logout(server?: string): Promise<ShellString> {
+  logout(server?: string): string {
     const command = `${this.container} logout ${server}`;
 
-    return await this.execSync(command);
+    return this.execSync(command);
   }
   //#endregion
 
@@ -154,32 +140,26 @@ export default abstract class BaseBackend {
     return await this.fork(command, callback);
   }
 
-  async stop(
-    container: string | string[],
-    flags?: StopCommandFlags
-  ): Promise<ShellString> {
+  stop(container: string | string[], flags?: StopCommandFlags): string {
     const containers = Array.isArray(container)
       ? container.join(" ")
       : container;
     const command = `${this.container} stop ${this.mergeFlags(
       flags
     )} ${containers}`;
 
-    return await this.execSync(command);
+    return this.execSync(command);
   }
 
-  async remove(
-    container: string | string[],
-    flags?: RemoveCommandFlags
-  ): Promise<ShellString> {
+  remove(container: string | string[], flags?: RemoveCommandFlags): string {
     const containers = Array.isArray(container)
       ? container.join(" ")
       : container;
     const command = `${this.container} rm ${this.mergeFlags(
       flags
     )} ${containers}`;
 
-    return await this.execSync(command);
+    return this.execSync(command);
   }
 
   async logs(container: string, flags?: LogsCommandFlags): Promise<boolean> {
@@ -199,9 +179,7 @@ export default abstract class BaseBackend {
   }
 
   async getImages(): Promise<ImageResult[]> {
-    const child = (await this.exec(
-      `${this.container} images --format "{{json .}}"`
-    )) as ChildProcess;
+    const child = exec(`${this.container} images --format "{{json .}}"`);
 
     return new Promise((resolve, reject) => {
       if (!!child.exitCode) reject(null);
@@ -219,14 +197,14 @@ export default abstract class BaseBackend {
     });
   }
 
-  async removeImage(
+  removeImage(
     image: string | string[],
     flags?: RemoveImageCommandFlags
-  ): Promise<ShellString> {
+  ): string {
     const images = Array.isArray(image) ? image.join(" ") : image;
     const command = `${this.container} rmi ${this.mergeFlags(flags)} ${images}`;
 
-    return await this.execSync(command);
+    return this.execSync(command);
   }
   //#endregion
 }

src/vms/lima.ts

@@ -1,14 +1,12 @@
 import BaseBackend from "./base";
-import { ChildProcess } from "child_process";
 import { LimaListResult } from "@/types/lima";
 import { ProcessCallback } from "@/types";
+import { exec } from "child_process";
 import { isM1 } from "@/utils";
 
 export default class LimaBackend extends BaseBackend {
   async checkInstance(): Promise<boolean> {
-    const listChild = (await this.exec(
-      `${this.vm} list --json`
-    )) as ChildProcess;
+    const listChild = exec(`${this.vm} list --json`);
     if (!listChild || !listChild.stdout) return false;
 
     const list: LimaListResult[] = await new Promise((resolve, reject) => {