@fontoxml/fontoxml-development-tools 3.7.0-beta.6 → 3.8.0-beta.2

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@fontoxml/fontoxml-development-tools",
 	"description": "Development tools for Fonto.",
-	"version": "3.7.0-beta.6",
+	"version": "3.8.0-beta.2",
 	"author": "The Fonto Team",
 	"license": "MIT",
 	"keywords": [
@@ -17,6 +17,7 @@
 	"engines": {
 		"node": ">=12"
 	},
+	"type": "module",
 	"scripts": {
 		"lint": "eslint --ext .js,.jsx,.ts,.tsx --fix .",
 		"start": "node ./bin/development-tools",

package/src/App.js

@@ -1,24 +1,32 @@
-'use strict';
-
-const os = require('os');
-const path = require('path');
-
-const ask = require('ask-nicely');
-
-const FdtResponse = require('./response/FdtResponse');
-
-const AssertableWritableStream = require('./AssertableWritableStream');
-const ConfigManager = require('./ConfigManager');
-const FdtCommand = require('./FdtCommand');
-const ModuleRegistrationApi = require('./ModuleRegistrationApi');
-
-const addCoreModulesToApp = require('./addCoreModulesToApp');
-const addModulesToApp = require('./addModulesToApp');
-const createConfigFileInHomedir = require('./createConfigFileInHomedir');
-const enrichRequestObject = require('./enrichRequestObject');
-const getParentDirectoryContainingFileSync = require('./getParentDirectoryContainingFileSync');
-
-const packageJson = require(path.join(__dirname, '..', 'package.json'));
+import ask from 'ask-nicely';
+import { readFileSync } from 'fs';
+import os from 'os';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import addCoreModulesToApp from './addCoreModulesToApp.js';
+import addModulesToApp from './addModulesToApp.js';
+import AssertableWritableStream from './AssertableWritableStream.js';
+import ConfigManager from './ConfigManager.js';
+import createConfigFileInHomedir from './createConfigFileInHomedir.js';
+import enrichRequestObject from './enrichRequestObject.js';
+import FdtCommand from './FdtCommand.js';
+import getParentDirectoryContainingFileSync from './getParentDirectoryContainingFileSync.js';
+import ModuleRegistrationApi from './ModuleRegistrationApi.js';
+import FdtResponse from './response/FdtResponse.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+let packageJson = {};
+try {
+	packageJson = JSON.parse(
+		readFileSync(path.resolve(__dirname, '..', 'package.json'), 'utf8')
+	);
+} catch (_err) {
+	// TODO: Handle this error properly.
+	// Ignore
+}
 
 const DEFAULT_OPTIONS = {
 	appName: 'fdt',
@@ -52,9 +60,9 @@ function enableTestOutput(app, options) {
 	}
 }
 
-class FontoXMLDevelopmentToolsApp {
+export default class FontoXMLDevelopmentToolsApp {
 	/**
-	 * Creates an instance of the FontoXMLDevelopmentToolsApp.
+	 * Initializes this instance of the FontoXMLDevelopmentToolsApp.
 	 *
 	 * @param {object} [options]
 	 *     An optional options object.
@@ -92,9 +100,9 @@ class FontoXMLDevelopmentToolsApp {
 	 * @param {boolean} [options.useTestOutput]
 	 *     When set to true, enable test output. This is meant for unit tests and will do the following:
 	 *         - Output everything to .testOutput stream which has some helper methods for unit testing.
-	 * @constructor
 	 */
-	constructor(options = {}) {
+	async init(options = {}) {
+		// const appObject = new FontoXMLDevelopmentToolsApp();
 		/* istanbul ignore else: All tests should be run in testmode to prevent configuration conflicts */
 		if (options.testMode) {
 			enableTestMode(options);
@@ -160,16 +168,34 @@ class FontoXMLDevelopmentToolsApp {
 
 		this.modules = [];
 		this.builtInModules = [];
-		addCoreModulesToApp(this, options);
+		await addCoreModulesToApp(this, options);
 
 		this.request = Object.create(null);
 		if (!options.skipEnrichRequestObject) {
-			enrichRequestObject(this);
+			await enrichRequestObject(this);
 		}
 
 		if (!options.skipAddModules) {
-			addModulesToApp(this);
+			await addModulesToApp(this);
+		}
+		return this;
+	}
+
+	/**
+	 * Retrieve the path to a registered module by its name.
+	 *
+	 * @param {string} moduleName The name of the module (see its package.json).
+	 *
+	 * @return {(string|undefined)}
+	 */
+	getPathToModule(moduleName) {
+		for (const module of this.modules) {
+			const moduleInfo = module.getInfo();
+			if (moduleInfo.name === moduleName) {
+				return moduleInfo.path;
+			}
 		}
+		return undefined;
 	}
 
 	/**
@@ -181,8 +207,8 @@ class FontoXMLDevelopmentToolsApp {
 	 *
 	 * @return {(ModuleRegistrationApi|null)}
 	 */
-	enableBuiltInModule(modulePath, ...extra) {
-		const enabledModule = this.enableModule(modulePath, ...extra);
+	async enableBuiltInModule(modulePath, ...extra) {
+		const enabledModule = await this.enableModule(modulePath, ...extra);
 
 		if (enabledModule) {
 			this.builtInModules.push(enabledModule);
@@ -199,7 +225,7 @@ class FontoXMLDevelopmentToolsApp {
 	 *
 	 * @return {(ModuleRegistrationApi|null)}
 	 */
-	silentEnableModule(modulePath, ...extra) {
+	async silentEnableModule(modulePath, ...extra) {
 		const enabledModule = new ModuleRegistrationApi(this, modulePath);
 		const modInfo = enabledModule.getInfo();
 
@@ -210,7 +236,7 @@ class FontoXMLDevelopmentToolsApp {
 			return null;
 		}
 
-		enabledModule.load(...extra);
+		await enabledModule.load(...extra);
 
 		this.modules.push(enabledModule);
 
@@ -225,8 +251,8 @@ class FontoXMLDevelopmentToolsApp {
 	 *
 	 * @return {(ModuleRegistrationApi|null)}
 	 */
-	enableModule(modulePath, ...extra) {
-		let enabledModule = this.silentEnableModule(modulePath, ...extra);
+	async enableModule(modulePath, ...extra) {
+		let enabledModule = await this.silentEnableModule(modulePath, ...extra);
 
 		if (!enabledModule) {
 			enabledModule = new ModuleRegistrationApi(this, modulePath);
@@ -400,5 +426,3 @@ class FontoXMLDevelopmentToolsApp {
 		}
 	}
 }
-
-module.exports = FontoXMLDevelopmentToolsApp;

package/src/AssertableWritableStream.js

@@ -1,9 +1,6 @@
-'use strict';
-
-const assert = require('assert');
-const stream = require('stream');
-
-const stripAnsi = require('strip-ansi');
+import assert from 'assert';
+import stream from 'stream';
+import stripAnsi from 'strip-ansi';
 
 const OUTPUT = Symbol('test output');
 
@@ -34,7 +31,7 @@ function handleAllCallbacks(captures, endCallback, nextCaptureCallback) {
 	writeNextCapture();
 }
 
-class AssertableWritableStream extends stream.Writable {
+export default class AssertableWritableStream extends stream.Writable {
 	/**
 	 * Constructor for the AssertableWritableStream class. Based on stream.Writable.
 	 * @see https://nodejs.org/api/stream.html#stream_constructor_new_stream_writable_options
@@ -344,5 +341,3 @@ class AssertableWritableStream extends stream.Writable {
 		}
 	}
 }
-
-module.exports = AssertableWritableStream;

package/src/ConfigManager.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
 
 const BASE_LOCATION = Symbol('base configuration file location');
 const CONFIG_FILE_NAME = Symbol('configuration file name');
@@ -26,7 +24,7 @@ function readJsonOrReturnObject(jsonPath) {
 /**
  * Manages a unified configuration file for all modules that register their config.
  */
-class ConfigManager {
+export default class ConfigManager {
 	/**
 	 * @param {Array}  configLocation     The main config file location to which changes will be stored.
 	 * @param {Array}  baseConfigLocation A base config file to inherit from.
@@ -153,5 +151,3 @@ class ConfigManager {
 		return JSON.stringify(serializedConfig, null, '\t');
 	}
 }
-
-module.exports = ConfigManager;

package/src/EditorRepository.js

@@ -1,16 +1,12 @@
-'use strict';
+import { readFileSync } from 'fs';
+import path from 'path';
+import { pathToFileURL } from 'url';
 
-const path = require('path');
+import { isNightly, isPre770Editor, isPre782Editor } from './editorVersions.js';
+import getParentDirectoryContainingFileSync from './getParentDirectoryContainingFileSync.js';
 
-const getParentDirectoryContainingFileSync = require('./getParentDirectoryContainingFileSync');
-const {
-	isNightly,
-	isPre770Editor,
-	isPre782Editor,
-} = require('./editorVersions');
-
-class EditorRepository {
-	constructor(app) {
+export default class EditorRepository {
+	async init(app) {
 		this._app = app;
 
 		this.path = getParentDirectoryContainingFileSync(
@@ -31,7 +27,12 @@ class EditorRepository {
 		}
 
 		try {
-			Object.assign(this, require(path.join(this.path, 'manifest.json')));
+			Object.assign(
+				this,
+				JSON.parse(
+					readFileSync(path.join(this.path, 'manifest.json'), 'utf-8')
+				)
+			);
 		} catch (_error) {
 			this._app.logger.notice(`Could not read manifest.json.`);
 			this._app.logger.notice(
@@ -46,7 +47,7 @@ class EditorRepository {
 
 		try {
 			const configJsPath = path.join(this.path, 'config.js');
-			this.config = require(configJsPath)();
+			this.config = (await import(pathToFileURL(configJsPath))).default();
 			this.configSource = configJsPath;
 		} catch (_error) {
 			// No-op
@@ -55,7 +56,7 @@ class EditorRepository {
 		if (!this.configSource) {
 			try {
 				const configJsonPath = path.join(this.path, 'config.json');
-				this.config = require(configJsonPath);
+				this.config = JSON.parse(readFileSync(configJsonPath));
 				this.configSource = configJsonPath;
 			} catch (_error) {
 				// No-op
@@ -72,5 +73,3 @@ class EditorRepository {
 		}
 	}
 }
-
-module.exports = EditorRepository;

package/src/FdtCommand.js

@@ -1,8 +1,9 @@
-'use strict';
+import ask from 'ask-nicely';
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
 
-const path = require('path');
-
-const ask = require('ask-nicely');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const FILENAMES_TO_SKIP_FOR_SET_CONTROLLER_CALLSITES = Symbol(
 	'FILENAMES_TO_SKIP_FOR_SET_CONTROLLER_CALLSITES'
@@ -13,7 +14,7 @@ const FILENAMES_TO_SKIP_FOR_SET_CONTROLLER_CALLSITES = Symbol(
  *
  * @augments AskNicely.Command
  */
-class FdtCommand extends ask.Command {
+export default class FdtCommand extends ask.Command {
 	/**
 	 * @constructor
 	 * @param {string} commandName
@@ -62,37 +63,17 @@ class FdtCommand extends ask.Command {
 		return null;
 	}
 
-	_getCallSites() {
-		const _prepareStackTrace = Error.prepareStackTrace;
-		Error.prepareStackTrace = (_, stack) => stack;
-		const errorStack = new Error().stack;
-		Error.prepareStackTrace = _prepareStackTrace;
-		return errorStack
-			.map((s) => s.getFileName())
-			.filter(
-				(fileName) =>
-					!FdtCommand[
-						FILENAMES_TO_SKIP_FOR_SET_CONTROLLER_CALLSITES
-					].some(
-						(fileNameToSkip) =>
-							fileName && fileName.endsWith(fileNameToSkip)
-					)
-			);
-	}
-
 	_createLazyLoadController(controllerSource) {
-		if (
-			typeof controllerSource === 'string' &&
-			!path.isAbsolute(controllerSource)
-		) {
-			const callsiteFilename = this._getCallSites()[0];
-			controllerSource = path.resolve(
-				path.join(path.dirname(callsiteFilename), controllerSource)
+		if (!path.isAbsolute(controllerSource)) {
+			throw new Error(
+				`Command controller "${controllerSource}" should be registered using an absolute path instead of a relative one.`
 			);
 		}
 
 		return (...args) => {
-			return require(controllerSource)(...args);
+			return import(pathToFileURL(controllerSource)).then((module) =>
+				module.default(...args)
+			);
 		};
 	}
 
@@ -346,5 +327,3 @@ FdtCommand.addFileNameToSkipForSetControllerCallsites(
 FdtCommand.addFileNameToSkipForSetControllerCallsites(
 	`/${fdtBasename}/src/response/FdtResponse.js`
 );
-
-module.exports = FdtCommand;

package/src/FdtLicense.js

@@ -1,16 +1,15 @@
-'use strict';
+import compareVersions from 'compare-versions';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import requestPromise from 'request-promise-native';
+import util from 'util';
 
-const compareVersions = require('compare-versions');
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const util = require('util');
+import getParentDirectoryContainingFileSync from './getParentDirectoryContainingFileSync.js';
 
 const readFile = util.promisify(fs.readFile);
 const writeFile = util.promisify(fs.writeFile);
 
-const getParentDirectoryContainingFileSync = require('./getParentDirectoryContainingFileSync');
-
 const DEFAULT_LICENSE_FILENAME = 'fonto.lic';
 
 const LICENSE_FILE_ERROR_SOLUTION =
@@ -87,7 +86,7 @@ class ProductVersions {
 	}
 }
 
-class FdtLicense {
+export default class FdtLicense {
 	constructor(app) {
 		this.app = app;
 
@@ -419,7 +418,6 @@ class FdtLicense {
 	validateAndUpdateLicenseFile() {
 		return this.getLicenseFileBuffer()
 			.then((licenseFileBuffer) => {
-				const requestPromise = require('request-promise-native');
 				// Remotely validate the license file.
 				return requestPromise.post(
 					`${this._backendBaseUrl}/license/validate`,
@@ -530,7 +528,6 @@ class FdtLicense {
 	getDataForProducts(productsWithData) {
 		return this.getLicenseFileBuffer()
 			.then((licenseFileBuffer) => {
-				const requestPromise = require('request-promise-native');
 				// Remotely get the required data.
 				return requestPromise.post(
 					`${this._backendBaseUrl}/product/data`,
@@ -652,7 +649,6 @@ class FdtLicense {
 	sendTelemetry(data) {
 		return this.getLicenseFileBuffer()
 			.then((licenseFileBuffer) => {
-				const requestPromise = require('request-promise-native');
 				return requestPromise.post(
 					`${this._backendBaseUrl}/telemetry`,
 					{
@@ -705,5 +701,3 @@ class FdtLicense {
 			});
 	}
 }
-
-module.exports = FdtLicense;

package/src/FdtTable.js

@@ -1,8 +1,6 @@
-'use strict';
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
 
 function escapeCellForTabSeperatedOutput(cell) {
 	if (cell === undefined || cell === null) {
@@ -107,7 +105,7 @@ const exportTransformers = {
 	json: jsonFormatted,
 };
 
-class FdtTable {
+export default class FdtTable {
 	constructor(moduleRegistration, columns) {
 		this.columns = columns;
 
@@ -193,5 +191,3 @@ class FdtTable {
 		res.debug(`Exported file: ${exported.length} characters`);
 	}
 }
-
-module.exports = FdtTable;

package/src/ModuleRegistrationApi.js

@@ -1,7 +1,7 @@
-'use strict';
-
-const ask = require('ask-nicely');
-const path = require('path');
+import ask from 'ask-nicely';
+import { readFileSync } from 'fs';
+import path from 'path';
+import { pathToFileURL } from 'url';
 
 const APP = Symbol('app');
 const CONTEXTINFORMERS = Symbol('context informers');
@@ -12,7 +12,7 @@ const PACKAGEJSON = Symbol('package.json');
  * The unified API for registering module functionality with the FDT instance. The callback exposed
  * by a module will get an instance of ModuleRegistrationApi to register itself with.
  */
-class ModuleRegistrationApi {
+export default class ModuleRegistrationApi {
 	/**
 	 * Should not be called by a module.
 	 *
@@ -26,7 +26,9 @@ class ModuleRegistrationApi {
 
 		this[LOCATION] = moduleLocation;
 
-		this[PACKAGEJSON] = require(path.join(this[LOCATION], 'package.json'));
+		this[PACKAGEJSON] = JSON.parse(
+			readFileSync(path.join(this[LOCATION], 'package.json'), 'utf-8')
+		);
 
 		this[CONTEXTINFORMERS] = [];
 
@@ -40,14 +42,16 @@ class ModuleRegistrationApi {
 	 *
 	 * @param {...*} extra
 	 */
-	load(...extra) {
-		const mod = require(this[LOCATION]);
+	async load(...extra) {
+		const defaultExport = (
+			await import(pathToFileURL(path.join(this[LOCATION], 'index.js')))
+		).default;
 
-		if (typeof mod !== 'function') {
+		if (typeof defaultExport !== 'function') {
 			throw new Error(`${this[PACKAGEJSON].name} is not a function.`);
 		}
 
-		mod(this, ...extra);
+		defaultExport(this, ...extra);
 	}
 
 	/**
@@ -161,5 +165,3 @@ class ModuleRegistrationApi {
 		return this[CONTEXTINFORMERS].slice(0);
 	}
 }
-
-module.exports = ModuleRegistrationApi;

package/src/addCoreModulesToApp.js

@@ -1,13 +1,15 @@
-'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 = function addCoreModulesToApp(app, options) {
+export default async function addCoreModulesToApp(app, options) {
 	// Load modules list from configuration dot-rc file.
 	const moduleConfig = app.config.registerConfig('modules', []);
 
 	// Load the core module and hide it from listing.
-	const coreModule = app.enableBuiltInModule(
+	const coreModule = await app.enableBuiltInModule(
 		path.join(__dirname, 'modules', 'core'),
 		app,
 		options
@@ -24,4 +26,4 @@ module.exports = function addCoreModulesToApp(app, options) {
 			app.error(`${path.basename(modulePath)} modulefail`, err);
 		}
 	});
-};
+}

package/src/addModulesToApp.js

@@ -1,19 +1,29 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const path = require('path');
+import { isPre770Editor } from './editorVersions.js';
 
-const { isPre770Editor } = require('./editorVersions');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-module.exports = function addModulesToApp(app) {
+export default async function addModulesToApp(app) {
 	// Default modules.
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'localization'));
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'operations'));
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'schema'));
+	await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'localization')
+	);
+	await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'operations')
+	);
+	await app.enableBuiltInModule(path.join(__dirname, 'modules', 'schema'));
 
 	// Conditional modules based on product license (without actually validating the license).
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'connectors'));
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'content-quality'));
-	app.enableBuiltInModule(
+	await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'connectors')
+	);
+	await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'content-quality')
+	);
+	await app.enableBuiltInModule(
 		path.join(__dirname, 'modules', 'document-history')
 	);
 	if (
@@ -25,15 +35,21 @@ module.exports = function addModulesToApp(app) {
 				app.request.fdt.editorRepository.sdkVersion
 		)
 	) {
-		app.enableBuiltInModule(
+		await app.enableBuiltInModule(
 			path.join(__dirname, 'modules', 'editor-pre-7-7-0')
 		);
 	} else {
-		app.enableBuiltInModule(path.join(__dirname, 'modules', 'editor'));
+		await app.enableBuiltInModule(
+			path.join(__dirname, 'modules', 'editor')
+		);
 	}
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'review'));
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'schema-compiler'));
-	app.enableBuiltInModule(path.join(__dirname, 'modules', 'spell-checker'));
+	await app.enableBuiltInModule(path.join(__dirname, 'modules', 'review'));
+	await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'schema-compiler')
+	);
+	await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'spell-checker')
+	);
 
 	// Load additional modules from config.json.
 	if (
@@ -44,18 +60,20 @@ module.exports = function addModulesToApp(app) {
 		app.request.fdt.editorRepository.config.developmentToolsModules &&
 		app.request.fdt.editorRepository.path
 	) {
-		app.request.fdt.editorRepository.config.developmentToolsModules.forEach(
-			(developmentToolsModule) => {
-				const developmentToolsModulePath = path.isAbsolute(
-					developmentToolsModule
-				)
-					? developmentToolsModule
-					: path.join(
-							app.request.fdt.editorRepository.path,
-							developmentToolsModule
-					  );
-				app.enableBuiltInModule(developmentToolsModulePath);
-			}
+		await Promise.all(
+			app.request.fdt.editorRepository.config.developmentToolsModules.map(
+				(developmentToolsModule) => {
+					const developmentToolsModulePath = path.isAbsolute(
+						developmentToolsModule
+					)
+						? developmentToolsModule
+						: path.join(
+								app.request.fdt.editorRepository.path,
+								developmentToolsModule
+						  );
+					return app.enableBuiltInModule(developmentToolsModulePath);
+				}
+			)
 		);
 	}
-};
+}

package/src/createConfigFileInHomedir.js

@@ -1,10 +1,8 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
 
 /* istanbul ignore next */
-module.exports = function createConfigFileInHomedir(options) {
+export default function createConfigFileInHomedir(options) {
 	// Create config file in the homedir, if it does not exist.
 	// Saving to a globally installed package might cause problems.
 	try {
@@ -19,4 +17,4 @@ module.exports = function createConfigFileInHomedir(options) {
 	} catch (_error) {
 		// Do nothing, file might already exist
 	}
-};
+}