https://github.com/nfischer/shelljs-plugin-inspect

:mag: Add a .inspect method to ShellJS objects for REPL use
https://github.com/nfischer/shelljs-plugin-inspect

shelljs shelljs-plugin

Last synced: 3 months ago
JSON representation

:mag: Add a .inspect method to ShellJS objects for REPL use

• Host: GitHub
• URL: https://github.com/nfischer/shelljs-plugin-inspect
• Owner: nfischer
• License: mit
• Created: 2016-07-27T23:26:52.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T08:11:39.000Z (about 1 year ago)
• Last Synced: 2024-09-14T09:49:33.622Z (4 months ago)
• Topics: shelljs, shelljs-plugin
• Language: JavaScript
• Homepage:
• Size: 46.9 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# shelljs-plugin-inspect

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/nfischer/shelljs-plugin-inspect/main.yml?style=flat-square&logo=github)](https://github.com/nfischer/shelljs-plugin-inspect/actions/workflows/main.yml)

[![npm](https://img.shields.io/npm/v/shelljs-plugin-inspect.svg?style=flat-square)](https://www.npmjs.com/package/shelljs-plugin-inspect)

[![shelljs-plugin](https://img.shields.io/badge/shelljs-plugin-brightgreen.svg?style=flat-square)](https://github.com/shelljs/shelljs/wiki/Using-ShellJS-Plugins)

A [ShellJS](https://github.com/shelljs/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).

## Installation

```bash

$ npm install --save shelljs

$ npm install --save shelljs-plugin-inspect

```

**Tip:** If you want to use this plugin (and more REPL goodies), check out my

project [n\_shell](https://github.com/nfischer/n_shell) to get a REPL with

ShellJS loaded by default!

## Usage

Here's what ShellJS looks like by default in the REPL:

```javascript

> // 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](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](test/test.js).