@ui5/webcomponents-tools 0.0.0-9261ac932 → 0.0.0-95afb1087

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

@@ -4,74 +4,89 @@ 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 {scopeUi5Variables} 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 generate = async (argv) => {
+    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 packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+    const inputFilesGlob = "src/themes/*.css";
+    const restArgs = argv.slice(2);
 
-let customPlugin = {
-    name: 'ui5-tools',
-    setup(build) {
-        build.initialOptions.write = false;
+    let customPlugin = {
+        name: 'ui5-tools',
+        setup(build) {
+            build.initialOptions.write = false;
 
-        build.onEnd(result => {
-            result.outputFiles.forEach(async f => {
-                // scoping
-                const newText = scopeVariables(f.text, packageJSON);
-                await mkdir(path.dirname(f.path), {recursive: true});
-                writeFile(f.path, newText);
+            build.onEnd(result => {
+                result.outputFiles.forEach(async f => {
+                    // scoping
+                    let newText = scopeUi5Variables(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);
 
-                // JS/TS
-                const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
-                const jsContent = getFileContent(tsMode, jsPath, packageJSON.name, "\`" + newText + "\`", true);
-                writeFileIfChanged(jsPath, jsContent);
-            });
-        })
-    },
-}
+                    // 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;
+    }
 
-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,75 +5,114 @@ 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 scopeVariables from "./scope-variables.mjs";
+import { writeFileIfChanged, getFileContent } from "./shared.mjs";
+import { scopeUi5Variables, scopeThemingVariables } from "./scope-variables.mjs";
+import { pathToFileURL } from "url";
 
-const tsMode = process.env.UI5_TS === "true";
-const extension = tsMode ? ".css.ts" : ".css.js";
+async function processThemingPackageFile(f) {
+    const selector = ':root';
+    const newRule = postcss.rule({ selector });
+    const result = await postcss().process(f.text);
 
-const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+    result.root.walkRules(selector, rule => {
+        for (const decl of rule.nodes) {
+            if (decl.type !== 'decl' ) {
+                continue;
+            } else if (decl.prop.startsWith('--sapFontUrl')) {
+                continue;
+            } else if (!decl.prop.startsWith('--sap')) {
+                newRule.append(decl.clone());
+            } else {
+                const originalProp = decl.prop;
+                const originalValue = decl.value;
 
-let inputFiles = await globby("src/**/parameters-bundle.css");
-const restArgs = process.argv.slice(2);
+                newRule.append(decl.clone({ prop: originalProp.replace("--sap", "--ui5-sap"), value: `var(${originalProp}, ${originalValue})` }));
+            }
+        }
+    });
 
-const removeDuplicateSelectors = async (text) => {
-    const result = await postcss(combineDuplicatedSelectors).process(text);
-    return result.css;
+    return newRule.toString();
+};
+
+async function processComponentPackageFile(f, packageJSON) {
+    let result = await postcss(combineDuplicatedSelectors).process(f.text);
+
+    result = scopeUi5Variables(result.css, packageJSON, f.path);
+
+    result = scopeThemingVariables(result);
+
+    return result;
 }
 
-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});
-                const data = {
-                    packageName: packageJSON.name,
-                    fileName: jsonPath.substr(jsonPath.lastIndexOf("themes")),
-                    content: newText,
-                };
-                writeFileIfChanged(jsonPath, JSON.stringify({_: data}));
-
-                // JS/TS
-                const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
-                const jsContent = getFileContent(tsMode, jsPath, packageJSON.name, "\`" + newText + "\`");
-                writeFileIfChanged(jsPath, jsContent);
-            });
-        })
-    },
+async function generate(argv) {
+    const tsMode = process.env.UI5_TS === "true";
+    const extension = tsMode ? ".css.ts" : ".css.js";
+
+    const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+
+    const inputFiles = await globby([
+        "src/**/parameters-bundle.css",
+    ]);
+    const restArgs = argv.slice(2);
+
+    let scopingPlugin = {
+        name: 'scoping',
+        setup(build) {
+            build.initialOptions.write = false;
+
+            build.onEnd(result => {
+                result.outputFiles.forEach(async f => {
+                    let newText = f.path.includes("packages/theming") ? await processThemingPackageFile(f) : await processComponentPackageFile(f, packageJSON);
+
+                    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);
+                });
+            })
+        },
+    }
+
+    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);
+        console.log('watching...')
+        await ctx.watch()
+    } else {
+        await esbuild.build(config);
+    }
 }
 
-const config = {
-    entryPoints: inputFiles,
-    bundle: true,
-    minify: true,
-    outdir: 'dist/css',
-    outbase: 'src',
-    plugins: [
-        scopingPlugin,
-    ],
-    external: ["*.ttf", "*.woff", "*.woff2"],
-};
+const filePath = process.argv[1];
+const fileUrl = pathToFileURL(filePath).href;
+
+if (import.meta.url === fileUrl) {
+    generate(process.argv)
+}
+
+export default {
+    _ui5mainFn: generate
+}
 
-if (restArgs.includes("-w")) {
-    let ctx = await esbuild.context(config);
-    await ctx.watch()
-    console.log('watching...')
-} else {
-    const result = await esbuild.build(config);
+export {
+    processComponentPackageFile
 }

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

@@ -9,9 +9,9 @@ const require = createRequire(import.meta.url);
  * @returns
  */
 const getOverrideVersion = filePath => {
-    if (!filePath) {
-        return;
-    }
+	if (!filePath) {
+		return;
+	}
 
 	if (!filePath.includes(`overrides${path.sep}`)) {
 		return; // The "overrides/" directory is the marker
@@ -36,14 +36,22 @@ const getOverrideVersion = filePath => {
 	return overrideVersion;
 }
 
-const scopeVariables = (cssText, packageJSON, inputFile) => {
-    const escapeVersion = version => "v" + version?.replaceAll(/[^0-9A-Za-z\-_]/g, "-");
-    const versionStr = escapeVersion(getOverrideVersion(inputFile) || packageJSON.version);
+const scopeUi5Variables = (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;
+	let newText = cssText.replaceAll(expr, `$1-${versionStr}$2`);
 
-    const expr = /(--_?ui5)([^\,\:\)\s]+)/g;
+	return newText.replaceAll("--sap", `--ui5-sap`);
+}
 
-    return cssText.replaceAll(expr, `$1-${versionStr}$2`);
+// Used with CSS text and SVG file content (illustrations)
+const scopeThemingVariables = (cssText) => {
+	return cssText.replaceAll("--sap", `--ui5-sap`);
 }
 
-export default scopeVariables;
+export {
+	scopeUi5Variables,
+	scopeThemingVariables,
+};
 

package/lib/css-processors/shared.mjs

@@ -24,16 +24,6 @@ const writeFileIfChanged = async (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 getDefaultThemeCode = packageName => {
@@ -42,35 +32,15 @@ const getDefaultThemeCode = packageName => {
 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);
 `;
 };
 
-const getFileContent = (tsMode, targetFile, packageName, css, includeDefaultTheme) => {
-	if (tsMode) {
-		return getTSContent(targetFile, packageName, css, includeDefaultTheme);
-	}
-
-	return getJSContent(targetFile, packageName, css, includeDefaultTheme);
-}
-
-const getTSContent = (targetFile, packageName, css, includeDefaultTheme) => {
-	const typeImport = "import type { StyleData } from \"@ui5/webcomponents-base/dist/types.js\";"
+const getFileContent = (packageName, css, includeDefaultTheme) => {
 	const defaultTheme = includeDefaultTheme ? getDefaultThemeCode(packageName) : "";
-
-	// tabs are intentionally mixed to have proper identation in the produced file
-	return `${typeImport}
-${defaultTheme}
-const styleData: StyleData = {packageName:"${packageName}",fileName:"${targetFile.substr(targetFile.lastIndexOf("themes"))}",content:${css}};
-export default styleData;
-	`;
+	return `${defaultTheme}export default ${css.trim()}`
 }
 
-const getJSContent = (targetFile, packageName, css, includeDefaultTheme) => {
-	const defaultTheme = includeDefaultTheme ? getDefaultThemeCode(packageName) : "";
-
-	return `${defaultTheme}export default {packageName:"${packageName}",fileName:"${targetFile.substr(targetFile.lastIndexOf("themes"))}",content:${css}}`
-}
 
-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/yargs';
-import { hideBin }  from 'yargs/helpers';
+import yargs from 'yargs';
+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
+}

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

@@ -1,23 +1,17 @@
-const virtualIndexPlugin = async () => {
-	const path = await import("path");
-	const { globby } = await import("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));
-	});
+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 = {};
+			const rollupInput = {};
 
-	files.forEach(file => {
-		rollupInput[file] = path.resolve(process.cwd(), file);
-	})
+			files.forEach(file => {
+				rollupInput[file] = path.resolve(process.cwd(), file);
+			});
 
-	return {
-		name: 'virtual-index-html',
-		config() {
 			return {
 				build: {
 					rollupOptions: {
@@ -26,7 +20,17 @@ const virtualIndexPlugin = async () => {
 				}
 			}
 		},
-		configureServer(server) {
+		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);
@@ -37,8 +41,8 @@ const virtualIndexPlugin = async () => {
 						const pages = pagesPerFolder[folder];
 						return `<h1>${folder}</h1>
 							${pages.map(page => {
-								return `<li><a href='${folder}/${page}'>${page}</a></li>`
-							}).join("")}
+							return `<li><a href='${folder}/${page}'>${page}</a></li>`
+						}).join("")}
 						`
 					}).join("")}`);
 				} else {

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;