@ui5/webcomponents-tools 0.0.0-deac3098a → 0.0.0-df5b4199a

package/lib/copy-and-watch/index.js

@@ -1,122 +1,153 @@
+/*
+MIT License
+
+Copyright (c) 2017
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+
 const fs = require('fs');
 const path = require('path');
 const chokidar = require('chokidar');
 const glob = require('glob');
 const globParent = require('glob-parent');
-require('colors');
 
 /* CODE */
 
-const args = process.argv.slice(2);
-const options = {};
+const copyAndWatchFn = async (argv) => {
+	const args = argv.slice(2);
+	const options = {};
 
-['watch', 'clean', 'skip-initial-copy', 'safe',  'silent'].forEach(key => {
-	const index = args.indexOf(`--${key}`);
-	if (index >= 0) {
-		options[key] = true;
-		args.splice(index, 1);
+	['watch', 'clean', 'skip-initial-copy', 'safe', 'silent'].forEach(key => {
+		const index = args.indexOf(`--${key}`);
+		if (index >= 0) {
+			options[key] = true;
+			args.splice(index, 1);
+		}
+	});
+
+	if (args.length < 2) {
+		console.error('Not enough arguments: copy-and-watch [options] <sources> <target>');
+		process.exit(1);
 	}
-});
 
-if (args.length < 2) {
-	console.error('Not enough arguments: copy-and-watch [options] <sources> <target>'.red);
-	process.exit(1);
-}
+	if (options['skip-initial-copy'] && !options['watch']) {
+		console.error('--skip-initial-copy argument is meant to be used with --watch, otherwise no files will be copied');
+		process.exit(1);
+	}
 
-if (options['skip-initial-copy'] && !options['watch']) {
-	console.error('--skip-initial-copy argument is meant to be used with --watch, otherwise no files will be copied'.red);
-	process.exit(1);
-}
+	const target = args.pop();
+	const sources = args;
+	const parents = [...new Set(sources.map(globParent))];
 
-const target = args.pop();
-const sources = args;
-const parents = [...new Set(sources.map(globParent))];
-
-const findTarget = from => {
-	const parent = parents
-		.filter(p => from.indexOf(p) >= 0)
-		.sort()
-		.reverse()[0];
-	return path.join(target, path.relative(parent, from));
-};
-const createDirIfNotExist = to => {
-	'use strict';
-
-	const dirs = [];
-	let dir = path.dirname(to);
-
-	while (dir !== path.dirname(dir)) {
-		dirs.unshift(dir);
-		dir = path.dirname(dir);
-	}
+	const findTarget = from => {
+		const parent = parents
+			.filter(p => from.indexOf(p) >= 0)
+			.sort()
+			.reverse()[0];
+		return path.join(target, path.relative(parent, from));
+	};
+	const createDirIfNotExist = to => {
+		'use strict';
 
-	dirs.forEach(dir => {
-		if (!fs.existsSync(dir)) {
-			fs.mkdirSync(dir);
+		const dirs = [];
+		let dir = path.dirname(to);
+
+		while (dir !== path.dirname(dir)) {
+			dirs.unshift(dir);
+			dir = path.dirname(dir);
 		}
-	});
-};
-const copy = from => {
-	const to = findTarget(from);
-	createDirIfNotExist(to);
-	const stats = fs.statSync(from);
-	if (stats.isDirectory()) {
-		return;
-	}
-	fs.writeFileSync(to, fs.readFileSync(from));
-	options.silent || console.log('[COPY]'.yellow, from, 'to'.yellow, to);
-};
-const remove = from => {
-	const to = findTarget(from);
-	fs.unlinkSync(to);
-	options.silent || console.log('[DELETE]'.yellow, to);
-};
-const rimraf = dir => {
-	if (fs.existsSync(dir)) {
-		fs.readdirSync(dir).forEach(entry => {
-			const entryPath = path.join(dir, entry);
-			if (fs.lstatSync(entryPath).isDirectory()) {
-				rimraf(entryPath);
-			} else {
-				fs.unlinkSync(entryPath);
+
+		dirs.forEach(dir => {
+			if (!fs.existsSync(dir)) {
+				fs.mkdirSync(dir);
 			}
 		});
-		fs.rmdirSync(dir);
+	};
+	const copy = from => {
+		const to = findTarget(from);
+		createDirIfNotExist(to);
+		const stats = fs.statSync(from);
+		if (stats.isDirectory()) {
+			return;
+		}
+		fs.writeFileSync(to, fs.readFileSync(from));
+		options.silent || console.log('[COPY]', from, 'to', to);
+	};
+	const remove = from => {
+		const to = findTarget(from);
+		fs.unlinkSync(to);
+		options.silent || console.log('[DELETE]', to);
+	};
+	const rimraf = dir => {
+		if (fs.existsSync(dir)) {
+			fs.readdirSync(dir).forEach(entry => {
+				const entryPath = path.join(dir, entry);
+				if (fs.lstatSync(entryPath).isDirectory()) {
+					rimraf(entryPath);
+				} else {
+					fs.unlinkSync(entryPath);
+				}
+			});
+			fs.rmdirSync(dir);
+		}
+	};
+
+	// clean
+	if (options.clean) {
+		rimraf(target);
 	}
-};
 
-// clean
-if (options.clean) {
-	rimraf(target);
-}
+	// initial copy
+	if (!options['skip-initial-copy']) {
+		sources.forEach(s => glob.sync(s).forEach(copy));
+	}
 
-// initial copy
-if (!options['skip-initial-copy']) {
-	sources.forEach(s => glob.sync(s).forEach(copy));
-}
+	// watch
+	if (options.watch) {
+		const chokidarOptions = {
+			ignoreInitial: true
+		};
 
-// watch
-if (options.watch) {
-	const chokidarOptions = {
-		ignoreInitial: true
-	};
+		if (options.safe) {
+			chokidarOptions.awaitWriteFinish = {
+				stabilityThreshold: 500,
+				pollInterval: 100
+			};
+		}
 
-	if (options.safe) {
-		chokidarOptions.awaitWriteFinish = {
-			stabilityThreshold: 500,
-			pollInterval: 100
-		};
+		chokidar
+			.watch(sources, chokidarOptions)
+			.on('ready', () => sources.forEach(s => {
+				options.silent || console.log('[WATCH]', s);
+			}))
+			.on('add', copy)
+			.on('addDir', copy)
+			.on('change', copy)
+			.on('unlink', remove)
+			.on('unlinkDir', remove)
+			.on('error', e => console.log('[ERROR]', e));
 	}
+}
 
-	chokidar
-		.watch(sources, chokidarOptions)
-		.on('ready', () => sources.forEach(s => {
-			options.silent || console.log('[WATCH]'.yellow, s);
-		}))
-		.on('add', copy)
-		.on('addDir', copy)
-		.on('change', copy)
-		.on('unlink', remove)
-		.on('unlinkDir', remove)
-		.on('error', e => console.log('[ERROR]'.red, e));
+if (require.main === module) {
+	copyAndWatchFn(process.argv)
 }
+
+exports._ui5mainFn = copyAndWatchFn;

package/lib/copy-list/index.js

@@ -1,28 +1,34 @@
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require("path");
-const mkdirp = require("mkdirp");
 
-const fileList = process.argv[2];
-const dest = process.argv[3];
-const src = "../../node_modules/@openui5/sap.ui.core/src/";
+const generate = async (argv) => {
+	const fileList = argv[2];
+	const dest = argv[3];
+	const src = "@openui5/sap.ui.core/src/";
+	const filesToCopy = (await fs.readFile(fileList)).toString();
+	// console.log(filesToCopy);
 
-const filesToCopy = fs.readFileSync(fileList).toString();
-// console.log(filesToCopy);
+	// Support full-line comments starting with # in the used-modules.txt file
+	const shouldCopy = file => file.length && !file.startsWith("#");
 
-// Support full-line comments starting with # in the used-modules.txt file
-const shouldCopy = file => file.length && !file.startsWith("#");
+	const trimFile = file => file.trim();
 
-const trimFile = file => file.trim();
+	const promises = filesToCopy.split("\n").map(trimFile).filter(shouldCopy).map(async moduleName => {
+		const srcPath = require.resolve(path.join(src, moduleName), { paths: [process.cwd()] });
+		const destPath = path.join(dest, moduleName);
 
-filesToCopy.split("\n").map(trimFile).filter(shouldCopy).forEach(async moduleName => {
-	const srcPath = path.join(src, moduleName);
-	const destPath = path.join(dest, moduleName);
+		await fs.mkdir(path.dirname(destPath), { recursive: true });
+		return fs.copyFile(srcPath, destPath);
+	});
 
-	await mkdirp(path.dirname(destPath));
-    fs.copyFile(srcPath, destPath, (err) => {
-    	if (err) {
-    		throw err;
-		}
-		console.log(`${destPath} created.`);
+	return Promise.all(promises).then(() => {
+		console.log("Files copied.");
 	});
-});
+};
+
+
+if (require.main === module) {
+	generate(process.argv)
+}
+
+exports._ui5mainFn = generate;

package/lib/create-icons/index.js

@@ -1,72 +1,131 @@
-const fs = require("fs");
-const path = require("path");
-const mkdirp = require("mkdirp");
-
-const collectionName = process.argv[2] || "SAP-icons";
-const collectionVersion = process.argv[3];
-const srcFile = collectionVersion ? path.normalize(`src/${collectionVersion}/${collectionName}.json`) : path.normalize(`src/${collectionName}.json`);
-const destDir = collectionVersion ? path.normalize(`dist/${collectionVersion}/`) : path.normalize("dist/");
-
-mkdirp.sync(destDir);
-
-const iconTemplate = (name, pathData, ltr, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
-
-const name = "${name}";
-const pathData = "${pathData}";
-const ltr = ${ltr};
-const collection = "${collection}";
-const packageName = "${packageName}";
-
-registerIcon(name, { pathData, ltr, collection, packageName });
-
-export default { pathData };`;
-
-
-const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
-import { ${accData.key} } from "../generated/i18n/i18n-defaults.js";
-
-const name = "${name}";
-const pathData = "${pathData}";
-const ltr = ${ltr};
-const accData = ${accData.key};
-const collection = "${collection}";
-const packageName = "${packageName}";
-
-registerIcon(name, { pathData, ltr, accData, collection, packageName });
-
-export default { pathData, accData };`;
-
-
-
-const collectionTemplate = (name) => `import { isThemeFamily } from "@ui5/webcomponents-base/dist/config/Theme.js";
-import pathDataV4 from "./v5/${name}.js";
-import pathDataV5 from "./v4/${name}.js";
-const pathData = isThemeFamily("sap_horizon") ? pathDataV5 : pathDataV4;
-export default { pathData };`;
-
-
-const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
-	<path d="${pathData}"/>
-</svg>`;
-
-const createIcons = (file) => {
-	const json = JSON.parse(fs.readFileSync(file));
-
-	for (let name in json.data) {
-		const iconData = json.data[name];
-		const pathData = iconData.path;
-		const ltr = !!iconData.ltr;
-		const acc = iconData.acc;
-
-		const content = acc ? iconAccTemplate(name, pathData, ltr, acc, json.collection, json.packageName) : iconTemplate(name, pathData, ltr, json.collection, json.packageName);
-
-		fs.writeFileSync(path.join(destDir, `${name}.js`), content);
-		fs.writeFileSync(path.join(destDir, `${name}.svg`), svgTemplate(pathData));
-
-		if (json.version) {
-			fs.writeFileSync(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name));
-		}
-	}
-};
-
-createIcons(srcFile);
+const fs = require("fs").promises;
+const path = require("path");
+
+const iconTemplate = (name, pathData, ltr, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
+
+const name = "${name}";
+const pathData = "${pathData}";
+const ltr = ${ltr};
+const accData = null;
+const collection = "${collection}";
+const packageName = "${packageName}";
+
+registerIcon(name, { pathData, ltr, collection, packageName });
+
+export default "${collection}/${name}";
+export { pathData, ltr, accData };`;
+
+
+const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName, versioned) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
+import { ${accData.key} } from "${versioned ? "../" : "./"}generated/i18n/i18n-defaults.js";
+
+const name = "${name}";
+const pathData = "${pathData}";
+const ltr = ${ltr};
+const accData = ${accData.key};
+const collection = "${collection}";
+const packageName = "${packageName}";
+
+registerIcon(name, { pathData, ltr, accData, collection, packageName });
+
+export default "${collection}/${name}";
+export { pathData, ltr, accData };`;
+
+
+
+const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamilyAsync } from "@ui5/webcomponents-base/dist/config/Theme.js";
+import { pathData as pathData${versions[0]}, ltr, accData } from "./${versions[0]}/${name}.js";
+import { pathData as pathData${versions[1]} } from "./${versions[1]}/${name}.js";
+
+const getPathData = async() => {
+	return await isLegacyThemeFamilyAsync() ? pathDatav4 : pathDatav5;
+};
+
+export default "${fullName}";
+export { getPathData, ltr, accData };`;
+
+
+const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
+declare const ltr: boolean;
+declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
+declare const _default: "${collection}/${name}";
+
+export default _default;
+export { pathData, ltr, accData };`
+
+const collectionTypeDefinitionTemplate = (name, accData) => `declare const getPathData: () => Promise<string>;
+declare const ltr: boolean;
+declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
+declare const _default: "${name}";
+
+export default _default;
+export { getPathData, ltr, accData };`
+
+
+const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
+	<path d="${pathData}"/>
+</svg>`;
+
+const createIcons = async (argv) => {
+	const collectionName = argv[2] || "SAP-icons-v4";
+	const collectionVersion = argv[3];
+	const srcFile = collectionVersion ? path.normalize(`src/${collectionVersion}/${collectionName}.json`) : path.normalize(`src/${collectionName}.json`);
+	const destDir = collectionVersion ? path.normalize(`dist/${collectionVersion}/`) : path.normalize("dist/");
+	await fs.mkdir(destDir, { recursive: true });
+
+	const json = JSON.parse(await fs.readFile(srcFile));
+
+	const promises = [];
+	for (let name in json.data) {
+		const iconData = json.data[name];
+		const pathData = iconData.path;
+		const ltr = !!iconData.ltr;
+		const acc = iconData.acc;
+		const packageName = json.packageName;
+		const collection = json.collection;
+		const versioned = json.version;
+
+		const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName, versioned) : iconTemplate(name, pathData, ltr, collection, packageName);
+
+		promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
+		promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
+		promises.push(fs.writeFile(path.join(destDir, `${name}.d.ts`), typeDefinitionTemplate(name, acc, collection)));
+
+		// For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
+		// For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
+		// - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
+		// - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
+
+		if (versioned) {
+			// The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
+			// to add or not the collection name to the exported value:
+			// For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
+			// For non-default collections (SAPTNTIcons and SAPBSIcons) we export the full name - "export default { 'tnt/actor' }"
+			const effectiveName = isDefaultCollection(collection) ? name : getUnversionedFullIconName(name, collection);
+			promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name, json.versions, effectiveName)));
+			promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
+		}
+	}
+
+	return Promise.all(promises)
+		.then(() => {
+			console.log("Icons created.");
+		});
+};
+
+const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4" || collectionName === "SAP-icons-v5";
+const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
+const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
+
+const CollectionVersionedToUnversionedMap = {
+	"tnt-v2": "tnt",
+	"tnt-v3": "tnt",
+	"business-suite-v1": "business-suite",
+	"business-suite-v2": "business-suite",
+};
+
+if (require.main === module) {
+	createIcons(process.argv)
+}
+
+exports._ui5mainFn = createIcons;