enola
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.5 • Public • Published

    Enola

    npm GitHub repository license

    Command-line utility for obliterating files and directories as quickly as possible. It's the equivalent of Linux's rm -rf command.

    Usage

    npm install -g enola

    The above command will use NPM to install Enola globally.

    Command Line (CLI)

    To destroy a file or directory, use the nuke command:

    nuke ["path"] [--pretty | -p] [--silent | -s]
    • --pretty will allow the command line utility to use colours when outputting text. This is helpful when you want more readable output, but it may cause problems when printing to terminals that do not support ANSI colour codes. true by default.
    • --silent will mute all error and output streams. false by default.

    API

    Enola's functions can be invoked from code via the Promise-based API:

    import * as enola from "enola";
     
    enola.nuke("path/to/directory")
        .then(() => console.log("Nuked!"));

    Build & Test

    To build the project, run npm run build from the command line. This will launch a Gulp task which will compile the source files and output the result to a build/ directory (which is created if it doesn't already exist).

    To run the project's tests, run npm test from the command line. The results of the tests will be outputted to the standard output and error streams.

    License

    See the LICENSE file for license information. Mushroom Cloud icon by Icons8.

    Install

    npm i enola

    DownloadsWeekly Downloads

    0

    Version

    0.4.5

    License

    MIT

    Unpacked Size

    20.7 kB

    Total Files

    20

    Last publish

    Collaborators

    • mgthomas99