@fontoxml/fontoxml-development-tools 3.9.0-beta.5 → 3.9.0

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
 	"name": "@fontoxml/fontoxml-development-tools",
-	"version": "3.9.0-beta.5",
+	"version": "3.9.0",
 	"lockfileVersion": 2,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "@fontoxml/fontoxml-development-tools",
-			"version": "3.9.0-beta.5",
+			"version": "3.9.0",
 			"license": "MIT",
 			"dependencies": {
 				"@babel/core": "7.14.6",

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@fontoxml/fontoxml-development-tools",
 	"description": "Development tools for Fonto.",
-	"version": "3.9.0-beta.5",
+	"version": "3.9.0",
 	"author": "The Fonto Team",
 	"license": "MIT",
 	"keywords": [

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

@@ -10,6 +10,7 @@ import webpack from 'webpack';
 
 import normalisePath from '../src/helpers/normalisePath.js';
 import getNamesAndPaths from './helpers/getNamesAndPaths.js';
+import CheckDeepImportsResolvePlugin from './webpackPlugins/CheckDeepImportsResolvePlugin.js';
 import CopyPlugin from './webpackPlugins/CopyPlugin.js';
 import DependenciesInLoadOrderPlugin from './webpackPlugins/DependenciesInLoadOrderPlugin.js';
 import FdtOutputPlugin from './webpackPlugins/FdtOutputPlugin.js';
@@ -44,6 +45,9 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 		generatedFile: picomatch.makeRe(paths.generatedFile),
 
 		// Folders
+		config: picomatch.makeRe(`${paths.configFolder}**/*`),
+		packages: picomatch.makeRe(`${paths.packagesFolder}**/*`),
+		packagesShared: picomatch.makeRe(`${paths.packagesSharedFolder}**/*`),
 		platform: picomatch.makeRe(`${paths.platformFolder}**/*`),
 		platformVendors: picomatch.makeRe(`${paths.platformVendorsFolder}**/*`),
 		platformLinkedVendors: picomatch.makeRe(
@@ -51,8 +55,25 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 		),
 		srcFolder: picomatch.makeRe(`${paths.srcFolder}**/*`),
 		testAssets: picomatch.makeRe(`${paths.testAssetsFolder}**/*`),
+
+		// Deep imports
+		platformDeepImport: picomatch.makeRe(
+			`${paths.platformFolder}*/src/*/**/*`
+		),
+		platformLinkedDeepImport: picomatch.makeRe(
+			`${paths.platformLinkedFolder}*/src/*/**/*`
+		),
 	};
 
+	// Used to share some state between (resolve) plugins.
+	const fdtOutputPlugin =
+		!appConfig.verbose && options.fdtResponse
+			? new FdtOutputPlugin({
+					inDevelopmentMode: options.inDevelopmentMode,
+					res: options.fdtResponse,
+			  })
+			: null;
+
 	return {
 		context: paths.srcFolder,
 		entry: !options.unitTest ? paths.entryFile : undefined,
@@ -88,23 +109,23 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 							!regExps.json.test(resource)),
 					type: 'asset/source',
 				},
-				{
-					test: (resource) =>
-						regExps.platform.test(resource) &&
-						!regExps.platformVendors.test(resource) &&
-						!regExps.assets.test(resource) &&
-						regExps.code.test(resource),
-					use: [
-						{
-							loader: paths.platformSourceMapLoader,
-							options: {
-								platformFolder: paths.platformFolder,
-								platformSourceMapFile:
-									paths.platformSourceMapFile,
-							},
-						},
-					],
-				},
+				// {
+				// 	test: (resource) =>
+				// 		regExps.platform.test(resource) &&
+				// 		!regExps.platformVendors.test(resource) &&
+				// 		!regExps.assets.test(resource) &&
+				// 		regExps.code.test(resource),
+				// 	use: [
+				// 		{
+				// 			loader: paths.platformSourceMapLoader,
+				// 			options: {
+				// 				platformFolder: paths.platformFolder,
+				// 				platformSourceMapFile:
+				// 					paths.platformSourceMapFile,
+				// 			},
+				// 		},
+				// 	],
+				// },
 				{
 					test: (resource) =>
 						regExps.platformLinkedVendors.test(resource) &&
@@ -297,13 +318,8 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 			new MiniCssExtractPlugin({
 				filename: names.outputCssFile,
 			}),
-			appConfig.verbose
-				? !options.unitTest && new webpack.ProgressPlugin()
-				: !!options.fdtResponse &&
-				  new FdtOutputPlugin({
-						inDevelopmentMode: options.inDevelopmentMode,
-						res: options.fdtResponse,
-				  }),
+			fdtOutputPlugin ||
+				(!options.unitTest && new webpack.ProgressPlugin()),
 			!options.unitTest &&
 				new HtmlWebpackPlugin({
 					editor: {
@@ -354,7 +370,22 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 				new RemoveExplicitExtensionResolvePlugin({
 					extensions: resolveExtensions,
 				}),
-			],
+				!options.unitTest &&
+					new CheckDeepImportsResolvePlugin({
+						extensions: resolveExtensions,
+						contextFolder: paths.contextFolder,
+						issuerRegExps: [
+							regExps.packages,
+							regExps.packagesShared,
+							regExps.config,
+						],
+						importPathRegExps: [
+							regExps.platformDeepImport,
+							regExps.platformLinkedDeepImport,
+						],
+						fdtOutputPlugin,
+					}),
+			].filter(Boolean),
 			// Module resolution is attempted in the order defined here.
 			modules: paths.packageRootFolders,
 			symlinks: false,

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

@@ -113,7 +113,7 @@ export default function getNamesAndPaths(appConfig, options) {
 		platformSourceMapLoader: path.posix.join(
 			srcFolder,
 			'webpackLoaders',
-			'vendorsSourceMapLoader.cjs'
+			'platformSourceMapLoader.cjs'
 		),
 		srcFolder,
 		symbolLoader: path.posix.join(
@@ -129,7 +129,7 @@ export default function getNamesAndPaths(appConfig, options) {
 		vendorsSourceMapLoader: path.posix.join(
 			srcFolder,
 			'webpackLoaders',
-			'platformSourceMapLoader.cjs'
+			'vendorsSourceMapLoader.cjs'
 		),
 	};
 	paths.generatedFile = path.posix.join(paths.templatesFolder, 'generated');

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

@@ -0,0 +1,123 @@
+import path from 'path';
+
+import normalisePath from '../helpers/normalisePath.js';
+
+/** @typedef {import('enhanced-resolve').Resolver} Resolver */
+
+const firstPathSegmentRegExp = /^.+?\//;
+
+/**
+ * Converts the given path to something that approximates its import identifier.
+ *
+ * @param {string} targetPath
+ * @returns {string}
+ */
+function getApproximateImportIdentifierForPath(targetPath) {
+	const parsedTargetPath = path.parse(targetPath);
+
+	targetPath = normalisePath(
+		path.join(parsedTargetPath.dir, parsedTargetPath.name)
+	);
+
+	return targetPath.replace(firstPathSegmentRegExp, '');
+}
+
+class DeepImportWarning extends Error {
+	/**
+	 * @param {string} message
+	 * @param {string} file
+	 */
+	constructor(message, file) {
+		super(message);
+
+		this.file = file;
+	}
+
+	toString() {
+		return this.file
+			? `WARNING in ${this.file}:\n${this.message}`
+			: `WARNING: ${this.message}`;
+	}
+}
+
+/**
+ * This plugin generates a warning for imports to platform/ or platform-linked/ from from config/,
+ * packages/ or packages-shared/ that do not point to something in a package's 'src' folder.
+ */
+export default class CheckDeepImportsResolvePlugin {
+	constructor(options = {}) {
+		this.options = options;
+	}
+
+	/**
+	 * @param {Resolver} resolver
+	 */
+	apply(resolver) {
+		resolver
+			.getHook('resolved')
+			.tapAsync(
+				CheckDeepImportsResolvePlugin.name,
+				(request, _resolveContext, callback) => {
+					// Can only check if there's an issuer and a resolved path.
+					// Issuer: path to the file from which the import originates.
+					// Path: path to the file to which the import resolves.
+					if (
+						!request.context ||
+						!request.context.issuer ||
+						!request.path
+					) {
+						return callback();
+					}
+
+					if (
+						// Only check imports to code (i.e. .js, .ts, .jsx, .tsx).
+						// The .xqm and .svg files are transformed by a loader which do a deep
+						// import to XQueryModule and SVGModule respectively, for which no warning
+						// is needed.
+						this.options.extensions.includes(
+							path.posix.extname(request.context.issuer)
+						) &&
+						// Only check certain issuers (i.e. packages/, packages-shared/, config/).
+						this.options.issuerRegExps.some((regExp) =>
+							regExp.test(request.context.issuer)
+						) &&
+						// Does the import target an undesired path?
+						this.options.importPathRegExps.some((regExp) =>
+							regExp.test(request.path)
+						)
+					) {
+						// Make the absolute paths easier to read.
+						const relativePath = path.relative(
+							this.options.contextFolder,
+							request.path
+						);
+						const relativeIssuer = path.relative(
+							this.options.contextFolder,
+							request.context.issuer
+						);
+
+						// We don't have access to the import identifier matching the resolved path
+						// at this point, so approximate it for the warning message. Should be about
+						// right most of the time, but we can't say for sure.
+						const importIdentifier =
+							getApproximateImportIdentifierForPath(relativePath);
+
+						// Pass the warning to the output plugin so it can properly output it after
+						// the compilation finishes.
+						const warning = new DeepImportWarning(
+							`Import "${importIdentifier}" is not supported and might cause problems in future versions.`,
+							relativeIssuer
+						);
+						if (this.options.fdtOutputPlugin) {
+							this.options.fdtOutputPlugin.warn(warning);
+						} else {
+							console.warn(`\n${warning.toString()}`);
+						}
+					}
+
+					// We do not need to mutate the request, so call the callback without arguments.
+					return callback();
+				}
+			);
+	}
+}

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

@@ -24,10 +24,18 @@ export default class FdtOutputPlugin {
 		this.resetState();
 	}
 
+	/**
+	 * @param {Error} warning
+	 */
+	warn(warning) {
+		this.warnings.push(warning);
+	}
+
 	resetState() {
 		this.previousBuildMessageTimestamp = 0;
 		this.previousProgressIsBuild = false;
 		this.previousRoundedPercentage = null;
+		this.warnings = [];
 	}
 
 	/**
@@ -80,7 +88,10 @@ export default class FdtOutputPlugin {
 			  }ms`
 			: `Build done at ${endTimestamp}`;
 
-		if (stats && (stats.hasErrors() || stats.hasWarnings())) {
+		if (
+			stats &&
+			(stats.hasErrors() || stats.hasWarnings() || this.warnings.length)
+		) {
 			this.res.needsClearing = true;
 			this.res.clearIfNeeded();
 
@@ -91,8 +102,16 @@ export default class FdtOutputPlugin {
 				moduleTrace: true,
 				warnings: true,
 			});
-			this.res.raw(errorsAndWarnings);
-			this.res.raw(os.EOL + os.EOL);
+			if (errorsAndWarnings) {
+				this.res.raw(errorsAndWarnings);
+				this.res.raw(os.EOL);
+			}
+			if (this.warnings.length) {
+				for (const warning of this.warnings) {
+					this.res.notice(warning.toString());
+					this.res.raw(os.EOL);
+				}
+			}
 
 			this.res[stats.hasErrors() ? 'error' : 'notice'](
 				stats.hasErrors() && stats.hasWarnings()

package/src/modules/editor-pre-7-7-0/src/command.upgrade.controller.js

@@ -331,6 +331,21 @@ export default async function editorUpgradeCommand(req, res) {
 				overwrite: false,
 			}
 		);
+
+		// Add a package.json with a TypeScript dependency when there's none.
+		await fs.copy(
+			path.resolve(
+				__dirname,
+				'..',
+				'instanceTemplateTypeScript',
+				'package.json'
+			),
+			path.resolve(editorPath, 'package.json'),
+			{
+				// Silently fail when target already exists.
+				overwrite: false,
+			}
+		);
 	}
 
 	await req.fdt.license.sendTelemetry({
@@ -365,5 +380,12 @@ export default async function editorUpgradeCommand(req, res) {
 
 	// Done.
 	res.break();
-	res.notice('Done.');
+	res.notice('You succesfully upgraded Fonto Editor!');
+	if (platformHasTsConfig) {
+		res.break();
+		res.notice('For setting up code intelligence and/or TypeScript, see:');
+		res.notice(
+			'https://documentation.fontoxml.com/latest/typescript-f488eb98fb35'
+		);
+	}
 }