single-file-cli 2.0.63 → 2.0.65

package/lib/version.js

@@ -1 +1 @@
-export const version = "2.0.63";
+export const version = "2.0.65";

package/options.js

@@ -65,6 +65,7 @@ const OPTIONS_INFO = {
 	"browser-device-width": { description: "Width of the device viewport in pixels (default value is 360 when using --browser-mobile-emulation)", type: "number" },
 	"browser-device-height": { description: "Height of the device viewport in pixels (default value is 800 when using --browser-mobile-emulation)", type: "number" },
 	"browser-device-scale-factor": { description: "Scale factor of the device viewport (default value is 2 when using --browser-mobile-emulation)", type: "number" },
+	"console-messages-file": { description: "Path of the file where to save the console messages in JSON format", type: "string" },
 	"compress-CSS": { description: "Compress CSS stylesheets", type: "boolean" },
 	"compress-HTML": { description: "Compress HTML content", type: "boolean", defaultValue: true },
 	"crawl-links": { description: "Crawl and save pages found via inner links", type: "boolean" },
@@ -80,8 +81,8 @@ const OPTIONS_INFO = {
 	"crawl-rewrite-rule": { description: "Rewrite rule used to rewrite URLs of crawled pages", type: "string[]" },
 	"dump-content": { description: "Dump the content of the processed page in the console ('true' when running in Docker)", type: "boolean" },
 	"emulate-media-feature": { description: "Emulate a media feature. The syntax is <name>:<value>, e.g. \"prefers-color-scheme:dark\"", type: "string[]" },
-	"error-file": { description: "Path of the file where to save the error messages", type: "string" },
-	"error-traces-disabled": { description: "Remove error stack traces in the error messages", type: "boolean", defaultValue: true },
+	"errors-file": { description: "Path of the file where to save the error messages", type: "string", alias: "error-file" },
+	"errors-traces-disabled": { description: "Remove error stack traces in the error messages", type: "boolean", defaultValue: true, alias: "error-traces-disabled" },
 	"filename-template": { description: "Template used to generate the output filename (see help page of the extension for more info)", type: "string", defaultValue: "%if-empty<{page-title}|No title> ({date-locale} {time-locale}).{filename-extension}" },
 	"filename-conflict-action": { description: "Action when the filename is conflicting with existing one on the filesystem. The possible values are \"uniquify\" (default), \"overwrite\" and \"skip\"", type: "string", defaultValue: "uniquify" },
 	"filename-replacement-character": { description: "The character used for replacing invalid characters in filenames", type: "string", defaultValue: "_" },
@@ -132,6 +133,7 @@ const OPTIONS_INFO = {
 	"extract-data-from-page": { description: "Extract compressed data from the page instead of fetching the page in order to create universal self-extracting HTML files", type: "boolean", defaultValue: true },
 	"prevent-appended-data": { description: "Prevent appending data after the compressed data when creating self-extracting HTML files", type: "boolean" },
 	"embed-screenshot": { description: "Embed a screenshot of the page as a PNG file in the compressed file (self-extracting HTML or ZIP file). When enabled, the resulting file can be read as a ZIP file or a PNG image.", type: "boolean" },
+	"embed-screenshot-options": { description: "Options passed to the CDP method `Page.captureScreenshot()` given as a JSON string (e.g. { \"captureBeyondViewport\": false })", type: "string" },
 	"embedded-image": { description: "Path to a PNG image to embed in the compressed file.", type: "string" },
 	"embed-pdf": { description: "Embed a PDF file in the ZIP or self-extracting file. When enabled, the resulting file can be read as a ZIP file or a PDF file.", type: "boolean" },
 	"embed-pdf-options": { description: "Options passed to the CDP method `Page.printToPDF()` given as a JSON string (e.g. { \"pageRanges\": \"1-1\", \"paperWidth\": 11, \"paperHeight\": 8.5 })", type: "string" },
@@ -152,7 +154,14 @@ export default options;
 
 async function getOptions() {
 	const { positionals, options } = parseArgs(Array.from(args));
-	if ((!positionals.length && !Object.keys(options).length) || positionals.length > 2 || options.help) {
+	const unknownOptions = [];
+	positionals.forEach(positional => {
+		if (positional.startsWith("--")) {
+			unknownOptions.push(positional);
+			positionals.splice(positionals.indexOf(positional), 1);
+		}
+	});
+	if ((!positionals.length && !Object.keys(options).length) || positionals.length > 2 || options.help || unknownOptions.length) {
 		console.log(USAGE_TEXT + "\n"); // eslint-disable-line no-console
 		console.log("Options:"); // eslint-disable-line no-console
 		Object.keys(OPTIONS_INFO).forEach(optionName => {
@@ -165,6 +174,10 @@ async function getOptions() {
 			const optionDefaultValue = optionInfo.defaultValue === undefined ? "" : `(default: ${JSON.stringify(optionInfo.defaultValue)})`;
 			console.log(`  --${optionName}: ${optionDescription} <${optionType}> ${optionDefaultValue}`); // eslint-disable-line no-console
 		});
+		if (unknownOptions.length) {
+			console.log(""); // eslint-disable-line no-console
+			console.log(`Error: Unknown option${unknownOptions.length > 1 ? "s" : ""} ${unknownOptions.join(", ")}`); // eslint-disable-line no-console
+		}
 		console.log(""); // eslint-disable-line no-console
 		exit(0);
 	}
@@ -196,6 +209,14 @@ async function getOptions() {
 		options.browserArgs = options.browserArguments;
 		delete options.browserArguments;
 	}
+	if (options.errorFile) {
+		options.errorsFile = options.errorFile;
+		delete options.errorFile;
+	}
+	if (options.errorTracesDisabled) {
+		options.errorsTracesDisabled = options.errorTracesDisabled;
+		delete options.errorTracesDisabled;
+	}
 	delete options.acceptHeaderFont;
 	delete options.acceptHeaderImage;
 	delete options.acceptHeaderStylesheet;
@@ -291,7 +312,11 @@ function parseArg(arg) {
 }
 
 function getOptionInfo(optionName) {
-	return OPTIONS_INFO[Object.keys(OPTIONS_INFO).find(keyName => keyName.toLowerCase() == optionName.toLowerCase())];
+	for (const keyName in OPTIONS_INFO) {
+		if (keyName.toLowerCase() == optionName.toLowerCase() || OPTIONS_INFO[keyName].alias == optionName.toLowerCase()) {
+			return OPTIONS_INFO[keyName];
+		}
+	}
 }
 
 function kebabToCamelCase(optionName) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "single-file-cli",
-	"version": "2.0.63",
+	"version": "2.0.65",
 	"description": "SingleFile CLI",
 	"author": "Gildas Lormeau",
 	"engines": {

package/single-file-cli-api.js

@@ -223,7 +223,7 @@ async function saveTasks() {
 	}
 }
 
-function rewriteURL(url, crawlRemoveURLFragment, crawlRewriteRules) {
+function rewriteURL(url, crawlRemoveURLFragment, crawlRewriteRules = []) {
 	url = url.trim();
 	if (crawlRemoveURLFragment) {
 		url = url.replace(/^(.*?)#.*$/, "$1");
@@ -248,6 +248,9 @@ async function capturePage(options) {
 		options.zipScript = getZipScriptSource();
 		const pageData = await backend.getPageData(options);
 		content = pageData.content;
+		if (options.consoleMessagesFile && pageData.consoleMessages) {
+			await writeTextFile(options.consoleMessagesFile, JSON.stringify(pageData.consoleMessages, null, 2));
+		}
 		if (options.outputJson) {
 			if (content instanceof Uint8Array) {
 				const fileReader = new FileReader();
@@ -293,12 +296,12 @@ async function capturePage(options) {
 	} catch (error) {
 		const date = new Date();
 		let message = `[${date.toISOString()}] URL: ${options.url}`;
-		if (!options.errorTracesDisabled) {
+		if (!options.errorsTracesDisabled) {
 			message += "\nStack: " + error.stack;
 		}
 		message += "\n";
-		if (options.errorFile) {
-			await writeTextFile(options.errorFile, message, { append: true });
+		if (options.errorsFile) {
+			await writeTextFile(options.errorsFile, message, { append: true });
 		} else {
 			console.error(error.message || error, message); // eslint-disable-line no-console
 		}