@ui5/webcomponents-tools 0.0.0-32b659ddc → 0.0.0-35e2c9666

package/lib/jsdoc/template/publish.js

@@ -2651,8 +2651,8 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 
 	attrib("name", symbol.longname);
 	attrib("basename", symbol.name);
-	if (symbol.customtag) {
-		attrib("customTag", symbol.customtag);
+	if (symbol.tagname) {
+		attrib("tagname", symbol.tagname);
 	}
 	if (symbol.appenddocs) {
 		attrib("appenddocs", symbol.appenddocs);
@@ -2804,6 +2804,10 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 						attrib("export", undefined, '', true);
 					}
 
+					if (member.noattribute) {
+						attrib("noattribute", true);
+					}
+
 					if (member.readonly) {
 						attrib("readonly", member.readonly, null);
 					}
@@ -2815,7 +2819,14 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 					if ( member.since ) {
 						attrib("since", extractVersion(member.since));
 					}
-					attrib("type", listTypes(member.type));
+
+					var type = listTypes(member.type);
+					attrib("type", type);
+
+					if ((type === "object" || type === "Object") && visibility(member) === "public") {
+						attrib("noattribute", true);
+					}
+
 					tag("description", normalizeWS(member.description), true);
 					if (member.defaultvalue) {
 						attrib("defaultValue", member.defaultvalue);
@@ -2838,6 +2849,9 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 				if (member.slot) {
 					tag("property");
 					attrib("name", member.name);
+					if (member.propertyName) {
+						attrib("propertyName", member.propertyName);
+					}
 					if (member.__ui5.module && member.__ui5.module !== symbol.__ui5.module) {
 						attrib("module", member.__ui5.module);
 						attrib("export", undefined, '', true);
@@ -2879,6 +2893,12 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
 					attrib("module", member.__ui5.module);
 					attrib("export", undefined, '', true);
 				}
+				if (member.allowPreventDefault) {
+					attrib("allowPreventDefault", true);
+				}
+				if (member.native) {
+					attrib("native", true);
+				}
 				attrib("visibility", visibility(member), 'public');
 				if ( member.scope === 'static' ) {
 					attrib("static", true, false, /* raw = */true);
@@ -3845,7 +3865,7 @@ function createAPIJS(symbols, filename) {
 
 	var output = [];
 
-	var rkeywords = /^(?:abstract|as|boolean|break|byte|case|catch|char|class|continue|const|debugger|default|delete|do|double|else|enum|export|extends|false|final|finally|float|for|function|goto|if|implements|import|in|instanceof|int|interface|is|long|namespace|native|new|null|package|private|protected|public|return|short|static|super|switch|synchronized|this|throw|throws|transient|true|try|typeof|use|var|void|volatile|while|with)$/;
+	var rkeywords = /^(?:abstract|as|boolean|break|byte|case|catch|char|class|continue|const|debugger|default|delete|do|double|else|enum|export|extends|false|final|finally|float|for|function|goto|if|implements|import|in|instanceof|int|interface|is|long|namespace|native|new|null|noattribute|package|private|protected|public|return|short|static|super|switch|synchronized|this|throw|throws|transient|true|try|typeof|use|var|void|volatile|while|with)$/;
 
 	function isNoKeyword($) { return !rkeywords.test($.name); }
 

package/lib/polyfill-placeholder/index.js

@@ -0,0 +1,5 @@
+const mkdirp = require("mkdirp");
+const fs = require("fs");
+
+mkdirp.sync("dist/webcomponentsjs/");
+fs.writeFileSync("dist/webcomponentsjs/webcomponents-loader.js", "");

package/lib/postcss-css-to-esm/index.js

@@ -1,33 +1,45 @@
-const postcss = require('postcss');
 const fs = require('fs');
 const path = require('path');
 const mkdirp = require('mkdirp');
+const assets = require("../../assets-meta.js");
 
-const getDefaultThemeCode = packageName => {
-	return `import "@ui5/webcomponents-theme-base/dist/DefaultTheme.js";
-	
-import { registerThemeProperties } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
+const DEFAULT_THEME = assets.themes.default;
 
-import fiori3 from "./sap_fiori_3/parameters-bundle.css.js";
+const getDefaultThemeCode = packageName => {
+	return `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
 
-registerThemeProperties("${packageName}", "sap_fiori_3", fiori3);
+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}", () => defaultThemeBase);
+registerThemePropertiesLoader("${packageName}", "${DEFAULT_THEME}", () => defaultTheme);
 `;
 };
 
-module.exports = postcss.plugin('add css to esm transform plugin', function (opts) {
-	opts = opts || {};
-
-	return function (root) {
-		const css = JSON.stringify(root.toString());
-		const targetFile = root.source.input.from.replace(`/${opts.toReplace}/`, "/dist/generated/").replace(`\\${opts.toReplace}\\`, "\\dist\\generated\\");
+const proccessCSS = 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 JSON.stringify(css);
+}
 
-		mkdirp.sync(path.dirname(targetFile));
+module.exports = function (opts) {
+	opts = opts || {};
 
-		const filePath = `${targetFile}.js`;
+	return {
+		postcssPlugin: 'postcss-css-to-esm',
+		Once (root) {
+			let css = root.toString();
+			css = proccessCSS(css);
 
-		const defaultTheme = opts.includeDefaultTheme ? getDefaultThemeCode(opts.packageName) : ``;
+			const targetFile = root.source.input.from.replace(`/${opts.toReplace}/`, "/dist/generated/").replace(`\\${opts.toReplace}\\`, "\\dist\\generated\\");
+			mkdirp.sync(path.dirname(targetFile));
 
-		fs.writeFileSync(filePath, `${defaultTheme}export default ${css};`);
-	}
-});
+			const filePath = `${targetFile}.js`;
+			const defaultTheme = opts.includeDefaultTheme ? getDefaultThemeCode(opts.packageName) : ``;
+			fs.writeFileSync(filePath, `${defaultTheme}export default {packageName:"${opts.packageName}",fileName:"${targetFile.substr(targetFile.lastIndexOf("themes"))}",content:${css}}`);
+		}
+	};
+};
+module.exports.postcss = true;

package/lib/postcss-css-to-json/index.js

@@ -1,20 +1,36 @@
-const postcss = require('postcss');
 const fs = require('fs');
 const path = require('path');
 const mkdirp = require('mkdirp');
 
-module.exports = postcss.plugin('add css to JSON transform plugin', function (opts) {
-	opts = opts || {};
+const proccessCSS = 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;
+}
 
-	return function (root) {
-		const css = root.toString();
-		const targetFile = root.source.input.from.replace(`/${opts.toReplace}/`, "/dist/generated/assets/").replace(`\\${opts.toReplace}\\`, "\\dist\\generated\\assets\\");
+module.exports = function (opts) {
+	opts = opts || {};
 
-		mkdirp.sync(path.dirname(targetFile));
+	return {
+		postcssPlugin: 'postcss-css-to-json',
+		Once (root) {
+			let css = root.toString();
+			css = proccessCSS(css);
 
-		const filePath = `${targetFile}.json`;
+			const targetFile = root.source.input.from.replace(`/${opts.toReplace}/`, "/dist/generated/assets/").replace(`\\${opts.toReplace}\\`, "\\dist\\generated\\assets\\");
+			mkdirp.sync(path.dirname(targetFile));
 
-		fs.writeFileSync(filePath, JSON.stringify({_: css}));
+			const filePath = `${targetFile}.json`;
+			const data = {
+				packageName: opts.packageName,
+				fileName: targetFile.substr(targetFile.lastIndexOf("themes")),
+				content: css
+			};
+			fs.writeFileSync(filePath, JSON.stringify({_: data}));
+		}
+	};
+};
 
-	}
-});
+module.exports.postcss = true;

package/lib/postcss-new-files/index.js

@@ -0,0 +1,36 @@
+const chokidar = require("chokidar");
+const commandLineArgs = require("command-line-args");
+const { exec } = require("child_process");
+
+const options = commandLineArgs([
+	{ name: "srcFiles", type: String },
+]);
+
+const runPostcss = path => {
+	let command = `postcss ${path} --config config/postcss.components --base src --dir dist/css/`;
+	console.log(`Executing: ${command}`);
+	exec(command, (err, stdout, stderr) => {
+		if (err) {
+			console.log(`Could not run postcss for ${path}. Error: ${err}`);
+		}
+	});
+
+	command = `${command} -w`;
+	console.log(`Executing: ${command}`);
+	exec(command, (err, stdout, stderr) => {
+		if (err) {
+			console.log(`Could not run postcss in watch mode for ${path}. Error: ${err}`);
+		}
+	});
+};
+
+let ready = false; // Do nothing until the ready event has been fired (we don't want to recompile all files initially)
+const watcher = chokidar.watch(options.srcFiles);
+watcher.on("ready", () => {
+	ready = true; // Initial scan is over -> waiting for new files
+});
+watcher.on("add", path => {
+	if (ready) {
+		runPostcss(path);
+	}
+});

package/lib/postcss-p/postcss-p.mjs

@@ -0,0 +1,11 @@
+import 'zx/globals';
+
+const inputFiles = await globby("src/**/parameters-bundle.css");
+
+const restArgs = process.argv.slice(2);
+
+// run all postcss processes in parallel as passing the glob directly to postcss makes them processed sequentially.
+// and the amount of imports give a big speed up when run in parallel
+await Promise.all(inputFiles.map(file => {
+  return $`postcss ${file} --config config/postcss.themes --base src --dir dist/css/ ${restArgs}`;
+}));

package/lib/replace-global-core/index.js

@@ -0,0 +1,20 @@
+const fs = require("fs");
+const glob = require("glob");
+
+const basePath = process.argv[2];
+
+const replaceGlobalCoreUsage = (srcPath) => {
+
+	const original = fs.readFileSync(srcPath).toString();
+	let replaced = original.replace(/sap\.ui\.getCore\(\)/g, `Core`);
+
+	if (original !== replaced) {
+		replaced = `import Core from 'sap/ui/core/Core';
+		${replaced}`;
+		fs.writeFileSync(srcPath, replaced);
+	}
+};
+
+const fileNames = glob.sync(basePath + "**/*.js");
+fileNames.forEach(replaceGlobalCoreUsage);
+console.log("Success: Replaced global core usage in:", basePath);

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

@@ -0,0 +1,44 @@
+const fs = require("fs");
+const path = require("path");
+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;
+};
+
+const getPackageTags = (packageDir) => {
+	const srcDir = path.join(packageDir, "src/");
+	return glob.sync(path.join(srcDir, "/**/*.js")).flatMap(file => {
+		const tag = getTag(file);
+		const altTag = getAltTag(file);
+		return [tag, altTag];
+	}).filter(item => !!item);
+};
+
+const isComponentsPackage = (packageFileContent) => {
+	return packageFileContent.ui5 && packageFileContent.ui5.webComponentsPackage;
+};
+
+const getDepComponentPackages = packageDir => {
+	const packageFile = path.join(packageDir, "package.json");
+	const packageFileContent = JSON.parse(fs.readFileSync(packageFile));
+	if (!isComponentsPackage(packageFileContent)) {
+		return [];
+	}
+
+	return Object.keys(packageFileContent.dependencies || {}).map(dep => path.dirname(require.resolve(path.join(dep, "package.json"))));
+};
+
+const getAllTags = (packageDir) => {
+	return getPackageTags(packageDir).concat(getDepComponentPackages(packageDir).flatMap(getPackageTags));
+};
+
+module.exports = getAllTags;

package/lib/scoping/lint-src.js

@@ -0,0 +1,31 @@
+const fs = require("fs");
+const path = require("path");
+const glob = require("glob");
+const getAllTags = require("./get-all-tags.js");
+
+const tags = getAllTags(process.cwd());
+
+const errors = [];
+
+glob.sync(path.join(process.cwd(), "src/**/*.css")).forEach(file => {
+	let content = String(fs.readFileSync(file));
+	tags.forEach(tag => {
+		if (content.match(new RegExp(`(^|[^\.\-_A-Za-z0-9"\[])(${tag})([^\-_A-Za-z0-9]|$)`, "g"))) {
+			errors.push(`Warning! ${tag} found in ${file}`);
+		}
+	});
+});
+
+glob.sync(path.join(process.cwd(), "src/**/*.js")).forEach(file => {
+	let content = String(fs.readFileSync(file));
+	tags.forEach(tag => {
+		if (content.match(new RegExp(`querySelector[A-Za-z]*..${tag}`, "g"))) {
+			errors.push(`Warning! querySelector for ${tag} found in ${file}`);
+		}
+	});
+});
+
+if (errors.length) {
+	errors.forEach(error => console.log(error));
+	throw new Error("Errors found.");
+}

package/lib/scoping/missing-dependencies.js

@@ -0,0 +1,65 @@
+const fs = require("fs");
+const glob = require("glob");
+const path = require("path");
+const process = require("process");
+
+const projectPath = process.argv[2];
+
+// gather all tags from all files
+const tagsToFiles = new Map();
+const filesToTags = new Map();
+
+let files = [
+	...glob.sync(path.join("packages/main/src/**/*.js")),
+	...glob.sync(path.join("packages/fiori/src/**/*.js")),
+];
+files.forEach(file => {
+	let matches = file.match(/([a-zA-Z0-9_]+)\.js$/);
+	const name = matches[1];
+
+	const content = `${fs.readFileSync(file)}`;
+	matches = content.match(/tag: "(.*?)",/);
+	if (matches) {
+		const tag = matches[1];
+		tagsToFiles.set(tag, name);
+		filesToTags.set(name, tag);
+	}
+});
+
+// Process the package
+files = glob.sync(path.join(projectPath, "src/**/*.js"));
+tagsToFiles.forEach((file, tag) => {
+	const sourcePath = path.join(projectPath, "src/", `${file}.js`);
+	if (!fs.existsSync(sourcePath)) {
+		return;
+	}
+	const sourceContent = `${fs.readFileSync(sourcePath)}`.split("\n").join(" ");
+
+	const hbsPath = path.join(projectPath, "src/", `${file}.hbs`);
+	const hbsContent = fs.existsSync(hbsPath) ? `${fs.readFileSync(hbsPath)}` : "";
+
+	const hbsPopoverPath = path.join(projectPath, "src/", `${file}Popover.hbs`);
+	const hbsPopoverContent = fs.existsSync(hbsPopoverPath) ? `${fs.readFileSync(hbsPopoverPath)}` : "";
+
+	// deps
+	let deps = [];
+	let matches = sourceContent.match(/static get dependencies\(\) \{\s+return \[(.*?)\]/);
+	if (matches) {
+		deps = matches[1].split(",").map(x => x.trim()).filter(x => !!x);
+	}
+
+	// tags
+	matches = [
+		...hbsContent.matchAll(/<ui5-[a-z0-9-]+/g),
+		...hbsPopoverContent.matchAll(/<ui5-[a-z0-9-]+/g),
+	];
+	if (matches) {
+		matches.forEach(match => {
+			const tagUsed = match[0].substr(1);
+			const dep = tagsToFiles.get(tagUsed);
+			if (!deps.includes(dep)) {
+				console.log(`${file} used ${tagUsed}`);
+			}
+		});
+	}
+});

package/lib/scoping/report-tags-usage.js

@@ -0,0 +1,28 @@
+const fs = require("fs");
+const glob = require("glob");
+const path = require("path");
+const process = require("process");
+
+// gather all tags from all files
+const tags = new Set();
+const files = glob.sync(path.join(process.argv[2], "src/**/*.js"));
+files.forEach(file => {
+	const content = `${fs.readFileSync(file)}`;
+	const matches = content.match(/tag: "(.*?)",/);
+	if (matches) {
+		tags.add(matches[1]);
+	}
+});
+
+// report all usages of any tag within any file, which is not the tag definition and is not hasAttribute
+files.forEach(file => {
+	const content = `${fs.readFileSync(file)}`;
+	const lines = content.split("\n");
+	lines.forEach(line => {
+		tags.forEach(tag => {
+			if (line.includes(`"${tag}"`) && !line.includes(`tag: "${tag}",`) && !line.includes(`hasAttribute("${tag}")`)) {
+				console.log(`${file}: ${line.trim()}`);
+			}
+		});
+	});
+});

package/lib/scoping/scope-test-pages.js

@@ -0,0 +1,40 @@
+const fs = require("fs");
+const path = require("path");
+const glob = require("glob");
+const getAllTags = require("./get-all-tags.js");
+
+const root = process.argv[2];
+const suffix = process.argv[3];
+
+const tags = getAllTags(process.cwd());
+
+// Replaces tags in HTML content, f.e. <ui5-button> with <ui5-button-ver> or </ui5-button> with </ui5-button-ver>
+const replaceTagsHTML = content => {
+	tags.forEach(tag => {
+		content = content.replace(new RegExp(`(<\/?)(${tag})(\/?[> \t\n])`, "g"), `$1$2-${suffix}$3`);
+	});
+	return content;
+};
+
+// Replace tags in any content
+const replaceTagsAny = content => {
+	tags.forEach(tag => {
+		content = content.replace(new RegExp(`(^|[^\-_A-Za-z0-9])(${tag})([^\-_A-Za-z0-9]|$)`, "g"), `$1$2-${suffix}$3`);
+	});
+	return content;
+};
+
+// Replace bundle names and HTML tag names in test pages
+glob.sync(path.join(root, "/**/*.html")).forEach(file => {
+	let content = String(fs.readFileSync(file));
+	content = content.replace(/bundle\.(.*?)\.js/g, `bundle.scoped.$1.js`);
+	content = replaceTagsHTML(content);
+	fs.writeFileSync(file, content);
+});
+
+// Replace tag names everywhere
+glob.sync(path.join(root, "/**/*.{html,css,js}")).forEach(file => {
+	let content = String(fs.readFileSync(file));
+	content = replaceTagsAny(content);
+	fs.writeFileSync(file, content);
+});

package/lib/serve/index.js

@@ -0,0 +1,46 @@
+const fs = require("fs");
+const path = require("path");
+const commandLineArgs = require("command-line-args");
+const { exec } = require("child_process");
+const colors = require("cli-color");
+const isPortReachable = require("is-port-reachable");
+
+const options = commandLineArgs([
+	{ name: "port", type: Number },
+	{ name: "portStep", type: Number },
+	{ name: "packageName", type: String },
+	{ name: "dir", type: String },
+	{ name: "config", type: String },
+]);
+const serveConfig = path.join(__dirname, `serve.json`);
+
+const requestPort = async () => {
+	const serveProcess = (await gen.next()).value;
+	serveProcess.stdout.on('data', data => {
+		const matches = data.match(/Accepting connections at .*?:(\d+)/);
+		if (matches) {
+			console.log(colors.yellow(`Reserved port ${matches[1]} for the ${options.packageName} package.`));
+			fs.writeFileSync(".port", matches[1]);
+		}
+	});
+};
+
+async function* serverGenerator(callback, port = 8080, step = 1) {
+	while (true) {
+		const portInUse = await isPortReachable(port, { host: "127.0.0.1" });
+		if (!portInUse) {
+			const command = `serve --config "${serveConfig}" --no-port-switching --no-clipboard -l ${port} ${options.dir}`;
+			console.log(colors.yellow(`Executing: ${command}`));
+			const serveProcess = exec(command, (err) => {
+				console.log(colors.yellow(`Port ${port} already in use.`));
+				callback();
+			});
+			yield serveProcess;
+		}
+		port += step;
+	}
+}
+
+const gen = serverGenerator(requestPort, options.port, options.portStep);
+
+requestPort();

package/package-lock.json

@@ -0,0 +1,48 @@
+{
+  "name": "@ui5/webcomponents-tools",
+  "version": "1.0.0-rc.8",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "balanced-match": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
+      "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=",
+      "dev": true
+    },
+    "brace-expansion": {
+      "version": "1.1.11",
+      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+      "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+      "dev": true,
+      "requires": {
+        "balanced-match": "^1.0.0",
+        "concat-map": "0.0.1"
+      }
+    },
+    "concat-map": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+      "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=",
+      "dev": true
+    },
+    "minimatch": {
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "dev": true,
+      "requires": {
+        "brace-expansion": "^1.1.7"
+      }
+    },
+    "recursive-readdir": {
+      "version": "2.2.2",
+      "resolved": "https://registry.npmjs.org/recursive-readdir/-/recursive-readdir-2.2.2.tgz",
+      "integrity": "sha512-nRCcW9Sj7NuZwa2XvH9co8NPeXUBhZP7CRKJtU+cS6PW9FpCIFoI5ib0NT1ZrbNuPoRy0ylyCaUL8Gih4LSyFg==",
+      "dev": true,
+      "requires": {
+        "minimatch": "3.0.4"
+      }
+    }
+  }
+}