@ui5/webcomponents-tools 0.0.0-934b4df24 → 0.0.0-998083e44

package/lib/generate-json-imports/i18n.js

@@ -1,35 +1,38 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require('path');
-const mkdirp = require("mkdirp");
 
-const packageName = JSON.parse(fs.readFileSync("package.json")).name;
+const generate = async () => {
 
-const inputFolder = path.normalize(process.argv[2]);
-const outputFile = path.normalize(`${process.argv[3]}/i18n.js`);
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
+
+	const inputFolder = path.normalize(process.argv[2]);
+	const outputFile = path.normalize(`${process.argv[3]}/i18n-static.js`);
+	const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
 
 // All languages present in the file system
-const files = fs.readdirSync(inputFolder);
-const languages = files.map(file => {
-  const matches = file.match(/messagebundle_(.+?).json$/);
-  return matches ? matches[1] : undefined;
-}).filter(key => !!key);
+	const files = await fs.readdir(inputFolder);
+	const languages = files.map(file => {
+		const matches = file.match(/messagebundle_(.+?).json$/);
+		return matches ? matches[1] : undefined;
+	}).filter(key => !!key);
 
-let content;
+	let contentStatic, contentDynamic;
 
 // No i18n - just import dependencies, if any
-if (languages.length === 0) {
-  content = ``;
+	if (languages.length === 0) {
+		contentStatic = "";
+		contentDynamic = "";
 // There is i18n - generate the full file
-} else {
-
-  // Keys for the array
-  const languagesKeysString = languages.map(key => `${key},`).join("\n\t");
+	} else {
+		// Keys for the array
+		const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
+		const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
 
-  // Actual imports for json assets
-  const assetsImportsString = languages.map(key => `import ${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
+		// Actual imports for json assets
+		const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
 
-  // Resulting file content
-  content = `import { registerI18nBundle } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+		// static imports
+		contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
 
 ${assetsImportsString}
 
@@ -37,17 +40,59 @@ const bundleMap = {
 	${languagesKeysString}
 };
 
-const allEntriesInlined = Object.entries(bundleMap).every(([_key, value]) => typeof (value) === "object");
-
-if (allEntriesInlined) {
-	console.warn(\`Inefficient bundling detected: consider bundling i18n imports as URLs instead of inlining them.
-See rollup-plugin-url or webpack file-loader for more information.
-Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
+const fetchMessageBundle = async (localeId) => {
+	if (typeof bundleMap[localeId] === "object") {
+		// inlined from build
+		throw new Error("[i18n] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs")
+	}
+	return (await fetch(bundleMap[localeId])).json()
 }
 
-registerI18nBundle("${packageName}", bundleMap);
+const localeIds = [${languagesKeysStringArray}];
+
+localeIds.forEach(localeId => {
+	registerI18nLoader("${packageName}", localeId, fetchMessageBundle);
+});
 `;
+
+		// Actual imports for json assets
+		const dynamicImportsString = languages.map(key => `		case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
+
+		// Resulting file content
+		contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+
+	const importMessageBundle = async (localeId) => {
+		switch (localeId) {
+	${dynamicImportsString}
+			default: throw "unknown locale"
+		}
+	}
+
+	const importAndCheck = async (localeId) => {
+		const data = await importMessageBundle(localeId);
+		if (typeof data === "string" && data.endsWith(".json")) {
+			throw new Error(\`[i18n] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
+		}
+		return data;
+	}
+
+	const localeIds = [${languagesKeysStringArray}];
+
+	localeIds.forEach(localeId => {
+		registerI18nLoader("${packageName}", localeId, importAndCheck);
+	});
+	`;
+
+
+	}
+
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	return Promise.all([
+		fs.writeFile(outputFile, contentStatic),
+		fs.writeFile(outputFileDynamic, contentDynamic),
+	]);
 }
 
-mkdirp.sync(path.dirname(outputFile));
-fs.writeFileSync(outputFile, content);
+generate().then(() => {
+	console.log("Generated i18n JSON imports.");
+});

package/lib/generate-json-imports/themes.js

@@ -1,33 +1,80 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require('path');
-const mkdirp = require("mkdirp");
 const assets = require("../../assets-meta.js");
 
-const outputFile = path.normalize(`${process.argv[2]}/Themes.js`);
+const generate = async () => {
+	const inputFolder = path.normalize(process.argv[2]);
+	const outputFile = path.normalize(`${process.argv[3]}/Themes-static.js`);
+	const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.js`);
 
-const optionalThemes = assets.themes.all.filter(theme => theme !== assets.themes.default);
+// All supported optional themes
+	const allThemes = assets.themes.all;
 
-const packageName = JSON.parse(fs.readFileSync("package.json")).name;
+// All themes present in the file system
+	const dirs = await fs.readdir(inputFolder);
+	const themesOnFileSystem = dirs.map(dir => {
+		const matches = dir.match(/sap_.*$/);
+		return matches ? dir : undefined;
+	}).filter(key => !!key && allThemes.includes(key));
 
-const importLines = optionalThemes.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
-const isInlinedCondition = optionalThemes.map(theme => `isInlined(${theme})`).join(" || ");
-const registerLines = optionalThemes.map(theme => `registerThemeProperties("${packageName}", "${theme}", ${theme});`).join("\n");
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
 
-// Resulting file content
-const content = `import { registerThemeProperties } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+	const importLines = themesOnFileSystem.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
+	const themeUrlsByName = "{\n" + themesOnFileSystem.join(",\n") + "\n}";
+	const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
+	const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import("../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
+
+
+// static imports file content
+	const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
 
 ${importLines}
 
+const themeUrlsByName = ${themeUrlsByName};
 const isInlined = obj => typeof (obj) === "object";
 
-if (${isInlinedCondition}) {
-	console.warn(\`Inefficient bundling detected: consider bundling theme properties imports as URLs instead of inlining them.
-See rollup-plugin-url or webpack file-loader for more information.
-Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
-}
+const loadThemeProperties = async (themeName) => {
+	if (typeof themeUrlsByName[themeName] === "object") {
+		// inlined from build
+		throw new Error("[themes] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs");
+	}
+	return (await fetch(themeUrlsByName[themeName])).json();
+};
 
-${registerLines};
+${availableThemesArray}
+  .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadThemeProperties));
 `;
 
-mkdirp.sync(path.dirname(outputFile));
-fs.writeFileSync(outputFile, content);
+
+// dynamic imports file content
+	const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+
+const loadThemeProperties = async (themeName) => {
+	switch (themeName) {
+${dynamicImportLines}
+		default: throw "unknown theme"
+	}
+};
+
+const loadAndCheck = async (themeName) => {
+	const data = await loadThemeProperties(themeName);
+	if (typeof data === "string" && data.endsWith(".json")) {
+		throw new Error(\`[themes] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
+	}
+	return data;
+};
+
+${availableThemesArray}
+  .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadAndCheck));
+`;
+
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	return Promise.all([
+		fs.writeFile(outputFile, contentStatic),
+		fs.writeFile(outputFileDynamic, contentDynamic)
+	]);
+};
+
+generate().then(() => {
+	console.log("Generated themes JSON imports.");
+});

package/lib/hbs2lit/index.js

@@ -1,5 +1,3 @@
-const compiler = require("./src/compiler");
+const hbs2lit = require("./src/compiler");
 
-module.exports = {
-	compileString: compiler.compileString
-};
+module.exports = hbs2lit;

package/lib/hbs2lit/src/compiler.js

@@ -6,17 +6,15 @@ const svgProcessor = require("./svgProcessor");
 
 const removeWhiteSpaces = (source) => {
 	return source
-		.replace(/\n+/g, "")
-		.replace(/\s*<\s*/g, "<")
-		.replace(/\s*>\s*/g, ">")
-		.replace(/}}\s+{{/g, "}}{{")
-		.replace(/\t+/g, " ");
+		.replace(/\s*\r*\n+\s*/g, " ") // Replace new lines and all whitespace between them with a space
+		.replace(/\s*<\s*/g, "<") // Strip whitespace round <
+		.replace(/\s*>\s*/g, ">") // Strip whitespace round >
+		.replace(/}}\s+{{/g, "}}{{"); // Remove whitespace between }} and {{
 };
 
-const compileString = async (sInput, config) => {
-	let sPreprocessed = sInput;
+const hbs2lit = async (file) => {
+	let sPreprocessed = await includesReplacer.replace(file);
 
-	sPreprocessed = includesReplacer.replace(sPreprocessed, config);
 	sPreprocessed = removeWhiteSpaces(sPreprocessed);
 
 	const ast = Handlebars.parse(sPreprocessed);
@@ -32,13 +30,20 @@ const compileString = async (sInput, config) => {
 	lv.accept(ast);
 
 	for (let key in lv.blocks) {
-		result += lv.blocks[key] + "\n";
+		let block = lv.blocks[key];
+
+		if (block.match(/scopeTag/)) {
+			const matches = block.match(/^(.*?)( => )(.*?);$/);
+			const scopedCode = matches[3];
+			const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
+			block = `${matches[1]}${matches[2]}suffix ? ${scopedCode} : ${normalCode};`;
+		}
+
+		result += block + "\n";
 	}
 
 	result = svgProcessor.process(result);
 	return result;
 };
 
-module.exports = {
-	compileString
-};
+module.exports = hbs2lit;

package/lib/hbs2lit/src/includesReplacer.js

@@ -1,20 +1,31 @@
 const path = require("path");
-const nativeFs = require("fs");
+const fs = require("fs").promises;
 
-function replaceIncludes(hbs, config) {
-	const fs = config.fs || nativeFs;
-	const inclRegex = /{{>\s*include\s*["']([a-zA-Z.\/]+)["']}}/g;
+const replaceIncludes = async (file) => {
+	const filePath = path.dirname(file);
+	let fileContent = await fs.readFile(file, "utf-8");
+
+	const inclRegex = /{{>\s*include\s*["'](.+?)["']}}/g;
 	let match;
 
-	while((match = inclRegex.exec(hbs)) !== null) {
+	while((match = inclRegex.exec(fileContent)) !== null) {
 		inclRegex.lastIndex = 0;
-		const includeContent = fs.readFileSync(path.join(config.templatesPath, match[1]), "utf-8");
-		hbs = hbs.replace(match[0], includeContent);
+
+		let targetFile = match[1];
+		if (targetFile.startsWith(".")) {
+			// Relative path, f.e. {{>include "./Popup.hbs"}} or {{>include "../partials/Header.hbs"}}
+			targetFile = path.join(filePath, targetFile);
+		} else {
+			// Node module path, f.e. {{>include "@ui5/webcomponents/src/Popup.hbs"}}
+			targetFile = require.resolve(targetFile);
+		}
+
+		fileContent = fileContent.replace(match[0], await replaceIncludes(targetFile));
 	}
 
-	return hbs;
-}
+	return fileContent;
+};
 
 module.exports = {
 	replace: replaceIncludes
-};
+};

package/lib/hbs2lit/src/litVisitor2.js

@@ -5,9 +5,29 @@ const Visitor = Handlebars.Visitor;
 // skip ifDefined for event handlers and boolean attrs
 let skipIfDefined = false;
 
+// when true => an HTML node value, when false => an attribute value
+let isNodeValue = false;
+
+// when true => the current attribute is "style"
+let isStyleAttribute = false;
+
 // matches event handlers @click= and boolean attrs ?disabled=
 const dynamicAttributeRgx = /\s(\?|@)([a-zA-Z|-]+)="?\s*$/;
 
+if (!String.prototype.replaceAll) {
+	String.prototype.replaceAll = function(str, newStr){
+
+		// If a regex pattern
+		if (Object.prototype.toString.call(str).toLowerCase() === '[object regexp]') {
+			return this.replace(str, newStr);
+		}
+
+		// If a string
+		return this.replace(new RegExp(str, 'g'), newStr);
+
+	};
+}
+
 function HTMLLitVisitor(debug) {
 	this.blockCounter = 0;
 	this.keys = [];
@@ -15,7 +35,7 @@ function HTMLLitVisitor(debug) {
 	this.result = "";
 	this.mainBlock = "";
 	this.blockPath = "context";
-	this.blockParameters = ["context"];
+	this.blockParameters = ["context", "tags", "suffix"];
 	this.paths = []; //contains all normalized relative paths
 	this.debug = debug;
 	if (this.debug) {
@@ -31,7 +51,7 @@ HTMLLitVisitor.prototype.Program = function(program) {
 	this.keys.push(key);
 	this.debug && this.blockByNumber.push(key);
 
-	this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => { return ";
+	this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => ";
 
 	if (this.keys.length > 1) { //it's a nested block
 		this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
@@ -42,7 +62,7 @@ HTMLLitVisitor.prototype.Program = function(program) {
 
 	this.blocks[this.currentKey()] += "html`";
 	Visitor.prototype.Program.call(this, program);
-	this.blocks[this.currentKey()] += "`; };";
+	this.blocks[this.currentKey()] += "`;";
 
 	this.keys.pop(key);
 };
@@ -51,9 +71,24 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
 	Visitor.prototype.ContentStatement.call(this, content);
 	// let content = content.orgiinal; // attribute="__ attribute = "__  attribute ="__
 
-	const contentStatement = content.original;
+	let contentStatement = content.original;
 	skipIfDefined = !!dynamicAttributeRgx.exec(contentStatement);
 
+	const closingIndex = contentStatement.lastIndexOf(">");
+	const openingIndex = contentStatement.lastIndexOf("<");
+	if (closingIndex !== -1 || openingIndex !== -1) { // Only change isNodeValue whenever < or > is found in the content statement
+		isNodeValue = closingIndex > openingIndex;
+	}
+
+	isStyleAttribute = !isNodeValue && contentStatement.match(/style *= *["']? *$/);
+
+	if (!isStyleAttribute && contentStatement.match(/style=/)) {
+		console.log("WARNING: style hard-coded", contentStatement);
+	}
+
+	// Scope custom element tags
+	contentStatement = contentStatement.replaceAll(/(<\/?\s*)([a-zA-Z0-9_]+-[a-zA-Z0-9_-]+)/g, "$1\${scopeTag(\"$2\", tags, suffix)}");
+
 	this.blocks[this.currentKey()] += contentStatement;
 };
 
@@ -65,13 +100,14 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
 	} else {
 		const path = normalizePath.call(this, mustache.path.original);
 		const hasCalculatingClasses = path.includes("context.classes");
-		const hasStylesCalculation = path.includes("context.styles");
 
 		let parsedCode = "";
 
-		if (hasCalculatingClasses) {
+		if (isNodeValue && !mustache.escaped) {
+			parsedCode = `\${unsafeHTML(${path})}`;
+		} else if (hasCalculatingClasses) {
 			parsedCode = `\${classMap(${path})}`;
-		} else if (hasStylesCalculation) {
+		} else if (isStyleAttribute) {
 			parsedCode = `\${styleMap(${path})}`;
 		} else if (skipIfDefined){
 			parsedCode = `\${${path}}`;

package/lib/hbs2lit/src/svgProcessor.js

@@ -46,8 +46,8 @@ function getSVGMatches(template) {
 
 function getSVGBlock(input, blockCounter) {
 	return {
-		usage: `\${blockSVG${blockCounter}(context)}`,
-		definition: `\nconst blockSVG${blockCounter} = (context) => {return svg\`${input}\`};`,
+		usage: `\${blockSVG${blockCounter}(context, tags, suffix)}`,
+		definition: `\nconst blockSVG${blockCounter} = (context, tags, suffix) => svg\`${input}\`;`,
 	};
 }
 
@@ -55,7 +55,7 @@ function replaceInternalBlocks(template, svgContent) {
 	const internalBlocks = svgContent.match(blockrx) || [];
 
 	internalBlocks.forEach(blockName => {
-		const rx = new RegExp(`const ${blockName}.*(html\`).*};`);
+		const rx = new RegExp(`const ${blockName}.*(html\`).*;`);
 		template = template.replace(rx, (match, p1) => {
 			return match.replace(p1, "svg\`");
 		});

package/lib/hbs2ui5/RenderTemplates/LitRenderer.js

@@ -1,10 +1,10 @@
 const buildRenderer = (controlName, litTemplate) => {
-	return `
-/* eslint no-unused-vars: 0 */
-import ifDefined from '@ui5/webcomponents-base/dist/renderer/ifDefined.js';
-import { html, svg, repeat, classMap, styleMap } from '@ui5/webcomponents-base/dist/renderer/LitRenderer.js';
+	return `/* eslint no-unused-vars: 0 */
+import { html, svg, repeat, classMap, styleMap, ifDefined, unsafeHTML, scopeTag } from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+
 ${litTemplate}
-export default block0;`
+
+export default block0;`;
 };
 
 module.exports = {

package/lib/hbs2ui5/index.js

@@ -1,8 +1,9 @@
-const fs = require('fs');
+const fs = require('fs').promises;
 const getopts = require('getopts');
 const hbs2lit = require('../hbs2lit');
 const path = require('path');
 const litRenderer = require('./RenderTemplates/LitRenderer');
+const recursiveReadDir = require("recursive-readdir");
 
 const args = getopts(process.argv.slice(2), {
 	alias: {
@@ -18,55 +19,74 @@ const args = getopts(process.argv.slice(2), {
 
 const onError = (place) => {
 	console.log(`A problem occoured when reading ${place}. Please recheck passed parameters.`);
-}
+};
+
 const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
-const parseFile = (filePath, inputDir, outputDir) => {
-	fs.readFile(filePath, 'utf-8', (err, content) => {
 
-		if (err) {
-			onError('file');
-		}
+const processFile = async (file, outputDir) => {
+	const litCode = await hbs2lit(file);
+	const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
+	const componentNameMatcher = /(\w+)(\.hbs)/gim;
+	const componentName = componentNameMatcher.exec(file)[1];
 
-		hbs2lit.compileString(content, {
-			templatesPath: inputDir,
-			compiledTemplatesPath: outputDir
-		}).then((litCode) => {
-			const componentNameMatcher = /(\w+)(\.hbs)/gim;
-			const componentName = componentNameMatcher.exec(filePath)[1];
+	return writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
+};
 
-			writeRenderers(outputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
-		});
-	});
-}
+const composeAbsoluteOutputDir = (file, outputDir) => {
+	// (1) Extract the dir structure from the source file path - "src/lvl1/lvl2/MyCompBadge.hbs"
+	// - remove the filename - "src/lvl1/lvl2"
+	// - remove the leading dir - "lvl1/lvl2"
+	const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
+
+	// (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
+	return `${outputDir}${path.sep}${fileDir}`;
+};
 
 const wrapDirectory = (directory, outputDir) => {
 	directory = path.normalize(directory);
 	outputDir = path.normalize(outputDir);
 
-	fs.readdir(directory, (err, files) => {
+	return new Promise((resolve, reject) => {
+		recursiveReadDir(directory, (err, files) => {
 
-		if (err) {
-			onError('directory');
-		}
+			if (err) {
+				onError('directory');
+				reject();
+			}
 
-		files.forEach(fileName => {
-			if (isHandlebars(fileName)) {
+			const promises = files.map(fileName => {
+				if (isHandlebars(fileName)) {
+					return processFile(fileName, outputDir);
+				}
+			}).filter(x => !!x);
 
-				// could be refactored a bit
-				parseFile(directory + fileName, directory, outputDir);
-			}
+			resolve(Promise.all(promises));
 		});
-	})
+	});
 };
 
-const writeRenderers = (outputDir, controlName, fileContent) => {
+const writeRenderers = async (outputDir, controlName, fileContent) => {
 	try {
+
+		await fs.mkdir(outputDir, { recursive: true });
+
 		const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
 
 		// strip DOS line endings because the break the source maps
 		let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
 		fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
-		fs.writeFileSync(compiledFilePath, fileContentUnix);
+
+		// Only write to the file system actual changes - each updated file, no matter if the same or not, triggers an expensive operation for rollup
+		// Note: .hbs files that include a changed .hbs file will also be recompiled as their content will be updated too
+
+		let existingFileContent = "";
+		try {
+			existingFileContent = await fs.readFile(compiledFilePath);
+		} catch (e) {}
+
+		if (existingFileContent !== fileContentUnix) {
+			return fs.writeFile(compiledFilePath, fileContentUnix);
+		}
 
 	} catch (e) {
 		console.log(e);
@@ -76,5 +96,7 @@ const writeRenderers = (outputDir, controlName, fileContent) => {
 if (!args['d'] || !args['o']) {
 	console.log('Please provide an input and output directory (-d and -o)');
 } else {
-	wrapDirectory(args['d'], args['o']);
+	wrapDirectory(args['d'], args['o']).then(() => {
+		console.log("Templates generated");
+	});
 }