@ui5/webcomponents-tools 0.0.0-c6155714e → 0.0.0-c638668a1

package/lib/hash/config.js

@@ -0,0 +1,10 @@
+const config = {
+	files: {
+		exclude: ['serve.json']
+	},
+	folders: {
+		exclude: ['resources']
+	},
+};
+
+module.exports = config;

package/lib/hash/generate.js

@@ -0,0 +1,19 @@
+const fs = require("fs");
+const path = require("path");
+const process = require("process");
+const { hashElement } = require("folder-hash");
+const config = require("./config.js");
+
+const inputDir = path.normalize(process.argv[2]);
+const outputFileName = path.normalize(process.argv[3]);
+
+const generateHash = async (inputDir, outputFileName) => {
+	const result = await hashElement(inputDir, config);
+	const hash = result.hash;
+	fs.writeFileSync(outputFileName, hash);
+	return hash;
+};
+
+generateHash(inputDir, outputFileName).then(hash => {
+	console.log(`Generated hash: ${hash}`);
+});

package/lib/hash/upToDate.js

@@ -0,0 +1,31 @@
+const fs = require("fs");
+const path = require("path");
+const process = require("process");
+const { hashElement } = require("folder-hash");
+const config = require("./config.js");
+
+const inputDir = path.normalize(process.argv[2]);
+const hashFileName = path.normalize(process.argv[3]);
+
+const isUpToDate = async (inputDir, hashFileName) => {
+	// No dist/ directory or no hash file
+	if (!fs.existsSync(inputDir) || !fs.existsSync(hashFileName)) {
+		return false;
+	}
+
+	// Empty hash file
+	const existingHash = `${fs.readFileSync(hashFileName)}`;
+	if (!existingHash) {
+		return false;
+	}
+
+	// Calculate the hash of the dist/ directory
+	const result = await hashElement(inputDir, config);
+	const newHash = result.hash;
+
+	return newHash === existingHash;
+};
+
+isUpToDate(inputDir, hashFileName).then(upToDate => {
+	process.exit(upToDate ? 0 : 1); // 0 means success (it is up to date), 1 means failure (must rebuild the dist/)
+});

package/lib/hbs2lit/index.js

@@ -1,5 +1,3 @@
-const compiler = require("./src/compiler");
+const hbs2lit = require("./src/compiler");
 
-module.exports = {
-	compileString: compiler.compileString
-};
+module.exports = hbs2lit;

package/lib/hbs2lit/src/compiler.js

@@ -5,13 +5,16 @@ const includesReplacer = require("./includesReplacer");
 const svgProcessor = require("./svgProcessor");
 
 const removeWhiteSpaces = (source) => {
-	return source.replace(/\n+/g, "").replace(/\s+</g, "<").replace(/}}\s+{{/g, "}}{{");
+	return source
+		.replace(/\s*\r*\n+\s*/g, " ") // Replace new lines and all whitespace between them with a space
+		.replace(/\s*<\s*/g, "<") // Strip whitespace round <
+		.replace(/\s*>\s*/g, ">") // Strip whitespace round >
+		.replace(/}}\s+{{/g, "}}{{"); // Remove whitespace between }} and {{
 };
 
-const compileString = async (sInput, config) => {
-	let sPreprocessed = sInput;
+const hbs2lit = (file) => {
+	let sPreprocessed = includesReplacer.replace(file);
 
-	sPreprocessed = await includesReplacer.replace(sPreprocessed, config);
 	sPreprocessed = removeWhiteSpaces(sPreprocessed);
 
 	const ast = Handlebars.parse(sPreprocessed);
@@ -34,6 +37,4 @@ const compileString = async (sInput, config) => {
 	return result;
 };
 
-module.exports = {
-	compileString
-};
+module.exports = hbs2lit;

package/lib/hbs2lit/src/includesReplacer.js

@@ -1,25 +1,31 @@
 const path = require("path");
-const {promisify} = require("util");
-const nativeFs = require("fs");
+const fs = require("fs");
 
-function replaceIncludes(hbs, config) {
-	const fs = config.fs || nativeFs;
-	const readFile = promisify(fs.readFile);
-	const inclRegex = /{{>\s*include\s*["']([a-zA-Z.\/]+)["']}}/g;
-
-	async function replacer(match, p1) {
-		const includeContent = await readFile(path.join(config.templatesPath, p1), "utf-8");
-		hbs = hbs.replace(match, includeContent);
-	}
+function replaceIncludes(file) {
+	const filePath = path.dirname(file);
+	let fileContent = fs.readFileSync(file, "utf-8");
 
+	const inclRegex = /{{>\s*include\s*["'](.+?)["']}}/g;
 	let match;
-	const replacers = [];
-	while ((match = inclRegex.exec (hbs)) !== null) {
-		replacers.push(replacer(match[0], match[1]));
+
+	while((match = inclRegex.exec(fileContent)) !== null) {
+		inclRegex.lastIndex = 0;
+
+		let targetFile = match[1];
+		if (targetFile.startsWith(".")) {
+			// Relative path, f.e. {{>include "./Popup.hbs"}} or {{>include "../partials/Header.hbs"}}
+			targetFile = path.join(filePath, targetFile);
+		} else {
+			// Node module path, f.e. {{>include "@ui5/webcomponents/src/Popup.hbs"}}
+			targetFile = require.resolve(targetFile);
+		}
+
+		fileContent = fileContent.replace(match[0], replaceIncludes(targetFile));
 	}
-	return Promise.all(replacers).then(() => hbs);
+
+	return fileContent;
 }
 
 module.exports = {
 	replace: replaceIncludes
-};
+};

package/lib/hbs2lit/src/litVisitor2.js

@@ -2,6 +2,32 @@ const Handlebars = require("handlebars/dist/handlebars.min.js");
 const path = require("path");
 const Visitor = Handlebars.Visitor;
 
+// skip ifDefined for event handlers and boolean attrs
+let skipIfDefined = false;
+
+// when true => an HTML node value, when false => an attribute value
+let isNodeValue = false;
+
+// when true => the current attribute is "style"
+let isStyleAttribute = false;
+
+// matches event handlers @click= and boolean attrs ?disabled=
+const dynamicAttributeRgx = /\s(\?|@)([a-zA-Z|-]+)="?\s*$/;
+
+if (!String.prototype.replaceAll) {
+	String.prototype.replaceAll = function(str, newStr){
+
+		// If a regex pattern
+		if (Object.prototype.toString.call(str).toLowerCase() === '[object regexp]') {
+			return this.replace(str, newStr);
+		}
+
+		// If a string
+		return this.replace(new RegExp(str, 'g'), newStr);
+
+	};
+}
+
 function HTMLLitVisitor(debug) {
 	this.blockCounter = 0;
 	this.keys = [];
@@ -9,7 +35,7 @@ function HTMLLitVisitor(debug) {
 	this.result = "";
 	this.mainBlock = "";
 	this.blockPath = "context";
-	this.blockParameters = ["context"];
+	this.blockParameters = ["context", "tags", "suffix"];
 	this.paths = []; //contains all normalized relative paths
 	this.debug = debug;
 	if (this.debug) {
@@ -25,7 +51,7 @@ HTMLLitVisitor.prototype.Program = function(program) {
 	this.keys.push(key);
 	this.debug && this.blockByNumber.push(key);
 
-	this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => { return ";
+	this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => ";
 
 	if (this.keys.length > 1) { //it's a nested block
 		this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
@@ -36,7 +62,7 @@ HTMLLitVisitor.prototype.Program = function(program) {
 
 	this.blocks[this.currentKey()] += "html`";
 	Visitor.prototype.Program.call(this, program);
-	this.blocks[this.currentKey()] += "`; };";
+	this.blocks[this.currentKey()] += "`;";
 
 	this.keys.pop(key);
 };
@@ -45,8 +71,25 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
 	Visitor.prototype.ContentStatement.call(this, content);
 	// let content = content.orgiinal; // attribute="__ attribute = "__  attribute ="__
 
-	this.blocks[this.currentKey()] += content.original;
+	let contentStatement = content.original;
+	skipIfDefined = !!dynamicAttributeRgx.exec(contentStatement);
+
+	const closingIndex = contentStatement.lastIndexOf(">");
+	const openingIndex = contentStatement.lastIndexOf("<");
+	if (closingIndex !== -1 || openingIndex !== -1) { // Only change isNodeValue whenever < or > is found in the content statement
+		isNodeValue = closingIndex > openingIndex;
+	}
+
+	isStyleAttribute = !isNodeValue && contentStatement.match(/style *= *["']? *$/);
 
+	if (!isStyleAttribute && contentStatement.match(/style=/)) {
+		console.log("WARNING: style hard-coded", contentStatement);
+	}
+
+	// Scope custom element tags
+	contentStatement = contentStatement.replaceAll(/(<\/?\s*)([a-zA-Z0-9_]+-[a-zA-Z0-9_-]+)/g, "$1\${scopeTag(\"$2\", tags, suffix)}");
+
+	this.blocks[this.currentKey()] += contentStatement;
 };
 
 HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
@@ -57,14 +100,17 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
 	} else {
 		const path = normalizePath.call(this, mustache.path.original);
 		const hasCalculatingClasses = path.includes("context.classes");
-		const hasStylesCalculation = path.includes("context.styles");
-		
+
 		let parsedCode = "";
 
-		if (hasCalculatingClasses) {
-			parsedCode = `\${ifDefined(classMap(${path}))}`;
-		} else if (hasStylesCalculation) {
-			parsedCode = `\${ifDefined(styleMap(${path}))}`;
+		if (isNodeValue && !mustache.escaped) {
+			parsedCode = `\${unsafeHTML(${path})}`;
+		} else if (hasCalculatingClasses) {
+			parsedCode = `\${classMap(${path})}`;
+		} else if (isStyleAttribute) {
+			parsedCode = `\${styleMap(${path})}`;
+		} else if (skipIfDefined){
+			parsedCode = `\${${path}}`;
 		} else {
 			parsedCode = `\${ifDefined(${path})}`;
 		}
@@ -125,7 +171,7 @@ function visitEachBlock(block) {
 	var bParamAdded = false;
 	visitSubExpression.call(this, block);
 
-	this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", undefined, (item, index) => ";
+	this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
 	this.paths.push(normalizePath.call(this, block.params[0].original));
 	this.blockPath = "item";
 

package/lib/hbs2lit/src/svgProcessor.js

@@ -46,8 +46,8 @@ function getSVGMatches(template) {
 
 function getSVGBlock(input, blockCounter) {
 	return {
-		usage: `\${blockSVG${blockCounter}(context)}`,
-		definition: `\nconst blockSVG${blockCounter} = (context) => {return svg\`${input}\`};`,
+		usage: `\${blockSVG${blockCounter}(context, tags, suffix)}`,
+		definition: `\nconst blockSVG${blockCounter} = (context, tags, suffix) => svg\`${input}\`;`,
 	};
 }
 
@@ -55,7 +55,7 @@ function replaceInternalBlocks(template, svgContent) {
 	const internalBlocks = svgContent.match(blockrx) || [];
 
 	internalBlocks.forEach(blockName => {
-		const rx = new RegExp(`const ${blockName}.*(html\`).*};`);
+		const rx = new RegExp(`const ${blockName}.*(html\`).*;`);
 		template = template.replace(rx, (match, p1) => {
 			return match.replace(p1, "svg\`");
 		});

package/lib/hbs2ui5/RenderTemplates/LitRenderer.js

@@ -1,10 +1,10 @@
 const buildRenderer = (controlName, litTemplate) => {
-	return `
-/* eslint no-unused-vars: 0 */
-import ifDefined from '@ui5/webcomponents-base/dist/renderer/ifDefined.js';
-import { html, svg, repeat, classMap, styleMap } from '@ui5/webcomponents-base/dist/renderer/LitRenderer.js';
+	return `/* eslint no-unused-vars: 0 */
+import { html, svg, repeat, classMap, styleMap, ifDefined, unsafeHTML, scopeTag } from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+
 ${litTemplate}
-export default block0;`
+
+export default block0;`;
 };
 
 module.exports = {

package/lib/hbs2ui5/index.js

@@ -3,6 +3,8 @@ const getopts = require('getopts');
 const hbs2lit = require('../hbs2lit');
 const path = require('path');
 const litRenderer = require('./RenderTemplates/LitRenderer');
+const recursiveReadDir = require("recursive-readdir");
+const mkdirp = require('mkdirp');
 
 const args = getopts(process.argv.slice(2), {
 	alias: {
@@ -18,32 +20,34 @@ const args = getopts(process.argv.slice(2), {
 
 const onError = (place) => {
 	console.log(`A problem occoured when reading ${place}. Please recheck passed parameters.`);
-}
+};
+
 const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
-const parseFile = (filePath, inputDir, outputDir) => {
-	fs.readFile(filePath, 'utf-8', (err, content) => {
 
-		if (err) {
-			onError('file');
-		}
+const processFile = (file, outputDir) => {
+	const litCode = hbs2lit(file);
+	const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
+	const componentNameMatcher = /(\w+)(\.hbs)/gim;
+	const componentName = componentNameMatcher.exec(file)[1];
 
-		hbs2lit.compileString(content, {
-			templatesPath: inputDir,
-			compiledTemplatesPath: outputDir
-		}).then((litCode) => {
-			const componentNameMatcher = /(\w+)(\.hbs)/gim;
-			const componentName = componentNameMatcher.exec(filePath)[1];
+	writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
+};
 
-			writeRenderers(outputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
-		});
-	});
-}
+const composeAbsoluteOutputDir = (file, outputDir) => {
+	// (1) Extract the dir structure from the source file path - "src/lvl1/lvl2/MyCompBadge.hbs"
+	// - remove the filename - "src/lvl1/lvl2"
+	// - remove the leading dir - "lvl1/lvl2"
+	const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
+
+	// (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
+	return `${outputDir}${path.sep}${fileDir}`; 
+};
 
 const wrapDirectory = (directory, outputDir) => {
 	directory = path.normalize(directory);
 	outputDir = path.normalize(outputDir);
 
-	fs.readdir(directory, (err, files) => {
+	recursiveReadDir(directory, (err, files) => {
 
 		if (err) {
 			onError('directory');
@@ -51,9 +55,7 @@ const wrapDirectory = (directory, outputDir) => {
 
 		files.forEach(fileName => {
 			if (isHandlebars(fileName)) {
-
-				// could be refactored a bit
-				parseFile(directory + fileName, directory, outputDir);
+				processFile(fileName, outputDir);
 			}
 		});
 	})
@@ -61,6 +63,10 @@ const wrapDirectory = (directory, outputDir) => {
 
 const writeRenderers = (outputDir, controlName, fileContent) => {
 	try {
+		if (!fs.existsSync(outputDir)) {
+			mkdirp.sync(outputDir);
+		}
+
 		const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
 
 		// strip DOS line endings because the break the source maps

package/lib/i18n/defaults.js

@@ -1,7 +1,13 @@
 const fs = require('fs');
 const path = require('path');
 const PropertiesReader = require('properties-reader');
+const mkdirp = require("mkdirp");
+const assets = require('../../assets-meta.js');
+
+const defaultLanguage = assets.languages.default;
+
 const messageBundle = path.normalize(`${process.argv[2]}/messagebundle.properties`);
+const messageBundleDefaultLanguage = path.normalize(`${process.argv[2]}/messagebundle_${defaultLanguage}.properties`);
 const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.js`);
 
 if (!messageBundle || !outputFile) {
@@ -10,6 +16,13 @@ if (!messageBundle || !outputFile) {
 
 const properties = PropertiesReader(messageBundle)._properties;
 
+let defaultLanguageProperties;
+try {
+	defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
+}
+catch (e) {}
+
+
 /*
  * Returns the single text object to enable single export.
  *
@@ -19,7 +32,12 @@ const properties = PropertiesReader(messageBundle)._properties;
  *	defaultText: "Card Content",
  * };
  */
-const getTextInfo = (key, value) => `const ${key} = {key: "${key}", defaultText: "${value}"};`;
+const getTextInfo = (key, value, defaultLanguageValue) => {
+	let effectiveValue = defaultLanguageValue || value;
+	effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
+
+	return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
+};
 
 /*
  * Returns the complete content of i18n-defaults.js file:
@@ -31,13 +49,13 @@ const getTextInfo = (key, value) => `const ${key} = {key: "${key}", defaultText:
  *	ARIA_LABEL_CARD_CONTENT,
  * }
  */
-const getOutputFileContent = (properties) => {
+const getOutputFileContent = (properties, defaultLanguageProperties) => {
 	const textKeys = Object.keys(properties);
-	const texts = textKeys.map(prop => getTextInfo(prop, properties[prop])).join('');
+	const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
 
 	return `${texts}
 export {${textKeys.join()}};`;
-}
+};
 
 /*
  * Writes the i18n-defaults.js.
@@ -50,6 +68,7 @@ const writeI18nDefaultsFile = (file, content) => {
 
 		console.log(`[i18n]: "${file}" file has been created`);
 	});
-}
+};
 
-writeI18nDefaultsFile(outputFile, getOutputFileContent(properties));
+mkdirp.sync(path.dirname(outputFile));
+writeI18nDefaultsFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));

package/lib/i18n/toJSON.js

@@ -3,7 +3,7 @@
  *
  * Execution (note: the paths depends on the the execution context)
  * node toJSON.js ../../src/assets/i18n ../../dist/generated/assets/i18n
- * 
+ *
  * The 1st param '../../src/assets/i18n' is the location of messagebundle_*.properties files
  * The 2nd param './../dist/generated/assets/i18n' is where the JSON files would be written to.
  */
@@ -11,21 +11,32 @@ const path = require("path");
 const glob = require("glob");
 const PropertiesReader = require('properties-reader');
 const fs = require('fs');
+const assets = require('../../assets-meta.js');
+const mkdirp = require("mkdirp");
+
+const allLanguages = assets.languages.all;
+
 const messagesBundles = path.normalize(`${process.argv[2]}/messagebundle_*.properties`);
 const messagesJSONDist = path.normalize(`${process.argv[3]}`);
 
  const convertToJSON = (file) => {
 	const properties = PropertiesReader(file)._properties;
 	const filename = path.basename(file, path.extname(file));
+	const language = filename.match(/^messagebundle_(.*?)$/)[1];
+	if (!allLanguages.includes(language)) {
+		console.log("Not supported language: ", language);
+		return;
+	}
 	const outputFile = path.normalize(`${messagesJSONDist}/${filename}.json`);
 
 	fs.writeFileSync(outputFile, JSON.stringify(properties));
-	console.log(`[i18n]: "${filename}.json" has been generated!`);
-}
+	// console.log(`[i18n]: "${filename}.json" has been generated!`);
+};
 
+mkdirp.sync(messagesJSONDist);
  glob(messagesBundles, {}, (err, files) => {
 	if (err) {
 		return console.log("No messagebundle files found!");
 	}
 	files.forEach(convertToJSON);
-}); 
+});

package/lib/jsdoc/config.json

@@ -1,7 +1,7 @@
 {
 	"source": {
 		"include": "src",
-		"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js"
+		"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
 	},
 	"opts" : {
 		"recurse": true,

package/lib/jsdoc/plugin.js

@@ -29,7 +29,11 @@
  *
  *   appenddocs
  *
- *   customtag
+ *   tagname
+ *
+ *   native
+ *
+ *   allowPreventDefault
  *
  * It furthermore listens to the following JSDoc3 events to implement additional functionality
  *
@@ -2060,9 +2064,11 @@ exports.defineTags = function(dictionary) {
 	});
 
 	dictionary.defineTag('slot', {
-		mustNotHaveValue: true,
 		onTagged: function(doclet, tag) {
 			doclet.slot = true;
+			if (tag.value) {
+				doclet.propertyName = tag.value;
+			}
 		}
 	});
 
@@ -2073,10 +2079,24 @@ exports.defineTags = function(dictionary) {
 		}
 	});
 
-	dictionary.defineTag('customtag', {
+	dictionary.defineTag('tagname', {
 		mustHaveValue: true,
 		onTagged: function(doclet, tag) {
-			doclet.customtag = tag.value;
+			doclet.tagname = tag.value;
+		}
+	});
+
+	dictionary.defineTag('allowPreventDefault', {
+		mustHaveValue: false,
+		onTagged: function(doclet, tag) {
+			doclet.allowPreventDefault = true;
+		}
+	});
+
+	dictionary.defineTag('native', {
+		mustHaveValue: false,
+		onTagged: function(doclet, tag) {
+			doclet.native = true;
 		}
 	});
 };

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);
@@ -2838,6 +2838,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 +2882,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);

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", "");