@fontoxml/fontoxml-development-tools 3.7.0-beta.6 → 3.8.0-beta.2

package/src/modules/editor/test/helpers/appMutations/mutateConfigFontoManifest.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 = {
 	dependencies: null,
@@ -7,7 +7,7 @@ const DEFAULT_OPTIONS = {
 	dependencyRemovals: null,
 };
 
-module.exports = async function mutateConfigFontoManifest(instance, options) {
+export default async function mutateConfigFontoManifest(instance, options) {
 	options = { ...DEFAULT_OPTIONS, ...options };
 
 	// Read.
@@ -46,4 +46,4 @@ module.exports = async function mutateConfigFontoManifest(instance, options) {
 	await fs.outputJson(configFontoManifestPath, configFontoManifest, {
 		spaces: '\t',
 	});
-};
+}

package/src/modules/editor/test/helpers/appMutations/mutatePackageFontoManifest.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',
@@ -8,7 +8,7 @@ const DEFAULT_OPTIONS = {
 	dependencyRemovals: null,
 };
 
-module.exports = async function mutatePackageFontoManifest(
+export default async function mutatePackageFontoManifest(
 	instance,
 	packageName,
 	options
@@ -64,4 +64,4 @@ module.exports = async function mutatePackageFontoManifest(
 	await fs.outputJson(configFontoManifestPath, configFontoManifest, {
 		spaces: '\t',
 	});
-};
+}

package/src/modules/editor/test/helpers/appMutations/removeFilesFromPackage.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',
@@ -7,7 +7,7 @@ const DEFAULT_OPTIONS = {
 	filenames: null,
 };
 
-module.exports = async function removeFilesFromPackage(
+export default async function removeFilesFromPackage(
 	instance,
 	packageName,
 	options = {}
@@ -30,4 +30,4 @@ module.exports = async function removeFilesFromPackage(
 			})
 		);
 	}
-};
+}

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

@@ -1,7 +1,7 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
-const mutateConfigFontoManifest = require('./mutateConfigFontoManifest');
+import mutateConfigFontoManifest from './mutateConfigFontoManifest.js';
 
 const DEFAULT_OPTIONS = {
 	packageLocation: 'packages',
@@ -9,7 +9,7 @@ const DEFAULT_OPTIONS = {
 	removeFromConfigFontoManifest: true,
 };
 
-module.exports = async function removePackage(
+export default async function removePackage(
 	instance,
 	packageName,
 	options = {}
@@ -30,4 +30,4 @@ module.exports = async function removePackage(
 			dependencyRemovals: [packageName],
 		});
 	}
-};
+}

package/src/modules/editor/test/helpers/assertFixtureSnapshot.js

@@ -1,13 +1,15 @@
-const assert = require('assert');
-const fs = require('fs-extra');
-const mochaColoring = require('mocha').reporters.Base.color;
+import assert from 'assert';
+import fs from 'fs-extra';
+import mocha from 'mocha';
 
-const normaliseLineEndings = require('./normaliseLineEndings');
+import normaliseLineEndings from './normaliseLineEndings.js';
+
+const mochaColoring = mocha.reporters.Base.color;
 
 const UPDATE_SNAPSHOTS =
 	process.env.UPDATE_SNAPSHOTS || process.argv.includes('--update-snapshots');
 
-module.exports = async function assertFixtureSnapshot(
+export default async function assertFixtureSnapshot(
 	output,
 	snapshotPath,
 	fixtureOptions = []
@@ -54,4 +56,4 @@ module.exports = async function assertFixtureSnapshot(
 			throw error;
 		}
 	}
-};
+}

package/src/modules/editor/test/helpers/createAppStructure.js

@@ -1,7 +1,11 @@
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-module.exports = async function createAppStructure(appPath, type = 'minimal') {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default async function createAppStructure(appPath, type = 'minimal') {
 	if (!appPath) {
 		throw new Error(
 			'Cannot create a app structure without specifying a path.'
@@ -10,4 +14,4 @@ module.exports = async function createAppStructure(appPath, type = 'minimal') {
 
 	// Copy the minimal app template to the temp directory.
 	await fs.copy(path.join(__dirname, '..', 'apps', type), appPath);
-};
+}

package/src/modules/editor/test/helpers/createTempDirectory.js

@@ -1,6 +1,6 @@
-const tmp = require('tmp');
+import tmp from 'tmp';
 
-module.exports = async function createTempDirectory() {
+export default async function createTempDirectory() {
 	return new Promise((resolve, reject) => {
 		tmp.dir(
 			{
@@ -17,4 +17,4 @@ module.exports = async function createTempDirectory() {
 			}
 		);
 	});
-};
+}

package/src/modules/editor/test/helpers/createWebpackWatch.js

@@ -1,21 +1,20 @@
-const assert = require('assert');
-const express = require('express');
-const mochaColoring = require('mocha').reporters.Base.color;
-const path = require('path');
-const webpack = require('webpack');
-const webpackDevMiddleware = require('webpack-dev-middleware');
-
-const EventEmitter = require('events');
-
-const assertFixtureSnapshot = require('./assertFixtureSnapshot');
-const createAppStructure = require('./createAppStructure');
-const createTempDirectory = require('./createTempDirectory');
-
-const convert = require('../../src/convert');
-const getWebpackConfig = require('../../src/getWebpackConfig');
-const getWebpackDevMiddlewareConfig = require('../../src/getWebpackDevMiddlewareConfig');
-const setupDevCms = require('../../dev-cms/setupDevCms');
-
+import assert from 'assert';
+import EventEmitter from 'events';
+import express from 'express';
+import mocha from 'mocha';
+import path from 'path';
+import webpack from 'webpack';
+import webpackDevMiddleware from 'webpack-dev-middleware';
+
+import setupDevCms from '../../dev-cms/setupDevCms.js';
+import { fromSnakeCaseToCamelCase } from '../../src/convert.js';
+import getWebpackConfig from '../../src/getWebpackConfig.js';
+import getWebpackDevMiddlewareConfig from '../../src/getWebpackDevMiddlewareConfig.js';
+import assertFixtureSnapshot from './assertFixtureSnapshot.js';
+import createAppStructure from './createAppStructure.js';
+import createTempDirectory from './createTempDirectory.js';
+
+const mochaColoring = mocha.reporters.Base.color;
 class WebpackWatch {
 	constructor(options) {
 		this.options = options;
@@ -122,7 +121,7 @@ class WebpackWatch {
 			this.compiler,
 			getWebpackDevMiddlewareConfig(appConfig)
 		);
-		this.server.use(setupDevCms(appConfig), this.middleware);
+		this.server.use(await setupDevCms(appConfig), this.middleware);
 
 		this.eventEmitter = new EventEmitter();
 
@@ -348,7 +347,7 @@ class WebpackWatch {
 
 		parts = [].concat(testFunction.test.titlePath(), parts).map((part) => {
 			part = part.charAt(0).toLowerCase() + part.slice(1);
-			return convert.fromSnakeCaseToCamelCase(
+			return fromSnakeCaseToCamelCase(
 				part.replace(/([^\w]|\s|_)+/g, '-')
 			);
 		});
@@ -430,7 +429,7 @@ const DEFAULT_OPTIONS = {
 	waitTime: 20,
 };
 
-module.exports = async function createWebpackWatch(options = {}) {
+export default async function createWebpackWatch(options = {}) {
 	options = { ...DEFAULT_OPTIONS, ...options };
 
 	const instance = new WebpackWatch(options);
@@ -442,4 +441,4 @@ module.exports = async function createWebpackWatch(options = {}) {
 	);
 
 	return instance;
-};
+}

package/src/modules/editor/test/helpers/normaliseLineEndings.js

@@ -1,3 +1,3 @@
-module.exports = function normaliseLineEndings(code) {
+export default function normaliseLineEndings(code) {
 	return code.replace(/\r?\n/g, '\n');
-};
+}

package/src/modules/editor-pre-7-7-0/index.js

@@ -1,6 +1,13 @@
-'use strict';
-
-module.exports = (moduleRegistration) => {
+import commandConvertEditor from '../editor/src/commands/command.convert.editor.js';
+import commandConvertPackage from '../editor/src/commands/command.convert.package.js';
+import commandBuild from './src/command.build.js';
+import commandInit from './src/command.init.js';
+import commandRun from './src/command.run.js';
+import commandSchemaCompileSchema from './src/command.schema.compile.js';
+import commandUpgrade from './src/command.upgrade.js';
+import commandVersions from './src/command.versions.js';
+
+export default (moduleRegistration) => {
 	const editorCommand = moduleRegistration
 		.registerCommand('editor')
 		.setDescription(
@@ -8,19 +15,12 @@ module.exports = (moduleRegistration) => {
 		)
 		.setAsHelpCommand();
 
-	// Editor commands
-	[
-		// Platform SDK
-		require('./src/command.init.js'),
-		require('./src/command.upgrade.js'),
-
-		// Building and running
-		require('./src/command.build.js'),
-		require('./src/command.run.js'),
-
-		// Informative
-		require('./src/command.versions.js'),
-	].forEach((mod) => mod(moduleRegistration, editorCommand));
+	// // Editor commands
+	commandInit(moduleRegistration, editorCommand);
+	commandUpgrade(moduleRegistration, editorCommand);
+	commandBuild(moduleRegistration, editorCommand);
+	commandRun(moduleRegistration, editorCommand);
+	commandVersions(moduleRegistration, editorCommand);
 
 	// Editor convert commands
 	const convertCommand = editorCommand
@@ -30,10 +30,8 @@ module.exports = (moduleRegistration) => {
 		)
 		.setAsHelpCommand();
 
-	[
-		require('../editor/src/commands/command.convert.editor.js'),
-		require('../editor/src/commands/command.convert.package.js'),
-	].forEach((mod) => mod(moduleRegistration, convertCommand));
+	commandConvertEditor(moduleRegistration, convertCommand);
+	commandConvertPackage(moduleRegistration, convertCommand);
 
 	// Editor schema commands
 	const schemaCommand = editorCommand
@@ -41,7 +39,5 @@ module.exports = (moduleRegistration) => {
 		.setDescription('Tools for compiling the schema.')
 		.setAsHelpCommand();
 
-	[require('./src/command.schema.compile.js')].forEach((mod) =>
-		mod(moduleRegistration, schemaCommand)
-	);
+	commandSchemaCompileSchema(moduleRegistration, schemaCommand);
 };

package/src/modules/editor-pre-7-7-0/package.json

@@ -9,5 +9,6 @@
 		"fonto",
 		"fontoxml"
 	],
-	"main": "index.js"
+	"main": "index.js",
+	"type": "module"
 }

package/src/modules/editor-pre-7-7-0/src/api/addCommentToAstNode.js

@@ -1,5 +1,7 @@
-const { Lines } = require('recast/lib/lines');
-const { types: t } = require('@babel/core');
+import babel from '@babel/core';
+import { Lines } from 'recast/lib/lines.js';
+
+const t = babel.types;
 
 /**
  * Inserts fake .loc information to the comment node to force Recast to print a comment on a new line.
@@ -39,7 +41,7 @@ function trickRecastIntoInsertingNewlineBeforeComment(
 	};
 }
 
-function trickRecastIntoKeepingStatementsTogether(node) {
+export function trickRecastIntoKeepingStatementsTogether(node) {
 	const numberOfLeadingCommentLines = (node.leadingComments || []).length;
 	const numberOfTrailingCommentLines = (node.trailingComments || []).length;
 	const nodeLineNumber = numberOfLeadingCommentLines + 1;
@@ -92,7 +94,7 @@ function trickRecastIntoKeepingStatementsTogether(node) {
  * @param {string}          [trailingComment=false] Indicates if the comment should be trailing instead of leading, defaults to false.
  * @param {string}          [extraNewline=false]    Indicates if the trailing comment should have an extra newline before it, this has no effect on leading comments.
  */
-function addCommentToAstNode(
+export default function addCommentToAstNode(
 	astNode,
 	content,
 	trailingComment = false,
@@ -144,8 +146,3 @@ function addCommentToAstNode(
 	// Update the comments for the Recast plugin, which does comment handling slightly different than vanilla babel.
 	astNode.comments = [...leadingComments, ...trailingComments];
 }
-
-module.exports = addCommentToAstNode;
-
-module.exports.trickRecastIntoKeepingStatementsTogether =
-	trickRecastIntoKeepingStatementsTogether;

package/src/modules/editor-pre-7-7-0/src/api/addonsAddDependencies.js

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Add dependencies to the passed add-ons array for all add-ons in the array which have dependencies.
  *
@@ -8,7 +6,7 @@
  *
  * @return {Array<string>} The, modified, add-ons array.
  */
-module.exports = (addons, sdkAddons) => {
+export default (addons, sdkAddons) => {
 	addons.forEach((addonName) => {
 		const addon = sdkAddons.find(
 			(someAddon) => someAddon.package === addonName

package/src/modules/editor-pre-7-7-0/src/api/createMessageTemplate.js

@@ -1,9 +1,7 @@
-'use strict';
+import fs from 'fs-extra';
 
-const fs = require('fs-extra');
-
-const deduplicateMessages = require('../../../localization/src/api/deduplicateMessages');
-const Message = require('../../../localization/src/api/Message');
+import deduplicateMessages from '../../../localization/src/api/deduplicateMessages.js';
+import Message from '../../../localization/src/api/Message.js';
 
 /**
  * Create a messages-template.json file for a Fonto Editor instance based on the localization files
@@ -14,7 +12,7 @@ const Message = require('../../../localization/src/api/Message');
  *
  * @return {Promise}
  */
-module.exports = async (messagesFiles, messagesTemplatePath) => {
+export default async (messagesFiles, messagesTemplatePath) => {
 	if (!messagesFiles || !messagesFiles.length) {
 		throw new Error(
 			'Could not create localization messages template because there are no message files.'

package/src/modules/editor-pre-7-7-0/src/api/createPackageDirectoryPath.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
 /**
  * Create a package directory path based on pre-existing locations. If the package already
@@ -13,7 +11,7 @@ const path = require('path');
  *
  * @return {Promise}
  */
-module.exports = async function createPackageDirectoryPath(
+export default async function createPackageDirectoryPath(
 	outputPath,
 	packageName
 ) {
@@ -32,4 +30,4 @@ module.exports = async function createPackageDirectoryPath(
 	}
 
 	return packageDirectoryPath;
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/createPrettifiedCode.js

@@ -1,9 +1,13 @@
-'use strict';
+import babel from '@babel/core';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const path = require('path');
-const { types: t, transformFromAstAsync } = require('@babel/core');
+import prettifyJsFile from '../../../editor/src/helpers/prettifyJsFile.js';
 
-const prettifyJsFile = require('../../../editor/src/helpers/prettifyJsFile');
+const t = babel.types;
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const pluginPath = path.resolve(
 	__dirname,
@@ -22,23 +26,23 @@ const pluginPath = path.resolve(
  *
  * @return {Promise}
  */
-module.exports = async function createPrettifiedCode(programNode) {
+export default async function createPrettifiedCode(programNode) {
 	if (!programNode || !t.isProgram(programNode)) {
 		programNode = t.program([programNode]);
 	}
 
 	// Transform the AST to code.
-	const jsFile = await transformFromAstAsync(programNode, undefined, {
+	const jsFile = await babel.transformFromAstAsync(programNode, undefined, {
 		babelrc: false,
 		comments: true,
 		compact: false,
 		configFile: false,
 		sourceMaps: false,
-		plugins: [[path.join(pluginPath, 'recastPlugin'), {}]],
+		plugins: [[path.join(pluginPath, 'recastPlugin.cjs'), {}]],
 	});
 
 	// A filePath is required for prettier to work.
 	jsFile.filePath = './dummy-file.js';
 	const prettifiedJsFile = await prettifyJsFile(jsFile);
 	return prettifiedJsFile.code;
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/downloadEditorSDK.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const requestPromise = require('request-promise-native');
+import requestPromise from 'request-promise-native';
 
 /**
  * Download a zipped Fonto Editor SDK.
@@ -11,7 +9,7 @@ const requestPromise = require('request-promise-native');
  *
  * @return {Promise<any>}
  */
-module.exports = function downloadEditorSDK(sdkVersion, req, res) {
+export default function downloadEditorSDK(sdkVersion, req, res) {
 	const requestObj = {
 		editor: {
 			selfContained: {
@@ -72,4 +70,4 @@ module.exports = function downloadEditorSDK(sdkVersion, req, res) {
 					}
 				});
 		});
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/executeAndLog.js

@@ -1,10 +1,8 @@
-'use strict';
+import cp from 'child_process';
+import os from 'os';
+import supportsColor from 'supports-color';
 
-const cp = require('child_process');
-const os = require('os');
-const supportsColor = require('supports-color');
-
-module.exports = (
+export default (
 	res,
 	command,
 	args,

package/src/modules/editor-pre-7-7-0/src/api/extractZip.js

@@ -1,8 +1,6 @@
-'use strict';
-
-const fs = require('fs-extra');
-const path = require('path');
-const unzipper = require('unzipper');
+import fs from 'fs-extra';
+import path from 'path';
+import unzipper from 'unzipper';
 
 /**
  * Extract a zip archive to a directory.
@@ -13,7 +11,7 @@ const unzipper = require('unzipper');
  *
  * @return {Promise}
  */
-module.exports = async (zipBuffer, extractPath, filter = () => true) => {
+export default async (zipBuffer, extractPath, filter = () => true) => {
 	const directory = await unzipper.Open.buffer(zipBuffer);
 	for (const file of directory.files.filter(filter)) {
 		if (file.uncompressedSize === 0 && /[/\\]$/.test(file.path)) {

package/src/modules/editor-pre-7-7-0/src/api/getAddonLabel.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = function getAddonLabel(addonName, sdkAddons) {
+export default function getAddonLabel(addonName, sdkAddons) {
 	const addon = sdkAddons.find((sdkAddon) => sdkAddon.package === addonName);
 	return addon && addon.name ? addon.name : addonName;
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/getAddonLabels.js

@@ -1,7 +1,5 @@
-'use strict';
+import getAddonLabel from './getAddonLabel.js';
 
-const getAddonLabel = require('./getAddonLabel');
-
-module.exports = function getAddonLabels(addons, sdkAddons) {
+export default function getAddonLabels(addons, sdkAddons) {
 	return addons.map((addonName) => getAddonLabel(addonName, sdkAddons));
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/getAddonLabelsForChanges.js

@@ -1,10 +1,8 @@
-'use strict';
+import chalk from 'chalk';
 
-const chalk = require('chalk');
+import getAddonLabel from './getAddonLabel.js';
 
-const getAddonLabel = require('./getAddonLabel');
-
-module.exports = function getAddonLabelsForChanges(
+export default function getAddonLabelsForChanges(
 	currentAddons,
 	selectedAddons,
 	sdkAddons
@@ -25,4 +23,4 @@ module.exports = function getAddonLabelsForChanges(
 	}, []);
 
 	return addedAddons.concat(removedAddons);
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/getAddonsFromEditorSDK.js

@@ -1,5 +1,3 @@
-'use strict';
-
 function createAddon(addon, addonType) {
 	return {
 		package: addon.package,
@@ -20,7 +18,7 @@ function createAddon(addon, addonType) {
  *
  * @return {Array<Object>} The array of add-ons in the array.
  */
-module.exports = async function getAddonsFromEditorSDK(sdkManifest) {
+export default async function getAddonsFromEditorSDK(sdkManifest) {
 	if (!sdkManifest || !sdkManifest['add-ons']) {
 		throw new Error('Could not get list of add-ons in SDK.');
 	}
@@ -34,4 +32,4 @@ module.exports = async function getAddonsFromEditorSDK(sdkManifest) {
 	}
 
 	return addons;
-};
+}

package/src/modules/editor-pre-7-7-0/src/api/init/checkEditorDestination.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const fs = require('fs-extra');
+import fs from 'fs-extra';
 
 /**
  * Check if there are files in the editor path which are not allowed, which might be overwritten.
@@ -9,7 +7,7 @@ const fs = require('fs-extra');
  *
  * @throws If there are files in the editor path which are not allowed.
  */
-module.exports = async (editorPath) => {
+export default async (editorPath) => {
 	let files;
 	try {
 		files = await fs.readdir(editorPath);