@ui5/webcomponents-tools 0.0.0-39bd3067f → 0.0.0-4034de059

package/lib/eslint/eslint.js

@@ -0,0 +1,44 @@
+const fs = require("fs");
+const { ESLint: ESLint7 } = require("eslint"); // isolated v7
+const path = require("path");
+
+const main = async argv => {
+	let eslintConfig;
+	if (fs.existsSync(".eslintrc.js") || fs.existsSync(".eslintrc.cjs")) {
+		// preferred way of custom configuration in root project folder
+		eslintConfig = null;
+	} else {
+		// no custom configuration - use default from tools project
+		eslintConfig = require.resolve("@ui5/webcomponents-tools/components-package/eslint.js")
+	};
+
+	const packageDir = path.dirname(require.resolve("@ui5/webcomponents-tools/package.json"));
+	const eslint = new ESLint7({
+		overrideConfigFile: eslintConfig,
+		fix: argv.includes("--fix"),
+		resolvePluginsRelativeTo: packageDir,
+	});
+	console.log("Running ESLint v7...");
+
+	// Lint files
+	const results = await eslint.lintFiles(["."]);
+
+	// Format results
+	const formatter = await eslint.loadFormatter("stylish");
+	const resultText = formatter.format(results);
+
+	// Output results
+	console.log(resultText);
+
+	// Exit with error code if there are errors
+	const hasErrors = results.some(result => result.errorCount > 0);
+	if (hasErrors) {
+		process.exit(1);
+	}
+}
+
+if (require.main === module) {
+	main(process.argv)
+}
+
+exports._ui5mainFn = main;

package/lib/generate-js-imports/illustrations.js

@@ -0,0 +1,85 @@
+const fs = require("fs").promises;
+const path = require("path");
+
+const generateDynamicImportLines = async (fileNames, location, exclusionPatterns = []) => {
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
+	return fileNames
+		.filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
+		.map((fileName) => {
+			const illustrationName = fileName.replace(".svg", "");
+			const illustrationPath = `${location}/${illustrationName}`;
+			return `\t\tcase "${fileName.replace('.js', '')}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${illustrationName.toLowerCase()}" */ "${illustrationPath}.js")).default;`;
+		})
+		.join("\n");
+};
+
+const generateDynamicImportsFileContent = (dynamicImports, availableIllustrations, collection, set, prefix = "") => {
+	return `// @ts-nocheck
+import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+
+export const loadIllustration = async (illustrationName) => {
+	const collectionAndPrefix = "${set}/${collection}/${prefix}";
+	const cleanIllustrationName = illustrationName.startsWith(collectionAndPrefix) ? illustrationName.replace(collectionAndPrefix, "") : illustrationName;
+	switch (cleanIllustrationName) {
+${dynamicImports}
+		default:
+			throw new Error("[Illustrations] Illustration not found: " + illustrationName);
+	}
+};
+
+const loadAndCheck = async (illustrationName) => {
+	const data = await loadIllustration(illustrationName);
+	return data;
+};
+
+${availableIllustrations}.forEach((illustrationName) =>
+	registerIllustrationLoader(\`${set}/${collection}/${prefix}\${illustrationName}\`, loadAndCheck)
+);
+`;
+};
+
+const getMatchingFiles = async (folder, pattern) => {
+	const dir = await fs.readdir(folder);
+	return dir.filter((fileName) => fileName.match(pattern));
+};
+
+const generateIllustrations = async (argv) => {
+	const config = {
+		inputFolder: argv[2],
+		outputFile: argv[3],
+		set: argv[4],
+		collection: argv[5],
+		location: argv[6],
+		filterOut: argv[7].slice().split(","),
+	};
+
+
+	const { inputFolder, outputFile, collection, location, prefix, filterOut, set } = config;
+
+	const normalizedInputFolder = path.normalize(inputFolder);
+	const normalizedOutputFile = path.normalize(outputFile);
+
+	const svgFiles = await getMatchingFiles(normalizedInputFolder, /\.svg$/);
+
+	const illustrations = [
+		...new Set(
+			svgFiles
+				.filter(name => !name.includes("sapIllus-Patterns"))
+				.map(name => name.split("-").pop().replace(".svg", ""))
+		),
+	];
+
+	const dynamicImports = await generateDynamicImportLines(illustrations, location, filterOut);
+	const contentDynamic = generateDynamicImportsFileContent(dynamicImports, JSON.stringify(illustrations), collection, set, prefix);
+
+	await fs.mkdir(path.dirname(normalizedOutputFile), { recursive: true });
+	await fs.writeFile(normalizedOutputFile, contentDynamic);
+
+	console.log("Generated illustration imports.");
+};
+
+if (require.main === module) {
+	generateIllustrations(process.argv)
+}
+
+exports._ui5mainFn = generateIllustrations;

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

@@ -1,53 +1,91 @@
-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 isTypeScript = process.env.UI5_TS;
+const ext = isTypeScript ? 'ts' : 'js';
 
-const inputFolder = path.normalize(process.argv[2]);
-const outputFile = 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 getContent = function(caseLines, languagesKeysStringArray, packageName) {
+	return `// @ts-nocheck
+import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
 
-let content;
+const importMessageBundle = async (localeId) => {
+	switch (localeId) {
+		${caseLines}
+		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. Check the \"Assets\" documentation for more information.\`);
+	}
+	return data;
+}
+
+const localeIds = [${languagesKeysStringArray}];
+
+localeIds.forEach(localeId => {
+	registerI18nLoader(${ packageName.split("").map(c => `"${c}"`).join (" + ") }, localeId, importAndCheck);
+});
+`;
+}
+
+const generate = async (argv) => {
 
-// No i18n - just import dependencies, if any
-if (languages.length === 0) {
-  content = ``;
-// There is i18n - generate the full file
-} else {
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
 
-  // Keys for the array
-  const languagesKeysString = languages.map(key => `${key},`).join("\n\t");
+	const inputFolder = path.normalize(argv[2]);
+	const outputFileDynamic = path.normalize(`${argv[3]}/i18n.${ext}`);
+	const outputFileFetchMetaResolve = path.normalize(`${argv[3]}/i18n-fetch.${ext}`);
+	const outputFileDynamicImportJSONImport = path.normalize(`${argv[3]}/i18n-node.${ext}`);
 
-  // Actual imports for json assets
-  const assetsImportsString = languages.map(key => `import ${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
+	// All languages present in the file system
+	const files = await fs.readdir(inputFolder);
+	const languages = files.map(file => {
+		const matches = file.match(/messagebundle_(.+?).properties$/);
+		return matches ? matches[1] : undefined;
+	}).filter(key => !!key);
 
-  // Resulting file content
-  content = `import { registerI18nBundle } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
+	let contentDynamic;
+	let contentFetchMetaResolve;
+	let contentDynamicImportJSONAttr;
 
-${assetsImportsString}
+	// No i18n - just import dependencies, if any
+	if (languages.length === 0) {
+		contentDynamic = "";
+		contentFetchMetaResolve = "";
+		contentDynamicImportJSONAttr = "";
+	// There is i18n - generate the full file
+	} else {
+		// Keys for the array
+		const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
 
-const bundleMap = {
-	${languagesKeysString}
-};
+		// Actual imports for json assets
+		const dynamicImportsString = languages.map(key => `		case "${key}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-messagebundle-${key}" */ "../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
+		const fetchMetaResolveString = languages.map(key => `		case "${key}": return (await fetch(new URL("../assets/i18n/messagebundle_${key}.json", import.meta.url))).json();`).join("\n");
+		const dynamicImportJSONAttrString = languages.map(key => `		case "${key}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-messagebundle-${key}" */ "../assets/i18n/messagebundle_${key}.json", {with: { type: 'json'}})).default;`).join("\n");
 
-const allEntriesInlined = Object.entries(bundleMap).every(([_key, value]) => typeof (value) === "object");
+		// Resulting file content
 
-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"\`);
+		contentDynamic = getContent(dynamicImportsString, languagesKeysStringArray, packageName);
+		contentFetchMetaResolve = getContent(fetchMetaResolveString, languagesKeysStringArray, packageName);
+		contentDynamicImportJSONAttr = getContent(dynamicImportJSONAttrString, languagesKeysStringArray, packageName);
+	}
+
+	await fs.mkdir(path.dirname(outputFileDynamic), { recursive: true });
+	return Promise.all([
+		fs.writeFile(outputFileDynamic, contentDynamic),
+		fs.writeFile(outputFileFetchMetaResolve, contentFetchMetaResolve),
+		fs.writeFile(outputFileDynamicImportJSONImport, contentDynamicImportJSONAttr),
+	]).then(() => {
+		console.log("Generated i18n JSON imports.");
+	});
 }
 
-registerI18nBundle("${packageName}", bundleMap);
-`;
+if (require.main === module) {
+	generate(process.argv)
 }
 
-mkdirp.sync(path.dirname(outputFile));
-fs.writeFileSync(outputFile, content);
+exports._ui5mainFn = generate;

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

@@ -1,33 +1,71 @@
-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 isTypeScript = process.env.UI5_TS;
+const ext = isTypeScript ? 'ts' : 'js';
 
-const optionalThemes = assets.themes.all.filter(theme => theme !== assets.themes.default);
+const generate = async (argv) => {
+	const inputFolder = path.normalize(argv[2]);
+	const outputFileDynamic = path.normalize(`${argv[3]}/Themes.${ext}`);
+	const outputFileDynamicImportJSONAttr = path.normalize(`${argv[3]}/Themes-node.${ext}`);
+	const outputFileFetchMetaResolve = path.normalize(`${argv[3]}/Themes-fetch.${ext}`);
 
-const packageName = JSON.parse(fs.readFileSync("package.json")).name;
+	// All supported optional themes
+	const allThemes = assets.themes.all;
 
-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");
+	// 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));
 
-// Resulting file content
-const content = `import { registerThemeProperties } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+	const packageName = JSON.parse(await fs.readFile("package.json")).name;
 
-${importLines}
+	const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
+	const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${theme.replace("_", "-")}-parameters-bundle" */"../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
+	const dynamicImportJSONAttrLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${theme.replace("_", "-")}-parameters-bundle" */"../assets/themes/${theme}/parameters-bundle.css.json", {with: { type: 'json'}})).default;`).join("\n");
+	const fetchMetaResolveLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await fetch(new URL("../assets/themes/${theme}/parameters-bundle.css.json", import.meta.url))).json();`).join("\n");
 
-const isInlined = obj => typeof (obj) === "object";
+	// dynamic imports file content
+	const contentDynamic = function (lines) {
+		return `// @ts-nocheck
+import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
 
-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) => {
+	switch (themeName) {
+${lines}
+		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. Check the \"Assets\" documentation for more information.\`);
+	}
+	return data;
+};
 
-${registerLines};
+${availableThemesArray}
+  .forEach(themeName => registerThemePropertiesLoader(${packageName.split("").map(c => `"${c}"`).join(" + ")}, themeName, loadAndCheck));
 `;
+	}
+
+	await fs.mkdir(path.dirname(outputFileDynamic), { recursive: true });
+	return Promise.all([
+		fs.writeFile(outputFileDynamic, contentDynamic(dynamicImportLines)),
+		fs.writeFile(outputFileDynamicImportJSONAttr, contentDynamic(dynamicImportJSONAttrLines)),
+		fs.writeFile(outputFileFetchMetaResolve, contentDynamic(fetchMetaResolveLines)),
+	]).
+		then(() => {
+			console.log("Generated themes JSON imports.");
+		})
+};
+
+if (require.main === module) {
+	generate(process.argv)
+}
 
-mkdirp.sync(path.dirname(outputFile));
-fs.writeFileSync(outputFile, content);
+exports._ui5mainFn = generate;

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

@@ -5,19 +5,32 @@ const includesReplacer = require("./includesReplacer");
 const svgProcessor = require("./svgProcessor");
 
 const removeWhiteSpaces = (source) => {
-	return source.replace(/\n+/g, "").replace(/\s+</g, "<").replace(/}}\s+{{/g, "}}{{");
+	return source
+		.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, componentName) => {
+	let sPreprocessed = await includesReplacer.replace(file);
 
-	sPreprocessed = await includesReplacer.replace(sPreprocessed, config);
 	sPreprocessed = removeWhiteSpaces(sPreprocessed);
 
+	const blockSignature = process.env.UI5_TS ? `this: ${componentName}` : ""
+
+	// icons hack
+	if (sPreprocessed.startsWith("<g ") || sPreprocessed.startsWith("<g>")) {
+		return `
+		function block0 (${blockSignature}) {
+			return svg\`${sPreprocessed}\`
+		}`;
+	}
+
 	const ast = Handlebars.parse(sPreprocessed);
 
 	const pv = new PartialsVisitor();
-	const lv = new HTMLLitVisitor();
+	const lv = new HTMLLitVisitor(componentName);
 
 	let result = "";
 
@@ -27,13 +40,21 @@ 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 matches = block.match(/^(function .*? \{ return )(.*?);\}$/);
+			const scopedCode = matches[2];
+			const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
+			block = `${matches[1]}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,25 +1,31 @@
 const path = require("path");
-const {promisify} = require("util");
-const nativeFs = require("fs");
+const fs = require("fs").promises;
 
-function replaceIncludes(hbs, config) {
-	const fs = config.fs || nativeFs;
-	const readFile = promisify(fs.readFile);
-	const inclRegex = /{{>\s*include\s*["']([a-zA-Z.\/]+)["']}}/g;
-
-	async function replacer(match, p1) {
-		const includeContent = await readFile(path.join(config.templatesPath, p1), "utf-8");
-		hbs = hbs.replace(match, includeContent);
-	}
+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;
-	const replacers = [];
-	while ((match = inclRegex.exec (hbs)) !== null) {
-		replacers.push(replacer(match[0], match[1]));
+
+	while((match = inclRegex.exec(fileContent)) !== null) {
+		inclRegex.lastIndex = 0;
+
+		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 Promise.all(replacers).then(() => hbs);
-}
+
+	return fileContent;
+};
 
 module.exports = {
 	replace: replaceIncludes
-};
+};