[BREAKING] Transform to native ESM (#306)

BREAKING CHANGE:
This package has been transformed to native ESM. Therefore it no longer provides a CommonJS export.
If your project uses CommonJS, it needs to be converted to ESM or use a dynamic import.

For more information see also:
- https://sap.github.io/ui5-tooling/updates/migrate-v3/
- https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

Co-authored-by: Matthias Osswald <[email protected]>
Co-authored-by: Florian Vogt <[email protected]>

.eslintrc.js → .eslintrc.cjs

@@ -1,4 +1,7 @@
 module.exports = {
+	"parserOptions": {
+		"sourceType": "module",
+	},
 	"env": {
 		"node": true,
 		"es2021": true
@@ -71,7 +74,8 @@ module.exports = {
 	"settings": {
 		"jsdoc": {
 			"tagNamePreference": {
-				"return": "returns"
+				"return": "returns",
+				"augments": "extends"
 			}
 		}
 	},

jsdoc-plugin.cjs

@@ -0,0 +1,9 @@
+/*
+ * This plugin fixes unexpected JSDoc behavior that prevents us from using types that start with an at-sign (@).
+ * JSDoc doesn't see "{@" as a valid type expression, probably as there's also {@link ...}.
+ */
+exports.handlers = {
+	jsdocCommentFound: function(e) {
+		e.comment = e.comment.replace(/{@ui5\//g, "{ @ui5/");
+	}
+};

jsdoc.json

@@ -3,12 +3,12 @@
 		"allowUnknownTags": false
 	},
 	"source": {
-		"include": ["README.md", "index.js"],
+		"include": ["README.md"],
 		"includePattern": ".+\\.js$",
 		"excludePattern": "(node_modules(\\\\|/))"
 	},
 	"plugins": [
-		"./jsdoc-plugin"
+		"jsdoc-plugin.cjs"
 	],
 	"opts": {
 		"encoding": "utf8",

lib/logger.js

@@ -1,4 +1,4 @@
-const npmlog = require("npmlog");
+import npmlog from "npmlog";
 
 const levels = ["silly", "verbose", "perf", "info", "warn", "error", "silent"];
 if (process.env.UI5_LOG_LVL) {
@@ -160,10 +160,11 @@ const logger = {
 };
 
 // Export internal classes for testing only
+/* istanbul ignore else */
 if (process.env.NODE_ENV === "test") {
 	logger.__test__ = {
 		Logger, GroupLogger, TaskLogger
 	};
 }
 
-module.exports = logger;
+export default logger;