switched to ESM, abandoning CommonJS

Author: FND

bin/faucet

@@ -1,8 +1,6 @@
 #!/usr/bin/env node
-"use strict";
-
-let { faucetDispatch } = require("../lib");
-let { parseCLI } = require("../lib/cli");
+import { faucetDispatch } from "../lib/index.js";
+import { parseCLI } from "../lib/cli.js";
 
 parseCLI().
 	then(({ referenceDir, config, options }) => {

lib/cli.js

@@ -1,8 +1,6 @@
-"use strict";
-
-let { readConfig } = require("./config");
-let { abort, repr } = require("./util");
-let parseArgs = require("minimist");
+import { readConfig } from "./config.js";
+import { abort, repr } from "./util/index.js";
+import parseArgs from "minimist";
 
 let HELP = `
 Usage:
@@ -27,7 +25,7 @@ Options:
     serve generated files via HTTP with live reloading
 `.trim();
 
-exports.parseCLI = async function parseCLI(argv = process.argv.slice(2), help = HELP) {
+export async function parseCLI(argv = process.argv.slice(2), help = HELP) {
 	argv = parseArgs(argv, {
 		boolean: ["watch", "fingerprint", "sourcemaps", "compact"],
 		alias: {
@@ -58,4 +56,4 @@ exports.parseCLI = async function parseCLI(argv = process.argv.slice(2), help =
 	let rootDir = process.cwd();
 	let { referenceDir, config } = await readConfig(rootDir, argv.config);
 	return { referenceDir, config, options };
-};
+}

lib/config.js

@@ -1,11 +1,9 @@
-"use strict";
+import path from "path";
 
-let path = require("path");
-
-exports.readConfig = async function readConfig(rootDir, filepath = "faucet.config.js") {
+export async function readConfig(rootDir, filepath = "faucet.config.js") {
 	let configPath = path.resolve(rootDir, filepath);
 	return {
 		referenceDir: path.dirname(configPath),
-		config: await require(configPath)
+		config: await import(configPath)
 	};
-};
+}

lib/index.js

@@ -1,14 +1,12 @@
-"use strict";
+import { liveServer, staticServer } from "./server.js";
+import { pluginsByBucket } from "./plugins.js";
+import { AssetManager } from "./manager.js";
+import { resolvePath } from "./util/resolve.js";
+import { abort, repr } from "./util/index.js";
+import { SerializedRunner } from "./util/runner.js";
+import browserslist from "browserslist";
 
-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");
-
-exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
+export async function faucetDispatch(referenceDir, config,
 		{ watch, fingerprint, sourcemaps, compact, serve, liveserve }) {
 	config = await config;
 
@@ -51,19 +49,19 @@ exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
 		abort("ERROR: serve and liveserve must not be used together");
 	}
 	if(serve) {
-		server.static(serve, assetManager.manifest.webRoot);
+		staticServer(serve, assetManager.manifest.webRoot);
 	} else if(liveserve) {
-		server.live(liveserve, assetManager.manifest.webRoot);
+		liveServer(liveserve, assetManager.manifest.webRoot);
 	}
-};
+}
 
 function buildStep(plugins) {
 	return files => Promise.all(plugins.map(plugin => plugin(files))).
 		then(() => files);
 }
 
 async function makeWatcher(watchDirs, referenceDir) {
-	let niteOwl = await require("nite-owl");
+	let niteOwl = await import("nite-owl");
 
 	if(watchDirs) {
 		watchDirs = watchDirs.map(dir => resolvePath(dir, referenceDir,

lib/manager.js

@@ -1,12 +1,10 @@
-"use strict";
+import { Manifest } from "./manifest.js";
+import { createFile } from "./util/files/index.js";
+import { resolvePath } from "./util/resolve.js";
+import { reportFileStatus, abort, generateFingerprint } from "./util/index.js";
+import path from "path";
 
-let { Manifest } = require("./manifest");
-let { createFile } = require("./util/files");
-let { resolvePath } = require("./util/resolve");
-let { reportFileStatus, abort, generateFingerprint } = require("./util");
-let path = require("path");
-
-exports.AssetManager = class AssetManager {
+export class AssetManager {
 	constructor(referenceDir, { manifestConfig, fingerprint, exitOnError } = {}) {
 		this.referenceDir = referenceDir;
 		this.fingerprint = fingerprint;
@@ -57,4 +55,4 @@ exports.AssetManager = class AssetManager {
 		actualPath = path.relative(referenceDir, actualPath);
 		return this.manifest.set(originalPath, actualPath, targetDir);
 	}
-};
+}

lib/manifest.js

@@ -1,11 +1,9 @@
-"use strict";
+import { createFile } from "./util/files/index.js";
+import { resolvePath } from "./util/resolve.js";
+import { abort } from "./util/index.js";
+import path from "path";
 
-let { createFile } = require("./util/files");
-let { resolvePath } = require("./util/resolve");
-let { abort } = require("./util");
-let path = require("path");
-
-exports.Manifest = class Manifest {
+export class Manifest {
 	constructor(referenceDir, { target, key, value, baseURI, webRoot } = {}) {
 		if(value && (baseURI || webRoot)) {
 			abort("ERROR: `value` must not be used with `baseURI` and/or `webRoot`");
@@ -52,4 +50,4 @@ exports.Manifest = class Manifest {
 			return memo;
 		}, {});
 	}
-};
+}

lib/plugins.js

@@ -1,6 +1,4 @@
-"use strict";
-
-let { loadExtension, abort, repr } = require("./util");
+import { loadExtension, abort, repr } from "./util/index.js";
 
 // common plugins included for convenience
 let DEFAULTS = [{
@@ -26,15 +24,10 @@ let DEFAULT_KEYS = DEFAULTS.reduce((memo, plugin) => {
 }, new Set());
 let BUCKETS = new Set(["static", "scripts", "styles", "markup"]);
 
-module.exports = {
-	pluginsByBucket,
-	_determinePlugins: determinePlugins
-};
-
 // returns plugin functions grouped by bucket and filtered by relevance (based
 // on configuration)
-async function pluginsByBucket(config, defaults) {
-	let plugins = await determinePlugins(config.plugins, defaults);
+export async function pluginsByBucket(config, defaults) {
+	let plugins = await _determinePlugins(config.plugins, defaults);
 	let buckets = [...BUCKETS].reduce((memo, bucket) => {
 		memo[bucket] = [];
 		return memo;
@@ -60,7 +53,7 @@ async function pluginsByBucket(config, defaults) {
 // `plugins` is an array of plugins, each either a package identifier or a
 // `{ key, bucket, plugin }` object`, with `key` being the configuration key and
 // `plugin` being either a function or a package identifier
-async function determinePlugins(plugins = [], defaults = DEFAULTS) {
+export async function _determinePlugins(plugins = [], defaults = DEFAULTS) {
 	let registry = {};
 	// NB: default plugins are resolved lazily because eager loading would
 	//     result in them becoming a hard dependency rather than a convenience

lib/server.js

@@ -1,28 +1,24 @@
-let { loadExtension, abort, repr } = require("./util");
+import { loadExtension, abort, repr } from "./util/index.js";
 
 let DEFAULTS = {
 	host: "localhost",
 	port: 3000
 };
 
-exports.static = async (config, webroot) => {
-	let donny = await loadExtension("donny", "failed to activate server");
-	let [host, port] = parseHost(config);
+export async function liveServer(config, root) {
+	let server = await loadExtension("live-server", "failed to activate live-server");
+	let [host, port] = _parseHost(config);
+	server.start({ port, host, root, open: false });
+}
 
+export async function staticServer(config, webroot) {
+	let donny = await loadExtension("donny", "failed to activate server");
+	let [host, port] = _parseHost(config);
 	await donny({ port, bind: host, 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) {
+export function _parseHost(config) {
 	let { host, port } = DEFAULTS;
 	if(config === true) {
 		return [host, port];

lib/util/files/finder.js

@@ -1,7 +1,7 @@
-let { readdir, stat } = require("fs/promises");
-let path = require("path");
+import { readdir, stat } from "fs/promises";
+import path from "path";
 
-exports.FileFinder = class FileFinder {
+export class FileFinder {
 	constructor(directory, { skipDotfiles, filter = () => true } = {}) {
 		this.directory = directory;
 		this.filter = filename => {
@@ -23,7 +23,7 @@ exports.FileFinder = class FileFinder {
 		return filesWithinDirectory(this.directory, filepaths).
 			then(filepaths => filepaths.filter(this.filter));
 	}
-};
+}
 
 function tree(filepath, referenceDir = filepath) {
 	return stat(filepath).

lib/util/files/index.js

@@ -1,14 +1,12 @@
-"use strict";
-
-let { writeFile } = require("fs/promises");
-let { mkdirSync } = require("fs");
-let path = require("path");
+import { writeFile } from "fs/promises";
+import { mkdirSync } from "fs";
+import path from "path";
 
 let KNOWN = new Set(); // avoids redundant `mkdir` invocations
 let LOCKS = new Map();
 
 // avoids concurrent write operations and creates target directory if necessary
-exports.createFile = function createFile(filepath, contents) {
+export function createFile(filepath, contents) {
 	let lock = LOCKS.get(filepath);
 	if(lock) { // defer
 		return lock.then(() => createFile(filepath, contents));
@@ -25,4 +23,4 @@ exports.createFile = function createFile(filepath, contents) {
 	return prom.then(() => {
 		LOCKS.delete(filepath);
 	});
-};
+}