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

package/src/modules/editor/src/webpackPlugins/CopyPlugin.js

@@ -1,202 +1,217 @@
-const fastGlob = require('fast-glob');
-const fs = require('fs-extra');
-const path = require('path');
+import fastGlob from 'fast-glob';
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const normalisePath = require('../helpers/normalisePath');
+import normalisePath from '../helpers/normalisePath.js';
 
 const emittedAssets = new Map();
 const plugin = { name: 'CopyPlugin' };
 
-function CopyPlugin(options) {
-	this.options = options;
-}
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default class CopyPlugin {
+	constructor(options) {
+		this.options = options;
+	}
 
-CopyPlugin.prototype.apply = function (compiler) {
-	let packageInfos;
+	apply(compiler) {
+		let packageInfos;
 
-	compiler.hooks.emit.tapAsync(plugin, async (compilation, callback) => {
-		if (
-			compilation.packagesInfoInLoadOrderError ||
-			!compilation.packagesInfoInLoadOrder
-		) {
-			const error =
+		compiler.hooks.emit.tapAsync(plugin, async (compilation, callback) => {
+			if (
 				compilation.packagesInfoInLoadOrderError ||
-				new Error('Could not get package load order information.');
-			packageInfos = error.packageInfos || [];
-			compilation.errors.push(error);
-			callback();
-			return;
-		}
-
-		const templatesPath = normalisePath(
-			path.resolve(__dirname, '..', 'templates')
-		);
-		const assetInfoByTargetPath = new Map();
-
-		// TODO: It's not stricly necessary to process these assets every (re)compile.
-		// TODO: Consider placing these assets somewhere where they're unlikely to cause conflicts.
-		(
-			await fastGlob(
-				[`${fastGlob.escapePath(templatesPath)}/assets/**/*`],
-				{
-					absolute: true,
-					stats: true,
-				}
-			)
-		).forEach((globResult) => {
-			assetInfoByTargetPath.set(
-				normalisePath(path.relative(templatesPath, globResult.path)),
-				{
-					path: globResult.path,
-					stats: globResult.stats,
-				}
-			);
-		});
+				!compilation.packagesInfoInLoadOrder
+			) {
+				const error =
+					compilation.packagesInfoInLoadOrderError ||
+					new Error('Could not get package load order information.');
+				packageInfos = error.packageInfos || [];
+				compilation.errors.push(error);
+				callback();
+				return;
+			}
 
-		if (this.options.unitTest) {
-			const testAssetsPath = normalisePath(
-				path.resolve(this.options.paths.contextFolder)
+			const templatesPath = normalisePath(
+				path.resolve(__dirname, '..', 'templates')
 			);
+			const assetInfoByTargetPath = new Map();
+
+			// TODO: It's not stricly necessary to process these assets every (re)compile.
+			// TODO: Consider placing these assets somewhere where they're unlikely to cause conflicts.
 			(
 				await fastGlob(
-					[`${fastGlob.escapePath(testAssetsPath)}/test/assets/**/*`],
+					[`${fastGlob.escapePath(templatesPath)}/assets/**/*`],
 					{
 						absolute: true,
 						stats: true,
 					}
 				)
 			).forEach((globResult) => {
-				const targetPath = normalisePath(
-					path.relative(
-						path.join(this.options.paths.contextFolder, 'test'),
-						globResult.path
-					)
+				assetInfoByTargetPath.set(
+					normalisePath(
+						path.relative(templatesPath, globResult.path)
+					),
+					{
+						path: globResult.path,
+						stats: globResult.stats,
+					}
 				);
-				assetInfoByTargetPath.set(targetPath, {
-					path: globResult.path,
-					stats: globResult.stats,
-				});
 			});
-		}
-
-		packageInfos = compilation.packagesInfoInLoadOrder;
 
-		(
-			await Promise.all(
-				packageInfos.map(async (packageInfo) => {
-					const glob =
-						fastGlob.escapePath(normalisePath(packageInfo.path)) +
-						(packageInfo.name === 'config'
-							? '/assets/**/*'
-							: '/src/assets/**/*');
-
-					return await fastGlob([glob], {
-						absolute: true,
-						stats: true,
-					});
-				})
-			)
-		).reduce((map, globResults) => {
-			globResults.forEach((globResult) => {
-				const relativePath = normalisePath(
-					path.relative(
-						this.options.paths.contextFolder,
-						globResult.path
-					)
+			if (this.options.unitTest) {
+				const testAssetsPath = normalisePath(
+					path.resolve(this.options.paths.contextFolder)
 				);
-				const pathParts = relativePath.split(path.posix.sep);
-				const isRootPackage =
-					relativePath.startsWith('config') ||
-					(this.options.unitTest && relativePath.startsWith('src/'));
-				const targetPath = path.posix.join(
-					...pathParts.slice(isRootPackage ? 1 : 3)
-				);
-
-				map.set(targetPath, {
-					path: globResult.path,
-					stats: globResult.stats,
+				(
+					await fastGlob(
+						[
+							`${fastGlob.escapePath(
+								testAssetsPath
+							)}/test/assets/**/*`,
+						],
+						{
+							absolute: true,
+							stats: true,
+						}
+					)
+				).forEach((globResult) => {
+					const targetPath = normalisePath(
+						path.relative(
+							path.join(this.options.paths.contextFolder, 'test'),
+							globResult.path
+						)
+					);
+					assetInfoByTargetPath.set(targetPath, {
+						path: globResult.path,
+						stats: globResult.stats,
+					});
 				});
-			});
-
-			return map;
-		}, assetInfoByTargetPath);
+			}
 
-		await Promise.all(
-			[...emittedAssets.keys()].map(async (targetPath) => {
-				if (!assetInfoByTargetPath.has(targetPath)) {
-					const assetOutputPath = path.join(
-						compilation.getPath(compiler.outputPath),
-						targetPath
-					);
+			packageInfos = compilation.packagesInfoInLoadOrder;
 
-					await new Promise((resolve, reject) =>
-						compiler.outputFileSystem.unlink(
-							assetOutputPath,
-							(error) => (error ? reject(error) : resolve())
+			(
+				await Promise.all(
+					packageInfos.map(async (packageInfo) => {
+						const glob =
+							fastGlob.escapePath(
+								normalisePath(packageInfo.path)
+							) +
+							(packageInfo.name === 'config'
+								? '/assets/**/*'
+								: '/src/assets/**/*');
+
+						return await fastGlob([glob], {
+							absolute: true,
+							stats: true,
+						});
+					})
+				)
+			).reduce((map, globResults) => {
+				globResults.forEach((globResult) => {
+					const relativePath = normalisePath(
+						path.relative(
+							this.options.paths.contextFolder,
+							globResult.path
 						)
 					);
+					const pathParts = relativePath.split(path.posix.sep);
+					const isRootPackage =
+						relativePath.startsWith('config') ||
+						(this.options.unitTest &&
+							relativePath.startsWith('src/'));
+					const targetPath = path.posix.join(
+						...pathParts.slice(isRootPackage ? 1 : 3)
+					);
 
-					emittedAssets.delete(targetPath);
-				}
-			})
-		);
-
-		await Promise.all(
-			[...assetInfoByTargetPath.keys()].map(async (targetPath) => {
-				const assetInfo = assetInfoByTargetPath.get(targetPath);
-
-				if (
-					emittedAssets.has(targetPath) &&
-					emittedAssets.get(targetPath).path === assetInfo.path &&
-					emittedAssets.get(targetPath).stats.mtimeMs ===
-						assetInfo.stats.mtimeMs
-				) {
-					return;
-				}
+					map.set(targetPath, {
+						path: globResult.path,
+						stats: globResult.stats,
+					});
+				});
 
-				emittedAssets.set(targetPath, assetInfo);
+				return map;
+			}, assetInfoByTargetPath);
 
-				const content = await fs.readFile(assetInfo.path);
+			await Promise.all(
+				[...emittedAssets.keys()].map(async (targetPath) => {
+					if (!assetInfoByTargetPath.has(targetPath)) {
+						const assetOutputPath = path.join(
+							compilation.getPath(compiler.outputPath),
+							targetPath
+						);
+
+						await new Promise((resolve, reject) =>
+							compiler.outputFileSystem.unlink(
+								assetOutputPath,
+								(error) => (error ? reject(error) : resolve())
+							)
+						);
+
+						emittedAssets.delete(targetPath);
+					}
+				})
+			);
 
-				compilation.assets[targetPath] = {
-					size() {
-						return assetInfo.stats.size;
-					},
-					source() {
-						return content;
-					},
-				};
-			})
-		);
+			await Promise.all(
+				[...assetInfoByTargetPath.keys()].map(async (targetPath) => {
+					const assetInfo = assetInfoByTargetPath.get(targetPath);
+
+					if (
+						emittedAssets.has(targetPath) &&
+						emittedAssets.get(targetPath).path === assetInfo.path &&
+						emittedAssets.get(targetPath).stats.mtimeMs ===
+							assetInfo.stats.mtimeMs
+					) {
+						return;
+					}
 
-		callback();
-	});
+					emittedAssets.set(targetPath, assetInfo);
 
-	compiler.hooks.afterEmit.tapAsync(plugin, (compilation, callback) => {
-		const platformPath = path.normalize(this.options.paths.platformFolder);
+					const content = await fs.readFile(assetInfo.path);
 
-		// TODO: Consider checking if the assets folder/manifest file exists before watching.
-		packageInfos.forEach((packageInfo) => {
-			const packagePath = path.normalize(packageInfo.path);
+					compilation.assets[targetPath] = {
+						size() {
+							return assetInfo.stats.size;
+						},
+						source() {
+							return content;
+						},
+					};
+				})
+			);
 
-			if (packagePath === path.join(platformPath, packageInfo.name)) {
-				return;
-			}
+			callback();
+		});
 
-			compilation.contextDependencies.add(
-				path.join(
-					packagePath,
-					packageInfo.name === 'config' ? 'assets' : 'src/assets'
-				)
+		compiler.hooks.afterEmit.tapAsync(plugin, (compilation, callback) => {
+			const platformPath = path.normalize(
+				this.options.paths.platformFolder
 			);
 
-			compilation.fileDependencies.add(
-				path.join(packagePath, 'fonto-manifest.json')
-			);
-		});
+			// TODO: Consider checking if the assets folder/manifest file exists before watching.
+			packageInfos.forEach((packageInfo) => {
+				const packagePath = path.normalize(packageInfo.path);
+
+				if (packagePath === path.join(platformPath, packageInfo.name)) {
+					return;
+				}
 
-		callback();
-	});
-};
+				compilation.contextDependencies.add(
+					path.join(
+						packagePath,
+						packageInfo.name === 'config' ? 'assets' : 'src/assets'
+					)
+				);
+
+				compilation.fileDependencies.add(
+					path.join(packagePath, 'fonto-manifest.json')
+				);
+			});
 
-module.exports = CopyPlugin;
+			callback();
+		});
+	}
+}

package/src/modules/editor/src/webpackPlugins/DependenciesInLoadOrderPlugin.js

@@ -1,8 +1,6 @@
-const path = require('path');
+import getDependenciesInLoadOrder from '../getDependenciesInLoadOrder.js';
 
-const getDependenciesInLoadOrder = require('../getDependenciesInLoadOrder');
-
-class DependenciesInLoadOrderPlugin {
+export default class DependenciesInLoadOrderPlugin {
 	constructor(options) {
 		this.options = options;
 	}
@@ -37,5 +35,3 @@ class DependenciesInLoadOrderPlugin {
 		);
 	}
 }
-
-module.exports = DependenciesInLoadOrderPlugin;

package/src/modules/editor/src/webpackPlugins/FdtOutputPlugin.js

@@ -1,10 +1,10 @@
-const os = require('os');
-const webpack = require('webpack');
+import os from 'os';
+import DirectoryWatcher from 'watchpack/lib/DirectoryWatcher.js';
+import webpack from 'webpack';
 
 // Monkey patch watchpack to output any chokidar errors.
 let response;
 let watchErrorDebounceTimeout;
-const DirectoryWatcher = require('watchpack/lib/DirectoryWatcher');
 
 const originalOnWatcherError = DirectoryWatcher.prototype.onWatcherError;
 DirectoryWatcher.prototype.onWatcherError = function (_error) {
@@ -26,7 +26,7 @@ function getEndTimestamp(stats) {
 	).toLocaleTimeString();
 }
 
-class FdtOutputPlugin {
+export default class FdtOutputPlugin {
 	constructor(options) {
 		this.res = options.res;
 		this.inDevelopmentMode = options.inDevelopmentMode;
@@ -169,5 +169,3 @@ class FdtOutputPlugin {
 		});
 	}
 }
-
-module.exports = FdtOutputPlugin;

package/src/modules/editor/src/webpackPlugins/RemoveExplicitExtensionResolvePlugin.js

@@ -1,10 +1,9 @@
-const path = require('path');
-
-const getPaths = require('enhanced-resolve/lib/getPaths');
+import getPaths from 'enhanced-resolve/lib/getPaths.js';
+import path from 'path';
 
 /** @typedef {import('enhanced-resolve').Resolver} Resolver */
 
-class RemoveExplicitExtensionResolvePlugin {
+export default class RemoveExplicitExtensionResolvePlugin {
 	constructor(options = {}) {
 		this.options = options;
 
@@ -66,5 +65,3 @@ class RemoveExplicitExtensionResolvePlugin {
 			);
 	}
 }
-
-module.exports = RemoveExplicitExtensionResolvePlugin;

package/src/modules/editor/src/webpackPlugins/ResolveImportAliasPlugin.js

@@ -1,6 +1,6 @@
-const { importAliases: legacyImportAliases } = require('../config');
+import { importAliases as legacyImportAliases } from '../config.js';
 
-class ResolveImportAliasPlugin {
+export default class ResolveImportAliasPlugin {
 	#inDevelopmentMode;
 
 	constructor(options) {
@@ -124,5 +124,3 @@ class ResolveImportAliasPlugin {
 			});
 	}
 }
-
-module.exports = ResolveImportAliasPlugin;

package/src/modules/editor/src/webpackPlugins/UnitTestPlugin.js

@@ -1,12 +1,12 @@
-const plugin = { name: 'UnitTestPlugin' };
-
-const {
+import {
 	addPackageDependencies,
 	getPackageManifest,
 	orderPackages,
-} = require('../getDependenciesInLoadOrder');
+} from '../getDependenciesInLoadOrder.js';
 
-class UnitTestPlugin {
+const plugin = { name: 'UnitTestPlugin' };
+
+export default class UnitTestPlugin {
 	constructor(options) {
 		this.options = options;
 	}
@@ -98,5 +98,3 @@ class UnitTestPlugin {
 		});
 	}
 }
-
-module.exports = UnitTestPlugin;

package/src/modules/editor/test/dependecyWatching.test.js

@@ -1,15 +1,14 @@
-const assert = require('assert');
-const path = require('path');
-
-const createWebpackWatch = require('./helpers/createWebpackWatch');
-
-const addFilesToPackage = require('./helpers/appMutations/addFilesToPackage');
-const addPackage = require('./helpers/appMutations/addPackage');
-const generateSpecialFiles = require('./helpers/appMutations/generateSpecialFiles');
-const mutateConfigFontoManifest = require('./helpers/appMutations/mutateConfigFontoManifest');
-const mutatePackageFontoManifest = require('./helpers/appMutations/mutatePackageFontoManifest');
-const removeFilesFromPackage = require('./helpers/appMutations/removeFilesFromPackage');
-const removePackage = require('./helpers/appMutations/removePackage');
+import assert from 'assert';
+import path from 'path';
+
+import addFilesToPackage from './helpers/appMutations/addFilesToPackage.js';
+import addPackage from './helpers/appMutations/addPackage.js';
+import generateSpecialFiles from './helpers/appMutations/generateSpecialFiles.js';
+import mutateConfigFontoManifest from './helpers/appMutations/mutateConfigFontoManifest.js';
+import mutatePackageFontoManifest from './helpers/appMutations/mutatePackageFontoManifest.js';
+import removeFilesFromPackage from './helpers/appMutations/removeFilesFromPackage.js';
+import removePackage from './helpers/appMutations/removePackage.js';
+import createWebpackWatch from './helpers/createWebpackWatch.js';
 
 const SPECIAL_FILE_MODULES_CONFIGURE_SX_MODULE = [
 	'src/templates/generated?type=configureSxModule',

package/src/modules/editor/test/fixtures.test.js

@@ -1,17 +1,22 @@
-const assert = require('assert');
-const fastGlob = require('fast-glob');
-const fs = require('fs-extra');
-const path = require('path');
-
-const WarningsByFilename = require('../src/helpers/WarningsByFilename');
-const prettifyJsFile = require('../src/helpers/prettifyJsFile');
-const transformJsFile = require('../src/helpers/transformJsFile');
-const validateJsFile = require('../src/helpers/validateJsFile');
-
-const assertFixtureSnapshot = require('./helpers/assertFixtureSnapshot');
-const normaliseLineEndings = require('./helpers/normaliseLineEndings');
-
-const config = require('../src/config');
+import assert from 'assert';
+import fastGlob from 'fast-glob';
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import {
+	defaultBabelPlugins,
+	defaultBabelValidationPlugins,
+} from '../src/config.js';
+import prettifyJsFile from '../src/helpers/prettifyJsFile.js';
+import transformJsFile from '../src/helpers/transformJsFile.js';
+import validateJsFile from '../src/helpers/validateJsFile.js';
+import WarningsByFilename from '../src/helpers/WarningsByFilename.js';
+import assertFixtureSnapshot from './helpers/assertFixtureSnapshot.js';
+import normaliseLineEndings from './helpers/normaliseLineEndings.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const FIXTURES_FILTER = process.env.FIXTURES_FILTER;
 
@@ -40,7 +45,7 @@ const testFactoryFunctionByName = {
 		return async () => {
 			const transforms = [
 				{
-					plugins: config.defaultBabelPlugins,
+					plugins: defaultBabelPlugins,
 					snapshotPath: path.join(fixturesPath, fixtureOut),
 				},
 			];
@@ -114,7 +119,7 @@ const testFactoryFunctionByName = {
 		return async () => {
 			const transforms = [
 				{
-					plugins: config.defaultBabelValidationPlugins,
+					plugins: defaultBabelValidationPlugins,
 					snapshotPath: path.join(fixturesPath, fixtureOut),
 				},
 			];

package/src/modules/editor/test/helpers/appMutations/addFilesToPackage.js

@@ -1,5 +1,5 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
 const DEFAULT_OPTIONS = {
 	packageLocation: 'packages',
@@ -14,7 +14,7 @@ const DEFAULT_OPTIONS = {
 	files: null,
 };
 
-module.exports = async function addFilesToPackage(
+export default async function addFilesToPackage(
 	instance,
 	packageName,
 	options = {}
@@ -102,4 +102,4 @@ module.exports = async function addFilesToPackage(
 			})
 		);
 	}
-};
+}

package/src/modules/editor/test/helpers/appMutations/addFontoManifestToPackage.js

@@ -1,5 +1,5 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
 const DEFAULT_OPTIONS = {
 	packageLocation: 'packages',
@@ -9,7 +9,7 @@ const DEFAULT_OPTIONS = {
 	role: null,
 };
 
-module.exports = async function addFontoManifestToPackage(
+export default async function addFontoManifestToPackage(
 	instance,
 	packageName,
 	options = {}
@@ -43,4 +43,4 @@ module.exports = async function addFontoManifestToPackage(
 			}
 		);
 	}
-};
+}

package/src/modules/editor/test/helpers/appMutations/addPackage.js

@@ -1,9 +1,9 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
-const addFilesToPackage = require('./addFilesToPackage');
-const addFontoManifestToPackage = require('./addFontoManifestToPackage');
-const mutateConfigFontoManifest = require('./mutateConfigFontoManifest');
+import addFilesToPackage from './addFilesToPackage.js';
+import addFontoManifestToPackage from './addFontoManifestToPackage.js';
+import mutateConfigFontoManifest from './mutateConfigFontoManifest.js';
 
 const DEFAULT_OPTIONS = {
 	packageLocation: 'packages',
@@ -27,11 +27,7 @@ async function ensureNotExists(packagePath) {
 	}
 }
 
-module.exports = async function addPackage(
-	instance,
-	packageName,
-	options = {}
-) {
+export default async function addPackage(instance, packageName, options = {}) {
 	options = { ...DEFAULT_OPTIONS, ...options };
 
 	const packagePath = path.join(
@@ -54,4 +50,4 @@ module.exports = async function addPackage(
 			},
 		});
 	}
-};
+}

package/src/modules/editor/test/helpers/appMutations/generateSpecialFiles.js

@@ -9,7 +9,7 @@ const DEFAULT_FILES = [
 	'styles',
 ];
 
-module.exports = function generateSpecialFiles(
+export default function generateSpecialFiles(
 	files = DEFAULT_FILES,
 	keyword = null
 ) {
@@ -56,4 +56,4 @@ module.exports = function generateSpecialFiles(
 	});
 
 	return specialFiles;
-};
+}