DefinitelyTyped/types/shelljs/shelljs-tests.ts

// Tests taken from documentation samples.

import shell = require("shelljs");

if (!shell.which("git")) {
	shell.echo("Sorry, this script requires git");
	shell.exit(1);
}

// Copy files to release dir
shell.mkdir("-p", "out/Release");
shell.cp("-R", "stuff/*", "out/Release");

// Replace macros in each .js file
shell.cd("lib");
shell.ls("*.js").forEach(file => {
	shell.sed("-i", "BUILD_VERSION", "v0.1.2", file);
	shell.sed("-i", /.*REMOVE_THIS_LINE.*\n/, "", file);
	shell.sed(
		"-i",
		/.*REPLACE_LINE_WITH_MACRO.*\n/,
		shell.cat("macro.js"),
		file
	);
});

shell.cd("..");

shell.config.execPath = shell.which("node");

// Run external tool synchronously
if (shell.exec('git commit -am "Auto-commit"').code !== 0) {
	shell.echo("Error: Git commit failed");
	shell.exit(1);
}

shell.ls("projs/*.js");
shell.ls("-R", "/users/me", "/tmp");
shell.ls("-R", ["/users/me", "/tmp"]); // same as above

shell.find("src", "lib");
shell.find(["src", "lib"]); // same as above
shell.find(".").filter((file, i, n) => !!file.match(/\.js$/));

shell.cp("file1", "dir1");
shell.cp("-Rf", ["/tmp/*", "/usr/local/*"], "/home/tmp"); // same as aboveshell.

shell.rm("-rf", "/tmp/*");
shell.rm("some_file.txt", "another_file.txt");
shell.rm(["some_file.txt", "another_file.txt"]); // same as above

shell.mv(["file1", "file2"], "dir/"); // same as above

shell.mkdir("-p", "/tmp/a/b/c/d", "/tmp/e/f/g");
shell.mkdir("-p", ["/tmp/a/b/c/d", "/tmp/e/f/g"]); // same as above

if (shell.test("-d", "/tmp/a/b/c/d")) {
	/* do something with dir */
}
if (!shell.test("-f", "/tmp/a/b/c/d")) {
	/* do something with dir */
}

let str = shell.cat("file*.txt");
str = shell.cat("file1", "file2");
str = shell.cat(["file1", "file2"]); // same as above

shell.sed("-i", "PROGRAM_VERSION", "v0.1.3", "source.js");
shell.sed(/.*DELETE_THIS_LINE.*\n/, "", "source.js");

shell.grep("-v", "GLOBAL_VARIABLE", "*.js");
shell.grep("GLOBAL_VARIABLE", "*.js");

const nodeExec = shell.which("node");

shell.pushd("/etc"); // Returns /etc /usr
shell.pushd("+1");   // Returns /usr /etc

shell.echo(process.cwd()); // '/usr'
shell.pushd("/etc");       // '/etc /usr'
shell.echo(process.cwd()); // '/etc'
shell.popd();              // '/usr'
shell.echo(process.cwd()); // '/usr'

shell.ln("file", "newlink");
shell.ln("-sf", "file", "existing");

const testPath = shell.env["path"];
const version = shell.exec("node --version").stdout;

// $ExpectType ShellString
const version2 = shell.exec("node --version", {async: false});
const output = version2.stdout;

// $ExpectType ChildProcess
const asyncVersion3 = shell.exec("node --version", {async: true});
let pid = asyncVersion3.pid;

declare let isAsync: boolean;

// $ExpectType ShellString | ChildProcess
const unknownUntilRuntime = shell.exec("node --version", {async: isAsync});

shell.exec("node --version", {silent: true}, (code, stdout, stderr) => {
	const version = stdout;
});
shell.exec(
	"node --version",
	{silent: true, async: true, cwd: "/usr/local/bin"},
	(code, stdout, stderr) => {
		const version = stdout;
	}
);
shell.exec("node --version", (code, stdout, stderr) => {
	const version = stdout;
});
shell.exec("node --version", (code: number) => {
	const num: number = code;
});

// $ExpectType ChildProcess
const childProc = shell.exec("node --version", (code: number) => {
	const num: number = code;
});
pid = childProc.pid;

shell.set("+e");
shell.set("-e");
shell.set("+v");
shell.set("-v");
shell.set("+f");
shell.set("-f");

shell.chmod(755, "/Users/brandon");
shell.chmod("755", "/Users/brandon"); // same as above
shell.chmod("u+x", "/Users/brandon");
shell.chmod("-cR", 755, "/Users/brandon");
shell.chmod("-Rv", "u+x", "/Users/brandon");

shell.exit(0);

shell.touch("/Users/brandom/test1");
shell.touch("/Users/brandom/test1", "/Users/brandom/test2");

shell.touch(["/Users/brandom/test1"]);
shell.touch(["/Users/brandom/test1", "/Users/brandom/test2"]);

shell.touch("-c", "/Users/brandom/test1");
shell.touch("-c", "/Users/brandom/test1", "/Users/brandom/test2");
shell.touch("-c", ["/Users/brandom/test1", "/Users/brandom/test2"]);

shell.touch({"-r": "/some/file.txt"}, "/Users/brandom/test1");
shell.touch(
	{"-r": "/some/file.txt"},
	"/Users/brandom/test1",
	"/Users/brandom/test2"
);
shell.touch({"-r": "/oome/file.txt"}, [
	"/Users/brandom/test1",
	"/Users/brandom/test2"
]);

shell.head({"-n": 1}, "file*.txt");
shell.head("file1", "file2");
shell.head(["file1", "file2"]); // same as above

shell.sort("foo.txt", "bar.txt");
shell.sort("-r", "foo.txt");
shell.sort("-r", ["file.txt"]);
shell.sort(["file.txt"]);

shell.tail({"-n": 1}, "file*.txt");
shell.tail("file1", "file2");
shell.tail(["file1", "file2"]); // same as above

shell.uniq("foo.txt");
shell.uniq("-i", "foo.txt");
shell.uniq("-cd", "foo.txt", "bar.txt");

const tmp = shell.tempdir(); // "/tmp" for most *nix platforms

const errorlol = shell.error();

shell.config.reset();
shell.config.silent = true;
shell.config.fatal = true;
shell.config.verbose = true;
shell.config.execPath = null;
shell.config.execPath = "/bin/node";
shell.config.globOptions = {
	cwd: "./",
	dot: true
};

shell
	.ls("dir")
	.grep(/^stuff/)
	.head({"-n": 5}).stdout;

const foo = new shell.ShellString('hello world');
const farr = new shell.ShellString(['hello', 'world']);

const boo = shell.ShellString('hello world');
const barr = shell.ShellString(['hello', 'world']);