@fontoxml/fontoxml-development-tools 3.7.0 → 3.8.1

package/src/modules/editor/src/convert.js

@@ -6,7 +6,7 @@
  *
  * @return  {string}
  */
-function fromCamelCaseToSnakeCase(input, separator) {
+export function fromCamelCaseToSnakeCase(input, separator) {
 	separator = separator || '-';
 
 	// Matches upper cased letters.
@@ -27,7 +27,7 @@ function fromCamelCaseToSnakeCase(input, separator) {
  *
  * @return  {string}
  */
-function fromSnakeCaseToCamelCase(input, separator) {
+export function fromSnakeCaseToCamelCase(input, separator) {
 	separator = separator || '-';
 
 	// Matches segments starting with the given separator, followed by 1 character.
@@ -45,7 +45,7 @@ function fromSnakeCaseToCamelCase(input, separator) {
  *
  * @return  {string}
  */
-function uppercaseFirstLetter(input) {
+export function uppercaseFirstLetter(input) {
 	if (input === '') {
 		return input;
 	}
@@ -53,9 +53,3 @@ function uppercaseFirstLetter(input) {
 	const firstCharacter = String.fromCodePoint(input.codePointAt(0));
 	return firstCharacter.toUpperCase() + input.substr(firstCharacter.length);
 }
-
-module.exports = {
-	fromCamelCaseToSnakeCase,
-	fromSnakeCaseToCamelCase,
-	uppercaseFirstLetter,
-};

package/src/modules/editor/src/getAppConfig.js

@@ -1,6 +1,10 @@
-const deepmerge = require('deepmerge');
-const fs = require('fs-extra');
-const path = require('path');
+import deepmerge from 'deepmerge';
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 function parseSaveMode(saveMode) {
 	switch (saveMode) {
@@ -19,18 +23,33 @@ function parseSaveMode(saveMode) {
 	}
 }
 
-module.exports = function getAppConfig(contextPath, options) {
+export default async function getAppConfig(contextPath, options) {
 	contextPath = path.resolve(contextPath);
 
+	const defaultAppConfigJsonFilePath = path.resolve(
+		__dirname,
+		'..',
+		'dev-cms',
+		'config.json'
+	);
 	const appConfigJsFilePath = path.join(contextPath, 'config.js');
 	const appConfigJsonFilePath = path.join(contextPath, 'config.json');
 
 	let config = null;
-	const defaultDevCmsConfig = require('../dev-cms/config.json');
+	const defaultDevCmsConfig = JSON.parse(
+		fs.readFileSync(defaultAppConfigJsonFilePath)
+	);
+
 	if (fs.existsSync(appConfigJsFilePath)) {
-		config = deepmerge(defaultDevCmsConfig, require(appConfigJsFilePath)());
+		config = deepmerge(
+			defaultDevCmsConfig,
+			(await import(pathToFileURL(appConfigJsFilePath))).default()
+		);
 	} else if (fs.existsSync(appConfigJsonFilePath)) {
-		config = deepmerge(defaultDevCmsConfig, require(appConfigJsonFilePath));
+		config = deepmerge(
+			defaultDevCmsConfig,
+			JSON.parse(fs.readFileSync(appConfigJsonFilePath))
+		);
 	} else {
 		config = deepmerge(defaultDevCmsConfig, {});
 	}
@@ -72,4 +91,4 @@ module.exports = function getAppConfig(contextPath, options) {
 	config.writeToDisk = options['write-to-disk'] || config.writeToDisk;
 
 	return config;
-};
+}

package/src/modules/editor/src/getAppManifest.js

@@ -1,17 +1,17 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
-module.exports = async function getAppManifest(editorPath) {
+export default async function getAppManifest(editorPath) {
 	const appManifestFilePath = path.join(editorPath, 'manifest.json');
 	const appManifest = await fs.readJson(appManifestFilePath);
 	appManifest._rawLoaderExtensions = appManifest._rawLoaderExtensions || [];
 	appManifest.favicon = appManifest.favicon || 'assets/images/favicon.ico';
 	appManifest.name = appManifest.name || 'Fonto Editor';
 	appManifest.supportedBrowsers = appManifest.supportedBrowsers || {
-		chrome: '92',
-		edge: '92',
-		firefox: '91',
-		safari: '14',
+		chrome: '95',
+		edge: '95',
+		firefox: '94',
+		safari: '15',
 	};
 	return appManifest;
-};
+}

package/src/modules/editor/src/getDependenciesInLoadOrder.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');
-
-function getPackageManifest(packagePath) {
+export function getPackageManifest(packagePath) {
 	const fontoManifestPath = path.join(packagePath, 'fonto-manifest.json');
 	if (fs.existsSync(fontoManifestPath)) {
 		return fs.readJsonSync(fontoManifestPath);
@@ -40,7 +38,7 @@ function addPackageInfo(packagePath, packageName, packageInfoByPackageName) {
 	}
 }
 
-function addPackageDependencies(
+export function addPackageDependencies(
 	packageRoots,
 	dependencies,
 	packageInfoByPackageName
@@ -194,7 +192,7 @@ function addDependenciesForRoles(packageInfoByPackageName) {
 	});
 }
 
-function orderPackages(packageInfoByPackageName) {
+export function orderPackages(packageInfoByPackageName) {
 	// Topologically sort the list such that each package is loaded after all packages it depends on
 	const allPackageNames = Object.keys(packageInfoByPackageName);
 	const packageNamesWithNoUnfulfilledDependencies = [];
@@ -291,7 +289,7 @@ function orderPackages(packageInfoByPackageName) {
 	);
 }
 
-function getDependenciesInLoadOrder(
+export default function getDependenciesInLoadOrder(
 	packageRoots,
 	initialPackagePath,
 	initialPackageName
@@ -323,9 +321,3 @@ function getDependenciesInLoadOrder(
 		throw error;
 	}
 }
-
-module.exports = getDependenciesInLoadOrder;
-
-module.exports.addPackageDependencies = addPackageDependencies;
-module.exports.getPackageManifest = getPackageManifest;
-module.exports.orderPackages = orderPackages;

package/src/modules/editor/src/getImportsForPackages.js

@@ -1,9 +1,9 @@
-const fastGlob = require('fast-glob');
-const path = require('path');
+import fastGlob from 'fast-glob';
+import path from 'path';
 
-const { fromSnakeCaseToCamelCase } = require('./convert');
+import { fromSnakeCaseToCamelCase } from './convert.js';
 
-module.exports = async function getImportsForPackages(
+export default async function getImportsForPackages(
 	packagesInfo,
 	patterns,
 	disallowedExtensions
@@ -53,4 +53,4 @@ module.exports = async function getImportsForPackages(
 			return flattenedResults;
 		}, []);
 	});
-};
+}

package/src/modules/editor/src/getPatternsForSpecialFileType.js

@@ -1,4 +1,4 @@
-module.exports = function getPatternsForSpecialFileType(type) {
+export default function getPatternsForSpecialFileType(type) {
 	switch (type) {
 		case 'configureSxModule':
 			return ['src/configureSxModule.@(js|ts)', 'src/*.xqm'];
@@ -21,4 +21,4 @@ module.exports = function getPatternsForSpecialFileType(type) {
 		default:
 			throw new Error(`Unsupported special file type "${type}".`);
 	}
-};
+}

package/src/modules/editor/src/getWebpackConfig.js

@@ -1,29 +1,31 @@
-const minimatch = require('minimatch');
-const path = require('path');
-
 // Disable for now; partners might run into lots of issues when using a case-insensitive VCS.
 // const CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin');
-const { CleanWebpackPlugin } = require('clean-webpack-plugin');
-const HtmlWebpackPlugin = require('html-webpack-plugin');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
-const TerserPlugin = require('terser-webpack-plugin');
+import { CleanWebpackPlugin } from 'clean-webpack-plugin';
+import HtmlWebpackPlugin from 'html-webpack-plugin';
+import MiniCssExtractPlugin from 'mini-css-extract-plugin';
+import minimatch from 'minimatch';
+import OptimizeCSSAssetsPlugin from 'optimize-css-assets-webpack-plugin';
+import path from 'path';
+import TerserPlugin from 'terser-webpack-plugin';
+import { fileURLToPath } from 'url';
 
-const CopyPlugin = require('./webpackPlugins/CopyPlugin');
-const DependenciesInLoadOrderPlugin = require('./webpackPlugins/DependenciesInLoadOrderPlugin');
-const FdtOutputPlugin = require('./webpackPlugins/FdtOutputPlugin');
-const RemoveExplicitExtensionResolvePlugin = require('./webpackPlugins/RemoveExplicitExtensionResolvePlugin');
-const ResolveImportAliasPlugin = require('./webpackPlugins/ResolveImportAliasPlugin');
-const UnitTestPlugin = require('./webpackPlugins/UnitTestPlugin');
+import normalisePath from '../src/helpers/normalisePath.js';
+import CopyPlugin from './webpackPlugins/CopyPlugin.js';
+import DependenciesInLoadOrderPlugin from './webpackPlugins/DependenciesInLoadOrderPlugin.js';
+import FdtOutputPlugin from './webpackPlugins/FdtOutputPlugin.js';
+import RemoveExplicitExtensionResolvePlugin from './webpackPlugins/RemoveExplicitExtensionResolvePlugin.js';
+import ResolveImportAliasPlugin from './webpackPlugins/ResolveImportAliasPlugin.js';
+import UnitTestPlugin from './webpackPlugins/UnitTestPlugin.js';
 
-const normalisePath = require('../src/helpers/normalisePath');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-module.exports = function getWebpackConfig(appConfig, appManifest, options) {
+export default function getWebpackConfig(appConfig, appManifest, options) {
 	const contextPath = appConfig.root;
 	const names = {
 		configFolder: 'config',
 		configurationFile: 'configuration',
-		entryFile: 'app-entry.js',
+		entryFile: 'app-entry.cjs',
 		fontoManifestFile: 'fonto-manifest.json',
 		htmlTemplateFile: 'index.template.html',
 		outputCssFile: 'main.css',
@@ -113,7 +115,7 @@ module.exports = function getWebpackConfig(appConfig, appManifest, options) {
 							loader: path.resolve(
 								paths.srcFolder,
 								'webpackLoaders',
-								'generatedLoader.js'
+								'generatedLoader.cjs'
 							),
 							options: {
 								appManifest,
@@ -216,7 +218,7 @@ module.exports = function getWebpackConfig(appConfig, appManifest, options) {
 							loader: path.resolve(
 								paths.srcFolder,
 								'webpackLoaders',
-								'symbolLoader.js'
+								'symbolLoader.cjs'
 							),
 							options: {
 								className: 'SVGModule',
@@ -249,7 +251,7 @@ module.exports = function getWebpackConfig(appConfig, appManifest, options) {
 							loader: path.resolve(
 								paths.srcFolder,
 								'webpackLoaders',
-								'symbolLoader.js'
+								'symbolLoader.cjs'
 							),
 							options: {
 								className: 'XQueryModule',
@@ -276,7 +278,7 @@ module.exports = function getWebpackConfig(appConfig, appManifest, options) {
 							loader: path.resolve(
 								paths.srcFolder,
 								'webpackLoaders',
-								'platformSourceMapLoader.js'
+								'platformSourceMapLoader.cjs'
 							),
 							options: {
 								names,
@@ -300,7 +302,7 @@ module.exports = function getWebpackConfig(appConfig, appManifest, options) {
 							loader: path.resolve(
 								paths.srcFolder,
 								'webpackLoaders',
-								'vendorsSourceMapLoader.js'
+								'vendorsSourceMapLoader.cjs'
 							),
 						},
 					],
@@ -649,4 +651,4 @@ module.exports = function getWebpackConfig(appConfig, appManifest, options) {
 						colors: true,
 				  },
 	};
-};
+}

package/src/modules/editor/src/getWebpackDevMiddlewareConfig.js

@@ -1,4 +1,4 @@
-module.exports = function getWebpackDevMiddlewareConfig(appConfig) {
+export default function getWebpackDevMiddlewareConfig(appConfig) {
 	return {
 		logLevel: appConfig.verbose ? 'info' : 'silent',
 
@@ -17,4 +17,4 @@ module.exports = function getWebpackDevMiddlewareConfig(appConfig) {
 		watchOptions: { aggregateTimeout: 200 },
 		writeToDisk: appConfig.writeToDisk,
 	};
-};
+}

package/src/modules/editor/src/helpers/WarningsByFilename.js

@@ -1,4 +1,4 @@
-module.exports = class WarningsByFilename extends Map {
+export default class WarningsByFilename extends Map {
 	add(filename, warning) {
 		let warnings = this.get(filename);
 		if (!warnings) {

package/src/modules/editor/src/helpers/mergeIndexPageAndManifest.js

@@ -1,7 +1,7 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
-module.exports = async function mergeIndexPageAndManifest(
+export default async function mergeIndexPageAndManifest(
 	outputDir,
 	warningsByFilename
 ) {
@@ -21,4 +21,4 @@ module.exports = async function mergeIndexPageAndManifest(
 		error.message = `${indexPageFilePath}: ${error.message}`;
 		warningsByFilename.add(indexPageFilePath, error);
 	}
-};
+}

package/src/modules/editor/src/helpers/normalisePath.js

@@ -1,7 +1,7 @@
-const { posix } = require('path');
+import { posix } from 'path';
 
 const regex = /\\+/g;
 
-module.exports = function normalisePath(path) {
+export default function normalisePath(path) {
 	return path.replace(regex, posix.sep);
-};
+}

package/src/modules/editor/src/helpers/outputWarningsByFilename.js

@@ -1,6 +1,6 @@
-const fs = require('fs-extra');
-const path = require('path');
-const stripColor = require('strip-color');
+import fs from 'fs-extra';
+import path from 'path';
+import stripColor from 'strip-color';
 
 async function outputWarningsByFilename(warningsByFilename, outputPath = null) {
 	for (const fileName of [...warningsByFilename.keys()].sort()) {
@@ -17,4 +17,4 @@ async function outputWarningsByFilename(warningsByFilename, outputPath = null) {
 	}
 }
 
-module.exports = outputWarningsByFilename;
+export default outputWarningsByFilename;

package/src/modules/editor/src/helpers/prettifyJsFile.js

@@ -1,4 +1,4 @@
-const prettier = require('prettier');
+import prettier from 'prettier';
 
 const DEFAULT_OPTIONS = {
 	endOfLine: 'auto',
@@ -15,10 +15,7 @@ const DEFAULT_OPTIONS = {
  *
  * @return {Promise}
  */
-module.exports = async function prettifyJsFile(
-	file,
-	forceDefaultConfig = false
-) {
+export default async function prettifyJsFile(file, forceDefaultConfig = false) {
 	const fileInfo = await prettier.getFileInfo(file.filePath);
 	const prettierConfig = await prettier.resolveConfig(file.filePath);
 
@@ -38,4 +35,4 @@ module.exports = async function prettifyJsFile(
 	file.code = prettier.format(file.code, options);
 
 	return file;
-};
+}

package/src/modules/editor/src/helpers/renameJsxFile.js

@@ -1,5 +1,5 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
 /**
  * Rename a '.jsx.js' file extension to '.jsx'.
@@ -8,7 +8,7 @@ const path = require('path');
  *
  * @return {Promise}
  */
-module.exports = async function renameJsxFile(file) {
+export default async function renameJsxFile(file) {
 	if (!file.filePath.endsWith('.jsx.js')) {
 		return file;
 	}
@@ -20,4 +20,4 @@ module.exports = async function renameJsxFile(file) {
 	file.filePath = newFilePath;
 
 	return file;
-};
+}

package/src/modules/editor/src/helpers/transformJsFile.js

@@ -1,7 +1,17 @@
-const babel = require('@babel/core');
-const path = require('path');
+import babel from '@babel/core';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const config = require('../config');
+import {
+	defaultBabelPlugins,
+	defaultBabelValidationPlugins,
+	importAliases,
+	mainJsModuleNames,
+	namedExportModuleNames,
+} from '../config.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const pluginPath = path.resolve(__dirname, '..', '..', 'src', 'babelPlugins');
 
@@ -13,12 +23,16 @@ const pluginPath = path.resolve(__dirname, '..', '..', 'src', 'babelPlugins');
  *
  * @return {Promise}
  */
-module.exports = async function transformJsFile(
+export default async function transformJsFile(
 	file,
-	plugins = config.defaultBabelPlugins
+	plugins = defaultBabelPlugins
 ) {
 	const pluginOptions = {
-		...config,
+		defaultBabelPlugins,
+		defaultBabelValidationPlugins,
+		importAliases,
+		mainJsModuleNames,
+		namedExportModuleNames,
 		warningsByFilename: file.warningsByFilename,
 	};
 	const babelTransformResult = await babel.transformFileAsync(file.filePath, {
@@ -30,15 +44,15 @@ module.exports = async function transformJsFile(
 		sourceMaps: false,
 		plugins: [
 			// Use recast parse and print.
-			[path.join(pluginPath, 'recastPlugin'), pluginOptions],
+			[path.join(pluginPath, 'recastPlugin.cjs'), pluginOptions],
 
 			// Allow non default syntax.
 			'@babel/plugin-syntax-jsx',
 			'@babel/plugin-syntax-class-properties',
 			'@babel/plugin-syntax-object-rest-spread',
 
-			...plugins.map((plugin) => [
-				path.join(pluginPath, plugin),
+			...plugins.map((pluginName) => [
+				path.join(pluginPath, `${pluginName}.cjs`),
 				pluginOptions,
 			]),
 		],
@@ -49,4 +63,4 @@ module.exports = async function transformJsFile(
 	});
 
 	return file;
-};
+}

package/src/modules/editor/src/helpers/updateEditorPackageJson.js

@@ -1,7 +1,7 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
-module.exports = async function updateEditorPackageJson(
+export default async function updateEditorPackageJson(
 	outputDir,
 	warningsByFilename
 ) {
@@ -49,4 +49,4 @@ module.exports = async function updateEditorPackageJson(
 		error.message = `${packageJsonFilePath}: ${error.message}`;
 		warningsByFilename.add(packageJsonFilePath, error);
 	}
-};
+}

package/src/modules/editor/src/helpers/validateJsFile.js

@@ -1,7 +1,11 @@
-const babel = require('@babel/core');
-const path = require('path');
+import babel from '@babel/core';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const config = require('../config');
+import { defaultBabelValidationPlugins } from '../config.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const pluginPath = path.resolve(__dirname, '..', '..', 'src', 'babelPlugins');
 
@@ -13,9 +17,9 @@ const pluginPath = path.resolve(__dirname, '..', '..', 'src', 'babelPlugins');
  *
  * @return {Promise}
  */
-module.exports = async function validateJsFile(
+export default async function validateJsFile(
 	file,
-	plugins = config.defaultBabelValidationPlugins
+	plugins = defaultBabelValidationPlugins
 ) {
 	await babel.transformAsync(file.code, {
 		babelrc: false,
@@ -28,7 +32,7 @@ module.exports = async function validateJsFile(
 			'@babel/plugin-syntax-object-rest-spread',
 
 			...plugins.map((pluginName) => [
-				path.join(pluginPath, pluginName),
+				path.join(pluginPath, `${pluginName}.cjs`),
 				{
 					warningsByFilename: file.warningsByFilename,
 				},
@@ -37,4 +41,4 @@ module.exports = async function validateJsFile(
 	});
 
 	return file;
-};
+}

package/src/modules/editor/src/helpers/writeJsFileToDisk.js

@@ -1,4 +1,4 @@
-const fs = require('fs-extra');
+import fs from 'fs-extra';
 
 /**
  * Write the output file to disk.
@@ -7,8 +7,8 @@ const fs = require('fs-extra');
  *
  * @return {Promise}
  */
-module.exports = async function writeJsFileToDisk(file) {
+export default async function writeJsFileToDisk(file) {
 	await fs.outputFile(file.filePath, file.code);
 
 	return file;
-};
+}

package/src/modules/editor/src/webpackLoaders/{generatedLoader.js → generatedLoader.cjs}

@@ -1,9 +1,6 @@
 const loaderUtils = require('loader-utils');
 const path = require('path');
 
-const getImportsForPackages = require('../getImportsForPackages');
-const getPatternsForSpecialFileType = require('../getPatternsForSpecialFileType');
-
 function webpackAddDependencies(loaderContext, options, packageInfos = []) {
 	const platformPath = path.normalize(options.paths.platformFolder);
 
@@ -38,6 +35,9 @@ async function handleDependencyOrder({
 	const callback = loaderContext.async();
 
 	const { type } = resourceQuery;
+	const getPatternsForSpecialFileType = (
+		await import('../getPatternsForSpecialFileType.js')
+	).default;
 	const patterns = getPatternsForSpecialFileType(type);
 
 	if (
@@ -57,6 +57,9 @@ async function handleDependencyOrder({
 
 	webpackAddDependencies(loaderContext, options, packagesInfoInLoadOrder);
 
+	const getImportsForPackages = (await import('../getImportsForPackages.js'))
+		.default;
+
 	const statements = await getImportsForPackages(
 		packagesInfoInLoadOrder,
 		patterns,
@@ -188,6 +191,9 @@ async function handleUnitTest({
 	const callback = loaderContext.async();
 
 	const { type } = resourceQuery;
+	const getPatternsForSpecialFileType = (
+		await import('../getPatternsForSpecialFileType.js')
+	).default;
 	const patterns = getPatternsForSpecialFileType(type);
 
 	const unitTestPackageInfo = loaderContext._compilation.unitTestPackageInfo;
@@ -202,6 +208,9 @@ async function handleUnitTest({
 		return;
 	}
 
+	const getImportsForPackages = (await import('../getImportsForPackages.js'))
+		.default;
+
 	const statements = await getImportsForPackages(
 		[unitTestPackageInfo],
 		patterns,

package/src/modules/editor/src/webpackLoaders/{platformSourceMapLoader.js → platformSourceMapLoader.cjs}

@@ -2,8 +2,6 @@ const fs = require('fs-extra');
 const path = require('path');
 const loaderUtils = require('loader-utils');
 
-const normalisePath = require('../helpers/normalisePath');
-
 let compilation;
 let sourceMapsPromise;
 
@@ -32,6 +30,8 @@ module.exports = async function (input) {
 		return untouched();
 	}
 
+	const normalisePath = (await import('../helpers/normalisePath.js')).default;
+
 	const sourcePath = normalisePath(
 		path.relative(paths.platformFolder, this.resourcePath)
 	);