You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A ShellJS plugin to add custom REPL
inspection for ShellJS output. This turns hard-to-read ShellString objects
into nicely formatted text (resembling what the actual unix commands would
output).
Tip: If you want to use this plugin (and more REPL goodies), check out my
project n_shell to get a REPL with
ShellJS loaded by default!
Usage
Here's what ShellJS looks like by default in the REPL:
>// Before this plugin: hard-to-read ShellString objects>shell.cat('file1.txt');{[String: 'These are the file contents\nAnd they\'re printed out nicely!\n']
stdout:'These are the file contents\nAnd they\'re printed out nicely!\n',stderr: null,code: 0,cat: [Function: bound],head: [Function: bound],tail: [Function: bound],to: [Function: bound],toEnd: [Function: bound],sed: [Function: bound],sort: [Function: bound],uniq: [Function: bound],grep: [Function: bound],exec: [Function: bound]}
After:
> // After this plugin: nicely formatted text!
> require('shelljs-plugin-inspect');
> shell.cat('file.txt');
These are the file contents
And they're printed out nicely!
> shell.ls();
file.txt
otherfile.txt
...
> shell.pwd();
path/to/current/directory
Writing ShellJS plugins
If you're interested in taking a look at the current state of the ShellJS plugin
API, take a look at index.js. This has helpful comments explaining
the necessary boilerplate for writing a plugin. For an example usage of the
plugin, take a look at test/test.js.
About
🔍 Add a .inspect method to ShellJS objects for REPL use