You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by pu...@apache.org on 2017/05/25 20:38:34 UTC
[14/25] cordova-browser git commit: update shelljs version,
prepare is working
http://git-wip-us.apache.org/repos/asf/cordova-browser/blob/c846b473/node_modules/shelljs/README.md
----------------------------------------------------------------------
diff --git a/node_modules/shelljs/README.md b/node_modules/shelljs/README.md
index d6dcb63..91f110f 100644
--- a/node_modules/shelljs/README.md
+++ b/node_modules/shelljs/README.md
@@ -1,168 +1,141 @@
# ShellJS - Unix shell commands for Node.js
-[](https://gitter.im/shelljs/shelljs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[](http://travis-ci.org/shelljs/shelljs)
-[](https://ci.appveyor.com/project/shelljs/shelljs)
+[](https://gitter.im/shelljs/shelljs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[](https://travis-ci.org/shelljs/shelljs)
+[](https://ci.appveyor.com/project/shelljs/shelljs/branch/master)
+[](https://codecov.io/gh/shelljs/shelljs)
+[](https://www.npmjs.com/package/shelljs)
+[](https://www.npmjs.com/package/shelljs)
-ShellJS is a portable **(Windows/Linux/OS X)** implementation of Unix shell commands on top of the Node.js API. You can use it to eliminate your shell script's dependency on Unix while still keeping its familiar and powerful commands. You can also install it globally so you can run it from outside Node projects - say goodbye to those gnarly Bash scripts!
+ShellJS is a portable **(Windows/Linux/OS X)** implementation of Unix shell
+commands on top of the Node.js API. You can use it to eliminate your shell
+script's dependency on Unix while still keeping its familiar and powerful
+commands. You can also install it globally so you can run it from outside Node
+projects - say goodbye to those gnarly Bash scripts!
-The project is [unit-tested](http://travis-ci.org/shelljs/shelljs) and battled-tested in projects like:
+ShellJS is proudly tested on every node release since `v0.11`!
+
+The project is [unit-tested](http://travis-ci.org/shelljs/shelljs) and battle-tested in projects like:
+ [PDF.js](http://github.com/mozilla/pdf.js) - Firefox's next-gen PDF reader
+ [Firebug](http://getfirebug.com/) - Firefox's infamous debugger
-+ [JSHint](http://jshint.com) - Most popular JavaScript linter
++ [JSHint](http://jshint.com) & [ESLint](http://eslint.org/) - popular JavaScript linters
+ [Zepto](http://zeptojs.com) - jQuery-compatible JavaScript library for modern browsers
+ [Yeoman](http://yeoman.io/) - Web application stack and development tool
+ [Deployd.com](http://deployd.com) - Open source PaaS for quick API backend generation
++ And [many more](https://npmjs.org/browse/depended/shelljs).
-and [many more](https://npmjs.org/browse/depended/shelljs).
+If you have feedback, suggestions, or need help, feel free to post in our [issue
+tracker](https://github.com/shelljs/shelljs/issues).
-If you have feedback, suggestions, or need help, feel free to post in our [issue tracker](https://github.com/shelljs/shelljs/issues).
+Think ShellJS is cool? Check out some related projects in our [Wiki
+page](https://github.com/shelljs/shelljs/wiki)!
-## Installing
+Upgrading from an older version? Check out our [breaking
+changes](https://github.com/shelljs/shelljs/wiki/Breaking-Changes) page to see
+what changes to watch out for while upgrading.
-Via npm:
+## Command line use
-```bash
-$ npm install [-g] shelljs
+If you just want cross platform UNIX commands, checkout our new project
+[shelljs/shx](https://github.com/shelljs/shx), a utility to expose `shelljs` to
+the command line.
+
+For example:
+
+```
+$ shx mkdir -p foo
+$ shx touch foo/bar.txt
+$ shx rm -rf foo
```
-If the global option `-g` is specified, the binary `shjs` will be installed. This makes it possible to
-run ShellJS scripts much like any shell script from the command line, i.e. without requiring a `node_modules` folder:
+## A quick note about the docs
+
+For documentation on all the latest features, check out our
+[README](https://github.com/shelljs/shelljs). To read docs that are consistent
+with the latest release, check out [the npm
+page](https://www.npmjs.com/package/shelljs) or
+[shelljs.org](http://documentup.com/shelljs/shelljs).
+
+## Installing
+
+Via npm:
```bash
-$ shjs my_script
+$ npm install [-g] shelljs
```
## Examples
-### JavaScript
-
```javascript
-require('shelljs/global');
+var shell = require('shelljs');
-if (!which('git')) {
- echo('Sorry, this script requires git');
- exit(1);
+if (!shell.which('git')) {
+ shell.echo('Sorry, this script requires git');
+ shell.exit(1);
}
// Copy files to release dir
-mkdir('-p', 'out/Release');
-cp('-R', 'stuff/*', 'out/Release');
+shell.rm('-rf', 'out/Release');
+shell.cp('-R', 'stuff/', 'out/Release');
// Replace macros in each .js file
-cd('lib');
-ls('*.js').forEach(function(file) {
- sed('-i', 'BUILD_VERSION', 'v0.1.2', file);
- sed('-i', /.*REMOVE_THIS_LINE.*\n/, '', file);
- sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, cat('macro.js'), file);
+shell.cd('lib');
+shell.ls('*.js').forEach(function (file) {
+ shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file);
+ shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file);
+ shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file);
});
-cd('..');
+shell.cd('..');
// Run external tool synchronously
-if (exec('git commit -am "Auto-commit"').code !== 0) {
- echo('Error: Git commit failed');
- exit(1);
+if (shell.exec('git commit -am "Auto-commit"').code !== 0) {
+ shell.echo('Error: Git commit failed');
+ shell.exit(1);
}
```
-### CoffeeScript
-
-CoffeeScript is also supported automatically:
-
-```coffeescript
-require 'shelljs/global'
-
-if not which 'git'
- echo 'Sorry, this script requires git'
- exit 1
-
-# Copy files to release dir
-mkdir '-p', 'out/Release'
-cp '-R', 'stuff/*', 'out/Release'
-
-# Replace macros in each .js file
-cd 'lib'
-for file in ls '*.js'
- sed '-i', 'BUILD_VERSION', 'v0.1.2', file
- sed '-i', /.*REMOVE_THIS_LINE.*\n/, '', file
- sed '-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, cat('macro.js'), file
-cd '..'
-
-# Run external tool synchronously
-if (exec 'git commit -am "Auto-commit"').code != 0
- echo 'Error: Git commit failed'
- exit 1
-```
-
## Global vs. Local
-The example above uses the convenience script `shelljs/global` to reduce verbosity. If polluting your global namespace is not desirable, simply require `shelljs`.
+We no longer recommend using a global-import for ShellJS (i.e.
+`require('shelljs/global')`). While still supported for convenience, this
+pollutes the global namespace, and should therefore only be used with caution.
-Example:
+Instead, we recommend a local import (standard for npm packages):
```javascript
var shell = require('shelljs');
shell.echo('hello world');
```
-## Make tool
+<!-- DO NOT MODIFY BEYOND THIS POINT - IT'S AUTOMATICALLY GENERATED -->
-A convenience script `shelljs/make` is also provided to mimic the behavior of a Unix Makefile.
-In this case all shell objects are global, and command line arguments will cause the script to
-execute only the corresponding function in the global `target` object. To avoid redundant calls,
-target functions are executed only once per script.
-Example:
+## Command reference
-```javascript
-require('shelljs/make');
-target.all = function() {
- target.bundle();
- target.docs();
-};
+All commands run synchronously, unless otherwise stated.
+All commands accept standard bash globbing characters (`*`, `?`, etc.),
+compatible with the [node glob module](https://github.com/isaacs/node-glob).
-target.bundle = function() {
- cd(__dirname);
- mkdir('-p', 'build');
- cd('src');
- cat('*.js').to('../build/output.js');
-};
+For less-commonly used commands and features, please check out our [wiki
+page](https://github.com/shelljs/shelljs/wiki).
-target.docs = function() {
- cd(__dirname);
- mkdir('-p', 'docs');
- var files = ls('src/*.js');
- for(var i = 0; i < files.length; i++) {
- var text = grep('//@', files[i]); // extract special comments
- text = text.replace(/\/\/@/g, ''); // remove comment tags
- text.toEnd('docs/my_docs.md');
- }
-};
-```
-To run the target `all`, call the above script without arguments: `$ node make`. To run the target `docs`: `$ node make docs`.
+### cat(file [, file ...])
+### cat(file_array)
-You can also pass arguments to your targets by using the `--` separator. For example, to pass `arg1` and `arg2` to a target `bundle`, do `$ node make bundle -- arg1 arg2`:
+Examples:
```javascript
-require('shelljs/make');
-
-target.bundle = function(argsArray) {
- // argsArray = ['arg1', 'arg2']
- /* ... */
-}
+var str = cat('file*.txt');
+var str = cat('file1', 'file2');
+var str = cat(['file1', 'file2']); // same as above
```
-
-<!-- DO NOT MODIFY BEYOND THIS POINT - IT'S AUTOMATICALLY GENERATED -->
-
-
-## Command reference
-
-
-All commands run synchronously, unless otherwise stated.
+Returns a string containing the given file, or a concatenated string
+containing the files if more than one file is given (a new line character is
+introduced between each file).
### cd([dir])
@@ -170,48 +143,32 @@ Changes to directory `dir` for the duration of the script. Changes to home
directory if no argument is supplied.
-### pwd()
-Returns the current directory.
+### chmod([options,] octal_mode || octal_string, file)
+### chmod([options,] symbolic_mode, file)
-
-### ls([options,] [path, ...])
-### ls([options,] path_array)
Available options:
-+ `-R`: recursive
-+ `-A`: all files (include files beginning with `.`, except for `.` and `..`)
-+ `-d`: list directories themselves, not their contents
-+ `-l`: list objects representing each file, each with fields containing `ls
- -l` output fields. See
- [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)
- for more info
-
-Examples:
-
-```javascript
-ls('projs/*.js');
-ls('-R', '/users/me', '/tmp');
-ls('-R', ['/users/me', '/tmp']); // same as above
-ls('-l', 'file.txt'); // { name: 'file.txt', mode: 33188, nlink: 1, ...}
-```
-
-Returns array of files in the given path, or in current directory if no path provided.
-
++ `-v`: output a diagnostic for every file processed
++ `-c`: like verbose but report only when a change is made
++ `-R`: change files and directories recursively
-### find(path [, path ...])
-### find(path_array)
Examples:
```javascript
-find('src', 'lib');
-find(['src', 'lib']); // same as above
-find('.').filter(function(file) { return file.match(/\.js$/); });
+chmod(755, '/Users/brandon');
+chmod('755', '/Users/brandon'); // same as above
+chmod('u+x', '/Users/brandon');
+chmod('-R', 'a-w', '/Users/brandon');
```
-Returns array of all files (however deep) in the given paths.
+Alters the permissions of a file or directory by either specifying the
+absolute permissions in octal form or expressing the changes in symbols.
+This command tries to mimic the POSIX behavior as much as possible.
+Notable exceptions:
-The main difference from `ls('-R', path)` is that the resulting file names
-include the base directories, e.g. `lib/resources/file1` instead of just `file1`.
++ In symbolic modes, 'a-r' and '-r' are identical. No consideration is
+ given to the umask.
++ There is no "quiet" option since default behavior is to run silent.
### cp([options,] source [, source ...], dest)
@@ -220,340 +177,427 @@ Available options:
+ `-f`: force (default behavior)
+ `-n`: no-clobber
-+ `-r, -R`: recursive
++ `-u`: only copy if source is newer than dest
++ `-r`, `-R`: recursive
++ `-L`: follow symlinks
++ `-P`: don't follow symlinks
Examples:
```javascript
cp('file1', 'dir1');
+cp('-R', 'path/to/dir/', '~/newCopy/');
cp('-Rf', '/tmp/*', '/usr/local/*', '/home/tmp');
cp('-Rf', ['/tmp/*', '/usr/local/*'], '/home/tmp'); // same as above
```
-Copies files. The wildcard `*` is accepted.
+Copies files.
-### rm([options,] file [, file ...])
-### rm([options,] file_array)
+### pushd([options,] [dir | '-N' | '+N'])
+
Available options:
-+ `-f`: force
-+ `-r, -R`: recursive
++ `-n`: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated.
+
+Arguments:
+
++ `dir`: Makes the current working directory be the top of the stack, and then executes the equivalent of `cd dir`.
++ `+N`: Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
++ `-N`: Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
Examples:
```javascript
-rm('-rf', '/tmp/*');
-rm('some_file.txt', 'another_file.txt');
-rm(['some_file.txt', 'another_file.txt']); // same as above
+// process.cwd() === '/usr'
+pushd('/etc'); // Returns /etc /usr
+pushd('+1'); // Returns /usr /etc
```
-Removes files. The wildcard `*` is accepted.
+Save the current directory on the top of the directory stack and then cd to `dir`. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
+### popd([options,] ['-N' | '+N'])
-### mv([options ,] source [, source ...], dest')
-### mv([options ,] source_array, dest')
Available options:
-+ `-f`: force (default behavior)
-+ `-n`: no-clobber
++ `-n`: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated.
+
+Arguments:
+
++ `+N`: Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
++ `-N`: Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
Examples:
```javascript
-mv('-n', 'file', 'dir/');
-mv('file1', 'file2', 'dir/');
-mv(['file1', 'file2'], 'dir/'); // same as above
+echo(process.cwd()); // '/usr'
+pushd('/etc'); // '/etc /usr'
+echo(process.cwd()); // '/etc'
+popd(); // '/usr'
+echo(process.cwd()); // '/usr'
```
-Moves files. The wildcard `*` is accepted.
+When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
+### dirs([options | '+N' | '-N'])
-### mkdir([options,] dir [, dir ...])
-### mkdir([options,] dir_array)
Available options:
-+ `-p`: full path (will create intermediate dirs if necessary)
++ `-c`: Clears the directory stack by deleting all of the elements.
+
+Arguments:
+
++ `+N`: Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero.
++ `-N`: Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero.
+
+Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
+
+See also: pushd, popd
+
+
+### echo([options,] string [, string ...])
+Available options:
+
++ `-e`: interpret backslash escapes (default)
Examples:
```javascript
-mkdir('-p', '/tmp/a/b/c/d', '/tmp/e/f/g');
-mkdir('-p', ['/tmp/a/b/c/d', '/tmp/e/f/g']); // same as above
+echo('hello world');
+var str = echo('hello world');
```
-Creates directories.
+Prints string to stdout, and returns string with additional utility methods
+like `.to()`.
-### test(expression)
-Available expression primaries:
+### exec(command [, options] [, callback])
+Available options (all `false` by default):
-+ `'-b', 'path'`: true if path is a block device
-+ `'-c', 'path'`: true if path is a character device
-+ `'-d', 'path'`: true if path is a directory
-+ `'-e', 'path'`: true if path exists
-+ `'-f', 'path'`: true if path is a regular file
-+ `'-L', 'path'`: true if path is a symbolic link
-+ `'-p', 'path'`: true if path is a pipe (FIFO)
-+ `'-S', 'path'`: true if path is a socket
++ `async`: Asynchronous execution. If a callback is provided, it will be set to
+ `true`, regardless of the passed value.
++ `silent`: Do not echo program output to console.
++ and any option available to Node.js's
+ [child_process.exec()](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback)
Examples:
```javascript
-if (test('-d', path)) { /* do something with dir */ };
-if (!test('-f', path)) continue; // skip if it's a regular file
+var version = exec('node --version', {silent:true}).stdout;
+
+var child = exec('some_long_running_process', {async:true});
+child.stdout.on('data', function(data) {
+ /* ... do something with data ... */
+});
+
+exec('some_long_running_process', function(code, stdout, stderr) {
+ console.log('Exit code:', code);
+ console.log('Program output:', stdout);
+ console.log('Program stderr:', stderr);
+});
```
-Evaluates expression using the available primaries and returns corresponding value.
+Executes the given `command` _synchronously_, unless otherwise specified. When in synchronous
+mode, this returns a ShellString (compatible with ShellJS v0.6.x, which returns an object
+of the form `{ code:..., stdout:... , stderr:... }`). Otherwise, this returns the child process
+object, and the `callback` gets the arguments `(code, stdout, stderr)`.
+Not seeing the behavior you want? `exec()` runs everything through `sh`
+by default (or `cmd.exe` on Windows), which differs from `bash`. If you
+need bash-specific behavior, try out the `{shell: 'path/to/bash'}` option.
+
+**Note:** For long-lived processes, it's best to run `exec()` asynchronously as
+the current synchronous implementation uses a lot of CPU. This should be getting
+fixed soon.
-### cat(file [, file ...])
-### cat(file_array)
+### find(path [, path ...])
+### find(path_array)
Examples:
```javascript
-var str = cat('file*.txt');
-var str = cat('file1', 'file2');
-var str = cat(['file1', 'file2']); // same as above
+find('src', 'lib');
+find(['src', 'lib']); // same as above
+find('.').filter(function(file) { return file.match(/\.js$/); });
```
-Returns a string containing the given file, or a concatenated string
-containing the files if more than one file is given (a new line character is
-introduced between each file). Wildcard `*` accepted.
+Returns array of all files (however deep) in the given paths.
+The main difference from `ls('-R', path)` is that the resulting file names
+include the base directories, e.g. `lib/resources/file1` instead of just `file1`.
-### 'string'.to(file)
+
+### grep([options,] regex_filter, file [, file ...])
+### grep([options,] regex_filter, file_array)
+Available options:
+
++ `-v`: Inverse the sense of the regex and print the lines not matching the criteria.
++ `-l`: Print only filenames of matching files
Examples:
```javascript
-cat('input.txt').to('output.txt');
+grep('-v', 'GLOBAL_VARIABLE', '*.js');
+grep('GLOBAL_VARIABLE', '*.js');
```
-Analogous to the redirection operator `>` in Unix, but works with JavaScript strings (such as
-those returned by `cat`, `grep`, etc). _Like Unix redirections, `to()` will overwrite any existing file!_
+Reads input string from given files and returns a string containing all lines of the
+file that match the given `regex_filter`.
-### 'string'.toEnd(file)
+### head([{'-n': \<num\>},] file [, file ...])
+### head([{'-n': \<num\>},] file_array)
+Available options:
+
++ `-n <num>`: Show the first `<num>` lines of the files
Examples:
```javascript
-cat('input.txt').toEnd('output.txt');
+var str = head({'-n': 1}, 'file*.txt');
+var str = head('file1', 'file2');
+var str = head(['file1', 'file2']); // same as above
```
-Analogous to the redirect-and-append operator `>>` in Unix, but works with JavaScript strings (such as
-those returned by `cat`, `grep`, etc).
+Read the start of a file.
-### sed([options,] search_regex, replacement, file [, file ...])
-### sed([options,] search_regex, replacement, file_array)
+### ln([options,] source, dest)
Available options:
-+ `-i`: Replace contents of 'file' in-place. _Note that no backups will be created!_
++ `-s`: symlink
++ `-f`: force
Examples:
```javascript
-sed('-i', 'PROGRAM_VERSION', 'v0.1.3', 'source.js');
-sed(/.*DELETE_THIS_LINE.*\n/, '', 'source.js');
+ln('file', 'newlink');
+ln('-sf', 'file', 'existing');
```
-Reads an input string from `files` and performs a JavaScript `replace()` on the input
-using the given search regex and replacement string or function. Returns the new string after replacement.
+Links source to dest. Use -f to force the link, should dest already exist.
-### grep([options,] regex_filter, file [, file ...])
-### grep([options,] regex_filter, file_array)
+### ls([options,] [path, ...])
+### ls([options,] path_array)
Available options:
-+ `-v`: Inverse the sense of the regex and print the lines not matching the criteria.
++ `-R`: recursive
++ `-A`: all files (include files beginning with `.`, except for `.` and `..`)
++ `-L`: follow symlinks
++ `-d`: list directories themselves, not their contents
++ `-l`: list objects representing each file, each with fields containing `ls
+ -l` output fields. See
+ [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)
+ for more info
Examples:
```javascript
-grep('-v', 'GLOBAL_VARIABLE', '*.js');
-grep('GLOBAL_VARIABLE', '*.js');
+ls('projs/*.js');
+ls('-R', '/users/me', '/tmp');
+ls('-R', ['/users/me', '/tmp']); // same as above
+ls('-l', 'file.txt'); // { name: 'file.txt', mode: 33188, nlink: 1, ...}
```
-Reads input string from given files and returns a string containing all lines of the
-file that match the given `regex_filter`. Wildcard `*` accepted.
+Returns array of files in the given path, or in current directory if no path provided.
-### which(command)
+### mkdir([options,] dir [, dir ...])
+### mkdir([options,] dir_array)
+Available options:
+
++ `-p`: full path (will create intermediate dirs if necessary)
Examples:
```javascript
-var nodeExec = which('node');
+mkdir('-p', '/tmp/a/b/c/d', '/tmp/e/f/g');
+mkdir('-p', ['/tmp/a/b/c/d', '/tmp/e/f/g']); // same as above
```
-Searches for `command` in the system's PATH. On Windows, this uses the
-`PATHEXT` variable to append the extension if it's not already executable.
-Returns string containing the absolute path to the command.
+Creates directories.
-### echo(string [, string ...])
+### mv([options ,] source [, source ...], dest')
+### mv([options ,] source_array, dest')
+Available options:
+
++ `-f`: force (default behavior)
++ `-n`: no-clobber
Examples:
```javascript
-echo('hello world');
-var str = echo('hello world');
+mv('-n', 'file', 'dir/');
+mv('file1', 'file2', 'dir/');
+mv(['file1', 'file2'], 'dir/'); // same as above
```
-Prints string to stdout, and returns string with additional utility methods
-like `.to()`.
+Moves files.
-### pushd([options,] [dir | '-N' | '+N'])
+### pwd()
+Returns the current directory.
+
+### rm([options,] file [, file ...])
+### rm([options,] file_array)
Available options:
-+ `-n`: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated.
++ `-f`: force
++ `-r, -R`: recursive
-Arguments:
+Examples:
+
+```javascript
+rm('-rf', '/tmp/*');
+rm('some_file.txt', 'another_file.txt');
+rm(['some_file.txt', 'another_file.txt']); // same as above
+```
+
+Removes files.
-+ `dir`: Makes the current working directory be the top of the stack, and then executes the equivalent of `cd dir`.
-+ `+N`: Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
-+ `-N`: Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack.
+
+### sed([options,] search_regex, replacement, file [, file ...])
+### sed([options,] search_regex, replacement, file_array)
+Available options:
+
++ `-i`: Replace contents of 'file' in-place. _Note that no backups will be created!_
Examples:
```javascript
-// process.cwd() === '/usr'
-pushd('/etc'); // Returns /etc /usr
-pushd('+1'); // Returns /usr /etc
+sed('-i', 'PROGRAM_VERSION', 'v0.1.3', 'source.js');
+sed(/.*DELETE_THIS_LINE.*\n/, '', 'source.js');
```
-Save the current directory on the top of the directory stack and then cd to `dir`. With no arguments, pushd exchanges the top two directories. Returns an array of paths in the stack.
+Reads an input string from `files` and performs a JavaScript `replace()` on the input
+using the given search regex and replacement string or function. Returns the new string after replacement.
-### popd([options,] ['-N' | '+N'])
+Note:
-Available options:
+Like unix `sed`, ShellJS `sed` supports capture groups. Capture groups are specified
+using the `$n` syntax:
-+ `-n`: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated.
+```javascript
+sed(/(\w+)\s(\w+)/, '$2, $1', 'file.txt');
+```
-Arguments:
-+ `+N`: Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero.
-+ `-N`: Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero.
+### set(options)
+Available options:
+
++ `+/-e`: exit upon error (`config.fatal`)
++ `+/-v`: verbose: show all commands (`config.verbose`)
++ `+/-f`: disable filename expansion (globbing)
Examples:
```javascript
-echo(process.cwd()); // '/usr'
-pushd('/etc'); // '/etc /usr'
-echo(process.cwd()); // '/etc'
-popd(); // '/usr'
-echo(process.cwd()); // '/usr'
+set('-e'); // exit upon first error
+set('+e'); // this undoes a "set('-e')"
```
-When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.
+Sets global configuration variables
-### dirs([options | '+N' | '-N'])
+### sort([options,] file [, file ...])
+### sort([options,] file_array)
Available options:
-+ `-c`: Clears the directory stack by deleting all of the elements.
++ `-r`: Reverse the result of comparisons
++ `-n`: Compare according to numerical value
-Arguments:
-
-+ `+N`: Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero.
-+ `-N`: Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero.
+Examples:
-Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if +N or -N was specified.
+```javascript
+sort('foo.txt', 'bar.txt');
+sort('-r', 'foo.txt');
+```
-See also: pushd, popd
+Return the contents of the files, sorted line-by-line. Sorting multiple
+files mixes their content, just like unix sort does.
-### ln([options,] source, dest)
+### tail([{'-n': \<num\>},] file [, file ...])
+### tail([{'-n': \<num\>},] file_array)
Available options:
-+ `-s`: symlink
-+ `-f`: force
++ `-n <num>`: Show the last `<num>` lines of the files
Examples:
```javascript
-ln('file', 'newlink');
-ln('-sf', 'file', 'existing');
+var str = tail({'-n': 1}, 'file*.txt');
+var str = tail('file1', 'file2');
+var str = tail(['file1', 'file2']); // same as above
```
-Links source to dest. Use -f to force the link, should dest already exist.
+Read the end of a file.
-### exit(code)
-Exits the current process with the given exit code.
+### tempdir()
-### env['VAR_NAME']
-Object containing environment variables (both getter and setter). Shortcut to process.env.
+Examples:
-### exec(command [, options] [, callback])
-Available options (all `false` by default):
+```javascript
+var tmp = tempdir(); // "/tmp" for most *nix platforms
+```
-+ `async`: Asynchronous execution. If a callback is provided, it will be set to
- `true`, regardless of the passed value.
-+ `silent`: Do not echo program output to console.
-+ and any option available to NodeJS's
- [child_process.exec()](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback)
+Searches and returns string containing a writeable, platform-dependent temporary directory.
+Follows Python's [tempfile algorithm](http://docs.python.org/library/tempfile.html#tempfile.tempdir).
+
+
+### test(expression)
+Available expression primaries:
+
++ `'-b', 'path'`: true if path is a block device
++ `'-c', 'path'`: true if path is a character device
++ `'-d', 'path'`: true if path is a directory
++ `'-e', 'path'`: true if path exists
++ `'-f', 'path'`: true if path is a regular file
++ `'-L', 'path'`: true if path is a symbolic link
++ `'-p', 'path'`: true if path is a pipe (FIFO)
++ `'-S', 'path'`: true if path is a socket
Examples:
```javascript
-var version = exec('node --version', {silent:true}).stdout;
+if (test('-d', path)) { /* do something with dir */ };
+if (!test('-f', path)) continue; // skip if it's a regular file
+```
-var child = exec('some_long_running_process', {async:true});
-child.stdout.on('data', function(data) {
- /* ... do something with data ... */
-});
+Evaluates expression using the available primaries and returns corresponding value.
-exec('some_long_running_process', function(code, stdout, stderr) {
- console.log('Exit code:', code);
- console.log('Program output:', stdout);
- console.log('Program stderr:', stderr);
-});
-```
-Executes the given `command` _synchronously_, unless otherwise specified. When in synchronous
-mode returns the object `{ code:..., stdout:... , stderr:... }`, containing the program's
-`stdout`, `stderr`, and its exit `code`. Otherwise returns the child process object,
-and the `callback` gets the arguments `(code, stdout, stderr)`.
+### ShellString.prototype.to(file)
-**Note:** For long-lived processes, it's best to run `exec()` asynchronously as
-the current synchronous implementation uses a lot of CPU. This should be getting
-fixed soon.
+Examples:
+```javascript
+cat('input.txt').to('output.txt');
+```
-### chmod(octal_mode || octal_string, file)
-### chmod(symbolic_mode, file)
+Analogous to the redirection operator `>` in Unix, but works with
+ShellStrings (such as those returned by `cat`, `grep`, etc). _Like Unix
+redirections, `to()` will overwrite any existing file!_
-Available options:
-+ `-v`: output a diagnostic for every file processed
-+ `-c`: like verbose but report only when a change is made
-+ `-R`: change files and directories recursively
+### ShellString.prototype.toEnd(file)
Examples:
```javascript
-chmod(755, '/Users/brandon');
-chmod('755', '/Users/brandon'); // same as above
-chmod('u+x', '/Users/brandon');
+cat('input.txt').toEnd('output.txt');
```
-Alters the permissions of a file or directory by either specifying the
-absolute permissions in octal form or expressing the changes in symbols.
-This command tries to mimic the POSIX behavior as much as possible.
-Notable exceptions:
-
-+ In symbolic modes, 'a-r' and '-r' are identical. No consideration is
- given to the umask.
-+ There is no "quiet" option since default behavior is to run silent.
+Analogous to the redirect-and-append operator `>>` in Unix, but works with
+ShellStrings (such as those returned by `cat`, `grep`, etc).
-### touch([options,] file)
+### touch([options,] file [, file ...])
+### touch([options,] file_array)
Available options:
+ `-a`: Change only the access time
@@ -575,46 +619,84 @@ A FILE argument that does not exist is created empty, unless -c is supplied.
This is a partial implementation of *[touch(1)](http://linux.die.net/man/1/touch)*.
-### set(options)
+### uniq([options,] [input, [output]])
Available options:
-+ `+/-e`: exit upon error (`config.fatal`)
-+ `+/-v`: verbose: show all commands (`config.verbose`)
++ `-i`: Ignore case while comparing
++ `-c`: Prefix lines by the number of occurrences
++ `-d`: Only print duplicate lines, one for each group of identical lines
Examples:
```javascript
-set('-e'); // exit upon first error
-set('+e'); // this undoes a "set('-e')"
+uniq('foo.txt');
+uniq('-i', 'foo.txt');
+uniq('-cd', 'foo.txt', 'bar.txt');
```
-Sets global configuration variables
+Filter adjacent matching lines from input
-## Non-Unix commands
+### which(command)
+Examples:
+
+```javascript
+var nodeExec = which('node');
+```
+
+Searches for `command` in the system's PATH. On Windows, this uses the
+`PATHEXT` variable to append the extension if it's not already executable.
+Returns string containing the absolute path to the command.
-### tempdir()
+
+### exit(code)
+Exits the current process with the given exit code.
+
+### error()
+Tests if error occurred in the last command. Returns a truthy value if an
+error returned and a falsy value otherwise.
+
+**Note**: do not rely on the
+return value to be an error message. If you need the last error message, use
+the `.stderr` attribute from the last command's return value instead.
+
+
+### ShellString(str)
Examples:
```javascript
-var tmp = tempdir(); // "/tmp" for most *nix platforms
+var foo = ShellString('hello world');
```
-Searches and returns string containing a writeable, platform-dependent temporary directory.
-Follows Python's [tempfile algorithm](http://docs.python.org/library/tempfile.html#tempfile.tempdir).
+Turns a regular string into a string-like object similar to what each
+command returns. This has special methods, like `.to()` and `.toEnd()`
-### error()
-Tests if error occurred in the last command. Returns `null` if no error occurred,
-otherwise returns string explaining the error
+### env['VAR_NAME']
+Object containing environment variables (both getter and setter). Shortcut
+to process.env.
+
+### Pipes
+Examples:
+
+```javascript
+grep('foo', 'file1.txt', 'file2.txt').sed(/o/g, 'a').to('output.txt');
+echo('files with o\'s in the name:\n' + ls().grep('o'));
+cat('test.js').exec('node'); // pipe to exec() call
+```
+
+Commands can send their output to another command in a pipe-like fashion.
+`sed`, `grep`, `cat`, `exec`, `to`, and `toEnd` can appear on the right-hand
+side of a pipe. Pipes can be chained.
## Configuration
### config.silent
+
Example:
```javascript
@@ -629,19 +711,22 @@ Suppresses all command output if `true`, except for `echo()` calls.
Default is `false`.
### config.fatal
+
Example:
```javascript
require('shelljs/global');
config.fatal = true; // or set('-e');
-cp('this_file_does_not_exist', '/dev/null'); // dies here
+cp('this_file_does_not_exist', '/dev/null'); // throws Error here
/* more commands... */
```
-If `true` the script will die on errors. Default is `false`. This is
-analogous to Bash's `set -e`
+If `true` the script will throw a Javascript error when any shell.js
+command encounters an error. Default is `false`. This is analogous to
+Bash's `set -e`
### config.verbose
+
Example:
```javascript
@@ -656,3 +741,45 @@ Will print each command as follows:
cd dir/
ls subdir/
```
+
+### config.globOptions
+
+Example:
+
+```javascript
+config.globOptions = {nodir: true};
+```
+
+Use this value for calls to `glob.sync()` instead of the default options.
+
+### config.reset()
+
+Example:
+
+```javascript
+var shell = require('shelljs');
+// Make changes to shell.config, and do stuff...
+/* ... */
+shell.config.reset(); // reset to original state
+// Do more stuff, but with original settings
+/* ... */
+```
+
+Reset shell.config to the defaults:
+
+```javascript
+{
+ fatal: false,
+ globOptions: {},
+ maxdepth: 255,
+ noglob: false,
+ silent: false,
+ verbose: false,
+}
+```
+
+## Team
+
+| [](https://github.com/nfischer) | [](http://github.com/freitagbr) |
+|:---:|:---:|
+| [Nate Fischer](https://github.com/nfischer) | [Brandon Freitag](http://github.com/freitagbr) |
http://git-wip-us.apache.org/repos/asf/cordova-browser/blob/c846b473/node_modules/shelljs/bin/shjs
----------------------------------------------------------------------
diff --git a/node_modules/shelljs/bin/shjs b/node_modules/shelljs/bin/shjs
index aae3bc6..75ca58b 100755
--- a/node_modules/shelljs/bin/shjs
+++ b/node_modules/shelljs/bin/shjs
@@ -32,24 +32,8 @@ for (var i = 0, l = args.length; i < l; i++) {
}
}
-if (scriptName.match(/\.coffee$/)) {
- //
- // CoffeeScript
- //
- if (which('coffee')) {
- exec('coffee "' + scriptName + '" ' + args.join(' '), function(code) {
- process.exit(code);
- });
- } else {
- console.log('ShellJS: CoffeeScript interpreter not found');
- console.log();
- process.exit(1);
- }
-} else {
- //
- // JavaScript
- //
- exec('node "' + scriptName + '" ' + args.join(' '), function(code) {
- process.exit(code);
- });
-}
+var path = require('path');
+var extensions = require('interpret').extensions;
+var rechoir = require('rechoir');
+rechoir.prepare(extensions, scriptName);
+require(require.resolve(path.resolve(process.cwd(), scriptName)));
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org