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

package/test/App.test.js

@@ -1,23 +1,22 @@
-'use strict';
-
-const assert = require('assert');
-const fs = require('fs');
-const http = require('http');
-const multer = require('multer');
-const os = require('os');
-const path = require('path');
-const tmp = require('tmp');
-
-const fontoxmlDevelopmentTools = require('../');
-const addModulesToApp = require('../src/addModulesToApp');
-
-const EditorRepository = require('../src/EditorRepository');
-const FdtLicense = require('../src/FdtLicense');
-
-const App = fontoxmlDevelopmentTools.App;
+import assert from 'assert';
+import fs from 'fs';
+import http from 'http';
+import multer from 'multer';
+import os from 'os';
+import path from 'path';
+import tmp from 'tmp';
+import { fileURLToPath } from 'url';
+
+import { App, FdtCommand } from '../index.js';
+import addModulesToApp from '../src/addModulesToApp.js';
+import EditorRepository from '../src/EditorRepository.js';
+import FdtLicense from '../src/FdtLicense.js';
 
 const defaultStdoutColumns = process.stdout.columns;
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
 describe('App', () => {
 	let app;
 	let oldCwd;
@@ -90,7 +89,7 @@ describe('App', () => {
 		});
 	}
 
-	function createAppWithLicensesForAllRealProducts() {
+	async function createAppWithLicensesForAllRealProducts() {
 		createLicenseFileWithData({
 			key: 'TEST KEY',
 			licensee: 'Unit test suite',
@@ -104,20 +103,23 @@ describe('App', () => {
 		});
 
 		// Recreate the app.
-		app = new App({
+		app = new App();
+		await app.init({
 			appName: 'fontoxml-development-tools-test',
 			silent: true,
 			testMode: true,
 		});
 	}
 
-	beforeEach(() => {
+	beforeEach(async () => {
 		process.stdout.columns = 200;
 
 		oldCwd = process.cwd();
 		process.chdir(path.join(__dirname, 'app'));
 
-		app = new App({
+		app = new App();
+
+		await app.init({
 			appName: 'fontoxml-development-tools-test',
 			silent: true,
 			testMode: true,
@@ -145,8 +147,8 @@ describe('App', () => {
 		assert.strictEqual(app.name, 'fontoxml-development-tools-test');
 	});
 
-	it('can be configured with a custom Command class', () => {
-		class CustomCommandClass extends fontoxmlDevelopmentTools.FdtCommand {
+	it('can be configured with a custom Command class', async () => {
+		class CustomCommandClass extends FdtCommand {
 			constructor(commandName, controller) {
 				super(commandName, controller);
 
@@ -154,7 +156,8 @@ describe('App', () => {
 			}
 		}
 
-		const appWithCustomCommandClass = new App({
+		const appWithCustomCommandClass = new App();
+		await appWithCustomCommandClass.init({
 			appName: 'fontoxml-development-tools-test',
 			commandClass: CustomCommandClass,
 			silent: true,
@@ -173,8 +176,9 @@ describe('App', () => {
 	it('throws when configured with a custom Command class which does not inerit from FdtCommand', () => {
 		class CustomCommandClass {}
 
-		assert.throws(() => {
-			new App({
+		assert.rejects(async () => {
+			const app = new App();
+			await app.init({
 				appName: 'fontoxml-development-tools-test',
 				commandClass: CustomCommandClass,
 				silent: true,
@@ -260,9 +264,10 @@ describe('App', () => {
 			});
 		});
 
-		it('is able to skip a malformed config file', () => {
+		it('is able to skip a malformed config file', async () => {
+			const app = new App();
 			assert.ok(
-				new App({
+				await app.init({
 					appName: 'fontoxml-development-tools-test',
 					configFilename: 'index.js',
 					silent: true,
@@ -272,14 +277,15 @@ describe('App', () => {
 		});
 	});
 
-	it('throws when a loaded module is not a function', () => {
-		const appForInvalidModule = new App({
+	it('throws when a loaded module is not a function', async () => {
+		const appForInvalidModule = new App();
+		await appForInvalidModule.init({
 			appName: 'fontoxml-development-tools-test',
 			silent: true,
 			testMode: true,
 		});
-		assert.throws(() => {
-			appForInvalidModule.enableBuiltInModule(
+		assert.rejects(async () => {
+			await appForInvalidModule.enableBuiltInModule(
 				path.join(process.cwd(), 'invalid-module-1')
 			);
 		});
@@ -296,8 +302,9 @@ describe('App', () => {
 	});
 
 	describe('is able to handle any thrown errors', () => {
-		beforeEach(() => {
-			app = new App({
+		beforeEach(async () => {
+			app = new App();
+			await app.init({
 				appName: 'fontoxml-development-tools-test',
 				hideStacktraceOnErrors: false,
 				skipAddModules: true,
@@ -679,11 +686,13 @@ describe('App', () => {
 				);
 			});
 
-			it('has added config object and configSource to request.fdt.editorRepository for app with config.js', () => {
+			it('has added config object and configSource to request.fdt.editorRepository for app with config.js', async () => {
 				process.chdir(oldCwd);
 				process.chdir(path.join(__dirname, 'app-with-configjs'));
 
-				app = new App({
+				app = new App();
+
+				await app.init({
 					appName: 'fontoxml-development-tools-test-with-configjs',
 					silent: true,
 					testMode: true,
@@ -709,13 +718,14 @@ describe('App', () => {
 				);
 			});
 
-			it('has added isPre770 to request.fdt.editorRepository for pre 7.7.0 editors', () => {
+			it('has added isPre770 to request.fdt.editorRepository for pre 7.7.0 editors', async () => {
 				process.chdir(oldCwd);
 				process.chdir(path.join(__dirname, 'app-pre-7-7-0'));
 
-				createAppWithLicensesForAllRealProducts();
+				await createAppWithLicensesForAllRealProducts();
 
-				app = new App({
+				app = new App();
+				await app.init({
 					appName: 'fontoxml-development-tools-test-pre-7-7-0',
 					silent: true,
 					testMode: true,
@@ -1506,8 +1516,8 @@ describe('App', () => {
 				configDevelopmentToolsModulesBackup;
 		});
 
-		it('has built-in core module enabled', () => {
-			createAppWithLicensesForAllRealProducts();
+		it('has built-in core module enabled', async () => {
+			await createAppWithLicensesForAllRealProducts();
 
 			assert.ok(
 				app.modules.some(
@@ -1518,8 +1528,8 @@ describe('App', () => {
 			);
 		});
 
-		it('has built-in connectors module enabled', () => {
-			createAppWithLicensesForAllRealProducts();
+		it('has built-in connectors module enabled', async () => {
+			await createAppWithLicensesForAllRealProducts();
 
 			assert.ok(
 				app.modules.some(
@@ -1530,8 +1540,8 @@ describe('App', () => {
 			);
 		});
 
-		it('has built-in fcq module enabled', () => {
-			createAppWithLicensesForAllRealProducts();
+		it('has built-in fcq module enabled', async () => {
+			await createAppWithLicensesForAllRealProducts();
 
 			assert.ok(
 				app.modules.some(
@@ -1542,8 +1552,8 @@ describe('App', () => {
 			);
 		});
 
-		it('has built-in editor module enabled', () => {
-			createAppWithLicensesForAllRealProducts();
+		it('has built-in editor module enabled', async () => {
+			await createAppWithLicensesForAllRealProducts();
 
 			assert.ok(
 				app.modules.some(
@@ -1554,13 +1564,14 @@ describe('App', () => {
 			);
 		});
 
-		it('has built-in editor module enabled for pre 7.7.0 editors', () => {
+		it('has built-in editor module enabled for pre 7.7.0 editors', async () => {
 			process.chdir(oldCwd);
 			process.chdir(path.join(__dirname, 'app-pre-7-7-0'));
 
-			createAppWithLicensesForAllRealProducts();
+			await createAppWithLicensesForAllRealProducts();
 
-			app = new App({
+			app = new App();
+			await app.init({
 				appName: 'fontoxml-development-tools-test-pre-7-7-0',
 				silent: true,
 				testMode: true,
@@ -1611,8 +1622,9 @@ describe('App', () => {
 			);
 		});
 
-		it('can enable modules on a per editor basis using absolute paths', () => {
-			const appWithoutModules = new App({
+		it('can enable modules on a per editor basis using absolute paths', async () => {
+			const appWithoutModules = new App();
+			await appWithoutModules.init({
 				appName: 'fontoxml-development-tools-test',
 				silent: true,
 				skipAddModules: true,
@@ -1642,7 +1654,7 @@ describe('App', () => {
 			);
 
 			// Add modules to app, which will load the app specific module using the absolute path
-			addModulesToApp(appWithoutModules, appWithoutModules.request);
+			await addModulesToApp(appWithoutModules, appWithoutModules.request);
 
 			// Check if the module is actually loaded
 			assert.ok(
@@ -1652,8 +1664,9 @@ describe('App', () => {
 			);
 		});
 
-		it('does not load the same module twice and it outputs a notice about it', () => {
-			app = new App({
+		it('does not load the same module twice and it outputs a notice about it', async () => {
+			app = new App();
+			await app.init({
 				appName: 'fontoxml-development-tools-test',
 				hideStacktraceOnErrors: false,
 				skipAddModules: true,
@@ -1667,8 +1680,9 @@ describe('App', () => {
 				'modules',
 				'core'
 			);
-			const duplicateModule =
-				app.enableBuiltInModule(duplicateModulePath);
+			const duplicateModule = await app.enableBuiltInModule(
+				duplicateModulePath
+			);
 			assert.strictEqual(duplicateModule, null);
 
 			const startPosition = app.testOutput.findOutputIndex(
@@ -1690,7 +1704,7 @@ describe('App', () => {
 		});
 	});
 
-	it('can be created without tool specific logic', () => {
+	it('can be created without tool specific logic', async () => {
 		process.chdir(oldCwd);
 		const homedirConfigFilePath = path.join(
 			os.homedir(),
@@ -1704,7 +1718,8 @@ describe('App', () => {
 			// Ignore
 		}
 
-		const appStripped = new App({
+		const appStripped = new App();
+		await appStripped.init({
 			appName: 'fontoxml-development-tools-test',
 			configFilename: '.fdttestnocreatehomedirrc',
 			skipAddModules: true,
@@ -1765,46 +1780,51 @@ describe('App', () => {
 				const newCwd = process.cwd();
 				process.chdir(oldCwd);
 
-				const appOutsideEditorRepository = new App({
-					appName: 'fontoxml-development-tools-test',
-					silent: true,
-					testMode: true,
-				});
-
+				const appOutsideEditorRepository = new App();
 				appOutsideEditorRepository
-					.run([
-						'module',
-						'--dry',
-						'-a',
-						path.join(__dirname, 'app', 'test-module-1'),
-					])
+					.init({
+						appName: 'fontoxml-development-tools-test',
+						silent: true,
+						testMode: true,
+					})
 					.then(() => {
-						return appOutsideEditorRepository
-							.run(['test-command-1'])
+						appOutsideEditorRepository
+							.run([
+								'module',
+								'--dry',
+								'-a',
+								path.join(__dirname, 'app', 'test-module-1'),
+							])
 							.then(() => {
-								process.chdir(newCwd);
-								done(new Error('Should have thrown'));
+								appOutsideEditorRepository
+									.run(['test-command-1'])
+									.then(() => {
+										process.chdir(newCwd);
+										done(new Error('Should have thrown'));
+									})
+									.catch((error) => {
+										process.chdir(newCwd);
+										assert.ok(
+											error.hasOwnProperty('solution')
+										);
+										assert.strictEqual(
+											error.message,
+											'Not running from inside a Fonto Editor repository.'
+										);
+										assert.strictEqual(
+											error.solution,
+											'This command requires to be run from inside a Fonto Editor repository.'
+										);
+										done();
+									})
+									.catch((assertError) => {
+										done(assertError);
+									});
 							})
-							.catch((error) => {
+							.catch((_error) => {
 								process.chdir(newCwd);
-								assert.ok(error.hasOwnProperty('solution'));
-								assert.strictEqual(
-									error.message,
-									'Not running from inside a Fonto Editor repository.'
-								);
-								assert.strictEqual(
-									error.solution,
-									'This command requires to be run from inside a Fonto Editor repository.'
-								);
-								done();
-							})
-							.catch((assertError) => {
-								done(assertError);
+								done(new Error('Error while setting up test'));
 							});
-					})
-					.catch((_error) => {
-						process.chdir(newCwd);
-						done(new Error('Error while setting up test'));
 					});
 			});
 		});

package/test/AssertableWritableStream.test.js

@@ -1,12 +1,7 @@
-'use strict';
+import assert from 'assert';
+import stream from 'stream';
 
-const assert = require('assert');
-const stream = require('stream');
-
-const fontoxmlDevelopmentTools = require('../');
-
-const AssertableWritableStream =
-	fontoxmlDevelopmentTools.AssertableWritableStream;
+import { AssertableWritableStream } from '../index.js';
 
 let testOutput;
 

package/test/FdtCommand.test.js

@@ -1,10 +1,10 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const path = require('path');
+import { App } from '../index.js';
 
-const fontoxmlDevelopmentTools = require('../');
-
-const App = fontoxmlDevelopmentTools.App;
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const defaultStdoutColumns = process.stdout.columns;
 
@@ -12,13 +12,15 @@ describe('FdtCommand', () => {
 	let app;
 	let oldCwd;
 
-	beforeEach(() => {
+	beforeEach(async () => {
 		process.stdout.columns = 150;
 
 		oldCwd = process.cwd();
 		process.chdir(path.join(__dirname, 'app'));
 
-		app = new App({
+		app = new App();
+
+		await app.init({
 			appName: 'fontoxml-development-tools-test',
 			skipWarnIfNotInsideEditorRepository: true,
 			testMode: true,

package/test/FdtTable.test.js

@@ -1,14 +1,13 @@
-'use strict';
+import assert from 'assert';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const assert = require('assert');
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
+import { App, FdtTable } from '../index.js';
 
-const fontoxmlDevelopmentTools = require('../');
-
-const App = fontoxmlDevelopmentTools.App;
-const FdtTable = fontoxmlDevelopmentTools.FdtTable;
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const defaultStdoutColumns = process.stdout.columns;
 
@@ -20,7 +19,7 @@ let stubbedItems;
 let stubbedAdditionalItems;
 
 describe('FdtTable', () => {
-	beforeEach(() => {
+	beforeEach(async () => {
 		// cli-table, the package which outputs the table, uses this value, so make sure we have enough output width to
 		// output the table in unit tests.
 		process.stdout.columns = 150;
@@ -28,7 +27,9 @@ describe('FdtTable', () => {
 		oldCwd = process.cwd();
 		process.chdir(path.join(__dirname, 'app'));
 
-		app = new App({
+		app = new App();
+
+		await app.init({
 			appName: 'fontoxml-development-tools-test',
 			skipAddModules: true,
 			skipWarnIfNotInsideEditorRepository: true,

package/test/app/invalid-module-1/index.js

@@ -1 +1 @@
-module.exports = null;
+export default null;

package/test/app/invalid-module-1/package.json

@@ -1,4 +1,5 @@
 {
 	"name": "invalid-module-1",
+	"type": "module",
 	"version": "9.9.9"
 }

package/test/app/test-module-1/index.js

@@ -1,4 +1,4 @@
-module.exports = (moduleRegistration) => {
+export default (moduleRegistration) => {
 	moduleRegistration
 		.registerCommand('test-command-1')
 		.setLongDescription('Test command is used for test cases.')

package/test/app/test-module-1/package.json

@@ -1,4 +1,5 @@
 {
 	"name": "test-module-1",
+	"type": "module",
 	"version": "9.9.9"
 }

package/test/app/test-module-2/index.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 = (moduleRegistration) => {
+export default (moduleRegistration) => {
 	moduleRegistration.registerConfiguration('test-2-configuration', 'test-2');
 
 	moduleRegistration
@@ -25,22 +27,25 @@ module.exports = (moduleRegistration) => {
 		.setAsHelpCommand(false);
 
 	moduleRegistration
-		.registerCommand('test-2-command-4', './src/testLazyLoadCommand.js')
+		.registerCommand(
+			'test-2-command-4',
+			path.resolve(__dirname, 'src', 'testLazyLoadCommand.js')
+		)
 		.addCommand(
 			'test-command-4-sub-command-1',
-			'./src/testLazyLoadCommand.js'
+			path.resolve(__dirname, 'src', 'testLazyLoadCommand.js')
 		);
 
 	moduleRegistration.registerCommand(
 		'test-2-command-5',
-		path.resolve(path.join(__dirname, 'src/testLazyLoadCommand.js'))
+		path.resolve(__dirname, 'src', 'testLazyLoadCommand.js')
 	);
 
 	moduleRegistration
 		.registerCommand('test-2-command-6')
 		.addCommand(
 			'test-command-6-sub-command',
-			'./src/testLazyLoadCommand.js'
+			path.resolve(__dirname, 'src', 'testLazyLoadCommand.js')
 		);
 
 	moduleRegistration.registerContextInformer((_request, response) => {

package/test/app/test-module-2/package.json

@@ -1,4 +1,5 @@
 {
 	"name": "test-module-2",
+	"type": "module",
 	"version": "9.9.9"
 }

package/test/app/test-module-2/src/testLazyLoadCommand.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = function testLazyLoadCommand(req, res) {
+export default function testLazyLoadCommand(req, res) {
 	res.caption(`Test lazy load command: "${req.command && req.command.name}"`);
 
 	const moduleRegistration =
@@ -11,4 +9,4 @@ module.exports = function testLazyLoadCommand(req, res) {
 			moduleRegistration.constructor &&
 			moduleRegistration.constructor.name,
 	});
-};
+}

package/test/app/test-module-2-duplicate/index.js

@@ -1,5 +1,3 @@
-'use strict';
-
-module.exports = (_moduleRegistration) => {
+export default (_moduleRegistration) => {
 	// Duplicate module, but without actual code.
 };

package/test/app/test-module-2-duplicate/package.json

@@ -1,4 +1,5 @@
 {
 	"name": "test-module-2",
+	"type": "module",
 	"version": "8.8.8"
 }

package/test/app-pre-7-7-0/config.js

@@ -1,4 +1,4 @@
-module.exports = () => {
+export default () => {
 	const documentNumber = Math.floor(Math.random() * 10);
 
 	return {

package/test/app-with-configjs/config.js

@@ -1,4 +1,4 @@
-module.exports = () => {
+export default () => {
 	const documentNumber = Math.floor(Math.random() * 10);
 
 	return {