@ui5/webcomponents-tools 0.0.0-2c7615fe9 → 0.0.0-2c875c3d3

package/lib/i18n/defaults.js

@@ -1,74 +1,88 @@
-const fs = require('fs');
+const fs = require('fs').promises;
 const path = require('path');
 const PropertiesReader = require('properties-reader');
-const mkdirp = require("mkdirp");
 const assets = require('../../assets-meta.js');
 
-const defaultLanguage = assets.languages.default;
+const generate = async (argv) => {
+	const defaultLanguage = assets.languages.default;
 
-const messageBundle = path.normalize(`${process.argv[2]}/messagebundle.properties`);
-const messageBundleDefaultLanguage = path.normalize(`${process.argv[2]}/messagebundle_${defaultLanguage}.properties`);
-const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.js`);
+	const messageBundle = path.normalize(`${argv[2]}/messagebundle.properties`);
+	const messageBundleDefaultLanguage = path.normalize(`${argv[2]}/messagebundle_${defaultLanguage}.properties`);
+	const tsMode = process.env.UI5_TS === "true"; // In Typescript mode, we output .ts files and set the required types, otherwise - output pure .js files
 
-if (!messageBundle || !outputFile) {
-	return;
-}
+	const outputFile = path.normalize(`${argv[3]}/i18n-defaults.${tsMode ? "ts" : "js"}`);
 
-const properties = PropertiesReader(messageBundle)._properties;
+	if (!messageBundle || !outputFile) {
+		return;
+	}
 
-let defaultLanguageProperties;
-try {
-	defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
-}
-catch (e) {}
-
-
-/*
- * Returns the single text object to enable single export.
- *
- * Example:
- * const ARIA_LABEL_CARD_CONTENT = {
- *	key: "ARIA_LABEL_CARD_CONTENT",
- *	defaultText: "Card Content",
- * };
- */
-const getTextInfo = (key, value, defaultLanguageValue) => {
-	let effectiveValue = defaultLanguageValue || value;
-	effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
-
-	return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
-};
+	const properties = PropertiesReader(messageBundle)._properties;
 
-/*
- * Returns the complete content of i18n-defaults.js file:
- * (1) the single text objects
- * (2) the export statement at the end of the file
- *
- * Example:
- * export {
- *	ARIA_LABEL_CARD_CONTENT,
- * }
- */
-const getOutputFileContent = (properties, defaultLanguageProperties) => {
-	const textKeys = Object.keys(properties);
-	const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
-
-	return `${texts}
-export {${textKeys.join()}};`;
-};
+	let defaultLanguageProperties;
+	try {
+		defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
+	} catch (e) {
+	}
+
+	// Merge messagebundle.properties and messagebundle_en.properties files to generate the default texts.
+	// Note:
+	// (1) at DEV time, it's intuituve to work with the source bundle file - the messagebundle.properties,
+	// and see the changes there take effect.
+	// (2) as the messagebundle.properties file is always written in English,
+	// it makes sense to consider the messagebundle.properties content only when the default language is "en".
+	if (defaultLanguage === "en") {
+		// use messagebundle_en.properties to overwrite all developer properties, only the not translated ones will remain
+		defaultLanguageProperties = Object.assign({}, properties, defaultLanguageProperties);
+	}
+
+	/*
+	 * Returns the single text object to enable single export.
+	 *
+	 * Example:
+	 * const ARIA_LABEL_CARD_CONTENT = {
+	 *	key: "ARIA_LABEL_CARD_CONTENT",
+	 *	defaultText: "Card Content",
+	 * };
+	 */
+	const getTextInfo = (key, value, defaultLanguageValue) => {
+		let effectiveValue = defaultLanguageValue || value;
+		effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
 
-/*
- * Writes the i18n-defaults.js.
- */
-const writeI18nDefaultsFile = (file, content) => {
-	fs.writeFile(file, content, (err) => {
-		if (err) {
-			return console.log(err);
+		if (tsMode) {
+			return `const ${key}: I18nText = {key: "${key}", defaultText: "${effectiveValue}"};`;
 		}
+		return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
+	};
 
-		console.log(`[i18n]: "${file}" file has been created`);
-	});
+	/*
+	 * Returns the complete content of i18n-defaults.js file:
+	 * (1) the single text objects
+	 * (2) the export statement at the end of the file
+	 *
+	 * Example:
+	 * export {
+	 *	ARIA_LABEL_CARD_CONTENT,
+	 * }
+	 */
+	const getOutputFileContent = (properties, defaultLanguageProperties) => {
+		const textKeys = Object.keys(properties);
+		const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
+
+		// tabs are intentionally mixed to have proper identation in the produced file
+		return `${tsMode ? `import type { I18nText } from "@ui5/webcomponents-base/dist/i18nBundle.js";` : ""}
+${texts}
+export {${textKeys.join()}};`;
+	};
+
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
+
+
+	console.log("i18n default file generated.")
 };
 
-mkdirp.sync(path.dirname(outputFile));
-writeI18nDefaultsFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
+if (require.main === module) {
+	generate(process.argv)
+}
+
+exports._ui5mainFn = generate;

package/lib/i18n/toJSON.js

@@ -8,18 +8,13 @@
  * The 2nd param './../dist/generated/assets/i18n' is where the JSON files would be written to.
  */
 const path = require("path");
-const glob = require("glob");
 const PropertiesReader = require('properties-reader');
-const fs = require('fs');
+const fs = require('fs').promises;
 const assets = require('../../assets-meta.js');
-const mkdirp = require("mkdirp");
 
 const allLanguages = assets.languages.all;
 
-const messagesBundles = path.normalize(`${process.argv[2]}/messagebundle_*.properties`);
-const messagesJSONDist = path.normalize(`${process.argv[3]}`);
-
- const convertToJSON = (file) => {
+const convertToJSON = async (file, distPath) => {
 	const properties = PropertiesReader(file)._properties;
 	const filename = path.basename(file, path.extname(file));
 	const language = filename.match(/^messagebundle_(.*?)$/)[1];
@@ -27,16 +22,26 @@ const messagesJSONDist = path.normalize(`${process.argv[3]}`);
 		console.log("Not supported language: ", language);
 		return;
 	}
-	const outputFile = path.normalize(`${messagesJSONDist}/${filename}.json`);
+	const outputFile = path.normalize(`${distPath}/${filename}.json`);
 
-	fs.writeFileSync(outputFile, JSON.stringify(properties));
+	return fs.writeFile(outputFile, JSON.stringify(properties));
 	// console.log(`[i18n]: "${filename}.json" has been generated!`);
 };
 
-mkdirp.sync(messagesJSONDist);
- glob(messagesBundles, {}, (err, files) => {
-	if (err) {
-		return console.log("No messagebundle files found!");
-	}
-	files.forEach(convertToJSON);
-});
+const generate = async (agrv) => {
+	const { globby } = await import("globby");
+	const messagesBundles = path.normalize(`${agrv[2]}/messagebundle_*.properties`);
+	const messagesJSONDist = path.normalize(`${agrv[3]}`);
+	await fs.mkdir(messagesJSONDist, { recursive: true });
+	const files = await globby(messagesBundles.replace(/\\/g, "/"));
+	return Promise.all(files.map(file => convertToJSON(file, messagesJSONDist)))
+		.then(() => {
+			console.log("Message bundle JSON files generated.");
+		});
+};
+
+if (require.main === module) {
+	generate(process.argv)
+}
+
+exports._ui5mainFn = generate;

package/lib/icons-hash/icons-hash.mjs

@@ -0,0 +1,149 @@
+import fs from "fs/promises";
+import path from "path";
+import ignore from "ignore";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// -------------------
+// FNV-1a 32-bit hash
+// -------------------
+function fnv1aHash(str) {
+	let hash = 0x811c9dc5;
+	for (let i = 0; i < str.length; i++) {
+		hash ^= str.charCodeAt(i);
+		hash = (hash * 0x01000193) >>> 0;
+	}
+	return hash.toString(16);
+}
+
+async function findGitignoreFiles(startDir) {
+	const gitignores = [];
+	let currentDir = path.resolve(startDir);
+	while (true) {
+		const candidate = path.join(currentDir, ".gitignore");
+		try {
+			await fs.access(candidate);
+			gitignores.push(candidate);
+		} catch { }
+		const parentDir = path.dirname(currentDir);
+		if (parentDir === currentDir) break;
+		currentDir = parentDir;
+	}
+	return gitignores;
+}
+
+async function loadIgnoreRules(dir) {
+	const files = await findGitignoreFiles(dir);
+	const ig = ignore();
+	for (const file of files) {
+		const content = await fs.readFile(file, "utf8");
+		ig.add(content);
+	}
+	return ig;
+}
+
+async function walkDir(dir, ig, baseDir) {
+	const results = [];
+	const entries = await fs.readdir(dir, { withFileTypes: true });
+
+	for (const entry of entries) {
+		const absPath = path.join(dir, entry.name);
+		let relPath = path.relative(baseDir, absPath).replace(/\\/g, "/"); // normalize for .gitignore
+
+		if (ig.ignores(relPath) || relPath.startsWith("dist/")) continue;
+
+		if (entry.isDirectory()) {
+			results.push(...await walkDir(absPath, ig, baseDir));
+		} else {
+			results.push(relPath);
+		}
+	}
+	return results;
+}
+
+// Hash file content + mtime
+async function hashFile(filePath) {
+	const stat = await fs.stat(filePath);
+	const content = await fs.readFile(filePath, "utf8");
+	return fnv1aHash(String(stat.mtimeMs) + content);
+}
+
+function getRepoName(repoPath) {
+	return repoPath.split("/").pop();
+}
+
+async function computeHashes(repoPath, ig) {
+	const files = await walkDir(repoPath, ig, repoPath);
+	const hashEntries = await Promise.all(
+		files.map(async (file) => {
+			const absPath = path.join(repoPath, file);
+			const hash = await hashFile(absPath);
+			return [path.relative(process.cwd(), absPath), hash];
+		})
+	);
+	return Object.fromEntries(hashEntries);
+}
+
+async function saveHashes(repoPath, ig) {
+	const distPath = path.join(repoPath, "dist");
+	await fs.mkdir(distPath, { recursive: true });
+	const ui5iconsHashPath = path.join(distPath, ".ui5iconsHash");
+
+	// Cache the hashes for both the icons and tools packages, since the output depends on the content of both.
+	const hashes = {
+		...(await computeHashes(repoPath, ig)),
+		...(await computeHashes(path.resolve(__dirname, "../../"), ig)),
+	};
+
+	await fs.writeFile(ui5iconsHashPath, JSON.stringify(hashes, null, 2), "utf8");
+	console.log(`Saved build hashes for the ${getRepoName(repoPath)} package.`);
+}
+
+async function checkHashes(repoPath, ig) {
+	const ui5iconsHashPath = path.join(repoPath, "dist", ".ui5iconsHash");
+	let oldHashes = {};
+	try {
+		const raw = await fs.readFile(ui5iconsHashPath, "utf8");
+		oldHashes = JSON.parse(raw);
+	} catch {
+		console.log(`No build hashes found for the ${getRepoName(repoPath)} package. Building it now.`);
+		process.exit(1);
+	}
+
+	// Compare the hashes for both the icons and tools packages, since the output depends on the content of both.
+	const newHashes = {
+		...(await computeHashes(repoPath, ig)),
+		...(await computeHashes(path.resolve(__dirname, "../../"), ig)),
+	};
+
+	let changed = false;
+	for (const file of new Set([...Object.keys(oldHashes), ...Object.keys(newHashes)])) {
+		if (oldHashes[file] !== newHashes[file]) {
+			changed = true;
+		}
+	}
+
+	if (!changed) {
+		console.log(`No changes detected in the ${getRepoName(repoPath)} package.`);
+	} else {
+		console.log(`Changes detected in the ${getRepoName(repoPath)} package. Rebuilding it.`);
+		process.exit(1);
+	}
+}
+
+async function main() {
+	const mode = process.argv[2];
+	if (!["save", "check"].includes(mode)) {
+		throw new Error("Usage: node hashes.js <save|check>");
+	}
+
+	const repoPath = process.cwd();
+	const ig = await loadIgnoreRules(repoPath);
+
+	if (mode === "save") await saveHashes(repoPath, ig);
+	if (mode === "check") await checkHashes(repoPath, ig);
+}
+
+main().catch(console.error);

package/lib/postcss-combine-duplicated-selectors/index.js

@@ -0,0 +1,185 @@
+/*
+ The MIT License (MIT)
+
+Copyright (c) 2016 Christian Murphy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+
+const parser = require('postcss-selector-parser');
+const name = "postcss-combine-duplicated-selectors";
+
+/**
+ * Ensure that attributes with different quotes match.
+ * @param {Object} selector - postcss selector node
+ */
+function normalizeAttributes(selector) {
+	selector.walkAttributes((node) => {
+		if (node.value) {
+			// remove quotes
+			node.value = node.value.replace(/'|\\'|"|\\"/g, '');
+		}
+	});
+}
+
+/**
+ * Sort class and id groups alphabetically
+ * @param {Object} selector - postcss selector node
+ */
+function sortGroups(selector) {
+	selector.each((subSelector) => {
+		subSelector.nodes.sort((a, b) => {
+			// different types cannot be sorted
+			if (a.type !== b.type) {
+				return 0;
+			}
+
+			// sort alphabetically
+			return a.value < b.value ? -1 : 1;
+		});
+	});
+
+	selector.sort((a, b) => (a.nodes.join('') < b.nodes.join('') ? -1 : 1));
+}
+
+/**
+ * Remove duplicated properties
+ * @param {Object} selector - postcss selector node
+ * @param {Boolean} exact
+ */
+function removeDupProperties(selector, exact) {
+	if (!exact) { // Remove duplicated properties, regardless of value
+		const retainedProps = new Set();
+
+		for (let actIndex = selector.nodes.length - 1; actIndex >= 1; actIndex--) {
+			const prop = selector.nodes[actIndex].prop;
+			if (prop !== undefined) {
+				if (!retainedProps.has(prop)) {
+					retainedProps.add(prop); // Mark the prop as retained, all other occurrences must be removed
+				} else {
+					selector.nodes[actIndex].remove(); // This occurrence of the prop must be removed
+				}
+			}
+		}
+	} else {
+		// Remove duplicated properties from bottom to top ()
+		for (let actIndex = selector.nodes.length - 1; actIndex >= 1; actIndex--) {
+			for (let befIndex = actIndex - 1; befIndex >= 0; befIndex--) {
+				if (
+					selector.nodes[actIndex].prop === selector.nodes[befIndex].prop &&
+					selector.nodes[actIndex].value === selector.nodes[befIndex].value
+				) {
+					selector.nodes[befIndex].remove();
+					actIndex--;
+				}
+			}
+		}
+	}
+}
+
+const uniformStyle = parser((selector) => {
+	normalizeAttributes(selector);
+	sortGroups(selector);
+});
+
+const defaultOptions = {
+	removeDuplicatedProperties: false,
+};
+
+module.exports = (options) => {
+	options = Object.assign({}, defaultOptions, options);
+	return {
+		postcssPlugin: name,
+		prepare() {
+			// Create a map to store maps
+			const mapTable = new Map();
+			// root map to store root selectors
+			mapTable.set('root', new Map());
+
+			return {
+				Rule: (rule) => {
+					let map;
+					// Check selector parent for any at rule
+					if (rule.parent.type === 'atrule') {
+						// Use name and query params as the key
+						const query =
+							rule.parent.name.toLowerCase() +
+							rule.parent.params.replace(/\s+/g, '');
+
+						// See if this query key is already in the map table
+						map = mapTable.has(query) ? // If it is use it
+							mapTable.get(query) : // if not set it and get it
+							mapTable.set(query, new Map()).get(query);
+					} else {
+						// Otherwise we are dealing with a selector in the root
+						map = mapTable.get('root');
+					}
+
+					// create a uniform selector
+					const selector = uniformStyle.processSync(rule.selector, {
+						lossless: false,
+					});
+
+					if (map.has(selector)) {
+						// store original rule as destination
+						const destination = map.get(selector);
+
+						// check if node has already been processed
+						if (destination === rule) return;
+
+						// move declarations to original rule
+						while (rule.nodes.length > 0) {
+							destination.append(rule.nodes[0]);
+						}
+						// remove duplicated rule
+						rule.remove();
+
+						if (
+							options.removeDuplicatedProperties ||
+							options.removeDuplicatedValues
+						) {
+							// removeDupProperties(
+							// 	destination,
+							// 	options.removeDuplicatedValues,
+							// );
+						}
+					} else {
+						if (
+							options.removeDuplicatedProperties ||
+							options.removeDuplicatedValues
+						) {
+							// removeDupProperties(rule, options.removeDuplicatedValues);
+						}
+						// add new selector to symbol table
+						map.set(selector, rule);
+					}
+				},
+				OnceExit(root) {
+					root.nodes.forEach(node => {
+						if (node.type === "rule") {
+							removeDupProperties(node, options.removeDuplicatedValues);
+						}
+					})
+				}
+			};
+		},
+	};
+};
+
+module.exports.postcss = true;

package/lib/remove-dev-mode/remove-dev-mode.mjs

@@ -0,0 +1,51 @@
+import { globby } from "globby";
+import * as esbuild from 'esbuild'
+import * as fs from "fs";
+import { pathToFileURL } from "url";
+
+const generate = async () => {
+  let customPlugin = {
+    name: 'ui5-tools',
+    setup(build) {
+      build.onLoad({ filter: /UI5Element.ts$/ }, async (args) => {
+        let text = await fs.promises.readFile(args.path, 'utf8');
+        text = text.replaceAll(/const DEV_MODE = true/g, "");
+        text = text.replaceAll(/if \(DEV_MODE\)/g, "if (false)");
+        return {
+          contents: text,
+          loader: 'ts',
+        }
+      })
+    },
+  }
+
+  const getConfig = async () => {
+    const config = {
+      entryPoints: await globby("src/**/*.ts"),
+      bundle: false,
+      minify: true,
+      sourcemap: true,
+      outdir: 'dist/prod',
+      outbase: 'src',
+      plugins: [
+        customPlugin,
+      ]
+    };
+    return config;
+  }
+
+
+  const config = await getConfig();
+  const result = await esbuild.build(config);
+}
+
+const filePath = process.argv[1];
+const fileUrl = pathToFileURL(filePath).href;
+
+if (import.meta.url === fileUrl) {
+  generate()
+}
+
+export default {
+  _ui5mainFn: generate
+}

package/lib/rimraf/rimraf.js

@@ -0,0 +1,31 @@
+const fs = require('fs');
+const path = require('path');
+
+const rimraf = dir => {
+	if (fs.existsSync(dir)) {
+		fs.readdirSync(dir).forEach(entry => {
+			const entryPath = path.join(dir, entry);
+			if (fs.lstatSync(entryPath).isDirectory()) {
+				rimraf(entryPath);
+			} else {
+				fs.unlinkSync(entryPath);
+			}
+		});
+		fs.rmdirSync(dir);
+	}
+};
+
+const main = argv => {
+	if (argv.length < 3) {
+		console.error("rimraf <dir>");
+		process.exit(1);
+	}
+	const dir = argv[2];
+	rimraf(dir);
+};
+
+if (require.main === module) {
+	main(process.argv)
+}
+
+exports._ui5mainFn = main;

package/lib/scoping/get-all-tags.js

@@ -4,22 +4,22 @@ const glob = require("glob");
 
 const getTag = file => {
 	const fileContent = String(fs.readFileSync(file)).replace(/\n/g, "");
-	const matches = fileContent.match(/\btag\b:\s*\"(.*?)\"/);
-	return matches ? matches[1] : undefined;
-};
-
-const getAltTag = file => {
-	const fileContent = String(fs.readFileSync(file)).replace(/\n/g, "");
-	const matches = fileContent.match(/\baltTag\b:\s*\"(.*?)\"/);
-	return matches ? matches[1] : undefined;
+	let matches = fileContent.match(/\btag\b:\s*\"(.*?)\"/);
+	if (matches) {
+		return matches[1];
+	}
+	matches = fileContent.match(/@customElement\("(.*?)"\)/);
+	if (matches) {
+		return matches[1];
+	}
+	return undefined;
 };
 
 const getPackageTags = (packageDir) => {
 	const srcDir = path.join(packageDir, "src/");
-	return glob.sync(path.join(srcDir, "/**/*.js")).flatMap(file => {
+	return glob.sync(path.join(srcDir, "/**/*.ts")).flatMap(file => {
 		const tag = getTag(file);
-		const altTag = getAltTag(file);
-		return [tag, altTag];
+		return [tag];
 	}).filter(item => !!item);
 };