@ui5/webcomponents-tools 0.0.0-b132dd7b9 → 0.0.0-b3a4f8020

package/lib/create-new-component/index.js

@@ -2,6 +2,8 @@ const fs = require("fs");
 const prompts = require("prompts");
 const Component = require("./Component.js");
 const ComponentTemplate= require("./ComponentTemplate.js");
+const dotenv = require('dotenv');
+dotenv.config();
 
 /**
  * Hyphanates the given PascalCase string and adds prefix, f.e.:
@@ -11,7 +13,7 @@ const ComponentTemplate= require("./ComponentTemplate.js");
 const hyphaneteComponentName = (componentName) => {
 	const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
 
-	return `my-${result}`;
+	return `${process.env.UI5_TAG_NAME_PREFIX ?? "my"}-${result}`;
 };
 
 /**
@@ -62,7 +64,7 @@ const generateFiles = (componentName, tagName, library, packageName) => {
 	const filePaths = {
 		"main": `./src/${componentName}.ts`,
 		"css": `./src/themes/${componentName}.css`,
-		"template": `./src/${componentName}Template.tsx`,
+		"template": `./src/${componentName}${process.env.UI5_TEMPLATE_FILENAME_SUFFIX ?? "Template"}.tsx`,
 	};
 
 	fs.writeFileSync(filePaths.main, Component(componentName, tagName, library, packageName), { flag: "wx+" });
@@ -75,7 +77,7 @@ const generateFiles = (componentName, tagName, library, packageName) => {
 
 	// Change the color of the output
 	console.warn('\x1b[33m%s\x1b[0m', `
-Now, import the component in src/bundle.esm.ts via: "import ${componentName} from ./${componentName}.js";
+Now, import the component in "src/bundle.esm.ts" via: import "./${componentName}.js";
 And, add it to your HTML: <${tagName}></${tagName}>.`);
 }
 

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

@@ -6,73 +6,98 @@ 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 tsMode = process.env.UI5_TS === "true";
-const extension = tsMode ? ".css.ts" : ".css.js";
 
-const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
-const inputFilesGlob = "src/themes/*.css";
-const restArgs = process.argv.slice(2);
+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";
 
-let customPlugin = {
-    name: 'ui5-tools',
-    setup(build) {
-        build.initialOptions.write = false;
+    const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+    const basePackageJSON = (await import("@ui5/webcomponents-base/package.json", { with: { type: "json" } })).default;
 
-        build.onEnd(result => {
-            result.outputFiles.forEach(async f => {
-                // scoping
-                let newText = scopeVariables(f.text, packageJSON);
-                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);
+    const inputFilesGlob = "src/themes/*.css";
+    const restArgs = argv.slice(2);
 
-                // JS/TS
-                const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
-                const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`", true);
-                writeFileIfChanged(jsPath, jsContent);
-            });
-        })
-    },
-}
+    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);
 
-const getConfig = async () => {
-    const config = {
-        entryPoints: await globby(inputFilesGlob),
-        bundle: true,
-        minify: true,
-        outdir: 'dist/css',
-        outbase: 'src',
-        plugins: [
-            customPlugin,
-        ]
-    };
-    return config;
+                    // 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);
+    }
 }
 
-if (restArgs.includes("-w")) {
-    let ready;
-    let config = await getConfig();
-    let ctx = await esbuild.context(config);
-    await ctx.watch()
-    console.log('watching...')
+const filePath = process.argv[1];
+const fileUrl = pathToFileURL(filePath).href;
 
-    // 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);
+if (import.meta.url === fileUrl) {
+    generate(process.argv)
 }
+
+export default {
+    _ui5mainFn: generate
+}

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

@@ -5,70 +5,118 @@ 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 { writeFileIfChanged, stripThemingBaseContent, getFileContent } from "./shared.mjs";
+import postcssPlugin from "./postcss-plugin.mjs";
+import { writeFileIfChanged, getFileContent } from "./shared.mjs";
 import scopeVariables from "./scope-variables.mjs";
+import { pathToFileURL } from "url";
 
-const tsMode = process.env.UI5_TS === "true";
-const extension = tsMode ? ".css.ts" : ".css.js";
+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 packageJSON = JSON.parse(fs.readFileSync("./package.json"));
+    const basePackageJSON = (await import("@ui5/webcomponents-base/package.json", { with: { type: "json" } })).default;
 
-let inputFiles = await globby("src/**/parameters-bundle.css");
-const restArgs = process.argv.slice(2);
+    const inputFiles = await globby([
+        "src/**/parameters-bundle.css",
+    ]);
+    const restArgs = argv.slice(2);
 
-const removeDuplicateSelectors = async (text) => {
-    const result = await postcss(combineDuplicatedSelectors).process(text);
-    return result.css;
-}
+    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 });
 
-let scopingPlugin = {
-    name: 'scoping',
-    setup(build) {
-        build.initialOptions.write = false;
-
-        build.onEnd(result => {
-            result.outputFiles.forEach(async f => {
-                // remove duplicate selectors
-                let newText = await removeDuplicateSelectors(f.text);
-
-                // strip unnecessary theming-base-content
-                newText = stripThemingBaseContent(newText);
-
-                // scoping
-                newText = scopeVariables(newText, packageJSON, f.path);
-                await mkdir(path.dirname(f.path), {recursive: true});
-                writeFile(f.path, newText);
-
-                // JSON
-                const jsonPath = f.path.replace(/dist[\/\\]css/, "dist/generated/assets").replace(".css", ".css.json");
-                await mkdir(path.dirname(jsonPath), {recursive: true});
-                writeFileIfChanged(jsonPath, JSON.stringify(newText));
-
-                // JS/TS
-                const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
-                const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`");
-                writeFileIfChanged(jsPath, jsContent);
+        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)
 }
 
-const config = {
-    entryPoints: inputFiles,
-    bundle: true,
-    minify: true,
-    outdir: 'dist/css',
-    outbase: 'src',
-    plugins: [
-        scopingPlugin,
-    ],
-    external: ["*.ttf", "*.woff", "*.woff2"],
-};
-
-if (restArgs.includes("-w")) {
-    let ctx = await esbuild.context(config);
-    await ctx.watch()
-    console.log('watching...')
-} else {
-    const result = await esbuild.build(config);
+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

@@ -30,12 +30,37 @@ const getOverrideVersion = filePath => {
 	try {
 		overrideVersion = require(`${packageName}${path.sep}package.json`).version;
 	} catch (e) {
-		console.log(`Error requiring package ${packageName}: ${e.message}`);
+		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);

package/lib/css-processors/shared.mjs

@@ -18,39 +18,30 @@ const writeFileIfChanged = async (fileName, content) => {
     const oldContent = await readOldContent(fileName);
     if (content !== oldContent) {
         if (!oldContent) {
-            await mkdir(path.dirname(fileName), {recursive: true});
+            await mkdir(path.dirname(fileName), { recursive: true });
         }
         return writeFile(fileName, content);
     }
 }
 
-// strips the unnecessary theming data coming from @sap-theming/theming-base-content and leaves only the css parameters
-const stripThemingBaseContent = css => {
-	css = css.replace(/\.sapThemeMeta[\s\S]*?:root/, ":root");
-	css = css.replace(/\.background-image.*{.*}/, "");
-	css = css.replace(/\.sapContrast[ ]*:root[\s\S]*?}/, "");
-	css = css.replace(/--sapFontUrl.*\);?/, "");
-	return css;
-}
-
-
 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";
+    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}", "${DEFAULT_THEME}", async () => defaultTheme);
+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()}`
+    const defaultTheme = includeDefaultTheme ? getDefaultThemeCode(packageName) : "";
+    return `${defaultTheme}export default ${css.trim()}`
 }
 
 
-export { writeFileIfChanged, stripThemingBaseContent, getFileContent}
+export { writeFileIfChanged, getFileContent }

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

@@ -1,15 +1,12 @@
 import fs from "fs/promises";
 import { createServer } from 'vite';
 import yargs from 'yargs';
-import { hideBin }  from 'yargs/helpers';
+import { hideBin } from 'yargs/helpers';
+import { pathToFileURL } from "url";
 
-const argv = yargs(hideBin(process.argv))
-	.alias("c", "config")
-	.argv;
-
-const startVite = async (port) => {
+const startVite = async (config, port) => {
 	const server = await createServer({
-		configFile: argv.config,
+		configFile: config,
 		server: {
 			port: port,
 			strictPort: true,
@@ -28,7 +25,7 @@ const rmPortFile = async () => {
 	// exit handler must be sync
 	try {
 		await fs.rm(".dev-server-port");
-	} catch (e) {}
+	} catch (e) { }
 	process.exit();
 }
 
@@ -36,7 +33,11 @@ const rmPortFile = async () => {
 	process.on(eventType, rmPortFile);
 });
 
-(async () => {
+async function start(outArgv) {
+	const argv = yargs(hideBin(outArgv))
+		.alias("c", "config")
+		.argv;
+
 	let retries = 10;
 	let port = 8080;
 	while (retries--) {
@@ -44,7 +45,7 @@ const rmPortFile = async () => {
 		await fs.writeFile(".dev-server-port", `${port}`);
 		try {
 			// execSync(command, {stdio: 'pipe'});
-			const server = await startVite(port);
+			const server = await startVite(argv.config ?? "", port);
 			if (server) {
 				// server started, don't try other ports
 				break;
@@ -63,4 +64,15 @@ const rmPortFile = async () => {
 		// 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
+}