@fontoxml/fontoxml-development-tools 3.7.0 → 3.8.1

package/src/modules/operations/test/index.test.js

@@ -1,31 +1,31 @@
-'use strict';
+import assert from 'assert';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const assert = require('assert');
-const path = require('path');
+import { App } from '../../../../index.js';
+import operationsModule from '../index.js';
 
-const fontoxmlDevelopmentTools = require('../../../../');
-
-const App = fontoxmlDevelopmentTools.App;
-
-const operationsModule = require('../');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 let app;
 let oldCwd;
 let loadedOperationsModule;
 
 describe('fontoxml-development-tools-module-operations', () => {
-	beforeEach(() => {
+	beforeEach(async () => {
 		oldCwd = process.cwd();
 		process.chdir(path.join(__dirname, 'app'));
 
-		app = new App({
+		app = new App();
+		await app.init({
 			appName: 'fontoxml-development-tools-module-operations-test',
 			skipAddModules: true,
 			skipWarnIfNotInsideEditorRepository: true,
 			testMode: true,
 		});
 
-		loadedOperationsModule = app.enableBuiltInModule(
+		loadedOperationsModule = await app.enableBuiltInModule(
 			path.join(__dirname, '..')
 		);
 	});

package/src/modules/review/index.js

@@ -1,6 +1,11 @@
-'use strict';
+import commandBuild from './src/command.build.js';
+import commandDownloadSelfContained from './src/command.download-self-contained.js';
+import commandInit from './src/command.init.js';
+import commandRun from './src/command.run.js';
+import commandUpgrade from './src/command.upgrade.js';
+import commandVersions from './src/command.versions.js';
 
-module.exports = (moduleRegistration) => {
+export default (moduleRegistration) => {
 	const reviewCommand = moduleRegistration
 		.registerCommand('review')
 		.setDescription('Provides tools for working with Fonto Review.')
@@ -8,12 +13,10 @@ module.exports = (moduleRegistration) => {
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	[
-		require('./src/command.build.js'),
-		require('./src/command.download-self-contained.js'),
-		require('./src/command.init.js'),
-		require('./src/command.run.js'),
-		require('./src/command.upgrade.js'),
-		require('./src/command.versions.js'),
-	].forEach((mod) => mod(moduleRegistration, reviewCommand));
+	commandBuild(moduleRegistration, reviewCommand);
+	commandDownloadSelfContained(moduleRegistration, reviewCommand);
+	commandInit(moduleRegistration, reviewCommand);
+	commandRun(moduleRegistration, reviewCommand);
+	commandUpgrade(moduleRegistration, reviewCommand);
+	commandVersions(moduleRegistration, reviewCommand);
 };

package/src/modules/review/package.json

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

package/src/modules/review/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 FontoxmlReviewManifest from './utilities/FontoxmlReviewManifest.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 FontoxmlReviewManifest = require('./utilities/FontoxmlReviewManifest');
-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(
@@ -255,4 +253,4 @@ module.exports = function buildCommand(req, res) {
 					});
 			})
 	);
-};
+}

package/src/modules/review/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, reviewCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, reviewCommand) => {
 	reviewCommand
-		.addCommand('build', './command.build.controller')
+		.addCommand(
+			'build',
+			path.resolve(__dirname, 'command.build.controller.js')
+		)
 		.setDescription(
 			'Build a Fonto Review Docker image for production use. Requires Docker to be installed.'
 		)

package/src/modules/review/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(
@@ -106,4 +104,4 @@ module.exports = function buildCommand(req, res) {
 					);
 				});
 		});
-};
+}

package/src/modules/review/src/command.download-self-contained.js

@@ -1,10 +1,17 @@
-'use strict';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-module.exports = (moduleRegistration, reviewCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, reviewCommand) => {
 	reviewCommand
 		.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/review/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 FontoxmlReviewManifest from './utilities/FontoxmlReviewManifest.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
 
-const constants = require('./utilities/constants');
-const FontoxmlReviewManifest = require('./utilities/FontoxmlReviewManifest');
-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.
@@ -88,4 +86,4 @@ module.exports = async function initCommand(req, res) {
 				`See ${constants.DOCUMENTATION_GETTING_STARTED_GUIDE} for more information.`
 			);
 		});
-};
+}

package/src/modules/review/src/command.init.js

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

package/src/modules/review/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 FontoxmlReviewManifest = require('./utilities/FontoxmlReviewManifest');
-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 cleanup from './utilities/cleanup.js';
+import constants from './utilities/constants.js';
+import copyWhitelistedFiles from './utilities/copyWhitelistedFiles.js';
+import executeAndLog from './utilities/executeAndLog.js';
+import FontoxmlReviewManifest from './utilities/FontoxmlReviewManifest.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 verboseReviewConfigurationEntries = {
 	Logging__LogLevel__Default: 'Trace',
@@ -97,7 +95,7 @@ function copyReviewConfiguration(
 	});
 }
 
-module.exports = function runCommand(req, res) {
+export default function runCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	const directoryPath = path.resolve(
@@ -427,4 +425,4 @@ module.exports = function runCommand(req, res) {
 					});
 			})
 	);
-};
+}

package/src/modules/review/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, reviewCommand) => {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default (moduleRegistration, reviewCommand) => {
 	reviewCommand
-		.addCommand('run', './command.run.controller')
+		.addCommand('run', path.resolve(__dirname, 'command.run.controller.js'))
 		.setDescription(
 			'Run a Fonto Review instance for development purposes. Requires Docker to be installed.'
 		)

package/src/modules/review/src/command.upgrade.controller.js

@@ -1,14 +1,12 @@
-'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 FontoxmlReviewManifest from './utilities/FontoxmlReviewManifest.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
+import validateInstance from './utilities/validateInstance.js';
 
-const constants = require('./utilities/constants');
-const FontoxmlReviewManifest = require('./utilities/FontoxmlReviewManifest');
-const setEntryVisibility = require('./utilities/setEntryVisibility');
-const validateInstance = require('./utilities/validateInstance');
-
-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.
@@ -58,4 +56,4 @@ module.exports = async function upgradeCommand(req, res) {
 
 			throw error;
 		});
-};
+}

package/src/modules/review/src/command.upgrade.js

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

package/src/modules/review/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;
@@ -11,4 +9,4 @@ module.exports = async function versionsCommand(req, res) {
 	destroySpinner();
 	res.caption('Fonto Review versions');
 	res.list(all ? sdkVersions.getAll() : sdkVersions.getAllStable(), '-');
-};
+}

package/src/modules/review/src/command.versions.js

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

package/src/modules/review/src/utilities/FontoxmlReviewManifest.js

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

package/src/modules/review/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/review/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-review',
 	DEFAULT_IMAGE_TAG: 'latest',
 	VERBOSITY_LEVEL_DEBUG: 'debug',

package/src/modules/review/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/review/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/review/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/review/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/review/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/review/src/utilities/validateInstance.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 FontoxmlReviewManifest from './FontoxmlReviewManifest.js';
 
-const FontoxmlReviewManifest = require('./FontoxmlReviewManifest');
-const constants = require('./constants');
-
-module.exports = function validateInstance(directoryPath) {
+export default function validateInstance(directoryPath) {
 	const manifestFilePath = path.join(
 		directoryPath,
 		constants.MANIFEST_FILENAME
@@ -44,4 +42,4 @@ module.exports = function validateInstance(directoryPath) {
 				})
 			);
 		});
-};
+}

package/src/modules/schema/index.js

@@ -1,10 +1,15 @@
-'use strict';
+import os from 'os';
 
-module.exports = (moduleRegistration) => {
-	moduleRegistration.registerContextInformer((req, res) => {
-		const os = require('os');
-		const getSchemaSummaries = require('./src/api/getSchemaSummaries');
+import getSchemaSummaries from './src/api/getSchemaSummaries.js';
+import commandAttribute from './src/command.attribute.js';
+import commandattributes from './src/command.attributes.js';
+import commandElement from './src/command.element.js';
+import commandElements from './src/command.elements.js';
+import commandSchemas from './src/command.schemas.js';
+import commandSympleTypes from './src/command.simpletypes.js';
 
+export default (moduleRegistration) => {
+	moduleRegistration.registerContextInformer((req, res) => {
 		res.caption('Schema locations');
 
 		const schemaSummaries = req.fdt.editorRepository.path
@@ -25,23 +30,10 @@ module.exports = (moduleRegistration) => {
 		);
 	});
 
-	[
-		require('./src/command.attribute.js'),
-		require('./src/command.attributes.js'),
-		require('./src/command.element.js'),
-		require('./src/command.elements.js'),
-		require('./src/command.schemas.js'),
-		require('./src/command.simpletypes.js'),
-	].forEach((mod) => mod(moduleRegistration));
-};
-
-module.exports.getApi = function getApi() {
-	return {
-		getClosestMatchingSchemaSummary: require('./src/api/getClosestMatchingSchemaSummary'),
-		getSchemaSummaries: require('./src/api/getSchemaSummaries'),
-
-		AttributeSummary: require('./src/api/AttributeSummary'),
-		ElementSummary: require('./src/api/ElementSummary'),
-		SchemaSummary: require('./src/api/SchemaSummary'),
-	};
+	commandAttribute(moduleRegistration);
+	commandattributes(moduleRegistration);
+	commandElement(moduleRegistration);
+	commandElements(moduleRegistration);
+	commandSchemas(moduleRegistration);
+	commandSympleTypes(moduleRegistration);
 };

package/src/modules/schema/package.json

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