deno-run-simple's Introduction

run_simple

Simple run function to execute shell commands in Deno.

Returns a Promise of what the command printed.

The promise rejects with status if the command fails.

API

See the documentation, generated from the latest release.

Usage

// example.ts

import { run } from "https://deno.land/x/run_simple/mod.ts";

// Simple command
const dir: string = await run("ls -l");
console.log(dir);

// Command with variable argument
const uid = 1000;
const idLine: string = await run(["id", uid]);
console.log(idLine);

// An argument contains spaces
const remoteHost = "10.20.30.40";
const remoteCommand = "ps -ef --forest";
const remoteProcessTree: string = await run(["ssh", remoteHost, remoteCommand]);
console.log(remoteProcessTree);

// Supply STDIN to the command
const contents = `# Remote file

This will be the contents of the remote file.
`;
await run(
  ["ssh", remoteHost, "bash", "-c", "cat > remote_file.md"],
  { stdin: contents },
);

deno run --allow-run ./example.ts

deno-run-simple's People

Contributors

Stargazers

Watchers

deno-run-simple's Issues

Error: [non-error-thrown] [object Object]

Firstly, thanks a lot for simpe-run, it's really epic! 🧡 🧡 🧡

I'm seeing some errors produced like so:

Error: [non-error-thrown] [object Object]

I can't see the contents of the error because I just get [object Object]. From looking at the code it looks like run() throws a non error if the script exits with a non zero code. Is there a way to unpack the error and get it logged? Or would it make sense to extend the error class and throw that?

feat: extractShebangCommand

Add below function:

/**
 * Extracts the command to run a script, from its shebang line.
 * @param scriptContents the script source code
 * @returns array of command and parameters
 */
export function extractShebangCommand(scriptContents: string): string[] {
  return scriptContents.split("\n")[0].replace(/^#!/, "").split(" ");
}