single-file-cli 2.0.69 → 2.0.71

package/lib/version.js

@@ -1 +1 @@
-export const version = "2.0.69";
+export const version = "2.0.71";

package/options.js

@@ -42,12 +42,14 @@ const OPTIONS_INFO = {
 	"block-scripts": { description: "Block scripts", type: "boolean", defaultValue: true },
 	"block-videos": { description: "Block videos", type: "boolean", defaultValue: true },
 	"block-mixed-content": { description: "Block mixed contents", type: "boolean" },
+	"blocked-URL-pattern": { description: "Regular expression matching URLs to block (e.g. 'annoying-banners\\.com')", type: "string[]" },
 	"browser-server": { description: "Server to connect to", type: "string" },
 	"browser-headless": { description: "Run the browser in headless mode", type: "boolean", defaultValue: true },
 	"browser-executable-path": { description: "Path to chrome/chromium executable", type: "string" },
 	"browser-width": { description: "Width of the browser viewport in pixels", type: "number", defaultValue: 1280 },
 	"browser-height": { description: "Height of the browser viewport in pixels", type: "number", defaultValue: 720 },
-	"browser-load-max-time": { description: "Maximum delay of time to wait for page loading in ms", type: "number", defaultValue: 60000 },
+	"browser-load-max-time": { description: "Maximum delay of time to wait for loading the page in ms", type: "number", defaultValue: 60000 },
+	"browser-capture-max-time": { description: "Maximum delay of time to wait for capturing the page in ms", type: "number", defaultValue: 60000 },
 	"browser-wait-delay": { description: "Time to wait before capturing the page in ms", type: "number" },
 	"browser-wait-until": { description: "When to consider the page is loaded (InteractiveTime, networkIdle, networkAlmostIdle, load, domContentLoaded)", type: "string", defaultValue: "networkIdle" },
 	"browser-wait-until-delay": { description: "Delay of time in ms to wait before considering the page is loaded when the value of --browser-wait-until is reached", type: "number", defaultValue: 1000 },
@@ -67,6 +69,7 @@ const OPTIONS_INFO = {
 	"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" },
+	"debug-messages-file": { description: "Path of the file where to save the debug messages", 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" },
@@ -146,7 +149,7 @@ const OPTIONS_INFO = {
 	"resolve-links": { description: "Resolve link URLs to absolute URLs", type: "boolean", defaultValue: true },
 	"settings-file": { description: "Path to a JSON file containing the settings exported from the web extension", type: "string" },
 	"settings-file-profile": { description: "Name of the profile to use when using --settings-file", type: "string", defaultValue: "default" },
-	"group-duplicate-stylesheets": { description: "Group duplicate inline stylesheets into a single stylesheet in order to reduce the size of the page", type: "boolean", defaultValue: true }
+	"group-duplicate-stylesheets": { description: "Group duplicate inline stylesheets into a single stylesheet in order to reduce the size of the page", type: "boolean", defaultValue: false }
 };
 
 const { args, exit } = Deno;
@@ -189,7 +192,7 @@ function getOptions() {
 	return { ...options, url: positionals[0], output: positionals[1] };
 }
 
-function parseArgs(args) {
+function parseArgs(args, setDefaultValues = true) {
 	const positionals = [];
 	const options = {};
 	const result = { positionals, options: {} };
@@ -244,20 +247,33 @@ function parseArgs(args) {
 		}
 		result.options[optionKey] = optionValue;
 	});
-	Object.keys(OPTIONS_INFO).forEach(optionName => {
-		const optionInfo = getOptionInfo(optionName);
-		const optionKey = getOptionKey(optionName, optionInfo);
-		if (result.options[optionKey] === undefined && optionInfo.defaultValue !== undefined) {
-			result.options[optionKey] = OPTIONS_INFO[optionName].defaultValue;
-		}
-	});
-	result.options.acceptHeaders = {
-		font: result.options.acceptHeaderFont,
-		image: result.options.acceptHeaderImage,
-		stylesheet: result.options.acceptHeaderStylesheet,
-		script: result.options.acceptHeaderScript,
-		document: result.options.acceptHeaderDocument
-	};
+	if (setDefaultValues) {
+		Object.keys(OPTIONS_INFO).forEach(optionName => {
+			const optionInfo = getOptionInfo(optionName);
+			const optionKey = getOptionKey(optionName, optionInfo);
+			if (result.options[optionKey] === undefined && optionInfo.defaultValue !== undefined) {
+				result.options[optionKey] = OPTIONS_INFO[optionName].defaultValue;
+			}
+		});
+	}
+	if (result.options.acceptHeaderFont ||
+		result.options.acceptHeaderImage ||
+		result.options.acceptHeaderStylesheet ||
+		result.options.acceptHeaderScript ||
+		result.options.acceptHeaderDocument) {
+		result.options.acceptHeaders = {
+			font: result.options.acceptHeaderFont,
+			image: result.options.acceptHeaderImage,
+			stylesheet: result.options.acceptHeaderStylesheet,
+			script: result.options.acceptHeaderScript,
+			document: result.options.acceptHeaderDocument
+		};
+		delete result.options.acceptHeaderFont;
+		delete result.options.acceptHeaderImage;
+		delete result.options.acceptHeaderStylesheet;
+		delete result.options.acceptHeaderScript;
+		delete result.options.acceptHeaderDocument;
+	}
 	if (result.options.browserArgs) {
 		const browserArguments = result.options.browserArguments || [];
 		browserArguments.push(...JSON.parse(result.options.browserArgs));
@@ -304,11 +320,10 @@ function parseArgs(args) {
 		result.options.insertMetaCSP = result.options.insertMetaCsp;
 		delete result.options.insertMetaCsp;
 	}
-	delete result.options.acceptHeaderFont;
-	delete result.options.acceptHeaderImage;
-	delete result.options.acceptHeaderStylesheet;
-	delete result.options.acceptHeaderScript;
-	delete result.options.acceptHeaderDocument;
+	if (result.options.blockedUrlPatterns) {
+		result.options.blockedURLPatterns = result.options.blockedUrlPatterns;
+		delete result.options.blockedUrlPatterns;
+	}
 	return result;
 }
 

package/package.json

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

package/single-file-cli-api.js

@@ -39,8 +39,9 @@ const DEFAULT_OPTIONS = {
 	filenameTemplate: "{page-title} ({date-locale} {time-locale}).html",
 	filenameMaxLength: 192,
 	filenameMaxLengthUnit: "bytes",
-	filenameReplacedCharacters: ["~", "+", "\\\\", "?", "%", "*", ":", "|", "\"", "<", ">", "\x00-\x1f", "\x7F"],
+	filenameReplacedCharacters: ["~", "+", "?", "%", "*", ":", "|", "\"", "<", ">", "\\\\", "\x00-\x1f", "\x7F"],
 	filenameReplacementCharacter: "_",
+	filenameReplacementCharacters: ["～", "＋", "？", "％", "＊", "：", "｜", "＂", "＜", "＞", "＼"],
 	maxResourceSize: 10,
 	backgroundSave: true,
 	removeAlternativeFonts: true,
@@ -194,6 +195,7 @@ function testMaxDepth(task) {
 }
 
 async function createTask(url, options, parentTask, rootTaskURL) {
+	options.originalUrl = url;
 	url = parentTask ? rewriteURL(url, options.crawlRemoveURLFragment, options.crawlRewriteRules) : url;
 	if (url) {
 		if (!VALID_URL_TEST.test(url)) {
@@ -262,6 +264,10 @@ async function capturePage(options) {
 		if (options.consoleMessagesFile && pageData.consoleMessages) {
 			await writeTextFile(options.consoleMessagesFile, JSON.stringify(pageData.consoleMessages, null, 2));
 		}
+		if (options.debugMessagesFile && pageData.debugMessages) {
+			await writeTextFile(options.debugMessagesFile, pageData.debugMessages.map(([timestamp, message]) =>
+				`[${new Date(timestamp).toISOString()}] ${message.join(" ")}`).join("\n"));
+		}
 		if (options.outputJson) {
 			if (content instanceof Uint8Array) {
 				const fileReader = new FileReader();
@@ -316,6 +322,13 @@ async function capturePage(options) {
 		} else {
 			console.error(error.message || error, message); // eslint-disable-line no-console
 		}
+		if (options.consoleMessagesFile && error.consoleMessages) {
+			await writeTextFile(options.consoleMessagesFile, JSON.stringify(error.consoleMessages, null, 2));
+		}
+		if (options.debugMessagesFile && error.debugMessages) {
+			await writeTextFile(options.debugMessagesFile, error.debugMessages.map(([timestamp, message]) =>
+				`[${new Date(timestamp).toISOString()}] ${message.join(" ")}`).join("\n"));
+		}
 	}
 }
 

package/single-file-launcher.js

@@ -182,7 +182,7 @@ async function getUrlsFile(urlsFile) {
 			if (lastCharIndex < argsString.length) {
 				args.push(argsString.substring(lastCharIndex).trim());
 			}
-			const { options } = parseArgs(args);
+			const { options } = parseArgs(args, false);
 			return [url, options];
 		} else {
 			return value;