noop(); pop(); map();

    shelljs.exec
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/shelljs.exec package

    1.1.8 • Public • Published

    shelljs.exec


    Linux Build Windows Build Coverage Status
    npm Dependencies Status npm node

    Replacement for shelljs' slow exec method - benchmarked 20x faster


    Introduction

    shelljs is FAST  FAST  but its exec method is SLOW  SLOW

    • Use this module instead of shelljs' exec method for speeds 20x faster

    • Continue to use shelljs' other methods as they are lightning fast (e.g. shelljs.echo shelljs.which shelljs.cat etc)

    This module offers a shelljs.exec like interface and is a zero-dependency module


    Usage

    npm install --save shelljs.exec

    This module takes 2 arguments, the command to execute and an options object

    var exec = require('shelljs.exec')
    var cmdObj = exec('echo hello', {silent: true})

    Continuing from the code above, the resulting JSON looks like:

    var assert = require('assert')
    assert.deepEqual(cmdObj, {
      error: null,
      stdout: 'hello\n',
      stderr: '',
      code: 0,
      ok: true
    })

    Options object

    Available options:

    • encoding: Defaults to 'utf8'

    • silent: Do not echo any output to console, defaults to false

    • and any option available to Node.js' child_process.execSync

    When the stdio option of child_process.execSync is provided, it overrides silent


    Benchmarks

    Logs for benchmarks are here and specs are here

    Generally speaking, on Linux shelljs.exec (this module) is 20x faster and on Windows 5x faster than shelljs' exec method.

    However, shelljs supported commands, where available, are much faster than both. Use this module where no equivalent shelljs supported command is available.

    These tables compare average command execution times based on 1000 test runs:

    Linux (Travis CI) Node v6

    Linux benchmarks

    Windows (GIT bash) Node v6.10.0

    Windows benchmarks


    Limitations

    • No support for chaining (unlike shelljs)

    • Synchronous execution only (but feel free to wrap with a callback or promise)


    Author says

    But as the days of Noah were, so also will the coming of the Son of Man be. For as in the days before the flood, they were eating and drinking, marrying and giving in marriage, until the day that Noah entered the ark, and did not know until the flood came and took them all away, so also will the coming of the Son of Man be.

    Matthew 24:37-39






    Install

    npm i shelljs.exec

    DownloadsWeekly Downloads

    59,334

    Version

    1.1.8

    License

    ISC

    Unpacked Size

    98.9 kB

    Total Files

    24

    Last publish

    Collaborators

    • danday74