terser 5.11.0 → 5.12.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v5.12.0
+
+ - `TERSER_DEBUG_DIR` environment variable
+ - @copyright comments are now preserved with the comments="some" option (#1153)
+
 ## v5.11.0
 
  - Unicode code point escapes (`\u{abcde}`) are not emitted inside RegExp literals anymore (#1147)

package/README.md

@@ -5,7 +5,7 @@
   [![Travis Build][travis-image]][travis-url]
   [![Opencollective financial contributors][opencollective-contributors]][opencollective-url]
 
-A JavaScript parser and mangler/compressor toolkit for ES6+.
+A JavaScript mangler/compressor toolkit for ES6+.
 
 *note*: You can support this project on patreon: <a target="_blank" rel="nofollow" href="https://www.patreon.com/fabiosantoscode"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" alt="patron" width="100px" height="auto"></a>. Check out [PATRONS.md](https://github.com/terser/terser/blob/master/PATRONS.md) for our first-tier patrons.
 
@@ -127,8 +127,8 @@ a double dash to prevent input files being used as option arguments:
                                 as JSON to STDOUT respectively.
     --comments [filter]         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
+                                JSDoc-style comments that contain e.g. "@license",
+                                or start with "!". You can optionally pass one of the
                                 following arguments to this flag:
                                 - "all" to keep all comments
                                 - `false` to omit comments in the output
@@ -989,8 +989,8 @@ as "output options".
   statement.
 
 - `comments` (default `"some"`) -- by default it keeps JSDoc-style comments
-  that contain "@license", "@preserve" or start with `!`, pass `true` or
-  `"all"` to preserve all comments, `false` to omit comments in the output,
+  that contain "@license", "@copyright", "@preserve" or start with `!`, pass `true`
+  or `"all"` to preserve all comments, `false` to omit comments in the output,
   a regular expression string (e.g. `/^!/`) or a function.
 
 - `ecma` (default `5`) -- set desired EcmaScript standard version for output.
@@ -1062,9 +1062,9 @@ as "output options".
 ### Keeping copyright notices or other comments
 
 You can pass `--comments` to retain certain comments in the output.  By
-default it will keep JSDoc-style comments that contain "@preserve",
-"@license" or "@cc_on" (conditional compilation for IE).  You can pass
-`--comments all` to keep all the comments, or a valid JavaScript regexp to
+default it will keep comments starting with "!" and JSDoc-style comments that
+contain "@preserve", "@copyright", "@license" or "@cc_on" (conditional compilation for IE).
+You can pass `--comments all` to keep all the comments, or a valid JavaScript regexp to
 keep only comments that match this regexp.  For example `--comments /^!/`
 will keep comments like `/*! Copyright Notice */`.
 
@@ -1318,6 +1318,22 @@ $ yarn
 
 In the terser CLI we use [source-map-support](https://npmjs.com/source-map-support) to produce good error stacks. In your own app, you're expected to enable source-map-support (read their docs) to have nice stack traces that will help you write good issues.
 
+## Obtaining the source code given to Terser
+
+Because users often don't control the call to `await minify()` or its arguments, Terser provides a `TERSER_DEBUG_DIR` environment variable to make terser output some debug logs. If you're using a bundler or a project that includes a bundler and are not sure what went wrong with your code, pass that variable like so:
+
+```
+$ TERSER_DEBUG_DIR=/path/to/logs command-that-uses-terser
+$ ls /path/to/logs
+terser-debug-123456.log
+```
+
+If you're not sure how to set an environment variable on your shell (the above example works in bash), you can try using cross-env:
+
+```
+> npx cross-env TERSER_DEBUG_DIR=/path/to/logs command-that-uses-terser
+```
+
 # README.md Patrons:
 
 *note*: You can support this project on patreon: <a target="_blank" rel="nofollow" href="https://www.patreon.com/fabiosantoscode"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" alt="patron" width="100px" height="auto"></a>. Check out [PATRONS.md](https://github.com/terser/terser/blob/master/PATRONS.md) for our first-tier patrons.

package/dist/bundle.min.js

@@ -6975,7 +6975,7 @@ function is_some_comments(comment) {
     // multiline comment
     return (
         (comment.type === "comment2" || comment.type === "comment1")
-        && /@preserve|@lic|@cc_on|^\**!/i.test(comment.value)
+        && /@preserve|@copyright|@lic|@cc_on|^\**!/i.test(comment.value)
     );
 }
 
@@ -27555,7 +27555,54 @@ function cache_to_json(cache) {
     };
 }
 
-async function minify(files, options) {
+function log_input(files, options, fs, debug_folder) {
+    if (!(fs && fs.writeFileSync && fs.mkdirSync)) {
+        return;
+    }
+
+    try {
+        fs.mkdirSync(debug_folder);
+    } catch (e) {
+        if (e.code !== "EEXIST") throw e;
+    }
+
+    const log_path = `${debug_folder}/terser-debug-${(Math.random() * 9999999) | 0}.log`;
+
+    options = options || {};
+
+    const options_str = JSON.stringify(options, (_key, thing) => {
+        if (typeof thing === "function") return "[Function " + thing.toString() + "]";
+        if (thing instanceof RegExp) return "[RegExp " + thing.toString() + "]";
+        return thing;
+    }, 4);
+
+    const files_str = (file) => {
+        if (typeof file === "object" && options.parse && options.parse.spidermonkey) {
+            return JSON.stringify(file, null, 2);
+        } else if (typeof file === "object") {
+            return Object.keys(file)
+                .map((key) => key + ": " + files_str(file[key]))
+                .join("\n\n");
+        } else if (typeof file === "string") {
+            return "```\n" + file + "\n```";
+        } else {
+            return file; // What do?
+        }
+    };
+
+    fs.writeFileSync(log_path, "Options: \n" + options_str + "\n\nInput files:\n\n" + files_str(files) + "\n");
+}
+
+async function minify(files, options, _fs_module) {
+    if (
+        _fs_module
+        && typeof process === "object"
+        && process.env
+        && typeof process.env.TERSER_DEBUG_DIR === "string"
+    ) {
+        log_input(files, options, _fs_module, process.env.TERSER_DEBUG_DIR);
+    }
+
     options = defaults(options, {
         compress: {},
         ecma: undefined,
@@ -27578,6 +27625,7 @@ async function minify(files, options) {
         warnings: false,
         wrap: false,
     }, true);
+
     var timings = options.timings && {
         start: Date.now()
     };
@@ -27979,7 +28027,7 @@ async function run_cli({ program, packageJson, fs, path }) {
 
         let result;
         try {
-            result = await minify(files, options);
+            result = await minify(files, options, fs);
         } catch (ex) {
             if (ex.name == "SyntaxError") {
                 print_error("Parse error at " + ex.filename + ":" + ex.line + "," + ex.col);
@@ -28042,14 +28090,18 @@ async function run_cli({ program, packageJson, fs, path }) {
             }, 2));
         } else if (program.output == "spidermonkey") {
             try {
-                const minified = await minify(result.code, {
-                    compress: false,
-                    mangle: false,
-                    format: {
-                        ast: true,
-                        code: false
-                    }
-                });
+                const minified = await minify(
+                    result.code,
+                    {
+                        compress: false,
+                        mangle: false,
+                        format: {
+                            ast: true,
+                            code: false
+                        }
+                    },
+                    fs
+                );
                 console.log(JSON.stringify(minified.ast.to_mozilla_ast(), null, 2));
             } catch (ex) {
                 fatal(ex);

package/lib/cli.js

@@ -224,7 +224,7 @@ export async function run_cli({ program, packageJson, fs, path }) {
 
         let result;
         try {
-            result = await minify(files, options);
+            result = await minify(files, options, fs);
         } catch (ex) {
             if (ex.name == "SyntaxError") {
                 print_error("Parse error at " + ex.filename + ":" + ex.line + "," + ex.col);
@@ -287,14 +287,18 @@ export async function run_cli({ program, packageJson, fs, path }) {
             }, 2));
         } else if (program.output == "spidermonkey") {
             try {
-                const minified = await minify(result.code, {
-                    compress: false,
-                    mangle: false,
-                    format: {
-                        ast: true,
-                        code: false
-                    }
-                });
+                const minified = await minify(
+                    result.code,
+                    {
+                        compress: false,
+                        mangle: false,
+                        format: {
+                            ast: true,
+                            code: false
+                        }
+                    },
+                    fs
+                );
                 console.log(JSON.stringify(minified.ast.to_mozilla_ast(), null, 2));
             } catch (ex) {
                 fatal(ex);

package/lib/minify.js

@@ -61,7 +61,54 @@ function cache_to_json(cache) {
     };
 }
 
-async function minify(files, options) {
+function log_input(files, options, fs, debug_folder) {
+    if (!(fs && fs.writeFileSync && fs.mkdirSync)) {
+        return;
+    }
+
+    try {
+        fs.mkdirSync(debug_folder);
+    } catch (e) {
+        if (e.code !== "EEXIST") throw e;
+    }
+
+    const log_path = `${debug_folder}/terser-debug-${(Math.random() * 9999999) | 0}.log`;
+
+    options = options || {};
+
+    const options_str = JSON.stringify(options, (_key, thing) => {
+        if (typeof thing === "function") return "[Function " + thing.toString() + "]";
+        if (thing instanceof RegExp) return "[RegExp " + thing.toString() + "]";
+        return thing;
+    }, 4);
+
+    const files_str = (file) => {
+        if (typeof file === "object" && options.parse && options.parse.spidermonkey) {
+            return JSON.stringify(file, null, 2);
+        } else if (typeof file === "object") {
+            return Object.keys(file)
+                .map((key) => key + ": " + files_str(file[key]))
+                .join("\n\n");
+        } else if (typeof file === "string") {
+            return "```\n" + file + "\n```";
+        } else {
+            return file; // What do?
+        }
+    };
+
+    fs.writeFileSync(log_path, "Options: \n" + options_str + "\n\nInput files:\n\n" + files_str(files) + "\n");
+}
+
+async function minify(files, options, _fs_module) {
+    if (
+        _fs_module
+        && typeof process === "object"
+        && process.env
+        && typeof process.env.TERSER_DEBUG_DIR === "string"
+    ) {
+        log_input(files, options, _fs_module, process.env.TERSER_DEBUG_DIR);
+    }
+
     options = defaults(options, {
         compress: {},
         ecma: undefined,
@@ -84,6 +131,7 @@ async function minify(files, options) {
         warnings: false,
         wrap: false,
     }, true);
+
     var timings = options.timings && {
         start: Date.now()
     };

package/lib/output.js

@@ -172,7 +172,7 @@ function is_some_comments(comment) {
     // multiline comment
     return (
         (comment.type === "comment2" || comment.type === "comment1")
-        && /@preserve|@lic|@cc_on|^\**!/i.test(comment.value)
+        && /@preserve|@copyright|@lic|@cc_on|^\**!/i.test(comment.value)
     );
 }
 

package/package.json

@@ -4,7 +4,7 @@
   "homepage": "https://terser.org",
   "author": "Mihai Bazon <mihai.bazon@gmail.com> (http://lisperator.net/)",
   "license": "BSD-2-Clause",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "engines": {
     "node": ">=10"
   },
@@ -104,6 +104,8 @@
       "describe": false,
       "it": false,
       "require": false,
+      "before": false,
+      "after": false,
       "global": false,
       "process": false
     },