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

package/src/modules/editor-pre-7-7-0/test/schemaCompileController.test.js

@@ -0,0 +1,205 @@
+import assert from 'assert';
+
+import { shouldUseTypeScriptForSchemaPackages } from '../src/command.schema.compile.controller.js';
+
+describe('src/modules/editor-pre-7-7-0/src/command.schema.compile.controller.js', () => {
+	describe('shouldUseTypeScriptForSchemaPackages', () => {
+		describe('for editors that support TypeScript', () => {
+			it('uses TypeScript when there are no pre-existing SCHEMA_LOCATIONS file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = true;
+				const hasSchemaLocationsJs = false;
+				const hasSchemaLocationsTs = false;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, true);
+			});
+
+			it('uses TypeScript when there are both pre-existing SCHEMA_LOCATIONS.js and SCHEMA_LOCATIONS.ts file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = true;
+				const hasSchemaLocationsJs = true;
+				const hasSchemaLocationsTs = true;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, true);
+			});
+
+			it('does not use TypeScript when there are only pre-existing SCHEMA_LOCATIONS.js file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = true;
+				const hasSchemaLocationsJs = true;
+				const hasSchemaLocationsTs = false;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, false);
+			});
+
+			it('uses TypeScript when there are only pre-existing SCHEMA_LOCATIONS.ts file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = true;
+				const hasSchemaLocationsJs = false;
+				const hasSchemaLocationsTs = true;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, true);
+			});
+		});
+
+		describe('for editors that do not support TypeScript', () => {
+			it('does not use TypeScript when there are no pre-existing SCHEMA_LOCATIONS file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = false;
+				const hasSchemaLocationsTs = false;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, false);
+			});
+
+			it('does not use TypeScript when there are both pre-existing SCHEMA_LOCATIONS.js and SCHEMA_LOCATIONS.ts file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = true;
+				const hasSchemaLocationsTs = true;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, false);
+			});
+
+			it('does not use TypeScript when there are only pre-existing SCHEMA_LOCATIONS.js file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = true;
+				const hasSchemaLocationsTs = false;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, false);
+			});
+
+			it('does not use TypeScript when there are only pre-existing SCHEMA_LOCATIONS.ts file(s)', () => {
+				const isEditorRepositoryPath = true;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = false;
+				const hasSchemaLocationsTs = true;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, false);
+			});
+		});
+
+		describe('when running outside of an editor or editor repo', () => {
+			it('uses TypeScript when there are no pre-existing SCHEMA_LOCATIONS file(s)', () => {
+				const isEditorRepositoryPath = false;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = false;
+				const hasSchemaLocationsTs = false;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, true);
+			});
+
+			it('uses TypeScript when there are both pre-existing SCHEMA_LOCATIONS.js and SCHEMA_LOCATIONS.ts file(s)', () => {
+				const isEditorRepositoryPath = false;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = true;
+				const hasSchemaLocationsTs = true;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, true);
+			});
+
+			it('does not use TypeScript when there are only pre-existing SCHEMA_LOCATIONS.js file(s)', () => {
+				const isEditorRepositoryPath = false;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = true;
+				const hasSchemaLocationsTs = false;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, false);
+			});
+
+			it('uses TypeScript when there are only pre-existing SCHEMA_LOCATIONS.ts file(s)', () => {
+				const isEditorRepositoryPath = false;
+				const editorSupportsTypeScript = false;
+				const hasSchemaLocationsJs = false;
+				const hasSchemaLocationsTs = true;
+
+				const result = shouldUseTypeScriptForSchemaPackages(
+					isEditorRepositoryPath,
+					editorSupportsTypeScript,
+					hasSchemaLocationsJs,
+					hasSchemaLocationsTs
+				);
+
+				assert.strictEqual(result, true);
+			});
+		});
+	});
+});

package/src/modules/localization/index.js

@@ -1,5 +1,5 @@
+import fastGlob from 'fast-glob';
 import fs from 'fs';
-import glob from 'globby';
 import path from 'path';
 
 import commandExtract from './src/command.extract.js';
@@ -14,7 +14,7 @@ export default (moduleRegistration) => {
 		let messageBundles;
 
 		if (req.fdt.editorRepository.path) {
-			messageBundles = glob.sync(
+			messageBundles = fastGlob.sync(
 				[
 					'packages/**/messages.*.json',
 					'packages-shared/**/messages.*.json',

package/src/modules/operations/src/api/getOperations.js

@@ -1,9 +1,9 @@
+import fastGlob from 'fast-glob';
 import fs from 'fs';
-import glob from 'globby';
 import path from 'path';
 
 export default function getOperations(workingDirectory, roots, ignoreSymlinks) {
-	return glob(
+	return fastGlob(
 		Array.isArray(roots)
 			? roots.map((root) => path.join(root, '**', 'operations?(-*).json'))
 			: [
@@ -14,7 +14,7 @@ export default function getOperations(workingDirectory, roots, ignoreSymlinks) {
 			  ],
 		{
 			cwd: workingDirectory,
-			follow: !ignoreSymlinks,
+			followSymbolicLinks: !ignoreSymlinks,
 		}
 	).then((operationsJsons) => {
 		return operationsJsons.reduce((allOps, operationsJson) => {

package/src/modules/review/index.js

@@ -1,22 +1,107 @@
-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';
-
-export default (moduleRegistration) => {
-	const reviewCommand = moduleRegistration
-		.registerCommand('review')
-		.setDescription('Provides tools for working with Fonto Review.')
-		.addRequiredProductLicenses(['review'])
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default async (moduleRegistration) => {
+	const options = {
+		licenseProductName: 'review',
+		licensesRequired: ['review'],
+		productLabel: 'Fonto Review',
+		commandPrefix: 'review',
+
+		documentationConfigurationGuide:
+			'https://documentation.fontoxml.com/latest/configuration-13d2d631668c',
+		documentationExecuteError:
+			'https://documentation.fontoxml.com/latest/review-9c9f35e6d1bf',
+		documentationGettingStartedGuide:
+			'https://documentation.fontoxml.com/latest/getting-started-8ca615260377',
+
+		defaultHttpPort: 6020,
+		defaultImageName: 'fonto-review',
+		defaultImageTag: 'latest',
+
+		manifestFileName: '.fontoxmlReviewManifest',
+		manifestVersionPropertyName: 'reviewVersion',
+
+		instanceBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceDevBuildDirectoryPath: path.join(__dirname, 'instanceDevBuild'),
+		instanceDevBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceTemplateDirectoryPath: path.join(__dirname, 'instanceTemplate'),
+
+		requiredConfiguration: [],
+		temporaryDirectoryName: '.reviewTmp',
+		temporaryBuildDirectoryName: '.reviewBuildTmp',
+		whitelist: [
+			// Required.
+			'exports.xml',
+			// Optional.
+			'nlog.config',
+		],
+
+		debugEnvEntries: {
+			Logging__LogLevel__Default: 'Trace',
+		},
+	};
+
+	const command = moduleRegistration
+		.registerCommand(options.commandPrefix)
+		.setDescription(
+			`Provides tools for working with ${options.productLabel}.`
+		)
+
+		.addRequiredProductLicenses(options.licensesRequired)
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	commandBuild(moduleRegistration, reviewCommand);
-	commandDownloadSelfContained(moduleRegistration, reviewCommand);
-	commandInit(moduleRegistration, reviewCommand);
-	commandRun(moduleRegistration, reviewCommand);
-	commandUpgrade(moduleRegistration, reviewCommand);
-	commandVersions(moduleRegistration, reviewCommand);
+	if (options.commandAlias) {
+		command.addAlias(options.commandAlias);
+	}
+
+	const sharedModulePath = moduleRegistration.getPathToModule(
+		'@fontoxml/fontoxml-development-tools-module-shared'
+	);
+
+	// Add the docker based commands.
+	const addBackendDockerCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendDockerCommands.js')
+	);
+	const addBackendDockerCommands = (
+		await import(addBackendDockerCommandsPath)
+	).default;
+	addBackendDockerCommands(moduleRegistration, command, options);
+
+	// Add the version commands.
+	const addBackendVersionsCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendVersionsCommands.js')
+	);
+	const addBackendVersionsCommands = (
+		await import(addBackendVersionsCommandsPath)
+	).default;
+	addBackendVersionsCommands(moduleRegistration, command, options);
+
+	// Add the download-self-contained command.
+	const addBackendDownloadSelfContainedCommandsPath = pathToFileURL(
+		path.resolve(
+			sharedModulePath,
+			'src/addBackendDownloadSelfContainedCommands.js'
+		)
+	);
+	const addBackendDownloadSelfContainedCommands = (
+		await import(addBackendDownloadSelfContainedCommandsPath)
+	).default;
+	addBackendDownloadSelfContainedCommands(
+		moduleRegistration,
+		command,
+		options
+	);
 };

package/src/modules/review/instanceBuild/Dockerfile

@@ -1,4 +1,4 @@
-FROM ${reviewImage}
+FROM ${image}
 
 # copy files
 COPY ./instance .

package/src/modules/review/instanceDevBuild/docker-compose.yml

@@ -6,4 +6,4 @@ services:
         env_file:
             - .env
         ports:
-            - '${reviewPort}:80'
+            - '${httpPort}:80'

package/src/modules/schema/src/api/getSchemaSummaries.js

@@ -1,4 +1,4 @@
-import glob from 'globby';
+import fastGlob from 'fast-glob';
 import path from 'path';
 
 import SchemaSummary from './SchemaSummary.js';
@@ -6,7 +6,7 @@ import SchemaSummary from './SchemaSummary.js';
 export default function getSchemaSummaries(p) {
 	const basePath = path.resolve(p);
 
-	return glob
+	return fastGlob
 		.sync(
 			[
 				// Traditional schema files compiled in a build

package/src/modules/schema/test/getSchemaSummaries.test.js

@@ -22,18 +22,24 @@ describe('fontoxml-development-tools-module-schema/api/getSchemaSummaries', () =
 		assert.ok(schemaSummaries);
 		assert.strictEqual(schemaSummaries.length, 4);
 
+		schemaSummaries.sort((a, b) => {
+			return a.path.localeCompare(b.path);
+		});
+
 		assert.ok(schemaSummaries[0]);
 		assert.ok(
 			schemaSummaries[0].path.indexOf(
 				formatPath(
-					'test/app/packages/test-packages-schema/src/schema.json'
+					'test/app/packages-shared/test-packages-shared-lazy-schema/src/assets/schemas/test-packages-shared-lazy-shell.json'
 				)
 			) !== -1
 		);
-		assert.strictEqual(schemaSummaries[0].package, 'test-packages-schema');
+		assert.strictEqual(
+			schemaSummaries[0].package,
+			'test-packages-shared-lazy-schema'
+		);
 		assert.deepStrictEqual(schemaSummaries[0].locations, [
-			'urn:packages.xsd',
-			'packages.dtd',
+			'urn:packages-shared-lazy.xsd',
 		]);
 
 		assert.ok(schemaSummaries[1]);
@@ -70,16 +76,14 @@ describe('fontoxml-development-tools-module-schema/api/getSchemaSummaries', () =
 		assert.ok(
 			schemaSummaries[3].path.indexOf(
 				formatPath(
-					'test/app/packages-shared/test-packages-shared-lazy-schema/src/assets/schemas/test-packages-shared-lazy-shell.json'
+					'test/app/packages/test-packages-schema/src/schema.json'
 				)
 			) !== -1
 		);
-		assert.strictEqual(
-			schemaSummaries[3].package,
-			'test-packages-shared-lazy-schema'
-		);
+		assert.strictEqual(schemaSummaries[3].package, 'test-packages-schema');
 		assert.deepStrictEqual(schemaSummaries[3].locations, [
-			'urn:packages-shared-lazy.xsd',
+			'urn:packages.xsd',
+			'packages.dtd',
 		]);
 	});
 

package/src/modules/schema-compiler/index.js

@@ -1,24 +1,105 @@
-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';
-
-export default (moduleRegistration) => {
-	const schemaCompilerCommand = moduleRegistration
-		.registerHiddenCommand('schema-compiler')
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default async (moduleRegistration) => {
+	const options = {
+		licenseProductName: 'schema-compiler',
+		licensesRequired: ['editor'],
+		productLabel: 'Fonto Schema Compiler',
+		commandPrefix: 'schema-compiler',
+
+		documentationConfigurationGuide:
+			'https://documentation.fontoxml.com/latest/editor-b4ee7cad8e30',
+		documentationExecuteError:
+			'https://documentation.fontoxml.com/latest/editor-b4ee7cad8e30',
+		documentationGettingStartedGuide:
+			'https://documentation.fontoxml.com/latest/editor-b4ee7cad8e30',
+
+		defaultHttpPort: 6040,
+		defaultImageName: 'fonto-schema-compiler',
+		defaultImageTag: 'latest',
+
+		manifestFileName: '.fontoxmlSchemaCompilerManifest',
+		manifestVersionPropertyName: 'schemaCompilerVersion',
+
+		instanceBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceDevBuildDirectoryPath: path.join(__dirname, 'instanceDevBuild'),
+		instanceDevBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceTemplateDirectoryPath: path.join(__dirname, 'instanceTemplate'),
+
+		requiredConfiguration: [],
+		temporaryDirectoryName: '.schemaCompilerTmp',
+		temporaryBuildDirectoryName: '.schemaCompilerBuildTmp',
+		whitelist: [
+			// Optional.
+			'nlog.config',
+		],
+
+		debugEnvEntries: {
+			Logging__LogLevel__Default: 'Trace',
+		},
+	};
+
+	const command = moduleRegistration
+		.registerHiddenCommand(options.commandPrefix)
 		.setDescription(
-			'Provides tools for working with Fonto Schema Compiler.'
+			`Provides tools for working with ${options.productLabel}.`
 		)
-		.addRequiredProductLicenses(['editor'])
+
+		.addRequiredProductLicenses(options.licensesRequired)
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	commandBuild(moduleRegistration, schemaCompilerCommand);
-	commandDownloadSelfContained(moduleRegistration, schemaCompilerCommand);
-	commandInit(moduleRegistration, schemaCompilerCommand);
-	commandRun(moduleRegistration, schemaCompilerCommand);
-	commandUpgrade(moduleRegistration, schemaCompilerCommand);
-	commandVersions(moduleRegistration, schemaCompilerCommand);
+	if (options.commandAlias) {
+		command.addAlias(options.commandAlias);
+	}
+
+	const sharedModulePath = moduleRegistration.getPathToModule(
+		'@fontoxml/fontoxml-development-tools-module-shared'
+	);
+
+	// Add the docker based commands.
+	const addBackendDockerCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendDockerCommands.js')
+	);
+	const addBackendDockerCommands = (
+		await import(addBackendDockerCommandsPath)
+	).default;
+	addBackendDockerCommands(moduleRegistration, command, options);
+
+	// Add the version commands.
+	const addBackendVersionsCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendVersionsCommands.js')
+	);
+	const addBackendVersionsCommands = (
+		await import(addBackendVersionsCommandsPath)
+	).default;
+	addBackendVersionsCommands(moduleRegistration, command, options);
+
+	// Add the download-self-contained command.
+	const addBackendDownloadSelfContainedCommandsPath = pathToFileURL(
+		path.resolve(
+			sharedModulePath,
+			'src/addBackendDownloadSelfContainedCommands.js'
+		)
+	);
+	const addBackendDownloadSelfContainedCommands = (
+		await import(addBackendDownloadSelfContainedCommandsPath)
+	).default;
+	addBackendDownloadSelfContainedCommands(
+		moduleRegistration,
+		command,
+		options
+	);
 };

package/src/modules/schema-compiler/instanceBuild/Dockerfile

@@ -1,4 +1,4 @@
-FROM ${schemaCompilerImage}
+FROM ${image}
 
 # copy files
 COPY ./instance .

package/src/modules/schema-compiler/instanceDevBuild/docker-compose.yml

@@ -6,4 +6,4 @@ services:
         env_file:
             - .env
         ports:
-            - '${schemaCompilerPort}:80'
+            - '${httpPort}:80'

package/src/modules/shared/index.js

@@ -0,0 +1,3 @@
+export default (_moduleRegistration, _app, _options) => {
+	// Nothing to do for the shared module.
+};

package/src/modules/shared/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "@fontoxml/fontoxml-development-tools-module-shared",
+	"description": "Provides shared functionality for FontoXML Development Tools.",
+	"version": "1.0.0",
+	"author": "The Fonto Team",
+	"license": "MIT",
+	"keywords": [
+		"fdt",
+		"fonto",
+		"fontoxml"
+	],
+	"main": "index.js",
+	"type": "module"
+}