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

package/src/modules/content-quality/src/command.upgrade.controller.js

@@ -1,52 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './utilities/constants.js';
-import FontoxmlFcqManifest from './utilities/FontoxmlFcqManifest.js';
-import setEntryVisibility from './utilities/setEntryVisibility.js';
-
-export default async function upgradeCommand(req, res) {
-	res.caption(req.command.getLongName());
-
-	// Check if the given version exist.
-	const sdkVersions = await req.fdt.license.getVersionsForProduct(
-		'content-quality'
-	);
-	const version = req.options.version;
-	if (!sdkVersions.includes(version)) {
-		throw new Error(
-			`Could not upgrade to version (${version}), please check if it is a valid version. The latest version is ${sdkVersions.getLatestStable()}, run \`fdt content-quality versions\` to get a list of all available versions.`
-		);
-	}
-
-	const destroySpinner = res.spinner(
-		`Upgrading your Fonto Content Quality instance to ${version}...`
-	);
-
-	const directoryPath = path.resolve(
-		req.options.location ? req.options.location : process.cwd()
-	);
-	const manifestFilePath = path.join(
-		directoryPath,
-		constants.MANIFEST_FILENAME
-	);
-	let currentVersion;
-	return setEntryVisibility(manifestFilePath, true)
-		.then(() => FontoxmlFcqManifest.fromJsonFile(manifestFilePath))
-		.then((manifest) => {
-			currentVersion = manifest.fcqVersion;
-			manifest.fcqVersion = version;
-			return fs.writeJson(manifestFilePath, manifest);
-		})
-		.then(() => setEntryVisibility(manifestFilePath, false))
-		.then(() =>
-			req.fdt.license.sendTelemetry({
-				product: req.command.parent.name,
-				type: 'docker',
-				version,
-				currentVersion,
-				action: req.command.name,
-			})
-		)
-		.then(() => destroySpinner());
-}

package/src/modules/content-quality/src/command.upgrade.js

@@ -1,44 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-import constants from './utilities/constants.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default (moduleRegistration, fcqCommand) => {
-	fcqCommand
-		.addCommand(
-			'upgrade',
-			path.resolve(__dirname, 'command.upgrade.controller.js')
-		)
-		.setDescription(
-			'Upgrade an existing Fonto Content Quality instance to the specified version.'
-		)
-
-		.addOption(
-			'location',
-			'l',
-			'The directory of the instance to upgrade. If not set this defaults to the current working directory.',
-			false
-		)
-		.addOption(
-			'version',
-			null,
-			'The version to upgrade to. Can be either a specific version or "nightly". Be warned: nightly can be unstable or may not work at all.',
-			true
-		)
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} upgrade --version x.x.x`,
-			'Upgrade the Fonto Content Quality instance located at the current working directory to version x.x.x.'
-		)
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} ${
-				constants.COMMAND_PREFIX
-			} upgrade --location /opt/my-instance/ --version x.x.x`,
-			'Upgrade the Fonto Content Quality instance located at "/opt/my-instance/" to version x.x.x.'
-		);
-};

package/src/modules/content-quality/src/command.versions.controller.js

@@ -1,14 +0,0 @@
-export default async function versionsCommand(req, res) {
-	res.caption(req.command.getLongName());
-
-	const all = req.options.all;
-	const destroySpinner = res.spinner(
-		`Retrieving ${all ? 'all ' : ''}Fonto Content Quality versions...`
-	);
-	const sdkVersions = await req.fdt.license.getVersionsForProduct(
-		'content-quality'
-	);
-	destroySpinner();
-	res.caption('Fonto Content Quality versions');
-	res.list(all ? sdkVersions.getAll() : sdkVersions.getAllStable(), '-');
-}

package/src/modules/content-quality/src/command.versions.js

@@ -1,25 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export default (moduleRegistration, fcqCommand) => {
-	fcqCommand
-		.addCommand(
-			'versions',
-			path.resolve(__dirname, 'command.versions.controller.js')
-		)
-		.setDescription('List the available Fonto Content Quality versions.')
-
-		.addHiddenOption(
-			'all',
-			undefined,
-			'Include nightly and prerelease versions.'
-		)
-
-		.addExample(
-			`${moduleRegistration.getAppInfo().name} content-quality versions`,
-			'Request the available versions for Fonto Content Quality.'
-		);
-};

package/src/modules/content-quality/src/utilities/FontoxmlFcqManifest.js

@@ -1,30 +0,0 @@
-import fs from 'fs-extra';
-
-export default class FontoxmlFcqManifest {
-	constructor(fcqVersion) {
-		this.fcqVersion = fcqVersion;
-	}
-
-	static fromJsonFile(filePath) {
-		return fs
-			.exists(filePath)
-			.then((exists) => {
-				if (!exists) {
-					throw new Error(`The file ${filePath} does not exist.`);
-				}
-			})
-			.then(() => fs.readJson(filePath))
-			.then((content) => {
-				FontoxmlFcqManifest.validate(content);
-				return new FontoxmlFcqManifest(content.fcqVersion);
-			});
-	}
-
-	static validate(input) {
-		if (!input.fcqVersion) {
-			throw new Error(
-				"The Fonto Content Quality manifest file does not contain a 'fcqVersion'."
-			);
-		}
-	}
-}

package/src/modules/content-quality/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/content-quality/src/utilities/constants.js

@@ -1,44 +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-content-quality',
-	DEFAULT_IMAGE_TAG: 'latest',
-	VERBOSITY_LEVEL_DEBUG: 'debug',
-	VERBOSITY_LEVEL_NORMAL: 'normal',
-	VERBOSITY_LEVEL_VERBOSE: 'verbose',
-	DOCUMENTATION_CONFIGURATION_GUIDE:
-		'https://documentation.fontoxml.com/latest/configuration-f6814dd919fd',
-	DOCUMENTATION_GETTING_STARTED_GUIDE:
-		'https://documentation.fontoxml.com/latest/getting-started-86c3404e841c',
-	DOCUMENTATION_EXECUTE_ERROR:
-		'https://documentation.fontoxml.com/latest/troubleshooting-fc105f9f1e60',
-	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: '.fontoxmlFcqManifest',
-	REQUIRED_CONFIGURATION: ['Configuration'],
-	TEMPORARY_DIRECTORY_NAME: '.contentQualityTmp',
-	TEMPORARY_BUILD_DIRECTORY_NAME: '.contentQualityBuildTmp',
-	WHITELIST: ['nlog.config'],
-	COMMAND_PREFIX: 'content-quality',
-	COMMAND_PREFIX_ALIAS: 'fcq',
-};

package/src/modules/content-quality/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/content-quality/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/content-quality/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/content-quality/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/content-quality/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/content-quality/src/utilities/validateInstance.js

@@ -1,29 +0,0 @@
-import fs from 'fs-extra';
-import path from 'path';
-
-import constants from './constants.js';
-
-export default function validateInstance(directoryPath) {
-	return fs
-		.exists(directoryPath)
-		.then((exists) => {
-			if (!exists) {
-				throw new Error(`Directory "${directoryPath}" does not exist.`);
-			}
-		})
-		.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 Content Quality instance. Missing "${entryName}".`
-								);
-							}
-						});
-				})
-			);
-		});
-}