@positronic/shell 0.0.3 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@positronic/shell",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "publishConfig": {
     "access": "public"
   },
@@ -9,6 +9,10 @@
   "main": "dist/src/index.js",
   "types": "dist/types/index.ts",
   "license": "MIT",
+  "files": [
+    "dist",
+    "package.json"
+  ],
   "scripts": {
     "tsc": "tsc --project tsconfig.json",
     "swc": "swc src -d dist",

package/src/index.ts

@@ -1,4 +0,0 @@
-import { LocalShell } from './local-shell.js';
-import { SSH2Shell } from './ssh2-shell.js';
-
-export { LocalShell, SSH2Shell };

package/src/local-shell.ts

@@ -1,100 +0,0 @@
-import { spawn } from 'child_process';
-import { Readable } from 'stream';
-
-import type {
-  Shell,
-  ExecCommandOptions,
-  ExecCommandResponse,
-} from './types.js';
-
-interface LocalShellOptions {
-  cwd?: string;
-  shell?: string;
-  env?: NodeJS.ProcessEnv;
-}
-
-export class LocalShell implements Shell {
-  constructor(private config: LocalShellOptions = {}) {}
-
-  async execCommand(
-    givenCommand: string,
-    options: ExecCommandOptions = {}
-  ): Promise<ExecCommandResponse> {
-    return new Promise((resolve, reject) => {
-      const {
-        cwd = this.config.cwd || process.cwd(),
-        stdin,
-        encoding = 'utf8',
-        noTrim = false,
-        onStdout,
-        onStderr,
-        env = this.config.env,
-        timeout,
-        shell = this.config.shell || 'bash',
-      } = options;
-
-      const childProcess = spawn(shell, ['-c', givenCommand], {
-        cwd,
-        env,
-        timeout,
-      });
-
-      let stdout = '';
-      let stderr = '';
-
-      childProcess.stdout.on('data', (data: Buffer) => {
-        const chunk = data.toString(encoding);
-        stdout += chunk;
-        onStdout?.(data);
-      });
-
-      childProcess.stderr.on('data', (data: Buffer) => {
-        const chunk = data.toString(encoding);
-        stderr += chunk;
-        onStderr?.(data);
-      });
-
-      if (stdin) {
-        if (typeof stdin === 'string') {
-          childProcess.stdin.write(stdin);
-          childProcess.stdin.end();
-        } else if (stdin instanceof Readable) {
-          stdin.pipe(childProcess.stdin);
-        }
-      }
-
-      childProcess.on('close', (code, signal) => {
-        if (!noTrim) {
-          stdout = stdout.trim();
-          stderr = stderr.trim();
-        }
-        resolve({
-          stdout,
-          stderr,
-          code,
-          signal,
-        });
-      });
-
-      childProcess.on('error', (error) => {
-        reject(error);
-      });
-    });
-  }
-
-  async exec(
-    command: string,
-    parameters: string[],
-    options: ExecCommandOptions = {}
-  ): Promise<string | ExecCommandResponse> {
-    const { stream = 'stdout', ...execOptions } = options;
-    const fullCommand = `${command} ${parameters.join(' ')}`;
-    const result = await this.execCommand(fullCommand, execOptions);
-
-    if (stream === 'both') {
-      return result;
-    }
-
-    return stream === 'stdout' ? result.stdout : result.stderr;
-  }
-}

package/src/ssh2-shell.ts

@@ -1,150 +0,0 @@
-import { Client, ClientChannel } from 'ssh2';
-import type {
-  Shell,
-  ExecCommandOptions,
-  ExecCommandResponse,
-} from './types.js';
-import type { ConnectConfig } from 'ssh2';
-
-interface SSH2ShellOptions extends ConnectConfig {
-  env?: NodeJS.ProcessEnv;
-  timeout?: number;
-  shell?: 'bash' | 'sh' | 'zsh';
-  noTrim?: boolean;
-  cwd?: string;
-}
-
-export class SSH2Shell implements Shell {
-  private client: Client;
-  private defaultCwd?: string;
-
-  constructor(private config: SSH2ShellOptions) {
-    this.client = new Client();
-    this.defaultCwd = config.cwd;
-  }
-
-  async connect() {
-    return new Promise<void>((resolve, reject) => {
-      this.client.on('ready', () => {
-        resolve();
-      });
-
-      this.client.on('error', (err) => {
-        reject(err);
-      });
-
-      this.client.connect(this.config);
-    });
-  }
-
-  async execCommand(givenCommand: string, options: ExecCommandOptions = {}) {
-    return new Promise<ExecCommandResponse>((resolve, reject) => {
-      const env = { ...this.config.env, ...options.env };
-      const shell = this.config.shell || options.shell || null;
-      const shellCommand = shell
-        ? `${shell} -c "${givenCommand}"`
-        : givenCommand;
-      const cwd = options.cwd || this.defaultCwd;
-
-      if (cwd) {
-        // Prepend cd command if cwd is specified
-        const fullCommand = `cd ${cwd} && ${shellCommand}`;
-        this.client.exec(
-          fullCommand,
-          { env },
-          (err: Error | undefined, stream: ClientChannel) => {
-            if (err) {
-              reject(err);
-              return;
-            }
-
-            const { noTrim = false } = options;
-
-            let stdout: string[] = [];
-            let stderr: string[] = [];
-
-            stream.on('data', (data: Buffer) => {
-              stdout.push(data.toString());
-            });
-
-            stream.stderr.on('data', (data: Buffer) => {
-              stderr.push(data.toString());
-            });
-
-            stream.on('close', (code: number, signal: string | null) => {
-              const response: ExecCommandResponse = {
-                stdout: noTrim ? stdout.join('') : stdout.join('').trim(),
-                stderr: noTrim ? stderr.join('') : stderr.join('').trim(),
-                code,
-                signal,
-              };
-              resolve(response);
-            });
-
-            stream.on('error', (err: Error) => {
-              reject(err);
-            });
-          }
-        );
-      } else {
-        this.client.exec(
-          shellCommand,
-          { env },
-          (err: Error | undefined, stream: ClientChannel) => {
-            if (err) {
-              reject(err);
-              return;
-            }
-
-            const { noTrim = false } = options;
-
-            let stdout: string[] = [];
-            let stderr: string[] = [];
-
-            stream.on('data', (data: Buffer) => {
-              stdout.push(data.toString());
-            });
-
-            stream.stderr.on('data', (data: Buffer) => {
-              stderr.push(data.toString());
-            });
-
-            stream.on('close', (code: number, signal: string | null) => {
-              const response: ExecCommandResponse = {
-                stdout: noTrim ? stdout.join('') : stdout.join('').trim(),
-                stderr: noTrim ? stderr.join('') : stderr.join('').trim(),
-                code,
-                signal,
-              };
-              resolve(response);
-            });
-
-            stream.on('error', (err: Error) => {
-              reject(err);
-            });
-          }
-        );
-      }
-    });
-  }
-
-  async exec(
-    command: string,
-    parameters: string[],
-    options: ExecCommandOptions = {}
-  ) {
-    const { stream = 'stdout', ...execOptions } = options;
-    const fullCommand = `${command} ${parameters.join(' ')}`;
-    const result = await this.execCommand(fullCommand, execOptions);
-
-    if (stream === 'both') {
-      return result;
-    }
-
-    return stream === 'stdout' ? result.stdout : result.stderr;
-  }
-
-  async disconnect() {
-    this.client.end();
-  }
-}

package/src/types.ts

@@ -1,33 +0,0 @@
-import { Readable } from 'stream';
-
-export interface ExecCommandOptions {
-  cwd?: string;
-  stdin?: string | Readable;
-  env?: Record<string, string>;
-  timeout?: number;
-  shell?: 'sh' | 'bash' | 'zsh' | 'powershell';
-  encoding?: BufferEncoding;
-  noTrim?: boolean;
-  onStdout?: (chunk: Buffer) => void;
-  onStderr?: (chunk: Buffer) => void;
-  stream?: 'stdout' | 'stderr' | 'both';
-}
-
-export interface ExecCommandResponse {
-  stdout: string;
-  stderr: string;
-  code: number | null;
-  signal: string | null;
-}
-
-export interface Shell {
-  execCommand(
-    givenCommand: string,
-    options?: ExecCommandOptions
-  ): Promise<ExecCommandResponse>;
-  exec(
-    command: string,
-    parameters: string[],
-    options?: ExecCommandOptions
-  ): Promise<string | ExecCommandResponse>;
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "emitDeclarationOnly": true,
-    "declarationDir": "./dist/types"
-  },
-  "include": ["**/*"],
-  "exclude": ["dist", "node_modules", "**/*.test.ts"]
-}