@fontoxml/fontoxml-development-tools 3.10.0 → 3.12.0-beta.1

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

@@ -1,70 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-import executeAndLog from './executeAndLog.js';
-
-export default async function cleanup(
-	temporaryDirectoryPath,
-	projectName,
-	res,
-	verbosityLevel
-) {
-	const temporaryDirectoryExists = await fs.exists(temporaryDirectoryPath);
-	if (!temporaryDirectoryExists) {
-		return;
-	}
-
-	const destroySpinner = res.spinner('Removing temporary resources...');
-
-	try {
-		const dockerComposeFileExists = await fs.exists(
-			path.join(temporaryDirectoryPath, 'docker-compose.yml')
-		);
-
-		const errors = [];
-		const tasks = [
-			async () => {
-				if (dockerComposeFileExists && projectName) {
-					await executeAndLog(
-						res,
-						'docker-compose',
-						verbosityLevel === constants.VERBOSITY_LEVEL_DEBUG
-							? [
-									'-p',
-									projectName,
-									'--verbose',
-									'down',
-									'--rmi',
-									'local',
-							  ]
-							: ['-p', projectName, 'down', '--rmi', 'local'],
-						temporaryDirectoryPath,
-						verbosityLevel
-					);
-				}
-			},
-			async () => {
-				await fs.remove(temporaryDirectoryPath);
-			},
-		];
-
-		// Run all cleanup tasks in order. Continue on errors. But collect the errors.
-		for (let i = 0; i < tasks.length; i++) {
-			try {
-				await tasks[i]();
-			} catch (error) {
-				errors.push(error);
-			}
-		}
-
-		// Only throw if a task have failed.
-		if (errors.length > 0) {
-			throw errors[0];
-		}
-	} catch (error) {
-		throw error;
-	} finally {
-		destroySpinner();
-	}
-}

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

@@ -1,42 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default {
-	DEFAULT_IMAGE_NAME: 'fonto-spell-checker',
-	DEFAULT_IMAGE_TAG: 'latest',
-	VERBOSITY_LEVEL_DEBUG: 'debug',
-	VERBOSITY_LEVEL_NORMAL: 'normal',
-	VERBOSITY_LEVEL_VERBOSE: 'verbose',
-	DOCUMENTATION_CONFIGURATION_GUIDE:
-		'https://documentation.fontoxml.com/latest/fontoxml-spell-checker-4428b1080ce1',
-	DOCUMENTATION_GETTING_STARTED_GUIDE:
-		'https://documentation.fontoxml.com/latest/fontoxml-spell-checker-4428b1080ce1',
-	DOCUMENTATION_EXECUTE_ERROR:
-		'https://documentation.fontoxml.com/latest/fontoxml-spell-checker-4428b1080ce1',
-	INSTANCE_BUILD_DIRECTORY_PATH: path.join(
-		__dirname,
-		'..',
-		'..',
-		'instanceBuild'
-	),
-	INSTANCE_DEV_BUILD_DIRECTORY_PATH: path.join(
-		__dirname,
-		'..',
-		'..',
-		'instanceDevBuild'
-	),
-	INSTANCE_TEMPLATE_DIRECTORY_PATH: path.join(
-		__dirname,
-		'..',
-		'..',
-		'instanceTemplate'
-	),
-	MANIFEST_FILENAME: '.fontoxmlSpellCheckerManifest',
-	REQUIRED_CONFIGURATION: [],
-	TEMPORARY_DIRECTORY_NAME: '.spellCheckerTmp',
-	TEMPORARY_BUILD_DIRECTORY_NAME: '.spellCheckerBuildTmp',
-	WHITELIST: ['nlog.config'],
-};

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

@@ -1,22 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-export default function copyWhitelistedFiles(
-	whitelistedFiles,
-	sourceDirectory,
-	destinationDirectory
-) {
-	return Promise.all(
-		whitelistedFiles.map((item) => {
-			const itemPath = path.join(sourceDirectory, item);
-			return fs.exists(itemPath).then((exists) => {
-				if (exists) {
-					return fs.copy(
-						itemPath,
-						path.join(destinationDirectory, item)
-					);
-				}
-			});
-		})
-	);
-}

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

@@ -1,63 +0,0 @@
-import cp from 'child_process';
-
-import constants from './constants.js';
-
-export default function executeAndLog(
-	res,
-	command,
-	args,
-	currentWorkingDirectoryPath,
-	verbosityLevel,
-	showStdout,
-	processCreatedCallback
-) {
-	return new Promise((resolve, reject) => {
-		const errors = [];
-		const childProcess = cp.spawn(command, args, {
-			cwd: currentWorkingDirectoryPath,
-		});
-		const verbose = verbosityLevel !== constants.VERBOSITY_LEVEL_NORMAL;
-
-		if (processCreatedCallback) {
-			processCreatedCallback(process);
-		}
-
-		childProcess.stdout.on('data', (data) => {
-			if (verbose || showStdout) {
-				res.log(data);
-			}
-		});
-
-		childProcess.stderr.on('data', (data) => {
-			if (verbosityLevel === constants.VERBOSITY_LEVEL_DEBUG) {
-				res.log(data);
-			} else {
-				errors.push(data.toString());
-			}
-		});
-
-		childProcess.on('error', (error) => {
-			res.error(error);
-		});
-
-		childProcess.on('close', (code) => {
-			if (code === 0) {
-				if (verbose) {
-					res.debug(
-						`${command} ${args.join(' ')} exited with code ${code}`
-					);
-				}
-				resolve();
-			} else {
-				if (verbosityLevel !== constants.VERBOSITY_LEVEL_DEBUG) {
-					errors.forEach((error) => res.log(error));
-				}
-				reject(
-					new Error(
-						`${command} ${args.join(' ')} exited with code ${code}`
-					)
-				);
-			}
-		});
-	});
-}

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

@@ -1,11 +0,0 @@
-import constants from './constants.js';
-
-export default function getVerbosityLevel(verbose, debug) {
-	if (debug) {
-		return constants.VERBOSITY_LEVEL_DEBUG;
-	}
-	if (verbose) {
-		return constants.VERBOSITY_LEVEL_VERBOSE;
-	}
-	return constants.VERBOSITY_LEVEL_NORMAL;
-}

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

@@ -1,16 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-
-export default function getWhitelist() {
-	return fs
-		.readdir(constants.INSTANCE_TEMPLATE_DIRECTORY_PATH)
-		.then((entries) => {
-			return entries.map((entry) => path.basename(entry));
-		})
-		.then((whitelist) => {
-			whitelist.push(...constants.WHITELIST);
-			return whitelist;
-		});
-}

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

@@ -1,22 +0,0 @@
-import fswin from 'fswin';
-
-export default function setEntryVisibility(entryPath, isVisible) {
-	return new Promise((resolve, reject) => {
-		if (fswin) {
-			fswin.setAttributes(
-				entryPath,
-				{ IS_HIDDEN: !isVisible },
-				(success) => {
-					if (!success) {
-						reject();
-						return;
-					}
-					resolve();
-				}
-			);
-			return;
-		}
-
-		resolve();
-	});
-}

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

@@ -1,47 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-import FontoxmlSpellCheckerManifest from './FontoxmlSpellCheckerManifest.js';
-
-export default function validateInstance(directoryPath) {
-	const manifestFilePath = path.join(
-		directoryPath,
-		constants.MANIFEST_FILENAME
-	);
-	return fs
-		.exists(directoryPath)
-		.then((exists) => {
-			if (!exists) {
-				throw new Error(`Directory "${directoryPath}" does not exist.`);
-			}
-		})
-		.then(() => fs.exists(manifestFilePath))
-		.then((exists) => {
-			// Verify fontoxmlSpellCheckerManifest file is present and valid.
-			if (!exists) {
-				throw new Error(
-					'The Fonto Spell Checker manifest file does not exist.'
-				);
-			} else {
-				return FontoxmlSpellCheckerManifest.fromJsonFile(
-					manifestFilePath
-				);
-			}
-		})
-		.then(() => {
-			return Promise.all(
-				constants.REQUIRED_CONFIGURATION.map((entryName) => {
-					return fs
-						.exists(path.join(directoryPath, entryName))
-						.then((exists) => {
-							if (!exists) {
-								throw new Error(
-									`Directory "${directoryPath}" does not contain a valid Fonto Spell Checker instance. Missing "${entryName}".`
-								);
-							}
-						});
-				})
-			);
-		});
-}