Breaking Change: ESM Modules & rename from "static" to "files"

Author: moonglum

lib/index.js

@@ -1,19 +1,12 @@
-let { FileFinder } = require("./util.js");
-let { readFile, stat } = require("node:fs/promises");
-let path = require("node:path");
+import { FileFinder } from "./util.js";
+import { readFile, stat } from "node:fs/promises";
+import * as path from "node:path";
 
-module.exports = {
-	key: "static",
-	bucket: "static",
-	plugin: faucetStatic
-};
+export const key = "files";
+export const bucket = "static";
 
-/**
- * The static plugin copies files with an option to define compaction functions
- *
- * @type FaucetPlugin<Config>
- */
-function faucetStatic(config, assetManager, { compact } = {}) {
+/** @type FaucetPlugin<Config> */
+export function plugin(config, assetManager, { compact } = {}) {
 	let copiers = config.map(copyConfig =>
 		makeCopier(copyConfig, assetManager, { compact }));
 

lib/util.js

@@ -1,7 +1,7 @@
-let { readdir, stat } = require("node:fs/promises");
-let path = require("node:path");
+import { readdir, stat } from "node:fs/promises";
+import * as path from "node:path";
 
-exports.FileFinder = class FileFinder {
+export class FileFinder {
 	/**
 	 * @param {string} root
 	 * @param {FileFinderOptions} options
@@ -42,7 +42,7 @@ exports.FileFinder = class FileFinder {
 			filter(filename => !filename.startsWith("..")).
 			filter(this._filter);
 	}
-};
+}
 
 /**
  * flat list of all files of a directory tree

package.json

@@ -3,6 +3,7 @@
 	"version": "2.1.0",
 	"description": "static files for faucet-pipeline",
 	"main": "lib/index.js",
+	"type": "module",
 	"scripts": {
 		"test": "npm run lint && npm run typecheck && npm run test:cli",
 		"test:cli": "./test/run",

test/test_basic/faucet.config.js

@@ -1,10 +1,8 @@
-"use strict";
-let path = require("path");
+import { resolve } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src",
-		target: "./dist"
-	}],
-	plugins: [path.resolve(__dirname, "../..")]
-};
+export const files = [{
+	source: "./src",
+	target: "./dist"
+}];
+
+export const plugins = [resolve(import.meta.dirname, "../..")];

test/test_fingerprint/faucet.config.js

@@ -1,13 +1,12 @@
-"use strict";
-let path = require("path");
+import { resolve } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src",
-		target: "./dist"
-	}],
-	manifest: {
-		target: "./dist/manifest.json"
-	},
-	plugins: [path.resolve(__dirname, "../..")]
+export const files = [{
+	source: "./src",
+	target: "./dist"
+}];
+
+export const manifest = {
+	target: "./dist/manifest.json"
 };
+
+export const plugins = [resolve(import.meta.dirname, "../..")];

test/test_key_config/faucet.config.js

@@ -1,14 +1,13 @@
-"use strict";
-let path = require("path");
+import { resolve, relative } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src",
-		target: "./dist"
-	}],
-	manifest: {
-		target: "./dist/manifest.json",
-		key: (f, targetDir) => path.relative(targetDir, f)
-	},
-	plugins: [path.resolve(__dirname, "../..")]
+export const files = [{
+	source: "./src",
+	target: "./dist"
+}];
+
+export const manifest = {
+	target: "./dist/manifest.json",
+	key: (f, targetDir) => relative(targetDir, f)
 };
+
+export const plugins = [resolve(import.meta.dirname, "../..")];

test/test_key_for_single_file/faucet.config.js

@@ -1,14 +1,13 @@
-"use strict";
-let path = require("path");
+import { resolve, relative } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src/test.txt",
-		target: "./dist/test.txt"
-	}],
-	manifest: {
-		target: "./dist/manifest.json",
-		key: (f, targetDir) => path.relative(targetDir, f)
-	},
-	plugins: [path.resolve(__dirname, "../..")]
+export const files = [{
+	source: "./src/test.txt",
+	target: "./dist/test.txt"
+}];
+
+export const manifest = {
+	target: "./dist/manifest.json",
+	key: (f, targetDir) => relative(targetDir, f)
 };
+
+export const plugins = [resolve(import.meta.dirname, "../..")];

test/test_manifest_base_uri/faucet.config.js

@@ -1,14 +1,13 @@
-"use strict";
-let path = require("path");
+import { resolve, relative } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src",
-		target: "./dist"
-	}],
-	manifest: {
-		target: "./dist/manifest.json",
-		value: f => `/assets/${path.relative("./dist", f)}`
-	},
-	plugins: [path.resolve(__dirname, "../..")]
+export const files = [{
+	source: "./src",
+	target: "./dist"
+}];
+
+export const manifest = {
+	target: "./dist/manifest.json",
+	value: f => `/assets/${relative("./dist", f)}`
 };
+
+export const plugins = [resolve(import.meta.dirname, "../..")];

test/test_match_dirname/faucet.config.js

@@ -1,11 +1,9 @@
-"use strict";
-let path = require("path");
+import { resolve } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src",
-		target: "./dist",
-		filter: path => path.startsWith("inner/")
-	}],
-	plugins: [path.resolve(__dirname, "../..")]
-};
+export const files = [{
+	source: "./src",
+	target: "./dist",
+	filter: path => path.startsWith("inner/")
+}];
+
+export const plugins = [resolve(import.meta.dirname, "../..")];

test/test_match_extension/faucet.config.js

@@ -1,11 +1,9 @@
-"use strict";
-let path = require("path");
+import { resolve } from "node:path";
 
-module.exports = {
-	static: [{
-		source: "./src",
-		target: "./dist",
-		filter: path => path.endsWith(".txt")
-	}],
-	plugins: [path.resolve(__dirname, "../..")]
-};
+export const files = [{
+	source: "./src",
+	target: "./dist",
+	filter: path => path.endsWith(".txt")
+}];
+
+export const plugins = [resolve(import.meta.dirname, "../..")];