cleaned up

This is a breaking change.

* FileFinder is removed (pending based on the static/images work)
* resolvePath is moved into util/index.js (this is a breaking change
  for aiur)
* generateFingerprint is moved into lib/manager.js as it is the
  only place where it is used (the test is moved accordingly)
* SerializedRunner is moved to lib, as it is only used in core

Author: moonglum

lib/cli.js

@@ -1,8 +1,8 @@
 "use strict";
 
-let { readConfig } = require("./config");
 let { abort, repr } = require("./util");
 let { parseArgs } = require("node:util");
+let path = require("node:path");
 
 let HELP = `
 Usage:
@@ -37,7 +37,8 @@ exports.parseCLI = async function parseCLI() {
 			},
 			config: {
 				type: "string",
-				short: "c"
+				short: "c",
+				default: "faucet.config.js"
 			},
 			watch: {
 				type: "boolean",
@@ -69,21 +70,10 @@ exports.parseCLI = async function parseCLI() {
 		abort(HELP, 0);
 	}
 
-	let options = {
-		watch: values.watch,
-		fingerprint: values.fingerprint,
-		sourcemaps: values.sourcemaps,
-		compact: values.compact,
-		serve: values.serve,
-		liveserve: values.liveserve
+	let configPath = path.resolve(process.cwd(), values.config);
+	return {
+		referenceDir: path.dirname(configPath),
+		config: await require(configPath),
+		options: values
 	};
-
-	if(options.watch && options.fingerprint) { // for convenience
-		console.error("you might consider disabling fingerprinting in watch " +
-				"mode to avoid littering your file system with obsolete bundles");
-	}
-
-	let rootDir = process.cwd();
-	let { referenceDir, config } = await readConfig(rootDir, values.config);
-	return { referenceDir, config, options };
 };

lib/config.js

@@ -3,15 +3,12 @@
 let server = require("./server");
 let { pluginsByBucket } = require("./plugins");
 let { AssetManager } = require("./manager");
-let { resolvePath } = require("./util/resolve");
-let { abort, repr } = require("./util");
-let { SerializedRunner } = require("./util/runner");
+let { abort, repr, resolvePath } = require("./util");
+let { SerializedRunner } = require("./runner");
 let browserslist = require("browserslist");
 
 exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
 		{ watch, fingerprint, sourcemaps, compact, serve, liveserve }) {
-	config = await config;
-
 	let assetManager = new AssetManager(referenceDir, {
 		manifestConfig: config.manifest,
 		fingerprint,
@@ -39,12 +36,14 @@ exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
 	let res = runner.run();
 
 	if(watch) {
-		makeWatcher(config.watchDirs, referenceDir).
-			then(watcher => {
-				watcher.on("edit", filepaths => {
-					runner.rerun(filepaths);
-				});
-			});
+		if(fingerprint) {
+			console.error("you might consider disabling fingerprinting in watch " +
+					"mode to avoid littering your file system with obsolete bundles");
+		}
+		let watcher = await makeWatcher(config.watchDirs, referenceDir);
+		watcher.on("edit", filepaths => {
+			runner.rerun(filepaths);
+		});
 	}
 
 	if(serve && liveserve) {

lib/index.js

@@ -2,9 +2,9 @@
 
 let { Manifest } = require("./manifest");
 let { createFile } = require("./util/files");
-let { resolvePath } = require("./util/resolve");
-let { reportFileStatus, abort, generateFingerprint } = require("./util");
+let { reportFileStatus, abort, resolvePath } = require("./util");
 let path = require("path");
+let crypto = require("crypto");
 
 exports.AssetManager = class AssetManager {
 	constructor(referenceDir, { manifestConfig, fingerprint, exitOnError } = {}) {
@@ -43,18 +43,27 @@ exports.AssetManager = class AssetManager {
 			});
 	}
 
-	get packagesDir() {
-		let memo = this._packagesDir;
-		if(!memo) {
-			memo = this._packagesDir = this.resolvePath("./node_modules");
-		}
-		return memo;
-	}
-
 	_updateManifest(originalPath, actualPath, targetDir) {
 		let { referenceDir } = this;
 		originalPath = path.relative(referenceDir, originalPath);
 		actualPath = path.relative(referenceDir, actualPath);
 		return this.manifest.set(originalPath, actualPath, targetDir);
 	}
 };
+
+function generateFingerprint(filepath, data) {
+	let filename = path.basename(filepath);
+	let ext = filename.indexOf(".") === -1 ? "" : "." + filename.split(".").pop();
+	let name = ext.length === 0 ? filename : path.basename(filepath, ext);
+	let hash = generateHash(data);
+	return path.join(path.dirname(filepath), `${name}-${hash}${ext}`);
+}
+
+// exported for testing
+exports.generateFingerprint = generateFingerprint;
+
+function generateHash(str) {
+	let hash = crypto.createHash("md5");
+	hash.update(str);
+	return hash.digest("hex");
+}

lib/manager.js

@@ -1,8 +1,7 @@
 "use strict";
 
 let { createFile } = require("./util/files");
-let { resolvePath } = require("./util/resolve");
-let { abort } = require("./util");
+let { abort, resolvePath } = require("./util");
 let path = require("path");
 
 exports.Manifest = class Manifest {

lib/manifest.js

@@ -7,7 +7,7 @@ exports.SerializedRunner = class SerializedRunner {
 
 	run(...args) {
 		if(!this._pending) { // prevent concurrent execution
-			this._pending = augment(this.asyncOp(...args)).
+			this._pending = this.asyncOp(...args).
 				finally(() => {
 					this._pending = null;
 				});
@@ -24,7 +24,7 @@ exports.SerializedRunner = class SerializedRunner {
 		let enqueue = this._pending;
 		let res = this.run(...args);
 		if(enqueue) {
-			this._queued = res = augment(res).
+			this._queued = res = res.
 				finally(() => {
 					this._queued = null;
 				}).
@@ -33,20 +33,3 @@ exports.SerializedRunner = class SerializedRunner {
 		return res;
 	}
 };
-
-function augment(promise) {
-	promise.finally = always;
-	return promise;
-}
-
-// poor man's `Promise#finally` polyfill
-function always(fn) {
-	return this.
-		then(res => {
-			fn();
-			return res;
-		}, err => {
-			fn();
-			throw err;
-		});
-}

lib/util/runner.js renamed to lib/runner.js

@@ -1,10 +1,7 @@
 "use strict";
 
+let fs = require("fs");
 let path = require("path");
-let crypto = require("crypto");
-
-exports.abort = abort;
-exports.repr = repr;
 
 // reports success or failure for a given file path (typically regarding
 // compilation or write operations)
@@ -26,28 +23,39 @@ exports.loadExtension = async (pkg, errorMessage, supplier = pkg) => {
 	}
 };
 
-exports.generateFingerprint = (filepath, data) => {
-	let filename = path.basename(filepath);
-	let ext = filename.indexOf(".") === -1 ? "" : "." + filename.split(".").pop();
-	let name = ext.length === 0 ? filename : path.basename(filepath, ext);
-	let hash = generateHash(data);
-	return path.join(path.dirname(filepath), `${name}-${hash}${ext}`);
-};
-
 function abort(msg, code = 1) {
 	console.error(msg);
 	process.exit(code);
 }
+exports.abort = abort;
 
 function repr(value, jsonify = true) {
 	if(jsonify) {
 		value = JSON.stringify(value);
 	}
 	return `\`${value}\``;
 }
+exports.repr = repr;
 
-function generateHash(str) {
-	let hash = crypto.createHash("md5");
-	hash.update(str);
-	return hash.digest("hex");
-}
+exports.resolvePath = (filepath, referenceDir, { enforceRelative } = {}) => {
+	if(/^\.?\.\//.test(filepath)) { // starts with `./` or `../`
+		return path.resolve(referenceDir, filepath);
+	} else if(enforceRelative) {
+		abort(`ERROR: path must be relative: ${repr(filepath)}`);
+	} else { // attempt via Node resolution algorithm
+		try {
+			return require.resolve(filepath, { paths: [referenceDir] });
+		} catch(err) {
+			// attempt to resolve non-JavaScript package references by relying
+			// on typical package paths (simplistic approximation of Node's
+			// resolution algorithm)
+			let resolved = path.resolve(referenceDir, "node_modules", filepath);
+			try {
+				fs.statSync(resolved); // ensures file/directory exists
+			} catch(_err) {
+				abort(`ERROR: could not resolve ${repr(filepath)}`);
+			}
+			return resolved;
+		}
+	}
+};