🔖 v0.5.0

Author: jaandrle

README.md

@@ -6,20 +6,18 @@ This is done by using [shelljs/shelljs](https://github.com/shelljs/shelljs) libr
 You can compare the final script code to `zx` example:
 ```javascript
 #!/usr/bin/env nodejsscript
-import { exec, exec$, grep, echo } from "nodejsscript";
-echo(grep("name", "package.json"));
+import { s, echo } from "nodejsscript";
+echo(s.grep("name", "package.json"));
 
-const branch= exec$("git branch --show-current");
-exec(`dep deploy --branch=${branch}`);
+s.exec("git branch --show-current").xargs(s.exec, "dep deploy --branch={}");
 
-exec("sleep 1; echo 1");
-exec("sleep 2; echo 2");
-exec("sleep 3; echo 3");
+s.exec("sleep 1; echo 1");
+s.exec("sleep 2; echo 2");
+s.exec("sleep 3; echo 3");
 
-import { mkdir, tempdir } from "nodejsscript";
 import { join } from "node:path";
 const name= "foo bar";
-mkdir(join(tempdir(), name));
+s.mkdir(join(s.tempdir(), name));
 ```
 
 ## Installation
@@ -29,16 +27,7 @@ mkdir(join(tempdir(), name));
 1. `npm install https://github.com/jaandrle/nodejsscript --global`
 
 ## Goods
-[shelljs/shelljs](https://github.com/shelljs/shelljs):
-[cat](https://github.com/shelljs/shelljs#catoptions-file--file-) · [cd](https://github.com/shelljs/shelljs#cddir) · [chmod](https://github.com/shelljs/shelljs#chmodoptions-octal_mode--octal_string-file) · [cp](https://github.com/shelljs/shelljs#cpoptions-source--source--dest)
- · [pushd](https://github.com/shelljs/shelljs#pushdoptions-dir---n--n) · [popd](https://github.com/shelljs/shelljs#popdoptions--n--n) · [dirs](https://github.com/shelljs/shelljs#dirsoptions--n---n) · [exec](https://github.com/shelljs/shelljs#execcommand--options--callback)
- · [find](https://github.com/shelljs/shelljs#findpath--path-) · [grep](https://github.com/shelljs/shelljs#grepoptions-regex_filter-file--file-) · [head](https://github.com/shelljs/shelljs#head-n-num-file--file-) · [ln](https://github.com/shelljs/shelljs#lnoptions-source-dest)
- · [ls](https://github.com/shelljs/shelljs#lsoptions-path-) · [mkdir](https://github.com/shelljs/shelljs#mkdiroptions-dir--dir-) · [mv](https://github.com/shelljs/shelljs#mvoptions--source--source--dest) · [pwd](https://github.com/shelljs/shelljs#pwd)
- · [rm](https://github.com/shelljs/shelljs#rmoptions-file--file-) · [sed](https://github.com/shelljs/shelljs#sedoptions-search_regex-replacement-file--file-) · [sort](https://github.com/shelljs/shelljs#sortoptions-file--file-)
- · [tail](https://github.com/shelljs/shelljs#tail-n-num-file--file-) · [tempdir](https://github.com/shelljs/shelljs#tempdir) · [test](https://github.com/shelljs/shelljs#testexpression) · [touch](https://github.com/shelljs/shelljs#touchoptions-file--file-)
- · [uniq](https://github.com/shelljs/shelljs#uniqoptions-input-output) · [which](https://github.com/shelljs/shelljs#whichcommand) · [exit](https://github.com/shelljs/shelljs#exitcode) · [error](https://github.com/shelljs/shelljs#error) · [errorCode](https://github.com/shelljs/shelljs#errorcode) 
- | another libs: [cli()](#cli) · [chalk](#chalk-package) · [fetch()](#fetch)
- | this lib: [xarg()](#xarg) · [pipe()](#pipe) · [question()](#question) · [echo()](#echo) · [exec$()](#exec$) · [stdin()](#stdin) · [config](#config)
+[s (shelljs)](#shelljs) · [cli()](#cli) · [chalk](#chalk-package) · [fetch()](#fetch) · [pipe()](#pipe) · [question()](#question) · [echo()](#echo) · [stdin()](#stdin) · [config](#config)
 
 
 ## Documentation
@@ -69,29 +58,39 @@ All function (`shelljs`, `fetch`, …) are exported by library, so use:
 import { … } from "nodejsscript";
 ```
 
-### `xarg()`
-Simplify version of `xargs` allowing passing one argument. For now only "-I" argument is allowed.
-By default `{}` will be replaced, if not presented the argument is append as last one.
+### shelljs
+The `shelljs` extension is available as `s`. For docs visits [shelljs/shelljs](https://github.com/shelljs/shelljs).
+You can pipe commands when make sense by changing see **[Pipes](https://github.com/shelljs/shelljs#pipes)**.
 
 ```js
-pipe(
-	exec$.bind(null, "git branch --show-current"),
-	xarg(exec, "echo deploy --branch={}")
-)();
-pipe(
-	exec$.bind(null, "git branch --show-current"),
-	xarg("-I §", exec, "echo deploy --branch=§")
-)();
+s.cat("./package.json").grep("version");
+```
+… this library adds two function `xargs` and `$`:
+#### `xargs(cmd, ...cmd_args)`
+#### `xargs("-I", pattern, cmd, ...cmd_args)`
+```js
+s.exec("git branch --show-current").xargs(s.exec, "dep deploy --branch={}");
+s.exec("git branch --show-current").xargs("-I", "§", s.exec, "dep deploy --branch=§");
+```
+
+#### `$()`
+#### `$("-svf")`
+Modifies config for next command in chain. The `$()` runs next command in silent mode (compare to bash `var=$(echo Hi)`).
+
+```js
+const branch= s.$().exec("git branch --show-current");
+echo(branch);
+
+s.$("-vf").exec("gyt branch --show-current");
 ```
 
 ### `pipe()`
 Function similar to [Ramda `R.pipe`](https://ramdajs.com/docs/#pipe)). Provides functional way to combine commands/functions.
-Can be used with [xarg()](#xarg). **Some functions from shelljs also allow you to combine them, see [Pipes](https://github.com/shelljs/shelljs#pipes)**.
 
 ```js
 pipe(
 	Number,
-	v=> s.greenBright(v+1),
+	v=> chalk.greenBright(v+1),
 	v=> `Result is: ${v}`,
 	echo
 )(await question("Choose number:"));
@@ -125,15 +124,6 @@ A wrapper around the [readline](https://nodejs.org/api/readline.html) package.
 const bear= await question('What kind of bear is best? ')
 ```
 
-### `exec$()`
-A wrapper around the [exec](https://github.com/shelljs/shelljs#execcommand--options--callback) function.
-Runs in silent mode and handle text to be used as variables.
-
-```js
-const branch= exec$("git branch --show-current");
-echo('Current branch is', branch);
-```
-
 ### `echo()`
 A `console.log()` alternative optimized for scripting.
 
@@ -166,11 +156,10 @@ const config.assign({ verbose: true, silent: false });
 ```
 
 ### `chalk` package
-The [chalk](https://www.npmjs.com/package/chalk) package. Also as shorthand **s**.
+The [chalk](https://www.npmjs.com/package/chalk) package.
 
 ```js
 echo(chalk.blue('Hello world!'));
-echo(s.blue('Hello world!'));
 ```
 
 [^node]: Alternatively `curl -sL install-node.vercel.app/17.0.1 | bash`

examples/background-process.mjs

@@ -1,8 +1,8 @@
 #!/usr/bin/env nodejsscript
 /* jshint esversion: 8,-W097, -W040, node: true, expr: true, undef: true */
-import { echo, exec, fetch, exit } from "nodejsscript";
+import { echo, s, fetch, exit } from "nodejsscript";
 
-const serve= exec("npx serve", { async: true });
+const serve= s.exec("npx serve", { async: true });
 for await (const chunk of serve.stdout)
 	if (chunk.includes('Accepting connections')) break;
 

examples/backup-github.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env nodejsscript
-import { cd, echo, exec, mkdir, question } from "nodejsscript";
+import { s, echo, question, fetch } from "/home/jaandrle/.nvm/versions/node/v17.0.1/lib/node_modules/nodejsscript/index.js";
 
 const username= await question('What is your GitHub username?');
 const token= await question('Do you have GitHub token in env?', {
@@ -15,8 +15,8 @@ if (process.env[token]) {
 const data= await fetch(`https://api.github.com/users/${username}/repos?per_page=1000`, { headers }).then(res=> res.json());
 const urls= data.map(x=> x.git_url.replace('git://github.com/', 'git@github.com:'));
 
-mkdir("-p", "backups");
-cd("./backups");
+s.mkdir("-p", "backups");
+s.cd("./backups");
 
 for(const url of urls)
-	exec(`git clone ${url}`);
+	s.exec(`git clone ${url}`);

examples/cli.mjs

@@ -1,19 +1,19 @@
 #!/usr/bin/env nodejsscript
-import { cli, echo, mkdir, pipe, rm, tempdir, test, xarg } from "nodejsscript";
+import { cli, s, echo, pipe } from "nodejsscript";
 import { join } from "node:path";
 
 cli("", true)
 	.version("0.1.0")
 	.describe("NodeJS Script cli test")
 	.option("--clear", "Clears cerated temp dir")
 	.action(function main({ clear }){
-		const name= join(tempdir(), "foo bar");
-		mkdir("-p", name);
+		const name= join(s.tempdir(), "foo bar");
+		s.mkdir("-p", name);
 
-		const testDir= pipe(xarg(test, "-d"), echo);
+		const testDir= pipe(s.test.bind(null, "-d"), echo);
 		testDir(name);
 
-		if(clear) rm("-R", name);
+		if(clear) s.rm("-R", name);
 		testDir(name);
 	})
 	.parse(process.argv);

index.js

@@ -1,83 +1,39 @@
 export const pipe= (...funs)=> input=> Array.prototype.reduce.call(funs, (out, f)=> f(out), input);
-function parseOptions(candidate, initial= {}){
-	if(typeof candidate!=="string") return Object.assign({}, initial, candidate);
-	return candidate.split(" -").reduce(function parse(out, curr, i){
-		const space_i= curr.indexOf(" ");
-		const name= ( i ? "-" : "" )+curr.slice(0, space_i);
-		Reflect.set(out, name, curr.slice(space_i+1));
-		return out;
-	}, initial);
-}
-export function xarg(...params){
-	const options_default= { "-I": "{}" };
-	const options= typeof params[0]!=="function" ? parseOptions(params.shift()) : options_default;
-	const needle= options["-I"];
-	const [ cmd, ...args ]= params;
-	return function call(arg){
-		let replaced= 0;
-		const args_final= args.map(a=> a.replaceAll(needle, ()=> ( replaced+= 1, arg )));
-		if(!replaced) args_final.push(arg);
-		return cmd.apply(null, args_final);
-	};
-}
-
-import shelljs from "shelljs";
-export const {
-	ls, find, dirs,
-	cd, pwd, pushd, popd,
-	cp, rm, mv, mkdir, ln, touch, tempdir,
-	chmod,
-	test, error,
-	cat, sed, grep, sort, head, tail, uniq,
-	which,
-	exit, env,
-	exec
-}= shelljs;
-/**
- * Silent execution of {@link exec} to be used with pipeing or as variable.
- * @param {string} command The command to execute.
- * @param {object} options 
- * @param {boolean} [options.fatal] Exit when command return code is non-zero.
- * @param {string} [options.encoding] Character encoding to use.
- * @example
- * const out= exec$("cmd");
- */
-export function exec$(command, options= {}){
-	return exec(command, Object.assign({}, options, { async: false, silent: true })).replace(/\n$/g, "");
-}
 
-const _config= shelljs.config;
+import s from "./src/shelljs.js";
+export { s };
+export const exit= s.exit;
 export const config= {
 	/**
 	 * Suppresses all command output if `true`, except for `echo()` call.
 	 * @default false
 	 * */
-	get silent(){ return _config.silent; },
-	set silent(v){ _config.silent= v; },
+	get silent(){ return s.config.silent; },
+	set silent(v){ s.config.silent= v; },
     /**
 	 * Will print each executed command to the screen.
 	 * @default false
 	 * */
-	get verbose(){ return _config.verbose; },
-	set verbose(v){ return (_config.verbose= v); },
+	get verbose(){ return s.config.verbose; },
+	set verbose(v){ return (s.config.verbose= v); },
     /**
 	 * If `true`, the script will throw a JavaScript error when any `shell.js` command encounters an error. This is analogous to Bash's `set -e`.
 	 * @default false
 	 * */
-	get fatal(){ return _config.fatal; },
-	set fatal(v){ return (_config.fatal= v); },
+	get fatal(){ return s.config.fatal; },
+	set fatal(v){ return (s.config.fatal= v); },
     /**
 	 * Disable filename expansion (globbing)
 	 * @default false
 	 * */
-	get noglob(){ return _config.noglob; },
-	set noglob(v){ return (_config.noglob= v); },
+	get noglob(){ return s.config.noglob; },
+	set noglob(v){ return (s.config.noglob= v); },
     /**
 	 * Options for [`glob.sync()`](https://github.com/isaacs/node-glob/tree/af57da21c7722bb6edb687ccd4ad3b99d3e7a333#options).
 	 * @default {}
 	 * */
-	get globOptions(){ return _config.globOptions; },
-	set globOptions(v){ return (_config.globOptions= v); },
+	get globOptions(){ return s.config.globOptions; },
+	set globOptions(v){ return (s.config.globOptions= v); },
 
 	/** Set multiple options with one command.
 	 * @param {...Record<"verbose"|"fatal"|"noglob"|"silent",boolean>} c
@@ -86,7 +42,7 @@ export const config= {
 };
 
 import chalk from "chalk";
-export { chalk, chalk as s };
+export { chalk };
 
 import nodeFetch from 'node-fetch';
 /**
@@ -96,14 +52,14 @@ import nodeFetch from 'node-fetch';
  * @return  {Promise<import('node-fetch').Response>}
  */
 export function fetch(url, init){
-	if(config.verbose) echo("fetch(", url, ",", init, ")");
+	if(s.config.verbose) echo("fetch(", url, ",", init, ")");
 	return nodeFetch(url, init);
 }
 
 import { log } from "node:console";
 export function echo(...messages){
 	log(...messages.map(v=>
-		v instanceof Error && config.verbose ? v :
+		v instanceof Error && s.config.verbose ? v :
 		( String(v)==="[object Object]" ? v : String(v).replaceAll("\t", "    ") )));
 }
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nodejsscript",
-	"version": "0.2.0",
+	"version": "0.5.0",
 	"author": "Jan Andrle <andrle.jan@centrum.cz>",
 	"license": "MIT",
 	"description": "A tool for writing better scripts",

src/shelljs.js

@@ -0,0 +1,48 @@
+import shelljs, {ShellString} from "shelljs";
+import plugin from "shelljs/plugin.js";
+
+plugin.register("xargs", xargs, {
+	canReceivePipe: true,
+	wrapOutput: false,
+	cmdOptions: {
+		I: 'needle'
+	}
+});
+plugin.register("$", $, {
+	canReceivePipe: true,
+	wrapOutput: false
+});
+
+export default shelljs;
+
+function xargs({ needle }, ...args){
+	if(!needle) needle= "{}";
+	else needle= args.shift();
+	const [ cmd, ...cmd_args ]= args;
+	if(typeof cmd!=="function")
+		plugin.error("xargs needs one of the `shelljs` commands as first argument");
+
+	const pipe= plugin.readFromPipe();
+	let replaced= 0;
+	const args_final= cmd_args.map(a=> typeof a !== "string" ? a : a.replaceAll(needle, ()=> ( replaced+= 1, pipe )));
+	if(!replaced) args_final.push(pipe);
+	return cmd.apply(null, args_final);
+}
+function $(config_next= "-s"){
+	config_next= plugin.parseOptions(config_next, {
+		v: "verbose",
+		f: "fatal",
+		s: "silent"
+	});
+	return new Proxy(this, {
+		get(target, p){
+			return function(...args){
+				const { silent, verbose, fatal }= shelljs.config;
+				Object.assign(shelljs.config, config_next);
+				const out= target[p].apply(target, args);
+				Object.assign(shelljs.config, { silent, verbose, fatal });
+				return out instanceof String && Reflect.has(out, "stdout") ? new shelljs.ShellString(out.replace(/\n$/g, ""), out.stderr, out.code) : out;
+			};
+		}
+	});
+}

types/index.d.ts

@@ -1,5 +1,5 @@
+export * from './types/shelljs.d.ts';
 export {
-	/* shelljs */ ls, find, dirs, cd, pwd, pushd, popd, cp, rm, mv, mkdir, ln, touch, tempdir, chmod, test, error, cat, sed, grep, sort, head, tail, uniq, which, exit, env, set, exec, config,
-	chalk, s, fetch,
-	echo, question, stdin, cli, exec$, xarg
+	chalk, fetch,
+	echo, question, stdin, cli
 } from "./index.js";