@ui5/webcomponents-tools 0.0.0-fb61e9889 → 0.0.0-fca1107e7

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

@@ -0,0 +1,73 @@
+const jsFileContentTemplate = (componentName, tagName, library, packageName) => {
+	return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
+
+// Styles
+import ${componentName}Css from "./generated/themes/${componentName}.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "${tagName}",
+	properties: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
+		//
+	},
+	slots: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
+		//
+	},
+	events: /** @lends sap.ui.webc.${library}.${componentName}.prototype */ {
+		//
+	},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ *
+ * <h3>Usage</h3>
+ *
+ * For the <code>${tagName}</code>
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "${packageName}/dist/${componentName}.js";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webc.${library}.${componentName}
+ * @extends sap.ui.webc.base.UI5Element
+ * @tagname ${tagName}
+ * @public
+ */
+class ${componentName} extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get styles() {
+		return ${componentName}Css;
+	}
+
+	static get template() {
+		return ${componentName}Template;
+	}
+
+	static get dependencies() {
+		return [];
+	}
+}
+
+${componentName}.define();
+
+export default ${componentName};
+`;
+};
+
+module.exports = jsFileContentTemplate;

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

@@ -0,0 +1,71 @@
+const tsFileContentTemplate = (componentName, tagName, library, packageName) => {
+	return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
+import property from "@ui5/webcomponents-base/dist/decorators/property.js";
+import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
+import event from "@ui5/webcomponents-base/dist/decorators/event.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+
+import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
+
+// Styles
+import ${componentName}Css from "./generated/themes/${componentName}.css.js";
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ *
+ * <h3>Usage</h3>
+ *
+ * For the <code>${tagName}</code>
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "${packageName}/dist/${componentName}.js";</code>
+ *
+ * @constructor
+ * @extends UI5Element
+ * @public
+ */
+@customElement({
+	tag: "${tagName}",
+	renderer: litRender,
+	styles: ${componentName}Css,
+	template: ${componentName}Template,
+	dependencies: [],
+})
+
+/**
+ * Example custom event.
+ * Please keep in mind that all public events should be documented in the API Reference as shown below.
+ *
+ * @public
+ */
+@event("interact", { detail: { /* event payload ( optional ) */ } })
+class ${componentName} extends UI5Element {
+	/**
+	 * Defines the value of the component.
+	 *
+	 * @default ""
+	 * @public
+	 */
+	@property()
+	value!: string;
+
+	/**
+	 * Defines the text of the component.
+	 *
+	 * @public
+	 */
+	@slot({ type: Node, "default": true })
+	text!: Array<Node>;
+}
+
+${componentName}.define();
+
+export default ${componentName};
+`;
+};
+
+module.exports = tsFileContentTemplate;

package/lib/css-processors/css-processor-component-styles.mjs

@@ -0,0 +1,47 @@
+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 scopeVariables from "./scope-variables.mjs";
+
+const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+const inputFiles = await globby("src/styles/*.module.css");
+const restArgs = process.argv.slice(2);
+
+let componentStylesPlugin = {
+    name: 'component-styles',
+    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);
+                writeFile(f.path.replace(".module.css", ".css"), newText);
+            });
+        })
+    },
+}
+
+const config = {
+    entryPoints: inputFiles,
+    outdir: 'dist',
+    outbase: 'src',
+    loader: {
+        ".module.css": "global-css"
+    },
+    plugins: [
+        componentStylesPlugin,
+    ]
+};
+
+if (restArgs.includes("-w")) {
+    let ctx = await esbuild.context(config);
+    await ctx.watch()
+    console.log('watching...')
+} else {
+    await esbuild.build(config);
+}

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

@@ -0,0 +1,77 @@
+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";
+
+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);
+
+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);
+
+                // 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);
+            });
+        })
+    },
+}
+
+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);
+}

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

@@ -0,0 +1,79 @@
+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 { writeFileIfChanged, stripThemingBaseContent, getFileContent } from "./shared.mjs";
+import scopeVariables from "./scope-variables.mjs";
+
+const tsMode = process.env.UI5_TS === "true";
+const extension = tsMode ? ".css.ts" : ".css.js";
+
+const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
+
+let inputFiles = await globby("src/**/parameters-bundle.css");
+const restArgs = process.argv.slice(2);
+
+const removeDuplicateSelectors = async (text) => {
+    const result = await postcss(combineDuplicatedSelectors).process(text);
+    return result.css;
+}
+
+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);
+            });
+        })
+    },
+}
+
+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);
+}

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

@@ -0,0 +1,49 @@
+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) {
+		console.log(`Error requiring package ${packageName}: ${e.message}`);
+	}
+
+	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 expr = /(--_?ui5)([^\,\:\)\s]+)/g;
+
+    return cssText.replaceAll(expr, `$1-${versionStr}$2`);
+}
+
+export default scopeVariables;
+

package/lib/css-processors/shared.mjs

@@ -0,0 +1,76 @@
+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);
+    }
+}
+
+// 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 => {
+	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);
+`;
+};
+
+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 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;
+	`;
+}
+
+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}

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.js

@@ -0,0 +1,66 @@
+const fs = require("fs/promises");
+const { createServer } = require('vite');
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+
+const argv = yargs(hideBin(process.argv))
+	.alias("c", "config")
+	.argv;
+
+const startVite = async (port) => {
+	const server = await createServer({
+		configFile: argv.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 () => {
+	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(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();
+	}
+})();

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

@@ -0,0 +1,52 @@
+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 rollupInput = {};
+
+	files.forEach(file => {
+		rollupInput[file] = path.resolve(process.cwd(), file);
+	})
+
+	return {
+		name: 'virtual-index-html',
+		config() {
+			return {
+				build: {
+					rollupOptions: {
+						input: rollupInput
+					}
+				}
+			}
+		},
+		configureServer(server) {
+			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;