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

A ShellJS plugin for the clear command
https://github.com/nfischer/shelljs-plugin-clear

shelljs shelljs-plugin

Last synced: 3 months ago
JSON representation

A ShellJS plugin for the clear command

• Host: GitHub
• URL: https://github.com/nfischer/shelljs-plugin-clear
• Owner: nfischer
• License: mit
• Created: 2016-08-09T21:38:18.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T08:04:11.000Z (about 1 year ago)
• Last Synced: 2024-09-26T15:19:24.042Z (4 months ago)
• Topics: shelljs, shelljs-plugin
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# shelljs-plugin-clear

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

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

[![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 for the `clear()` command

for REPL use.

## Installation

```bash

$ npm install --save shelljs

$ npm install --save shelljs-plugin-clear

```

## Usage

To use this plugin in your REPL, include it like so:

```

> require('shelljs-plugin-clear');

> var shell = require('shelljs');

> shell.clear();

```

## Writing plugins

If you're interested in taking a look at the current state of the 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).