@fontoxml/fontoxml-development-tools 3.7.0-beta.7 → 3.8.0

package/src/modules/spell-checker/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 FontoxmlSpellCheckerManifest from './utilities/FontoxmlSpellCheckerManifest.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
 
-const constants = require('./utilities/constants');
-const FontoxmlSpellCheckerManifest = require('./utilities/FontoxmlSpellCheckerManifest');
-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/spell-checker/src/command.init.js

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

package/src/modules/spell-checker/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 FontoxmlSpellCheckerManifest = require('./utilities/FontoxmlSpellCheckerManifest');
-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 FontoxmlSpellCheckerManifest from './utilities/FontoxmlSpellCheckerManifest.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 verboseSpellCheckerConfigurationEntries = {
 	Logging__LogLevel__Default: 'Trace',
@@ -98,7 +96,7 @@ function copySpellCheckerConfiguration(
 	});
 }
 
-module.exports = function runCommand(req, res) {
+export default function runCommand(req, res) {
 	res.caption(req.command.getLongName());
 
 	const directoryPath = path.resolve(

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

package/src/modules/spell-checker/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 FontoxmlSpellCheckerManifest from './utilities/FontoxmlSpellCheckerManifest.js';
+import setEntryVisibility from './utilities/setEntryVisibility.js';
+import validateInstance from './utilities/validateInstance.js';
 
-const constants = require('./utilities/constants');
-const FontoxmlSpellCheckerManifest = require('./utilities/FontoxmlSpellCheckerManifest');
-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.
@@ -60,4 +58,4 @@ module.exports = async function upgradeCommand(req, res) {
 
 			throw error;
 		});
-};
+}

package/src/modules/spell-checker/src/command.upgrade.js

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

package/src/modules/spell-checker/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 Spell Checker versions');
 	res.list(all ? sdkVersions.getAll() : sdkVersions.getAllStable(), '-');
-};
+}

package/src/modules/spell-checker/src/command.versions.js

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

package/src/modules/spell-checker/src/utilities/FontoxmlSpellCheckerManifest.js

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

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

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

package/src/response/FdtResponse.js

@@ -1,14 +1,11 @@
-'use strict';
+import ask from 'ask-nicely';
+import Table from 'cli-table';
+import os from 'os';
+import stripAnsi from 'strip-ansi';
+import util from 'util';
 
-const ask = require('ask-nicely');
-const os = require('os');
-const util = require('util');
-
-const Table = require('cli-table');
-const stripAnsi = require('strip-ansi');
-
-const primitives = require('./primitives');
-const extras = require('./extras');
+import extras from './extras.js';
+import primitives from './primitives.js';
 
 const DEFAULT_CONFIG = {
 	defaultWidth: extras.defaultWidth,
@@ -61,7 +58,7 @@ class ErrorWithInnerError extends ErrorWithSolution {
 	}
 }
 
-class FdtResponse {
+export default class FdtResponse {
 	/**
 	 *
 	 * @param {Object} [colors]
@@ -530,5 +527,3 @@ class FdtResponse {
 		);
 	}
 }
-
-module.exports = FdtResponse;

package/src/response/extras.js

@@ -1,10 +1,8 @@
-'use strict';
+import os from 'os';
 
-const os = require('os');
+import primitives from './primitives.js';
 
-const primitives = require('./primitives');
-
-module.exports = {
+export default {
 	defaultWidth: 200,
 	defaultTheme: {
 		log: ['reset'],

package/src/response/primitives.js

@@ -1,6 +1,6 @@
-const os = require('os');
-const wrapAnsi = require('wrap-ansi');
-const chalk = require('chalk');
+import chalk from 'chalk';
+import os from 'os';
+import wrapAnsi from 'wrap-ansi';
 
 function getTerminalWidth() {
 	return process.stdout.columns;
@@ -76,7 +76,7 @@ function getLeftIndentationString(indentation, indentationLevel) {
 	return str;
 }
 
-module.exports = {
+export default {
 	wrap,
 	formatString,
 	indentString,