@ui5/webcomponents-tools 0.0.0-d0bcf47c7 → 0.0.0-d479b681b

package/lib/hbs2ui5/index.js

@@ -0,0 +1,102 @@
+const fs = require('fs').promises;
+const getopts = require('getopts');
+const hbs2lit = require('../hbs2lit');
+const path = require('path');
+const litRenderer = require('./RenderTemplates/LitRenderer');
+const recursiveReadDir = require("recursive-readdir");
+
+const args = getopts(process.argv.slice(2), {
+	alias: {
+		o: 'output',
+		d: 'directory',
+		f: 'file',
+		t: 'type'
+	},
+	default: {
+		t: 'lit-html'
+	}
+});
+
+const onError = (place) => {
+	console.log(`A problem occoured when reading ${place}. Please recheck passed parameters.`);
+};
+
+const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
+
+const processFile = async (file, outputDir) => {
+	const litCode = await hbs2lit(file);
+	const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
+	const componentNameMatcher = /(\w+)(\.hbs)/gim;
+	const componentName = componentNameMatcher.exec(file)[1];
+
+	return writeRenderers(absoluteOutputDir, 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);
+
+	return new Promise((resolve, reject) => {
+		recursiveReadDir(directory, (err, files) => {
+
+			if (err) {
+				onError('directory');
+				reject();
+			}
+
+			const promises = files.map(fileName => {
+				if (isHandlebars(fileName)) {
+					return processFile(fileName, outputDir);
+				}
+			}).filter(x => !!x);
+
+			resolve(Promise.all(promises));
+		});
+	});
+};
+
+const writeRenderers = async (outputDir, controlName, fileContent) => {
+	try {
+
+		await fs.mkdir(outputDir, { recursive: true });
+
+		const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
+
+		// strip DOS line endings because the break the source maps
+		let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
+		fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
+
+		// Only write to the file system actual changes - each updated file, no matter if the same or not, triggers an expensive operation for rollup
+		// Note: .hbs files that include a changed .hbs file will also be recompiled as their content will be updated too
+
+		let existingFileContent = "";
+		try {
+			existingFileContent = await fs.readFile(compiledFilePath);
+		} catch (e) {}
+
+		if (existingFileContent !== fileContentUnix) {
+			return fs.writeFile(compiledFilePath, fileContentUnix);
+		}
+
+	} catch (e) {
+		console.log(e);
+	}
+};
+
+if (!args['d'] || !args['o']) {
+	console.log('Please provide an input and output directory (-d and -o)');
+} else {
+	wrapDirectory(args['d'], args['o']).then(() => {
+		console.log("Templates generated");
+	});
+}

package/lib/i18n/defaults.js

@@ -0,0 +1,82 @@
+const fs = require('fs').promises;
+const path = require('path');
+const PropertiesReader = require('properties-reader');
+const assets = require('../../assets-meta.js');
+
+const generate = async () => {
+	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 tsMode = process.env.UI5_TS === "true"; // In Typescript mode, we output .ts files and set the required types, otherwise - output pure .js files
+
+	const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.${tsMode ? "ts": "js"}`);
+
+	if (!messageBundle || !outputFile) {
+		return;
+	}
+
+	const properties = PropertiesReader(messageBundle)._properties;
+
+	let defaultLanguageProperties;
+	try {
+		defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
+	} catch (e) {
+	}
+
+	// Merge messagebundle.properties and messagebundle_en.properties files to generate the default texts.
+	// Note:
+	// (1) at DEV time, it's intuituve to work with the source bundle file - the messagebundle.properties,
+	// and see the changes there take effect.
+	// (2) as the messagebundle.properties file is always written in English,
+	// it makes sense to consider the messagebundle.properties content only when the default language is "en".
+	if (defaultLanguage === "en") {
+		defaultLanguageProperties = Object.assign({}, defaultLanguageProperties, properties);  
+	}
+
+	/*
+	 * Returns the single text object to enable single export.
+	 *
+	 * Example:
+	 * const ARIA_LABEL_CARD_CONTENT = {
+	 *	key: "ARIA_LABEL_CARD_CONTENT",
+	 *	defaultText: "Card Content",
+	 * };
+	 */
+	const getTextInfo = (key, value, defaultLanguageValue) => {
+		let effectiveValue = defaultLanguageValue || value;
+		effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
+
+		if (tsMode) {
+			return `const ${key}: I18nText = {key: "${key}", defaultText: "${effectiveValue}"};`;
+		}
+		return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
+	};
+
+	/*
+	 * Returns the complete content of i18n-defaults.js file:
+	 * (1) the single text objects
+	 * (2) the export statement at the end of the file
+	 *
+	 * Example:
+	 * export {
+	 *	ARIA_LABEL_CARD_CONTENT,
+	 * }
+	 */
+	const getOutputFileContent = (properties, defaultLanguageProperties) => {
+		const textKeys = Object.keys(properties);
+		const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
+
+		// tabs are intentionally mixed to have proper identation in the produced file
+		return `${tsMode ? `import { I18nText } from "@ui5/webcomponents-base/dist/i18nBundle.js";` : ""}
+${texts}
+export {${textKeys.join()}};`;
+	};
+
+	await fs.mkdir(path.dirname(outputFile), { recursive: true });
+	await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
+};
+
+generate().then(() => {
+	console.log("i18n default file generated.");
+});

package/lib/i18n/toJSON.js

@@ -0,0 +1,43 @@
+/*
+ * The script converts all messebindle_*.properties files to messagebundle_*.json files.
+ *
+ * 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.
+ */
+const path = require("path");
+const PropertiesReader = require('properties-reader');
+const fs = require('fs').promises;
+const assets = require('../../assets-meta.js');
+
+const allLanguages = assets.languages.all;
+
+const messagesBundles = path.normalize(`${process.argv[2]}/messagebundle_*.properties`);
+const messagesJSONDist = path.normalize(`${process.argv[3]}`);
+
+const convertToJSON = async (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`);
+
+	return fs.writeFile(outputFile, JSON.stringify(properties));
+	// console.log(`[i18n]: "${filename}.json" has been generated!`);
+};
+
+const generate = async () => {
+	const { globby } = await import("globby");
+	await fs.mkdir(messagesJSONDist, { recursive: true });
+	const files = await globby(messagesBundles.replace(/\\/g, "/"));
+	return Promise.all(files.map(convertToJSON));
+};
+
+generate().then(() => {
+	console.log("Message bundle JSON files generated.");
+});

package/lib/jsdoc/config.json

@@ -0,0 +1,29 @@
+{
+	"source": {
+		"include": "src",
+		"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
+	},
+	"opts" : {
+		"recurse": true,
+		"template" : "template",
+		"destination": ""
+	},
+	"plugins": [
+		"./plugin.js"
+	],
+	"templates" : {
+		"ui5" : {
+			"variants": [
+				"apijson"
+			],
+			"version": "1.62",
+			"apiJsonFolder": "",
+			"apiJsonFile": "dist/api.json",
+			"includeSettingsInConstructor": false
+		}
+	},
+	"tags": {
+		"allowUnknownTags": true,
+		"dictionaries": ["jsdoc"]
+	}
+}

package/lib/jsdoc/configTypescript.json

@@ -0,0 +1,29 @@
+{
+	"source": {
+		"include": "jsdoc-dist",
+		"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
+	},
+	"opts" : {
+		"recurse": true,
+		"template" : "template",
+		"destination": ""
+	},
+	"plugins": [
+		"./plugin.js"
+	],
+	"templates" : {
+		"ui5" : {
+			"variants": [
+				"apijson"
+			],
+			"version": "1.62",
+			"apiJsonFolder": "",
+			"apiJsonFile": "dist/api.json",
+			"includeSettingsInConstructor": false
+		}
+	},
+	"tags": {
+		"allowUnknownTags": true,
+		"dictionaries": ["jsdoc"]
+	}
+}