JoBoEVD/UglifyJS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make usage in README more readable.

Browse Source 
This isn't perfect, but I think it is much more readable than it used to be.
This commit is contained in:
Mike Cooper 2013-08-07 23:02:20 -07:00
parent 4c4dc2137c
commit 8fdf4060ad
1 changed files with 28 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -42,69 +42,37 @@ same global scope, that is, a reference from a file to some
variable/function declared in another file will be matched properly. variable/function declared in another file will be matched properly.
If you want to read from STDIN instead, pass a single dash instead of input If you want to read from STDIN instead, pass a single dash instead of input
files. files. Specify `--output` (`-o`) to declare the output file. Otherwise the
output goes to STDOUT.
The available options are: The available options are:
--source-map Specify an output file where to generate source map. | Option | Description | Type |
[string] |--------|-------------|------|
--source-map-root The path to the original source to be included in the | `--source-map` | Specify an output file where to generate source map. | String |
source map. [string] | `--source-map-root` | Path to the original source to be included in the source map. | String |
--source-map-url The path to the source map to be added in //# | `--source-map-url` | Path to the source map to be added in sourceMappingURL. Defaults to the value passed with `--source-map`. | String |
sourceMappingURL. Defaults to the value passed with | `--in-source-map` | Input source map, useful if you're compressing JS that was generated from some other original code. | Path |
--source-map. [string] | `--screw-ie8` | Pass this flag if you don't care about full compliance with Internet Explorer 6-8 quirks (by default UglifyJS will try to be IE-proof). | Boolean |
--in-source-map Input source map, useful if you're compressing JS that was | `--expr` | Parse a single expression, rather than a program (for parsing JSON) | Boolean |
generated from some other original code. | `-p`, `--prefix` | Skip prefix for original filenames that appear in source maps. For example `-p 3` will drop 3 directories from file names and ensure they are relative paths. You can also specify `-p` relative, which will make UglifyJS figure out itself the relative paths between original sources, the source map and the output file. | String |
--screw-ie8 Pass this flag if you don't care about full compliance | `-o`, `--output` | Output file (default STDOUT). | Path |
with Internet Explorer 6-8 quirks (by default UglifyJS | `-b`, `--beautify` | Beautify output/specify output options. | String |
will try to be IE-proof). [boolean] | `-m`, `--mangle` | Mangle names/pass mangler options. | String |
--expr Parse a single expression, rather than a program (for | `-r`, `--reserved` | Reserved names to exclude from mangling. | Path |
parsing JSON) [boolean] | `-c`, `--compress` | Enable compressor/pass compressor options. Pass options like `-c hoist_vars=false,if_return=false`. Use `-c` with no argument to use the default compression options. | String |
-p, --prefix Skip prefix for original filenames that appear in source | `-d`, `--define` | Global definitions | String |
maps. For example -p 3 will drop 3 directories from file | `-e`, `--enclose` | Embed everything in a big function, with a configurable parameter/argument list. | String |
names and ensure they are relative paths. You can also | `--comments` | Preserve copyright comments in the output. By default this works like Google Closure, keeping JSDoc-style comments that contain `@license` or `@preserve`. You can optionally pass one of the following arguments to this flag: `all` to keep all comments, or a valid JS regexp (needs to start with a slash) to keep only comments that match. Note that currently not *all* comments can be kept when compression is on, because of dead code removal or cascading statements into sequences. | String |
specify -p relative, which will make UglifyJS figure out | `--stats` | Display operations run time on STDERR. | Boolean |
itself the relative paths between original sources, the | `--acorn` | Use Acorn for parsing. | Boolean |
source map and the output file. [string] | `--spidermonkey` | Assume input files are SpiderMonkey AST format (as JSON). | Boolean |
-o, --output Output file (default STDOUT). | `--self` | Build itself (UglifyJS2) as a library (implies --wrap=UglifyJS --export-all) | Boolean |
-b, --beautify Beautify output/specify output options. [string] | `--wrap` | Embed everything in a big function, making the “exports” and “global” variables available. You need to pass an argument to this option to specify the name that your module will take when included in, say, a browser. | String |
-m, --mangle Mangle names/pass mangler options. [string] | `--export-all` | Only used when --wrap, this tells UglifyJS to add code to automatically export all globals. | Boolean |
-r, --reserved Reserved names to exclude from mangling. | `--lint` | Display some scope warnings | Boolean |
-c, --compress Enable compressor/pass compressor options. Pass options | `-v`, `--verbose` | Verbose | Boolean |
like -c hoist_vars=false,if_return=false. Use -c with no | `-V`, `--version` | Print version number and exit. | Boolean |
argument to use the default compression options. [string]
-d, --define Global definitions [string]
-e, --enclose Embed everything in a big function, with a configurable
parameter/argument list. [string]
--comments Preserve copyright comments in the output. By default this
works like Google Closure, keeping JSDoc-style comments
that contain "@license" or "@preserve". You can optionally
pass one of the following arguments to this flag:
- "all" to keep all comments
- a valid JS regexp (needs to start with a slash) to keep
only comments that match.
Note that currently not *all* comments can be kept when
compression is on, because of dead code removal or
cascading statements into sequences. [string]
--stats Display operations run time on STDERR. [boolean]
--acorn Use Acorn for parsing. [boolean]
--spidermonkey Assume input files are SpiderMonkey AST format (as JSON).
[boolean]
--self Build itself (UglifyJS2) as a library (implies
--wrap=UglifyJS --export-all) [boolean]
--wrap Embed everything in a big function, making the “exports”
and “global” variables available. You need to pass an
argument to this option to specify the name that your
module will take when included in, say, a browser.
[string]
--export-all Only used when --wrap, this tells UglifyJS to add code to
automatically export all globals. [boolean]
--lint Display some scope warnings [boolean]
-v, --verbose Verbose [boolean]
-V, --version Print version number and exit. [boolean]
Specify `--output` (`-o`) to declare the output file. Otherwise the output
goes to STDOUT.
## Source map options ## Source map options