[BREAKING] Transform module to ESM

.eslintrc.js → .eslintrc.cjs

@@ -1,4 +1,7 @@
 module.exports = {
+	"parserOptions": {
+		"sourceType": "module",
+	},
 	"env": {
 		"node": true,
 		"es2021": true

lib/AbstractReader.js

@@ -1,5 +1,5 @@
-const randomInt = require("random-int");
-const Trace = require("./tracing/Trace");
+import randomInt from "random-int";
+import Trace from "./tracing/Trace.js";
 
 /**
  * Abstract resource locator
@@ -168,4 +168,4 @@ class AbstractReader {
 	}
 }
 
-module.exports = AbstractReader;
+export default AbstractReader;

lib/AbstractReaderWriter.js

@@ -1,4 +1,4 @@
-const AbstractReader = require("./AbstractReader");
+import AbstractReader from "./AbstractReader.js";
 
 /**
  * Abstract resource locator
@@ -57,4 +57,4 @@ class AbstractReaderWriter extends AbstractReader {
 	}
 }
 
-module.exports = AbstractReaderWriter;
+export default AbstractReaderWriter;

lib/DuplexCollection.js

@@ -1,5 +1,5 @@
-const AbstractReaderWriter = require("./AbstractReaderWriter");
-const ReaderCollectionPrioritized = require("./ReaderCollectionPrioritized");
+import AbstractReaderWriter from "./AbstractReaderWriter.js";
+import ReaderCollectionPrioritized from "./ReaderCollectionPrioritized.js";
 
 /**
  * Wrapper to keep readers and writers together
@@ -90,4 +90,4 @@ class DuplexCollection extends AbstractReaderWriter {
 	}
 }
 
-module.exports = DuplexCollection;
+export default DuplexCollection;

lib/ReaderCollection.js

@@ -1,4 +1,4 @@
-const AbstractReader = require("./AbstractReader");
+import AbstractReader from "./AbstractReader.js";
 
 /**
  * Resource Locator ReaderCollection
@@ -79,4 +79,4 @@ class ReaderCollection extends AbstractReader {
 	}
 }
 
-module.exports = ReaderCollection;
+export default ReaderCollection;

lib/ReaderCollectionPrioritized.js

@@ -1,4 +1,4 @@
-const AbstractReader = require("./AbstractReader");
+import AbstractReader from "./AbstractReader.js";
 
 /**
  * Prioritized Resource Locator Collection
@@ -83,4 +83,4 @@ class ReaderCollectionPrioritized extends AbstractReader {
 	}
 }
 
-module.exports = ReaderCollectionPrioritized;
+export default ReaderCollectionPrioritized;

lib/Resource.js

@@ -1,6 +1,6 @@
-const stream = require("stream");
-const clone = require("clone");
-const path = require("path");
+import stream from "node:stream";
+import clone from "clone";
+import path from "node:path";
 
 const fnTrue = () => true;
 const fnFalse = () => false;
@@ -426,4 +426,4 @@ class Resource {
 	}
 }
 
-module.exports = Resource;
+export default Resource;

lib/ResourceFacade.js

@@ -192,4 +192,4 @@ class ResourceFacade {
 	}
 }
 
-module.exports = ResourceFacade;
+export default ResourceFacade;

lib/ResourceTagCollection.js

@@ -1,6 +1,6 @@
 const tagNamespaceRegExp = /^[a-z][a-z0-9]+$/; // part before the colon
 const tagNameRegExp = /^[A-Z][A-Za-z0-9]+$/; // part after the colon
-const ResourceFacade = require("./ResourceFacade");
+import ResourceFacade from "./ResourceFacade.js";
 
 class ResourceTagCollection {
 	constructor({allowedTags = [], allowedNamespaces = [], tags}) {
@@ -114,4 +114,4 @@ class ResourceTagCollection {
 	}
 }
 
-module.exports = ResourceTagCollection;
+export default ResourceTagCollection;

lib/WriterCollection.js

@@ -1,6 +1,6 @@
-const AbstractReaderWriter = require("./AbstractReaderWriter");
-const ReaderCollection = require("./ReaderCollection");
-const escapeStringRegExp = require("escape-string-regexp");
+import AbstractReaderWriter from "./AbstractReaderWriter.js";
+import ReaderCollection from "./ReaderCollection.js";
+import escapeStringRegExp from "escape-string-regexp";
 
 /**
  * Resource Locator WriterCollection
@@ -114,4 +114,4 @@ class WriterCollection extends AbstractReaderWriter {
 	}
 }
 
-module.exports = WriterCollection;
+export default WriterCollection;

lib/adapters/AbstractAdapter.js

@@ -1,8 +1,9 @@
-const log = require("@ui5/logger").getLogger("resources:adapters:AbstractAdapter");
-const minimatch = require("minimatch");
-const micromatch = require("micromatch");
-const AbstractReaderWriter = require("../AbstractReaderWriter");
-const Resource = require("../Resource");
+import logger from "@ui5/logger";
+const log = logger.getLogger("resources:adapters:AbstractAdapter");
+import minimatch from "minimatch";
+import micromatch from "micromatch";
+import AbstractReaderWriter from "../AbstractReaderWriter.js";
+import Resource from "../Resource.js";
 
 /**
  * Abstract Resource Adapter
@@ -203,4 +204,4 @@ class AbstractAdapter extends AbstractReaderWriter {
 	}
 }
 
-module.exports = AbstractAdapter;
+export default AbstractAdapter;

lib/adapters/FileSystem.js

@@ -1,13 +1,12 @@
-const log = require("@ui5/logger").getLogger("resources:adapters:FileSystem");
-const path = require("path");
-const {promisify} = require("util");
-const fs = require("graceful-fs");
-const copyFile = promisify(fs.copyFile);
-const chmod = promisify(fs.chmod);
-const globby = require("globby");
-const makeDir = require("make-dir");
-const {PassThrough} = require("stream");
-const AbstractAdapter = require("./AbstractAdapter");
+import logger from "@ui5/logger";
+const log = logger.getLogger("resources:adapters:FileSystem");
+import path from "node:path";
+import {promises as fs, createReadStream} from "node:fs";
+const {chmod, copyFile, stat} = fs;
+import globby from "globby";
+import makeDir from "make-dir";
+import {PassThrough} from "node:stream";
+import AbstractAdapter from "./AbstractAdapter.js";
 
 const READ_ONLY_MODE = 0o444;
 
@@ -55,7 +54,7 @@ class FileSystem extends AbstractAdapter {
 		const promises = [];
 		if (!opt.onlyFiles && patterns.includes("")) { // Match physical root directory
 			promises.push(new Promise((resolve, reject) => {
-				fs.stat(this._fsBasePath, (err, stat) => {
+				stat(this._fsBasePath, (err, stat) => {
 					if (err) {
 						reject(err);
 					} else {
@@ -68,7 +67,7 @@ class FileSystem extends AbstractAdapter {
 								fsPath: this._fsBasePath
 							},
 							createStream: () => {
-								return fs.createReadStream(this._fsBasePath);
+								return createReadStream(this._fsBasePath);
 							}
 						}));
 					}
@@ -91,7 +90,7 @@ class FileSystem extends AbstractAdapter {
 					const virPath = (this._virBasePath + matches[i]);
 
 					// Workaround for not getting the stat from the glob
-					fs.stat(fsPath, (err, stat) => {
+					stat(fsPath, (err, stat) => {
 						if (err) {
 							reject(err);
 						} else {
@@ -104,7 +103,7 @@ class FileSystem extends AbstractAdapter {
 									fsPath: fsPath
 								},
 								createStream: () => {
-									return fs.createReadStream(fsPath);
+									return createReadStream(fsPath);
 								}
 							}));
 						}
@@ -155,7 +154,7 @@ class FileSystem extends AbstractAdapter {
 			const fsPath = path.join(this._fsBasePath, relPath);
 
 			trace.pathCall();
-			fs.stat(fsPath, (err, stat) => {
+			stat(fsPath, (err, stat) => {
 				if (err) {
 					if (err.code === "ENOENT") { // "File or directory does not exist"
 						resolve(null);
@@ -178,7 +177,7 @@ class FileSystem extends AbstractAdapter {
 					if (!stat.isDirectory()) {
 						// Add content
 						options.createStream = function() {
-							return fs.createReadStream(fsPath);
+							return createReadStream(fsPath);
 						};
 					}
 
@@ -277,7 +276,7 @@ class FileSystem extends AbstractAdapter {
 				if (readOnly) {
 					// Create new stream from written file
 					resource.setStream(function() {
-						return fs.createReadStream(fsPath);
+						return createReadStream(fsPath);
 					});
 				}
 				resolve();
@@ -287,4 +286,4 @@ class FileSystem extends AbstractAdapter {
 	}
 }
 
-module.exports = FileSystem;
+export default FileSystem;

lib/adapters/Memory.js

@@ -1,6 +1,7 @@
-const log = require("@ui5/logger").getLogger("resources:adapters:Memory");
-const micromatch = require("micromatch");
-const AbstractAdapter = require("./AbstractAdapter");
+import logger from "@ui5/logger";
+const log = logger.getLogger("resources:adapters:Memory");
+import micromatch from "micromatch";
+import AbstractAdapter from "./AbstractAdapter.js";
 
 /**
  * Virtual resource Adapter
@@ -155,4 +156,4 @@ class Memory extends AbstractAdapter {
 	}
 }
 
-module.exports = Memory;
+export default Memory;

lib/fsInterface.js

@@ -15,7 +15,7 @@ function toPosix(inputPath) {
  * [<code>readdir</code>]{@link https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback} and
  * [<code>mkdir</code>]{@link https://nodejs.org/api/fs.html#fs_fs_mkdir_path_options_callback}
  */
-module.exports = (reader) => {
+export default (reader) => {
 	return {
 		readFile(fsPath, options, callback) {
 			if (typeof options === "function") {

lib/readers/Filter.js

@@ -1,4 +1,4 @@
-const AbstractReader = require("../AbstractReader");
+import AbstractReader from "../AbstractReader.js";
 
 /**
  * A reader that allows dynamic filtering of resources passed through it
@@ -70,4 +70,4 @@ class Filter extends AbstractReader {
 	}
 }
 
-module.exports = Filter;
+export default Filter;

lib/readers/Link.js

@@ -1,6 +1,6 @@
-const AbstractReader = require("../AbstractReader");
-const ResourceFacade = require("../ResourceFacade");
-const resourceFactory = require("../resourceFactory");
+import AbstractReader from "../AbstractReader.js";
+import ResourceFacade from "../ResourceFacade.js";
+import resourceFactory from "../resourceFactory.js";
 const log = require("@ui5/logger").getLogger("resources:readers:Link");
 
 /**
@@ -120,4 +120,4 @@ class Link extends AbstractReader {
 	}
 }
 
-module.exports = Link;
+export default Link;

lib/readers/Transformer.js

@@ -1,4 +1,4 @@
-const AbstractReader = require("../AbstractReader");
+import AbstractReader from "../AbstractReader.js";
 
 /**
  * A reader that allows modification of all resources passed through it.
@@ -65,7 +65,7 @@ class Transformer extends AbstractReader {
 			let resourceClone;
 			await this._callback(resource.getPath(), async function() {
 				// Make sure to only clone once
-				resourceClone = resourceClone || await resource.clone();
+				resourceClone = resourceClone || (await resource.clone());
 				return resourceClone;
 			});
 			return resourceClone || resource;
@@ -87,12 +87,12 @@ class Transformer extends AbstractReader {
 		if (resource) {
 			await this._callback(resource.getPath(), async function() {
 				// Make sure to only clone once
-				resourceClone = resourceClone || await resource.clone();
+				resourceClone = resourceClone || (await resource.clone());
 				return resourceClone;
 			});
 		}
 		return resourceClone || resource;
 	}
 }
 
-module.exports = Transformer;
+export default Transformer;

lib/resourceFactory.js

@@ -175,4 +175,4 @@ const resourceFactory = {
 	}
 };
 
-module.exports = resourceFactory;
+export default resourceFactory;

lib/tracing/Trace.js

@@ -1,8 +1,9 @@
-const log = require("@ui5/logger").getLogger("resources:tracing:Trace");
-const logGlobs = require("@ui5/logger").getLogger("resources:tracing:Trace:globs");
-const logPaths = require("@ui5/logger").getLogger("resources:tracing:Trace:paths");
-const prettyHrtime = require("pretty-hrtime");
-const summaryTrace = require("./traceSummary");
+import logger from "@ui5/logger";
+const log = logger.getLogger("resources:tracing:Trace");
+const logGlobs = logger.getLogger("resources:tracing:Trace:globs");
+const logPaths = logger.getLogger("resources:tracing:Trace:paths");
+import prettyHrtime from "pretty-hrtime";
+import summaryTrace from "./traceSummary.js";
 const hasOwnProperty = Object.prototype.hasOwnProperty;
 
 /**
@@ -93,4 +94,4 @@ class Trace {
 	}
 }
 
-module.exports = Trace;
+export default Trace;

lib/tracing/traceSummary.js

@@ -1,5 +1,7 @@
-const log = require("@ui5/logger").getLogger("resources:tracing:total");
-const prettyHrtime = require("pretty-hrtime");
+import logger from "@ui5/logger";
+const log = logger.getLogger("resources:tracing:total");
+
+import prettyHrtime from "pretty-hrtime";
 const hasOwnProperty = Object.prototype.hasOwnProperty;
 let timeoutId;
 let active = false;
@@ -115,7 +117,7 @@ function collection(name) {
 }
 
 
-module.exports = {
+export default {
 	pathCall: pathCall,
 	globCall: globCall,
 	collection: collection,