{

"kind": "package",

"name": "@microsoft/rushell",

"summary": [

{

"kind": "text",

"text": "Execute shell commands using a consistent syntax on every platform."

}

],

"remarks": [],

"exports": {

"Rushell": {

"kind": "class",

"extends": "",

"implements": "",

"typeParameters": [],

"deprecatedMessage": [],

"summary": [

{

"kind": "text",

"text": "The shell command interpreter."

}

],

"remarks": [],

"isBeta": false,

"isSealed": false

}

}

}

class Rushell {

!/bin/**

!/lib/**

!/dist/**

/dist/*.stats.*

/lib/*/test/*

@microsoft/rushell

Copyright (c) Microsoft Corporation. All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NodeJS provides APIs for executing shell commands, however *which* shell invokes these commands depends on your OS. There is no universal shell interpreter that is guaranteed to be installed on every PC with Linux, Mac, or Windows.

Unfortunately each shell has its own opinions about:

- Which characters are "special" and need to be escaped?

- How do you escape a special character?

- Is "/" or "\" the path separator?

- What's the syntax for substituting an environment variable?

The Rushell library provides a minimal subset of a POSIX-compatible shell, implemented in pure JavaScript, and guaranteed to behave consistently on every platform. Rushell does not aim to be an interactive command prompt or Turing-complete language. It's merely a reliable cross-platform solution for very basic needs such as:

- Invoke a tool with command-line arguments

- Reliably quote special symbols

- Chain multiple commands using `&&` or `||`

- Use `cd` to change the current working directory

- Expand environment variables

(These are the requirements that [Rush](https://rushjs.io) had when invoking lifecycle `scripts` from a package.json file.)

Invoking a script using Rushell should generally provide similar output as [dash](https://en.wikipedia.org/wiki/Almquist_shell). Only a small subset of POSIX shell features are supported. More can be added over time, although the overall aim is to remain simplistic, lightweight, and self-contained (i.e. no dependencies on other libraries).

Example shell scripts:

`echo "Hello, world"` - print a string containing a space

{

"enabled": true,

"apiReviewFolder": "../../common/reviews/api",

"apiJsonFolder": "./temp",

"entry": "lib/index.d.ts",

"generateDtsRollup": true

}

{

"isEnabled": true

}

const build = require('@microsoft/node-library-build');

{

"name": "@microsoft/rushell",

"version": "0.1.0",

"description": "Execute shell commands using a consistent syntax on every platform",

"repository": {

"type": "git",

"url": "https://github.com/microsoft/web-build-tools"

},

"main": "lib/index.js",

"typings": "dist/index-internal.d.ts",

"tsdoc": {

"tsdocFlavor": "AEDoc"

},

"scripts": {

"build": "gulp test --clean"

},

"license": "MIT",

"dependencies": {

},

"devDependencies": {

"@types/jest": "21.1.10",

"@types/node": "8.5.8",

"gulp": "~3.9.1",

"@microsoft/node-library-build": "4.3.41"

}

}