better code injection handling for js

This commit is contained in:
wing328
2016-06-28 23:17:28 +08:00
parent acc28495e8
commit aec2f4e27c
1354 changed files with 313854 additions and 109 deletions

View File

@@ -0,0 +1,196 @@
**cli is a toolkit for rapidly building command line apps - it includes:**
- Full featured opts/args parser
- Plugin support for adding common options and switches
- Helper methods for working with input/output and spawning child processes
- Output colored/styled messages, [progress bars](https://github.com/chriso/cli/blob/master/examples/progress.js) or [spinners](https://github.com/chriso/cli/blob/master/examples/spinner.js)
- Command [auto-completion](https://github.com/chriso/cli/blob/master/examples/command.js) and [glob support](https://github.com/chriso/cli/blob/master/examples/glob.js)
Install using `npm install cli` or just bundle [cli.js](https://github.com/chriso/cli/raw/master/cli.js) with your app.
## Example apps
### sort.js
```javascript
#!/usr/bin/env node
require('cli').withStdinLines(function(lines, newline) {
this.output(lines.sort().join(newline));
});
```
Try it out
```bash
$ ./sort.js < input.txt
```
Let's add support for an `-n` switch to use a numeric sort, and a `-r` switch to reverse output - only 5 extra lines of code (!)
```javascript
var cli = require('cli'), options = cli.parse();
cli.withStdinLines(function(lines, newline) {
lines.sort(!options.n ? null : function(a, b) {
return parseInt(a) > parseInt(b);
});
if (options.r) lines.reverse();
this.output(lines.join(newline));
});
```
### static.js
Let's create a static file server with daemon support to see the opts parser + plugins in use - note: this requires `npm install creationix daemon`
```javascript
var cli = require('cli').enable('daemon', 'status'); //Enable 2 plugins
cli.parse({
log: ['l', 'Enable logging'],
port: ['p', 'Listen on this port', 'number', 8080],
serve: [false, 'Serve static files from PATH', 'path', './public']
});
cli.main(function(args, options) {
var server, middleware = [];
if (options.log) {
this.debug('Enabling logging');
middleware.push(require('creationix/log')());
}
this.debug('Serving files from ' + options.serve);
middleware.push(require('creationix/static')('/', options.serve, 'index.html'));
server = this.createServer(middleware).listen(options.port);
this.ok('Listening on port ' + options.port);
});
```
To output usage information
```bash
$ ./static.js --help
```
To create a daemon that serves files from */tmp*, run
```bash
$ ./static.js -ld --serve=/tmp
```
For more examples, see [./examples](https://github.com/chriso/cli/tree/master/examples)
## Helper methods
cli has methods that collect stdin (newline is autodetected as \n or \r\n)
```javascript
cli.withStdin(callback); //callback receives stdin as a string
cli.withStdinLines(callback); //callback receives stdin split into an array of lines (lines, newline)
```
cli also has a lower level method for working with input line by line (see [./examples/cat.js](https://github.com/chriso/cli/blob/master/examples/cat.js) for an example).
```javascript
cli.withInput(file, function (line, newline, eof) {
if (!eof) {
this.output(line + newline);
}
});
```
*Note: `file` can be omitted if you want to work with stdin*
To output a progress bar, call
```javascript
cli.progress(progress); //Where 0 <= progress <= 1
```
To spawn a child process, use
```javascript
cli.exec(cmd, callback); //callback receives the output of the process (split into lines)
```
cli also comes bundled with kof's [node-natives](https://github.com/kof/node-natives) (access with cli.native) and creationix' [stack](https://github.com/creationix/stack) (access with cli.createServer)
## Plugins
Plugins are a way of adding common opts and can be enabled using
```javascript
cli.enable(plugin1, [plugin2, ...]); //To disable, use the equivalent disable() method
```
**help** - *enabled by default*
Adds `-h,--help` to output auto-generated usage information
**version**
Adds `-v,--version` to output version information for the app. cli will attempt to locate and parse a nearby *package.json*
To set your own app name and version, use `cli.setApp(app_name, version)`
**status**
Adds options to show/hide the stylized status messages that are output to the console when using one of these methods
```javascript
cli.debug(msg); //Only shown when using --debug
cli.error(msg);
cli.fatal(msg); //Exits the process after outputting msg
cli.info(msg);
cli.ok(msg);
```
`-k,--no-color` will omit ANSI color escapes from the output
**glob** - *requires* `npm install glob`
Enables glob matching of arguments
**daemon** - *requires* `npm install daemon`
Adds `-d,--daemon ARG` for daemonizing the process and controlling the resulting daemon
`ARG` can be either start (default), stop, restart, pid (outputs the daemon's pid if it's running), or log (output the daemon's stdout+stderr)
**timeout**
Adds `-t,--timeout N` to exit the process after N seconds with an error
**catchall**
Adds `-c,--catch` to catch and output uncaughtExceptions and resume execution
*Note: Plugins are automatically disabled if an option or switch of the same name is already defined*
## LICENSE
(MIT license)
Copyright (c) 2010 Chris O'Hara <cohara87@gmail.com>
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.

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,17 @@
#!/usr/bin/env node
var cli = require('cli');
var output_file = function (file) {
cli.withInput(file, function (line, sep, eof) {
if (!eof) {
cli.output(line + sep);
} else if (cli.args.length) {
output_file(cli.args.shift());
}
});
};
if (cli.args.length) {
output_file(cli.args.shift());
}

View File

@@ -0,0 +1,16 @@
#!/usr/bin/env node
var cli = require('cli');
//The second (optional) argument of cli.parse() is a command list
//Type `./command.js --help` for usage info
//cli enables auto-completion of commands (similiar to npm), e.g. all of
//the following are equivalent and result in "Command is: install":
// $ ./command.js install
// $ ./command.js inst
// $ ./command.js i
cli.parse(null, ['install', 'test', 'edit', 'remove', 'uninstall', 'ls']);
console.log('Command is: ' + cli.command);

View File

@@ -0,0 +1,54 @@
#!/usr/bin/env node
/* All of the following commands are equivalent and write `foo\tbar foo` to out.txt
$ ./echo.js -n -e --output=out.txt "foo\tbar" "foo"
$ ./echo.js --newline --escape --output "out.txt" "foo\tbar" "foo"
$ ./echo.js -ne --output=out.txt "foo\tbar" "foo"
$ ./echo.js -en --output="out.txt" "foo\tbar" "foo"
*/
var cli = require('cli');
cli.parse({
newline: ['n', 'Do not output the trailing newline'],
escape: ['e', 'Enable interpretation of backslash escapes'],
separator: ['s', 'Separate arguments using this value', 'string', ' '],
output: [false, 'Write to FILE rather than the console', 'file']
});
cli.main(function (args, options) {
var output = '', i, j, l, output_stream;
if (this.argc) {
if (options.escape) {
var replace = {'\\n':'\n','\\r':'\r','\\t':'\t','\\e':'\e','\\v':'\v','\\f':'\f','\\c':'\c','\\b':'\b','\\a':'\a','\\\\':'\\'};
var escape = function (str) {
str += '';
for (j in replace) {
str = str.replace(i, replace[i]);
}
return str;
}
for (i = 0, l = this.argc; i < l; i++) {
args[i] = escape(args[i]);
}
options.separator = escape(options.separator);
}
output += args.join(options.separator);
}
if (!options.newline) {
output += '\n';
}
try {
if (options.output) {
output_stream = this.native.fs.createWriteStream(options.output)
} else {
output_stream = process.stdout;
}
output_stream.write(output);
} catch (e) {
this.fatal('Could not write to output stream');
}
});

View File

@@ -0,0 +1,6 @@
#!/usr/bin/env node
var cli = require('cli').enable('glob');
//Running `./glob.js *.js` will output a list of .js files in this directory
console.log(cli.args);

View File

@@ -0,0 +1,20 @@
#!/usr/bin/env node
var cli = require('../');
//You can (optionally) boost the width of output with:
//cli.width = 120;
//You can also adjust the width of the options/command definitions
//cli.option_width = 25;
var long_desc = 'Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry\'s '
+ 'standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make'
+ ' a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, '
+ 'remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing '
+ 'Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions'
+ ' of Lorem Ipsum.';
cli.parse({
foo: ['f', long_desc]
});

View File

@@ -0,0 +1,11 @@
#!/usr/bin/env node
var cli = require('cli');
var i = 0, interval = setInterval(function () {
cli.progress(++i / 100);
if (i === 100) {
clearInterval(interval);
cli.ok('Finished!');
}
}, 50);

View File

@@ -0,0 +1,18 @@
#!/usr/bin/env node
var cli = require('cli');
var options = cli.parse({
numeric: ['n', 'Compare using a numeric sort'],
reverse: ['r', 'Reverse the results']
});
cli.withStdinLines(function (lines, newline) {
lines.sort(!options.numeric ? null : function (a, b) {
return parseInt(a) > parseInt(b);
});
if (options.reverse) {
lines.reverse();
}
this.output(lines.join(newline));
});

View File

@@ -0,0 +1,9 @@
#!/usr/bin/env node
var cli = require('cli');
cli.spinner('Working..');
setTimeout(function () {
cli.spinner('Working.. done!', true); //End the spinner
}, 3000);

View File

@@ -0,0 +1,27 @@
#!/usr/bin/env coffee
cli = require 'cli'
cli.enable('daemon','status')
.setUsage('static.coffee [OPTIONS]')
cli.parse {
log: ['l', 'Enable logging']
port: ['p', 'Listen on this port', 'number', 8080]
serve: [false, 'Serve static files from PATH', 'path', './public']
}
middleware = []
cli.main (args, options) ->
if options.log
@debug 'Enabling logging'
middleware.push require('creationix/log')()
@debug 'Serving files from ' + options.serve
middleware.push require('creationix/static')('/', options.serve, 'index.html')
server = @createServer(middleware).listen options.port
@ok 'Listening on port ' + options.port

View File

@@ -0,0 +1,25 @@
#!/usr/bin/env node
var cli = require('cli').enable('status', 'daemon');
cli.parse({
log: ['l', 'Enable logging'],
port: ['p', 'Listen on this port', 'number', 8080],
serve: [false, 'Serve static files from PATH', 'path', './public']
});
cli.main(function (args, options) {
var server, middleware = [];
if (options.log) {
this.debug('Enabling logging');
middleware.push(require('creationix/log')());
}
this.debug('Serving files from ' + options.serve);
middleware.push(require('creationix/static')('/', options.serve, 'index.html'));
server = this.createServer(middleware).listen(options.port);
this.ok('Listening on port ' + options.port);
});

View File

@@ -0,0 +1 @@
module.exports = require('./cli');

View File

@@ -0,0 +1,99 @@
{
"_args": [
[
"cli@0.6.x",
"/Users/williamcheng/Code/may2016/swagger-codegen/samples/client/petstore-security-test/javascript/node_modules/jshint"
]
],
"_from": "cli@>=0.6.0 <0.7.0",
"_id": "cli@0.6.6",
"_inCache": true,
"_installable": true,
"_location": "/cli",
"_nodeVersion": "0.12.1",
"_npmUser": {
"email": "cohara87@gmail.com",
"name": "cohara87"
},
"_npmVersion": "2.7.3",
"_phantomChildren": {},
"_requested": {
"name": "cli",
"raw": "cli@0.6.x",
"rawSpec": "0.6.x",
"scope": null,
"spec": ">=0.6.0 <0.7.0",
"type": "range"
},
"_requiredBy": [
"/jshint"
],
"_resolved": "https://registry.npmjs.org/cli/-/cli-0.6.6.tgz",
"_shasum": "02ad44a380abf27adac5e6f0cdd7b043d74c53e3",
"_shrinkwrap": null,
"_spec": "cli@0.6.x",
"_where": "/Users/williamcheng/Code/may2016/swagger-codegen/samples/client/petstore-security-test/javascript/node_modules/jshint",
"author": {
"email": "cohara87@gmail.com",
"name": "Chris O'Hara"
},
"bugs": {
"url": "http://github.com/chriso/cli/issues"
},
"contributors": [
{
"name": "Douglas Meyer"
}
],
"dependencies": {
"exit": "0.1.2",
"glob": "~ 3.2.1"
},
"description": "A tool for rapidly building command line apps",
"devDependencies": {},
"directories": {},
"dist": {
"shasum": "02ad44a380abf27adac5e6f0cdd7b043d74c53e3",
"tarball": "https://registry.npmjs.org/cli/-/cli-0.6.6.tgz"
},
"engines": {
"node": ">=0.2.5"
},
"gitHead": "088e01c2df81b0850ae4ae2daa7827fb6dcf0502",
"homepage": "http://github.com/chriso/cli",
"keywords": [
"args",
"argsparse",
"autocomplete",
"autocompletion",
"cli",
"command",
"command line",
"console",
"daemon",
"opt",
"optparse",
"opts",
"parseopt"
],
"licenses": [
{
"type": "MIT"
}
],
"main": "cli.js",
"maintainers": [
{
"name": "cohara87",
"email": "cohara87@gmail.com"
}
],
"name": "cli",
"optionalDependencies": {},
"repository": {
"type": "git",
"url": "http://github.com/chriso/cli.git"
},
"scripts": {},
"version": "0.6.6"
}

View File

@@ -0,0 +1,11 @@
#!/usr/bin/env node
var cli = require('./');
var i = 0, interval = setInterval(function () {
cli.progress(++i / 100);
if (i === 100) {
clearInterval(interval);
cli.ok('Finished!');
}
}, 50);

View File

@@ -0,0 +1,9 @@
#!/usr/bin/env node
var cli = require('./');
cli.spinner('Working..');
setTimeout(function () {
cli.spinner('Working.. done!', true); //End the spinner
}, 3000);