@fontoxml/fontoxml-development-tools 3.7.0 → 3.8.1

package/src/modules/content-quality/package.json

@@ -9,5 +9,6 @@
 		"fonto",
 		"fontoxml"
 	],
-	"main": "index.js"
+	"main": "index.js",
+	"type": "module"
 }

package/src/modules/content-quality/src/command.build.controller.js

@@ -1,19 +1,17 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import cleanup from './utilities/cleanup.js';
+import constants from './utilities/constants.js';
+import copyWhitelistedFiles from './utilities/copyWhitelistedFiles.js';
+import executeAndLog from './utilities/executeAndLog.js';
+import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
+import getVerbosityLevel from './utilities/getVerbosityLevel.js';
+import getWhitelist from './utilities/getWhitelist.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
+import validateInstance from './utilities/validateInstance.js';
 
-const FontoxmlFcqManifest = require('./utilities/FontoxmlFcqManifest');
-const cleanup = require('./utilities/cleanup');
-const constants = require('./utilities/constants');
-const copyWhitelistedFiles = require('./utilities/copyWhitelistedFiles');
-const executeAndLog = require('./utilities/executeAndLog');
-const getVerbosityLevel = require('./utilities/getVerbosityLevel');
-const getWhitelist = require('./utilities/getWhitelist');
-const setEntryVisibility = require('./utilities/setEntryVisibility');
-const validateInstance = require('./utilities/validateInstance');
-
-module.exports = function buildCommand(req, res) {
+export default function buildCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	const directoryPath = path.resolve(
@@ -259,4 +257,4 @@ module.exports = function buildCommand(req, res) {
 					});
 			})
 	);
-};
+}

package/src/modules/content-quality/src/command.build.js

@@ -1,10 +1,17 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const constants = require('./utilities/constants');
+import constants from './utilities/constants.js';
 
-module.exports = (moduleRegistration, fcqCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, fcqCommand) => {
 	fcqCommand
-		.addCommand('build', './command.build.controller')
+		.addCommand(
+			'build',
+			path.resolve(__dirname, 'command.build.controller.js')
+		)
 		.setDescription(
 			'Build a Fonto Content Quality Docker image for production use. Requires Docker to be installed.'
 		)

package/src/modules/content-quality/src/command.download-self-contained.controller.js

@@ -1,11 +1,9 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
+import requestPromise from 'request-promise-native';
+import url from 'url';
 
-const fs = require('fs-extra');
-const path = require('path');
-const requestPromise = require('request-promise-native');
-const url = require('url');
-
-module.exports = function buildCommand(req, res) {
+export default function buildCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	const directoryPath = path.resolve(
@@ -109,4 +107,4 @@ module.exports = function buildCommand(req, res) {
 					);
 				});
 		});
-};
+}

package/src/modules/content-quality/src/command.download-self-contained.js

@@ -1,12 +1,19 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const constants = require('./utilities/constants');
+import constants from './utilities/constants.js';
 
-module.exports = (moduleRegistration, fcqCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, fcqCommand) => {
 	fcqCommand
 		.addCommand(
 			'download-self-contained',
-			'./command.download-self-contained.controller'
+			path.resolve(
+				__dirname,
+				'command.download-self-contained.controller.js'
+			)
 		)
 		.addAlias('dsc')
 		.setDescription('Downloads a self-contained build.')

package/src/modules/content-quality/src/command.init.controller.js

@@ -1,13 +1,11 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import constants from './utilities/constants.js';
+import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
 
-const constants = require('./utilities/constants');
-const FontoxmlFcqManifest = require('./utilities/FontoxmlFcqManifest');
-const setEntryVisibility = require('./utilities/setEntryVisibility');
-
-module.exports = async function initCommand(req, res) {
+export default async function initCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	// Check if the version exists.
@@ -90,4 +88,4 @@ module.exports = async function initCommand(req, res) {
 				`See ${constants.DOCUMENTATION_GETTING_STARTED_GUIDE} for more information.`
 			);
 		});
-};
+}

package/src/modules/content-quality/src/command.init.js

@@ -1,10 +1,17 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const constants = require('./utilities/constants');
+import constants from './utilities/constants.js';
 
-module.exports = (moduleRegistration, fcqCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, fcqCommand) => {
 	fcqCommand
-		.addCommand('init', './command.init.controller')
+		.addCommand(
+			'init',
+			path.resolve(__dirname, 'command.init.controller.js')
+		)
 		.setDescription(
 			'Initialize a Fonto Content Quality instance in an empty or nonexistent directory.'
 		)

package/src/modules/content-quality/src/command.run.controller.js

@@ -1,18 +1,16 @@
-'use strict';
+import fs from'fs-extra';
+import os from 'os';
+import path from 'path';
 
-const fs = require('fs-extra');
-const os = require('os');
-const path = require('path');
-
-const FontoxmlFcqManifest = require('./utilities/FontoxmlFcqManifest');
-const cleanup = require('./utilities/cleanup');
-const constants = require('./utilities/constants');
-const copyWhitelistedFiles = require('./utilities/copyWhitelistedFiles');
-const executeAndLog = require('./utilities/executeAndLog');
-const getVerbosityLevel = require('./utilities/getVerbosityLevel');
-const getWhitelist = require('./utilities/getWhitelist');
-const setEntryVisibility = require('./utilities/setEntryVisibility');
-const validateInstance = require('./utilities/validateInstance');
+import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
+import cleanup from './utilities/cleanup.js';
+import constants from './utilities/constants.js';
+import copyWhitelistedFiles from './utilities/copyWhitelistedFiles.js';
+import executeAndLog from './utilities/executeAndLog.js';
+import getVerbosityLevel from './utilities/getVerbosityLevel.js';
+import getWhitelist from './utilities/getWhitelist.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
+import validateInstance from './utilities/validateInstance.js';
 
 const verboseFcqConfigurationEntries = {
 	Logging__LogLevel__Default: 'Trace',
@@ -86,7 +84,7 @@ function copyFcqConfiguration(fcqConfiguration, tempDir, verbosityLevel, res) {
 	});
 }
 
-module.exports = function runCommand(req, res) {
+export default function runCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	const directoryPath = path.resolve(

package/src/modules/content-quality/src/command.run.js

@@ -1,10 +1,14 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const constants = require('./utilities/constants');
+import constants from './utilities/constants.js';
 
-module.exports = (moduleRegistration, fcqCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, fcqCommand) => {
 	fcqCommand
-		.addCommand('run', './command.run.controller')
+		.addCommand('run', path.resolve(__dirname, 'command.run.controller.js'))
 		.setDescription(
 			'Run a Fonto Content Quality instance for development purposes. Requires Docker to be installed.'
 		)

package/src/modules/content-quality/src/command.upgrade.controller.js

@@ -1,13 +1,11 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import constants from './utilities/constants.js';
+import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
 
-const constants = require('./utilities/constants');
-const FontoxmlFcqManifest = require('./utilities/FontoxmlFcqManifest');
-const setEntryVisibility = require('./utilities/setEntryVisibility');
-
-module.exports = async function upgradeCommand(req, res) {
+export default async function upgradeCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	// Check if the given version exist.
@@ -51,4 +49,4 @@ module.exports = async function upgradeCommand(req, res) {
 			})
 		)
 		.then(() => destroySpinner());
-};
+}

package/src/modules/content-quality/src/command.upgrade.js

@@ -1,10 +1,17 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const constants = require('./utilities/constants');
+import constants from './utilities/constants.js';
 
-module.exports = (moduleRegistration, fcqCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, fcqCommand) => {
 	fcqCommand
-		.addCommand('upgrade', './command.upgrade.controller')
+		.addCommand(
+			'upgrade',
+			path.resolve(__dirname, 'command.upgrade.controller.js')
+		)
 		.setDescription(
 			'Upgrade an existing Fonto Content Quality instance to the specified version.'
 		)

package/src/modules/content-quality/src/command.versions.controller.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = async function versionsCommand(req, res) {
+export default async function versionsCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	const all = req.options.all;
@@ -13,4 +11,4 @@ module.exports = async function versionsCommand(req, res) {
 	destroySpinner();
 	res.caption('Fonto Content Quality versions');
 	res.list(all ? sdkVersions.getAll() : sdkVersions.getAllStable(), '-');
-};
+}

package/src/modules/content-quality/src/command.versions.js

@@ -1,8 +1,15 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-module.exports = (moduleRegistration, fcqCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, fcqCommand) => {
 	fcqCommand
-		.addCommand('versions', './command.versions.controller')
+		.addCommand(
+			'versions',
+			path.resolve(__dirname, 'command.versions.controller.js')
+		)
 		.setDescription('List the available Fonto Content Quality versions.')
 
 		.addHiddenOption(

package/src/modules/content-quality/src/utilities/FontoxmlFcqManifest.js

@@ -1,8 +1,6 @@
-'use strict';
+import fs from 'fs-extra';
 
-const fs = require('fs-extra');
-
-class FontoxmlFcqManifest {
+export default class FontoxmlFcqManifest {
 	constructor(fcqVersion) {
 		this.fcqVersion = fcqVersion;
 	}
@@ -30,5 +28,3 @@ class FontoxmlFcqManifest {
 		}
 	}
 }
-
-module.exports = FontoxmlFcqManifest;

package/src/modules/content-quality/src/utilities/cleanup.js

@@ -1,12 +1,10 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import constants from './constants.js';
+import executeAndLog from './executeAndLog.js';
 
-const constants = require('./constants');
-const executeAndLog = require('./executeAndLog');
-
-module.exports = async function cleanup(
+export default async function cleanup(
 	temporaryDirectoryPath,
 	projectName,
 	res,
@@ -69,4 +67,4 @@ module.exports = async function cleanup(
 	} finally {
 		destroySpinner();
 	}
-};
+}

package/src/modules/content-quality/src/utilities/constants.js

@@ -1,8 +1,10 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const path = require('path');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-module.exports = {
+export default {
 	DEFAULT_IMAGE_NAME: 'fonto-content-quality',
 	DEFAULT_IMAGE_TAG: 'latest',
 	VERBOSITY_LEVEL_DEBUG: 'debug',

package/src/modules/content-quality/src/utilities/copyWhitelistedFiles.js

@@ -1,9 +1,7 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
-
-module.exports = function copyWhitelistedFiles(
+export default function copyWhitelistedFiles(
 	whitelistedFiles,
 	sourceDirectory,
 	destinationDirectory
@@ -21,4 +19,4 @@ module.exports = function copyWhitelistedFiles(
 			});
 		})
 	);
-};
+}

package/src/modules/content-quality/src/utilities/executeAndLog.js

@@ -1,9 +1,8 @@
-'use strict';
+import cp from 'child_process';
 
-const cp = require('child_process');
-const constants = require('./constants');
+import constants from './constants.js';
 
-module.exports = function executeAndLog(
+export default function executeAndLog(
 	res,
 	command,
 	args,
@@ -61,4 +60,4 @@ module.exports = function executeAndLog(
 			}
 		});
 	});
-};
+}

package/src/modules/content-quality/src/utilities/getVerbosityLevel.js

@@ -1,8 +1,6 @@
-'use strict';
+import constants from './constants.js';
 
-const constants = require('./constants');
-
-module.exports = function getVerbosityLevel(verbose, debug) {
+export default function getVerbosityLevel(verbose, debug) {
 	if (debug) {
 		return constants.VERBOSITY_LEVEL_DEBUG;
 	}
@@ -10,4 +8,4 @@ module.exports = function getVerbosityLevel(verbose, debug) {
 		return constants.VERBOSITY_LEVEL_VERBOSE;
 	}
 	return constants.VERBOSITY_LEVEL_NORMAL;
-};
+}

package/src/modules/content-quality/src/utilities/getWhitelist.js

@@ -1,11 +1,9 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import constants from './constants.js';
 
-const constants = require('./constants');
-
-module.exports = function getWhitelist() {
+export default function getWhitelist() {
 	return fs
 		.readdir(constants.INSTANCE_TEMPLATE_DIRECTORY_PATH)
 		.then((entries) => {
@@ -15,4 +13,4 @@ module.exports = function getWhitelist() {
 			whitelist.push(...constants.WHITELIST);
 			return whitelist;
 		});
-};
+}

package/src/modules/content-quality/src/utilities/setEntryVisibility.js

@@ -1,17 +1,6 @@
-'use strict';
+import fswin from 'fswin';
 
-let fswin;
-// We replace the stdout.write with nothing to prevent fswin to output the Node.js version.
-const originalStdOutWrite = process.stdout.write;
-process.stdout.write = () => {};
-try {
-	fswin = require('fswin');
-} catch (_e) {
-	// Exception will be thrown on linux but fswin is not required on linux.
-}
-process.stdout.write = originalStdOutWrite;
-
-module.exports = function setEntryVisibility(entryPath, isVisible) {
+export default function setEntryVisibility(entryPath, isVisible) {
 	return new Promise((resolve, reject) => {
 		if (fswin) {
 			fswin.setAttributes(
@@ -30,4 +19,4 @@ module.exports = function setEntryVisibility(entryPath, isVisible) {
 
 		resolve();
 	});
-};
+}

package/src/modules/content-quality/src/utilities/validateInstance.js

@@ -1,11 +1,9 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import constants from './constants.js';
 
-const constants = require('./constants');
-
-module.exports = function validateInstance(directoryPath) {
+export default function validateInstance(directoryPath) {
 	return fs
 		.exists(directoryPath)
 		.then((exists) => {
@@ -28,4 +26,4 @@ module.exports = function validateInstance(directoryPath) {
 				})
 			);
 		});
-};
+}

package/src/modules/core/index.js

@@ -1,8 +1,13 @@
-'use strict';
+import path from 'path';
 
-const path = require('path');
+import commandFDT from './src/command.fdt.js';
+import commandLicenseValidate from './src/command.license.validate.js';
+import commandModule from './src/command.module.js';
+import commandWho from './src/command.who.js';
+import precontrollerDebug from './src/precontroller.debug.js';
+import precontrollerHelp from './src/precontroller.help.js';
 
-module.exports = (moduleRegistration, app, options) => {
+export default (moduleRegistration, app, options) => {
 	moduleRegistration.registerContextInformer((_request, response) => {
 		response.caption('Modules');
 
@@ -25,18 +30,11 @@ module.exports = (moduleRegistration, app, options) => {
 		});
 	});
 
-	[
-		// Pre controllers.
-		require('./src/precontroller.debug.js'),
-		require('./src/precontroller.help.js'),
-
-		// Root FDT command.
-		require('./src/command.fdt.js'),
-
-		// Commands.
-		require('./src/command.module.js'),
-		require('./src/command.who.js'),
-	].forEach((mod) => mod(moduleRegistration, app, options));
+	precontrollerDebug(moduleRegistration, app, options);
+	precontrollerHelp(moduleRegistration, app, options);
+	commandFDT(moduleRegistration, app, options);
+	commandModule(moduleRegistration, app, options);
+	commandWho(moduleRegistration, app, options);
 
 	// Only add Fonto related logic when configured to do so.
 	if (!options.skipAddModules) {
@@ -121,8 +119,6 @@ module.exports = (moduleRegistration, app, options) => {
 			.setDescription('License management.')
 			.setAsHelpCommand();
 
-		[require('./src/command.license.validate')].forEach((mod) =>
-			mod(moduleRegistration, licenseCommand)
-		);
+		commandLicenseValidate(moduleRegistration, licenseCommand);
 	}
 };

package/src/modules/core/package.json

@@ -9,5 +9,6 @@
 		"fonto",
 		"fontoxml"
 	],
-	"main": "index.js"
+	"main": "index.js",
+	"type": "module"
 }

package/src/modules/core/src/command.fdt.js

@@ -1,5 +1,3 @@
-'use strict';
-
 function leftAlign(text, lineWidth) {
 	if (text.length < lineWidth) {
 		text = '\xa0'.repeat(lineWidth - text.length) + text;
@@ -7,7 +5,7 @@ function leftAlign(text, lineWidth) {
 	return text;
 }
 
-module.exports = (moduleRegistration, app, opts) => {
+export default (moduleRegistration, app, opts) => {
 	const logoConfig = moduleRegistration.registerConfiguration(
 		'logo',
 		{

package/src/modules/core/src/command.license.validate.js

@@ -1,5 +1,3 @@
-'use strict';
-
 function outputLicenseInfoAndChanges(res, oldLicenseInfo, newLicenseInfo) {
 	// Compare old and new license info.
 	const licenseeHasChanged =
@@ -72,7 +70,7 @@ function outputLicenseInfoAndChanges(res, oldLicenseInfo, newLicenseInfo) {
 	);
 }
 
-module.exports = (moduleRegistration, licenseCommand) => {
+export default (moduleRegistration, licenseCommand) => {
 	function validateCommand(req, res) {
 		res.caption(req.command.getLongName());
 

package/src/modules/core/src/command.module.js

@@ -1,9 +1,7 @@
-'use strict';
+import path from 'path';
 
-const path = require('path');
-
-module.exports = (moduleRegistration, app) => {
-	function moduleController(req, res) {
+export default (moduleRegistration, app) => {
+	async function moduleController(req, res) {
 		res.caption(req.command.getLongName());
 
 		if (req.options.list) {
@@ -77,7 +75,7 @@ module.exports = (moduleRegistration, app) => {
 			res.debug(`Try enabling ${req.options.add.length} modules`);
 		}
 
-		req.options.add.forEach((option) => {
+		for (const option of req.options.add) {
 			const modulePath = path.resolve(process.cwd(), option);
 
 			const existingModAtPath = app.modules.find(
@@ -92,7 +90,7 @@ module.exports = (moduleRegistration, app) => {
 			}
 
 			try {
-				const mod = app.silentEnableModule(modulePath);
+				const mod = await app.silentEnableModule(modulePath);
 
 				if (!mod) {
 					res.property(
@@ -113,7 +111,7 @@ module.exports = (moduleRegistration, app) => {
 			} catch (e) {
 				res.property('skipped', e.stack, null, 'notice');
 			}
-		});
+		}
 
 		res.break();
 

package/src/modules/core/src/command.who.js

@@ -1,9 +1,11 @@
-'use strict';
+import os from 'os';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const os = require('os');
-const path = require('path');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-module.exports = (moduleRegistration, app) => {
+export default (moduleRegistration, app) => {
 	function whoController(req, res) {
 		res.caption(req.command.getLongName());