aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorexvisory <37081854+exvisory@users.noreply.github.com>2018-05-18 08:50:36 +0100
committerAlex Lam S.L <alexlamsl@gmail.com>2018-05-18 15:50:36 +0800
commit0b7c70f7260fc48023aa6e1685f35547b1cca6f2 (patch)
treed674a0ae337ae892dbaa9ddcd4e67d0fa58637b2
parentf72d3029ddb342ba4166ee0a8df9253387dbdd83 (diff)
downloadtracifyjs-0b7c70f7260fc48023aa6e1685f35547b1cca6f2.tar.gz
tracifyjs-0b7c70f7260fc48023aa6e1685f35547b1cca6f2.zip
Update README.md to clarify --source-map filename option (#3137)
Clarify that the --source-map filename option does NOT change the source map output filename but does set the 'file' attribute within the output source map. This was already documented in the API section of the README so I just copied that to the CLI options section, and a fragment to the CLI summary.
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4d4ebae1..6d1cdf8f 100644
--- a/README.md
+++ b/README.md
@@ -118,7 +118,8 @@ a double dash to prevent input files being used as option arguments:
JS that was generated from some other original
code. Specify "inline" if the source map is
included within the sources.
- `filename` Name and/or location of the output source.
+ `filename` Filename and/or location of the output source
+ (sets `file` attribute in source map).
`includeSources` Pass this flag if you want to include
the content of source files in the
source map as sourcesContent property.
@@ -149,7 +150,9 @@ debugging your compressed JavaScript. To get a source map, pass
Additional options:
-- `--source-map "filename='<NAME>'"` to specify the name of the source map.
+- `--source-map "filename='<NAME>'"` to specify the name of the source map. The value of
+ `filename` is only used to set `file` attribute (see [the spec][sm-spec])
+ in source map file.
- `--source-map "root='<URL>'"` to pass the URL where the original files can be found.