@ui5/webcomponents-tools 0.0.0-a3eca7ade → 0.0.0-a8a75c830

package/lib/css-processors/css-processor-components.mjs

@@ -0,0 +1,103 @@
+import { globby } from "globby";
+import * as esbuild from 'esbuild'
+import * as fs from "fs";
+import * as path from "path";
+import { writeFile, mkdir } from "fs/promises";
+import chokidar from "chokidar";
+import scopeVariables from "./scope-variables.mjs";
+import { writeFileIfChanged, getFileContent } from "./shared.mjs";
+import { pathToFileURL } from "url";
+
+
+const generate = async (argv) => {
+    const CSS_VARIABLES_TARGET = process.env.CSS_VARIABLES_TARGET === "host";
+    const tsMode = process.env.UI5_TS === "true";
+    const extension = tsMode ? ".css.ts" : ".css.js";
+
+    const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+    const basePackageJSON = (await import("@ui5/webcomponents-base/package.json", { with: { type: "json" } })).default;
+
+    const inputFilesGlob = "src/themes/*.css";
+    const restArgs = argv.slice(2);
+
+    let customPlugin = {
+        name: 'ui5-tools',
+        setup(build) {
+            build.initialOptions.write = false;
+
+            build.onEnd(result => {
+                result.outputFiles.forEach(async f => {
+                    let newText
+
+                    if (CSS_VARIABLES_TARGET) {
+                        newText = f.text;
+                    } else {
+                        // scoping
+                        newText = scopeVariables(f.text, basePackageJSON);
+                    }
+
+                    newText = newText.replaceAll(/\\/g, "\\\\"); // Escape backslashes as they might appear in css rules
+                    await mkdir(path.dirname(f.path), { recursive: true });
+                    writeFile(f.path, newText);
+
+                    // JS/TS
+                    const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
+                    const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`", true);
+                    writeFileIfChanged(jsPath, jsContent);
+                });
+            })
+        },
+    }
+
+    const getConfig = async () => {
+        const config = {
+            entryPoints: await globby(inputFilesGlob),
+            bundle: true,
+            minify: true,
+            outdir: 'dist/css',
+            outbase: 'src',
+            plugins: [
+                customPlugin,
+            ]
+        };
+        return config;
+    }
+
+    if (restArgs.includes("-w")) {
+        let ready;
+        let config = await getConfig();
+        let ctx = await esbuild.context(config);
+        await ctx.watch()
+        console.log('watching...')
+
+        // when new component css files are added, they do not trigger a build as no one directly imports them
+        // restart the watch mode with the new entry points if a css file is added.
+        const watcher = chokidar.watch(inputFilesGlob);
+        watcher.on("ready", () => {
+            ready = true; // Initial scan is over -> waiting for new files
+        });
+        watcher.on("add", async path => {
+            if (ready) {
+                // new file
+                ctx.dispose();
+                config = await getConfig();
+                ctx = await esbuild.context(config);
+                ctx.watch();
+            }
+        });
+    } else {
+        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(process.argv)
+}
+
+export default {
+    _ui5mainFn: generate
+}

package/lib/css-processors/css-processor-themes.mjs

@@ -0,0 +1,122 @@
+import { globby } from "globby";
+import * as esbuild from 'esbuild'
+import * as fs from "fs";
+import * as path from "path";
+import { writeFile, mkdir } from "fs/promises";
+import postcss from "postcss";
+import combineDuplicatedSelectors from "../postcss-combine-duplicated-selectors/index.js"
+import postcssPlugin from "./postcss-plugin.mjs";
+import { writeFileIfChanged, getFileContent } from "./shared.mjs";
+import scopeVariables from "./scope-variables.mjs";
+import { pathToFileURL } from "url";
+
+const generate = async (argv) => {
+    const CSS_VARIABLES_TARGET = process.env.CSS_VARIABLES_TARGET === "host";
+    const tsMode = process.env.UI5_TS === "true";
+    const extension = tsMode ? ".css.ts" : ".css.js";
+
+    const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+    const basePackageJSON = (await import("@ui5/webcomponents-base/package.json", { with: { type: "json" } })).default;
+
+    const inputFiles = await globby([
+        "src/**/parameters-bundle.css",
+    ]);
+    const restArgs = argv.slice(2);
+
+    const saveFiles = async (distPath, css, suffix = "") => {
+        await mkdir(path.dirname(distPath), { recursive: true });
+        writeFile(distPath.replace(".css", suffix + ".css"), css);
+
+        // JSON
+        const jsonPath = distPath.replace(/dist[\/\\]css/, "dist/generated/assets").replace(".css", suffix + ".css.json");
+        await mkdir(path.dirname(jsonPath), { recursive: true });
+        writeFileIfChanged(jsonPath, JSON.stringify(css));
+
+        // JS/TS
+        const jsPath = distPath.replace(/dist[\/\\]css/, "src/generated/").replace(".css", suffix + extension);
+        const jsContent = getFileContent(packageJSON.name, "\`" + css + "\`");
+        writeFileIfChanged(jsPath, jsContent);
+    }
+
+    const processThemingPackageFile = async (f) => {
+        const selector = ':root';
+        const result = await postcss().process(f.text, { from: undefined });
+
+        const newRule = postcss.rule({ selector });
+
+        result.root.walkRules(selector, rule => {
+            rule.walkDecls(decl => {
+                if (!decl.prop.startsWith('--sapFontUrl')) {
+                    newRule.append(decl.clone());
+                }
+            });
+        });
+
+        return { css: newRule.toString() };
+    };
+
+    const processComponentPackageFile = async (f) => {
+        if (CSS_VARIABLES_TARGET) {
+            const result = await postcss([
+                combineDuplicatedSelectors,
+                postcssPlugin
+            ]).process(f.text, { from: undefined });
+
+            return { css: result.css };
+        }
+
+
+        const combined = await postcss([
+            combineDuplicatedSelectors,
+        ]).process(f.text, { from: undefined });
+
+        return { css: scopeVariables(combined.css, basePackageJSON, f.path) };
+    }
+
+    let scopingPlugin = {
+        name: 'scoping',
+        setup(build) {
+            build.initialOptions.write = false;
+
+            build.onEnd(result => {
+                result.outputFiles.forEach(async f => {
+                    let { css } = f.path.includes("packages/theming") ? await processThemingPackageFile(f) : await processComponentPackageFile(f);
+
+                    saveFiles(f.path, css);
+                });
+            })
+        },
+    }
+
+    const config = {
+        entryPoints: inputFiles,
+        bundle: true,
+        minify: true,
+        outdir: 'dist/css',
+        outbase: 'src',
+        logLevel: process.env.UI5_VERBOSE === "true" ? "warning" : "error",
+        plugins: [
+            scopingPlugin,
+        ],
+        external: ["*.ttf", "*.woff", "*.woff2"],
+    };
+
+    if (restArgs.includes("-w")) {
+        let ctx = await esbuild.context(config);
+        console.log('watching...')
+        await ctx.watch()
+    } else {
+        await esbuild.build(config);
+    }
+}
+
+const filePath = process.argv[1];
+const fileUrl = pathToFileURL(filePath).href;
+
+if (import.meta.url === fileUrl) {
+    generate(process.argv)
+}
+
+export default {
+    _ui5mainFn: generate
+}

package/lib/css-processors/postcss-plugin.mjs

@@ -0,0 +1,153 @@
+
+import postcss from "postcss";
+
+const hostVariables = new Map();
+
+const SELECTOR = ":host";
+
+const saveVariable = (variable, value, density) => {
+    if (!hostVariables.has(variable)) {
+        hostVariables.set(variable, {});
+    }
+    hostVariables.get(variable)[density] = value;
+}
+
+/**
+ * PostCSS plugin for handling CSS variables across density modes (cozy and compact).
+ *
+ * The plugin scans CSS for `:host` rules that define density-specific custom properties.
+ * Variables declared in a root-level `:host` rule are treated as **cozy** values, while
+ * variables declared inside `@container style(--ui5_content_density: compact)` `:host` rules
+ * are treated as **compact** values.
+ *
+ * All discovered variables are merged into a single root `:host` rule. For variables that
+ * exist in both modes, the plugin generates a value that uses CSS variable fallbacks to
+ * dynamically switch between compact and cozy values based on the active density.
+ *
+ * Variables that exist in only one mode are preserved, with appropriate fallbacks added
+ * when needed.
+ *
+ * Example input:
+ *
+ * ```css
+ * :host {
+ *   --my-variable: cozy-value;
+ *   --cozy-only-variable: cozy-only-value;
+ * }
+ *
+ * @container style(--ui5_content_density: compact) {
+ *   :host {
+ *     --my-variable: compact-value;
+ *     --compact-only-variable: compact-only;
+ *   }
+ * }
+ * ```
+ *
+ * Output:
+ *
+ * ```css
+ * :host {
+ *   --my-variable: var(--_ui5-compact-size, compact-value) var(--_ui5-cozy-size, cozy-value);
+ *   --compact-only-variable: var(--_ui5-compact-size, compact-only) var(--_ui5-cozy-size, initial);
+ *   --cozy-only-variable: cozy-only-value;
+ * }
+ * ```
+ *
+ * This enables seamless runtime switching between density modes using CSS variables alone.
+ */
+
+export default function postcssPlugin() {
+    return {
+        postcssPlugin: 'postcss-content-density-variables',
+        Once(root) {
+            let hasRootHost = false;
+            let hostRule;
+
+            root.walkRules((rule) => {
+                // Only process :host rules
+                if (rule.selector !== SELECTOR) {
+                    return;
+                }
+
+                // Handle root-level :host rules (cozy)
+                if (rule.parent.type === "root") {
+                    if (!hasRootHost) {
+                        hasRootHost = true;
+                        hostRule = rule;
+                    }
+
+                    rule.walkDecls((decl) => {
+                        if (decl.prop.startsWith('--')) {
+                            saveVariable(decl.prop, decl.value, 'cozy');
+                            decl.remove();
+                        }
+                    });
+                }
+
+                // Handle :host rules inside @container (compact)
+                if (rule.parent.type === "atrule") {
+                    if (rule.parent.params.replaceAll("\s", "") === 'style(--ui5_content_density: compact)'.replaceAll("\s", "")) {
+                        rule.walkDecls((decl) => {
+                            if (decl.prop.startsWith('--')) {
+                                saveVariable(decl.prop, decl.value, 'compact');
+                                decl.remove();
+                            }
+                        });
+                    }
+                }
+
+                let current = rule;
+                // Remove up empty rules
+                while (current) {
+                    if (current.nodes.length === 0) {
+                        const parent = current.parent;
+                        current.remove();
+                        current = parent;
+                    }
+
+                    if (current.type === "root") {
+                        break;
+                    }
+                }
+            });
+
+            if (!hasRootHost) {
+                hostRule = postcss.rule({ selector: SELECTOR });
+            }
+
+            // Construct merged variable declarations depending on available modes
+            for (const [variable, variableData] of hostVariables) {
+                if (variableData.cozy && variableData.compact) {
+                    hostRule.append({
+                        prop: variable,
+                        value: `var(--_ui5-compact-size, ${variableData.compact})  var(--_ui5-cozy-size, ${variableData.cozy})`,
+                    });
+                } else if (variableData.compact) {
+
+                    // Use a non-existent variable to always trigger the fallback.
+                    // Because this variable is never defined, the fallback is used
+                    // in all cases.
+
+                    // Using `initial` as a fallback can work only for properties
+                    // that treat it as an invalid value. To avoid this inconsistency,
+                    // we intentionally reference an undefined variable, which is
+                    // always considered invalid and undefined.
+                    hostRule.append({
+                        prop: variable,
+                        value: `var(--_ui5-compact-size, ${variableData.compact}) var(--_ui5-cozy-size, var(--_ui5-f2d95f8))`,
+                    });
+                } else {
+                    hostRule.append({
+                        prop: variable,
+                        value: variableData.cozy,
+                    });
+                }
+            }
+
+            root.prepend(hostRule);
+            hostVariables.clear();
+        }
+    }
+}
+
+postcssPlugin.postcss = true;

package/lib/css-processors/scope-variables.mjs

@@ -0,0 +1,74 @@
+import * as path from "path";
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * Tries to detect an override for a package
+ * @param {*} filePath For example: /my_project/src/themes/overrides/@ui5/webcomponents/my_custom_theme/parameters-bundle.css
+ * @returns
+ */
+const getOverrideVersion = filePath => {
+    if (!filePath) {
+        return;
+    }
+
+	if (!filePath.includes(`overrides${path.sep}`)) {
+		return; // The "overrides/" directory is the marker
+	}
+	const override = filePath.split(`overrides${path.sep}`)[1]; // For example, this will be: @ui5/webcomponents/my_custom_theme/parameters-bundle.css
+	if (!override) {
+		return; // There must be other directories after overrides/, the path can't end with it
+	}
+	const parts = override.split(path.sep);
+	if (parts.length < 3) {
+		return; // There must be at least a directory for the theme that is being overridden (my_custom_theme) and the name of the CSS file after the name of the package that is overridden
+	}
+	const packageName = parts.slice(0, -2).join(path.sep); // After the last 2 parts are removed (my_custom_theme and parameters-bundle.css from the example), the rest is the package
+
+	let overrideVersion;
+	try {
+		overrideVersion = require(`${packageName}${path.sep}package.json`).version;
+	} catch (e) {
+		if (process.env.UI5_VERBOSE === "true") {
+			console.log(`Error requiring package ${packageName}: ${e.message}`);
+		}
+	}
+
+	return overrideVersion;
+}
+
+/**
+ * `packageJSON` should reference the `package.json` of the base package,
+ * as it serves as the starting point for every runtime and carries a unique version.
+ * The `getScopedVarName` function is also defined in the base package
+ * and is consumed by all other packages.
+ *
+ * Runtime (2.19.0)
+ * - base (2.19.0)
+ * - At least one of the following packages: ai / main / fiori / compat (2.19.0)
+ * - Custom package (x.x.x)
+ *
+ * It is not possible to have a runtime with the main package at version 2.19.0
+ * and the base package at a different version (e.g., 2.18.0),
+ * because the main package depends on the base package.
+ * Such a mismatch would create a new runtime.
+ *
+ * Therefore, we can safely assume that the base package version
+ * matches the runtime version and can be reliably used for scoping.
+ *
+ * It is still needed for third-party packages that have not yet migrated to the
+ * component-level variable approach.
+ */
+
+const scopeVariables = (cssText, packageJSON, inputFile) => {
+    const escapeVersion = version => "v" + version?.replaceAll(/[^0-9A-Za-z\-_]/g, "-");
+    const versionStr = escapeVersion(getOverrideVersion(inputFile) || packageJSON.version);
+
+    const expr = /(--_?ui5)([^\,\:\)\s]+)/g;
+
+    return cssText.replaceAll(expr, `$1-${versionStr}$2`);
+}
+
+export default scopeVariables;
+

package/lib/css-processors/shared.mjs

@@ -0,0 +1,47 @@
+import { writeFile, readFile, mkdir } from "fs/promises";
+import * as path from "path";
+import assets from "../../assets-meta.js";
+
+const readOldContent = async (fileName) => {
+    // it seems slower to read the old content, but writing the same content with no real changes
+    // (as in initial build and then watch mode) will cause an unnecessary dev server refresh
+    let oldContent = "";
+    try {
+        oldContent = (await readFile(fileName)).toString();
+    } catch (e) {
+        // file not found
+    }
+    return oldContent;
+}
+
+const writeFileIfChanged = async (fileName, content) => {
+    const oldContent = await readOldContent(fileName);
+    if (content !== oldContent) {
+        if (!oldContent) {
+            await mkdir(path.dirname(fileName), { recursive: true });
+        }
+        return writeFile(fileName, content);
+    }
+}
+
+const DEFAULT_THEME = assets.themes.default;
+const CSS_VARIABLES_TARGET = process.env.CSS_VARIABLES_TARGET === "host";
+
+const getDefaultThemeCode = packageName => {
+    return `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+
+import defaultThemeBase from "@ui5/webcomponents-theming/dist/generated/themes/${DEFAULT_THEME}/parameters-bundle.css.js";
+import defaultTheme from "./${DEFAULT_THEME}/parameters-bundle.css.js";
+
+registerThemePropertiesLoader("@" + "ui5" + "/" + "webcomponents-theming", "${DEFAULT_THEME}", async () => defaultThemeBase);
+registerThemePropertiesLoader(${packageName.split("").map(c => `"${c}"`).join(" + ")}, "${DEFAULT_THEME}", async () => defaultTheme${CSS_VARIABLES_TARGET ? ', "host"' : ''});
+`;
+};
+
+const getFileContent = (packageName, css, includeDefaultTheme) => {
+    const defaultTheme = includeDefaultTheme ? getDefaultThemeCode(packageName) : "";
+    return `${defaultTheme}export default ${css.trim()}`
+}
+
+
+export { writeFileIfChanged, getFileContent }

package/lib/dev-server/custom-hot-update-plugin.js

@@ -0,0 +1,39 @@
+const fs = require("fs");
+
+/**
+ * A change is observed on MacOS since 13.5, where the build generates a large amount
+ * of JSON file that spotlight search has to index, as they are considered new files.
+ *
+ * Starting the vitejs dev server reads all of these files and this triggers the indexing.
+ * The indexing has a side effect of changing some file metadata (can be checked with `mdls <path_to_file>`).
+ * This metadata change is changing the ctime of the file, but not the mtime. This can be checked with `stat -x <path_to_file>
+ *
+ * Essentially only metadata is changed, not content. This should not cause a page refresh,
+ * but chokidar reports this change and vite refreshes the page.
+ * The indexing is running with a 10 second interval, so for roughtly 20 minutes vite is refreshing the page every 10 seconds
+ *
+ * This plugin checks if the file causing the refresh is a generated json file (dist/*.json) and if ctime is changed after mtime
+ * In that case, returing an empty array tells vitejs that a custom update will be made by the plugin,
+ * which is in effect ignoring the page refresh.
+ */
+
+const customHotUpdate = async () => {
+	return {
+		name: 'custom-hot-update',
+		handleHotUpdate(ctx) {
+			// custom check for generated json files
+			if (ctx.file.endsWith(".json")) {
+				const stat = fs.statSync(ctx.file);
+
+				// metadata change only
+				if (stat.ctime > stat.mtime) {
+					// uncomment for debugging
+					// console.log("ignoring hot update for:", ctx.file);
+					return [];
+				}
+			}
+		}
+	}
+};
+
+module.exports = customHotUpdate;

package/lib/dev-server/dev-server.mjs

@@ -0,0 +1,78 @@
+import fs from "fs/promises";
+import { createServer } from 'vite';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { pathToFileURL } from "url";
+
+const startVite = async (config, port) => {
+	const server = await createServer({
+		configFile: config,
+		server: {
+			port: port,
+			strictPort: true,
+			open: true,
+			host: true,
+		},
+		logLevel: 'info',
+		clearScreen: false,
+	})
+	await server.listen()
+	server.printUrls()
+	return server;
+};
+
+const rmPortFile = async () => {
+	// exit handler must be sync
+	try {
+		await fs.rm(".dev-server-port");
+	} catch (e) { }
+	process.exit();
+}
+
+["exit", "SIGINT", "SIGUSR1", "SIGUSR2", "uncaughtException", "SIGTERM"].forEach((eventType) => {
+	process.on(eventType, rmPortFile);
+});
+
+async function start(outArgv) {
+	const argv = yargs(hideBin(outArgv))
+		.alias("c", "config")
+		.argv;
+
+	let retries = 10;
+	let port = 8080;
+	while (retries--) {
+		console.log(`taking port ${port}`);
+		await fs.writeFile(".dev-server-port", `${port}`);
+		try {
+			// execSync(command, {stdio: 'pipe'});
+			const server = await startVite(argv.config ?? "", port);
+			if (server) {
+				// server started, don't try other ports
+				break;
+			}
+		} catch (e) {
+			// uncomment for debug
+			// console.log(e.toString());
+			if (e.toString().includes("already in use")) {
+				console.log(`Port ${port} already in use`)
+				port++;
+				continue;
+			}
+			// other error or CTRL-C
+			process.exit();
+		}
+		// no error normal exit
+		// process.exit();
+	}
+};
+
+const filePath = process.argv[1];
+const fileUrl = pathToFileURL(filePath).href;
+
+if (import.meta.url === fileUrl) {
+	start(process.argv)
+}
+
+export default {
+	_ui5mainFn: start
+}

package/lib/dev-server/virtual-index-html-plugin.js

@@ -0,0 +1,56 @@
+const virtualIndexPlugin = () => {
+	return {
+		name: 'virtual-index-html',
+		async config() {
+			const path = (await import("path")).default;
+			const globby = (await import("globby")).globby;
+			const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
+
+			const rollupInput = {};
+
+			files.forEach(file => {
+				rollupInput[file] = path.resolve(process.cwd(), file);
+			});
+
+			return {
+				build: {
+					rollupOptions: {
+						input: rollupInput
+					}
+				}
+			}
+		},
+		async configureServer(server) {
+			const path = (await import("path")).default;
+			const globby = (await import("globby")).globby;
+			const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
+
+			const pagesPerFolder = {};
+			files.forEach(file => {
+				let folder = pagesPerFolder[path.dirname(file)] = pagesPerFolder[path.dirname(file)] || [];
+				folder.push(path.basename(file));
+			});
+
+			server.middlewares.use((req, res, next) => {
+				if (req.url === "/") {
+					const folders = Object.keys(pagesPerFolder);
+
+					res.statusCode = 200;
+					res.setHeader("Content-Type", "text/html; charset=utf-8");
+					res.end(`${folders.map(folder => {
+						const pages = pagesPerFolder[folder];
+						return `<h1>${folder}</h1>
+							${pages.map(page => {
+							return `<li><a href='${folder}/${page}'>${page}</a></li>`
+						}).join("")}
+						`
+					}).join("")}`);
+				} else {
+					next();
+				}
+			})
+		},
+	}
+};
+
+module.exports = virtualIndexPlugin;