v3.1.0

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:
@@ -23,8 +23,6 @@ Options:
     reduce output size (where supported)
   --serve [HOST:]PORT
     serve generated files via HTTP
-  --liveserve [HOST:]PORT
-    serve generated files via HTTP with live reloading
 `.trim();
 
 exports.parseCLI = async function parseCLI() {
@@ -37,7 +35,8 @@ exports.parseCLI = async function parseCLI() {
 			},
 			config: {
 				type: "string",
-				short: "c"
+				short: "c",
+				default: "faucet.config.js"
 			},
 			watch: {
 				type: "boolean",
@@ -69,21 +68,14 @@ 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
-	};
-
-	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");
+	if(values.liveserve) {
+		abort("The --liveserve option was removed. Please use --serve instead", 0);
 	}
 
-	let rootDir = process.cwd();
-	let { referenceDir, config } = await readConfig(rootDir, values.config);
-	return { referenceDir, config, options };
+	let configPath = path.resolve(process.cwd(), values.config);
+	return {
+		referenceDir: path.dirname(configPath),
+		config: await require(configPath),
+		options: values
+	};
 };

lib/index.js

@@ -3,30 +3,22 @@
 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 browserslist = require("browserslist");
+let { abort, repr, resolvePath, loadExtension } = require("./util");
+let { SerializedRunner } = require("./runner");
 
 exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
-		{ watch, fingerprint, sourcemaps, compact, serve, liveserve }) {
-	config = await config;
-
+		{ watch, fingerprint, sourcemaps, compact, serve }) {
 	let assetManager = new AssetManager(referenceDir, {
 		manifestConfig: config.manifest,
 		fingerprint,
 		exitOnError: !watch
 	});
-	let browsers = browserslist.findConfig(referenceDir) || {};
-	if(browsers.substr) {
-		browsers = [browsers];
-	}
 
 	let plugins = await pluginsByBucket(config);
 	// initialize plugins with corresponding configuration
 	let buckets = Object.keys(plugins).reduce((memo, bucket) => {
 		memo[bucket] = plugins[bucket].map(({ plugin, config }) => {
-			return plugin(config, assetManager, { browsers, sourcemaps, compact });
+			return plugin(config, assetManager, { sourcemaps, compact });
 		});
 		return memo;
 	}, {});
@@ -39,21 +31,18 @@ exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
 	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) {
-		abort("ERROR: serve and liveserve must not be used together");
-	}
 	if(serve) {
 		server.static(serve, assetManager.manifest.webRoot);
-	} else if(liveserve) {
-		server.live(liveserve, assetManager.manifest.webRoot);
 	}
 };
 
@@ -63,7 +52,8 @@ function buildStep(plugins) {
 }
 
 async function makeWatcher(watchDirs, referenceDir) {
-	let niteOwl = await require("nite-owl");
+	// XXX: Rename to faucet-pipeline-watch?
+	let niteOwl = await loadExtension("nite-owl", "failed to activate watching");
 
 	if(watchDirs) {
 		watchDirs = watchDirs.map(dir => resolvePath(dir, referenceDir,

lib/manager.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/manifest.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 {
@@ -12,6 +11,7 @@
 		}
 		this.webRoot = webRoot = resolvePath(webRoot || "./", referenceDir,
 				{ enforceRelative: true });
+		this.baseURI = baseURI || "/";
 
 		if(target) {
 			this.filepath = resolvePath(target, referenceDir, { enforceRelative: true });
@@ -27,8 +27,7 @@
 		if(value) {
 			this.valueTransform = value;
 		} else {
-			baseURI = baseURI || "/";
-			this.valueTransform = filepath => baseURI + path.relative(webRoot, filepath);
+			this.valueTransform = filepath => this.baseURI + path.relative(webRoot, filepath);
 		}
 	}
 

lib/plugins.js

@@ -15,6 +15,10 @@ let DEFAULTS = [{
 	key: "static",
 	bucket: "static",
 	plugin: "faucet-pipeline-static"
+}, {
+	key: "assets",
+	bucket: "static",
+	plugin: "faucet-pipeline-static"
 }, {
 	key: "images",
 	bucket: "static",

lib/util/runner.js → lib/runner.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/server.js

@@ -13,13 +13,6 @@ exports.static = async (config, webroot) => {
 	console.error(`serving ${repr(webroot)} at http://${host}:${port}`);
 };
 
-exports.live = async (config, root) => {
-	let liveServer = await loadExtension("live-server", "failed to activate live-server");
-	let [host, port] = parseHost(config);
-
-	liveServer.start({ port, host, root, open: false });
-};
-
 exports._parseHost = parseHost;
 
 function parseHost(config) {

lib/types.ts

@@ -0,0 +1,26 @@
+export interface FaucetPlugin<T> {
+	(config: T[], assetManager: AssetManager, options: FaucetPluginOptions): FaucetPluginFunc
+}
+
+export interface FaucetPluginFunc {
+	(filepaths: string[]): Promise<unknown>
+}
+
+export interface FaucetPluginOptions {
+	sourcemaps: boolean,
+	compact: boolean
+}
+
+export interface AssetManager {
+	resolvePath: (path: string, opts?: ResolvePathOpts) => string
+	writeFile: (targetPath: string, content: Buffer, options: WriteFileOpts) => Promise<unknown>
+}
+
+export interface ResolvePathOpts {
+	enforceRelative?: boolean
+}
+
+export interface WriteFileOpts {
+	targetDir: string,
+	fingerprint?: boolean
+}