Version 2.6.0

GitOrigin-RevId: 8e9dbb3acb16b0be3eb4047cf2a62c23aaba6374

Author: Interfaced

.eslintrc.js

@@ -63,7 +63,8 @@ module.exports = {
 			],
 			extends: 'interfaced/node',
 			rules: {
-				'jsdoc/no-undefined-types': "off" // Introduces circular dependencies
+				'jsdoc/no-undefined-types': 'off', // Introduces circular dependencies
+				'no-console': 'error' // Winston logger should be used for output
 			}
 		},
 		{

CHANGELOG.md

@@ -1,10 +1,20 @@
 # Change log
 
+## 2.6.0 (release date: 03.02.2020)
+
+### Tools
+* Build process was refactored, CLI commands and Platform API were affected. See [migrations/2.5.0.md](./docs/migrations/2.5.0.md) for more details.
+  * `zb build` now only accepts one platform and can't build for several at once.
+  * `AbstractPlatform.buildApp` method is deprecated in favor of `AbstractPlatform.pack`.
+  * Include entities now only get included in build for the platform that specified them. 
+* Console output and logging was improved and now can be controlled with `--log-level` or `-l` flag, see `zb --help`. 
+* `generated/package-info` was removed.
+
 ## 2.5.0 (release date 23.01.2020)
 
 ### Framework
 * ENTER key events caused by mouse clicks now no longer propagates down widget tree.
-* generated/package-info was deprecated and several defines were introduced to replace it. See [migrations/2.5.0.md](./docs/migrations/2.5.0.md) for more details.
+* `generated/package-info` was deprecated and several defines were introduced to replace it. See [migrations/2.5.0.md](./docs/migrations/2.5.0.md) for more details.
 * Version checker will now tolerate prerelease versions.
 
 ### Tools

bin/cli.js

@@ -16,6 +16,8 @@ const {findPackageJson} = require('../lib/utils');
 const Application = require('../lib/application');
 const TemplateHelper = require('../lib/template-helper');
 const Scaffolding = require('../lib/scaffolding');
+const {rootLogger, createChild} = require('../lib/logger');
+const logger = createChild('CLI');
 
 
 /**
@@ -40,6 +42,7 @@ class CLI {
 				if (this._application) {
 					locations = locations.concat(this._application.getPathHelper().getTemplateLocations());
 				}
+				logger.silly(`Template locations: \n\t${locations.join('\n\t')}`);
 				return locations;
 			}
 		);
@@ -57,6 +60,7 @@ class CLI {
 	 * Prepare app and start developer mode HTTP server.
 	 */
 	run() {
+		logger.verbose(`Starting dev server`);
 		this._assertApplication();
 
 		this._application.ready()
@@ -67,31 +71,41 @@ class CLI {
 	 * Build code and exit
 	 */
 	buildCode() {
+		logger.verbose(`Building generated application code`);
 		this._assertApplication();
 
 		this._application.ready()
 			.then(() => this._application.buildCode());
 	}
 
 	/**
-	 * @param {Array<string>} targets Platform names.
+	 * @param {string} target Platform name
 	 */
-	build(targets) {
+	build(target) {
+		logger.verbose(`Building application for ${target}`);
 		this._assertApplication();
 
-		const platformsToCompile = this._application.getPlatforms().filter((platform) =>
-			targets.includes(platform.getName()) || targets.includes('all')
-		);
+		const platform = this._application.getPlatforms().find((platform) => platform.getName() === target);
 
 		this._application.ready()
-			.then(() => this._application.compile(platformsToCompile));
+			.then(() => this._application.build(platform))
+			.catch((e) => {
+				if (e instanceof Error) {
+					logger.error(e.toString());
+					logger.debug(e.stack);
+				} else {
+					logger.error(e);
+				}
+				process.exit(2);
+			});
 	}
 
 	/**
 	 * @param {string} name
 	 * @param {string} path
 	 */
 	addScene(name, path) {
+		logger.verbose(`Generating scene ${name} at ${path}`);
 		this._assertApplication();
 
 		const appName = this._application.getConfig().project.name;
@@ -103,6 +117,7 @@ class CLI {
 	 * @param {string} path
 	 */
 	addPopup(name, path) {
+		logger.verbose(`Generating popup ${name} at ${path}`);
 		this._assertApplication();
 
 		const appName = this._application.getConfig().project.name;
@@ -114,6 +129,7 @@ class CLI {
 	 * @param {string} path
 	 */
 	addWidget(name, path) {
+		logger.verbose(`Generating widget ${name} at ${path}`);
 		this._assertApplication();
 
 		const appName = this._application.getConfig().project.name;
@@ -124,6 +140,7 @@ class CLI {
 	 * @param {string} target
 	 */
 	generateAliases(target) {
+		logger.verbose(`Generating aliases map in ${target}`);
 		this._assertApplication();
 
 		this._application.ready().then(() => {
@@ -133,14 +150,16 @@ class CLI {
 			for (const [key, value] of this._application.getAliases()) {
 				map[key] = value;
 			}
+
+			logger.debug(`Aliases: \n${JSON.stringify(map, null, '\t')}`);
 			const content = this._templateHelper.render('webpack.config.js.tpl', {map});
 
 			fs.writeFile(filename, content, 'utf8', (error) => {
 				if (error) {
-					console.error('Error writing aliases map:', error.message);
+					logger.error(`Error writing aliases map: ${error.message}`);
 					process.exit(1);
 				} else {
-					console.log('Aliases map generated in', chalk.cyan(filename));
+					logger.output(`Aliases map generated in ${chalk.underline(filename)}`);
 				}
 			});
 		});
@@ -154,28 +173,39 @@ class CLI {
 		/* eslint-disable newline-per-chained-call */
 		yargs
 			.array('config').default('config', [])
-			.array('addon').default('addon', []);
+			.array('addon').default('addon', [])
+			.string('log-level')
+			.alias('log-level', 'l')
+			.default('log-level', 'info')
+			.choices('log-level', Object.keys(logger.levels));
+
+		rootLogger.level = yargs.argv.logLevel;
 
 		// @see {https://github.com/yargs/yargs/issues/1336}
 		const configs = Array.isArray(yargs.argv.config) ?
 			yargs.argv.config.reduce((flat, value) => flat.concat(value), []) :
 			[yargs.argv.config];
 
 		const app = this._createApplication(configs, yargs.argv.addon);
-		const buildTargets = ['all'];
+		const buildTargets = [];
 		let projectConfig = null;
 
 		if (app) {
 			projectConfig = app.getConfig().project;
-			app.getPlatforms()
-				.forEach((platform) => {
-					buildTargets.push(platform.getName());
-					yargs.command(
-						platform.getName(),
-						`${platform.getName()} platform CLI commands`,
-						(yargs) => platform.buildCLI(yargs, app)
-					);
-				});
+			const platforms = app.getPlatforms();
+
+			logger.silly(`Application supports platforms: ${platforms.map((p) => p.getName()).join(', ')}`);
+
+			platforms.forEach((platform) => {
+				buildTargets.push(platform.getName());
+				yargs.command(
+					platform.getName(),
+					`${platform.getName()} platform CLI commands`,
+					(yargs) => platform.buildCLI(yargs, app)
+				);
+			});
+		} else {
+			logger.debug(`Application was not created, running without it`);
 		}
 
 		return yargs
@@ -193,11 +223,11 @@ class CLI {
 			)
 			.command('buildCode', 'Generate lifecycle code', (yargs) => this.buildCode(yargs))
 			.command(
-				'build <platform..>',
-				'Build artifact for one or several platforms',
+				'build <platform>',
+				'Build artifact for specific platform',
 				(yargs) => {
 					yargs.positional('platform', {
-						describe: 'platform name(s)',
+						describe: 'platform name',
 						choices: buildTargets
 					});
 				},
@@ -277,13 +307,13 @@ class CLI {
 	 * @protected
 	 */
 	init(name, root) {
-		const data = {
-			name
-		};
+		logger.verbose(`Creating boilerplate application "${name}" in ${root}`);
 
-		this._templateHelper.renderDir('boilerplate', root, data);
+		this._templateHelper.renderDir('boilerplate', root, {
+			name
+		});
 
-		console.log(`Boilerplate ZombieBox application ${name} created at`, root);
+		logger.output(`Boilerplate ZombieBox application "${name}" created at ${root}`);
 	}
 
 	/**
@@ -297,11 +327,19 @@ class CLI {
 			return this._application;
 		}
 
+		logger.silly(
+			`Trying to instantiate Application` +
+			(rawConfigs.length ? `\n\tConfigs: ${rawConfigs.join(', ')}` : '') +
+			(rawAddons.length ? `\n\tAddons: ${rawAddons.join(', ')}` : '')
+		);
+
 		const packageJson = findPackageJson(
 			process.cwd(),
 			(packageJson) => packageJson.dependencies && packageJson.dependencies.hasOwnProperty('zombiebox')
 		);
 
+		logger.debug(`Application package.json path: ${chalk.underline(packageJson)}`);
+
 		if (!packageJson) {
 			return null;
 		}
@@ -318,8 +356,11 @@ class CLI {
 		try {
 			this._application = new Application(path.dirname(packageJson), configs, addons);
 		} catch (e) {
-			console.error(e.message);
-			console.warn('Failed to create ZombieBox Application instance. CLI functionality will be limited');
+			logger.warn(
+				`Could not create Application instance, ` +
+				`CLI commands that require it will not work: ${e.toString()}`
+			);
+			logger.debug(e.stack);
 		}
 		return this._application;
 	}
@@ -329,7 +370,7 @@ class CLI {
 	 */
 	_assertApplication() {
 		if (!this._application) {
-			console.error('Could not find ZombieBox application');
+			logger.error('Cannot execute this command without application');
 			process.exit(1);
 		}
 	}

docs/migrations/2.6.0.md

@@ -0,0 +1,19 @@
+# Version 2.6.0
+
+## `zb build` CLI command
+
+`zb build` no longer accepts a list of platforms or a special argument `all`. Invoke this command several times to compile for several platforms.
+
+I.e. instead of `zb build tizen webos` use `zb build tizen` followed by `zb build webos`.
+
+## `AbstractPlatform.pack`
+
+`AbstractPlatform.pack` is meant to repalce `AbstractPlatform.buildApp`. The difference is that the new method is invoked after application `index.html` and static files were processed and only needs to pack them into platform artifact and does not need to call `BuildHelper` methods to build html application.
+
+To migrate, platforms should replace `buildApp` implementation with `pack`, remove calls to `writeIndexHTML` and `copyStaticFiles`, assume `index.html` and all the necessary files already exist in build dir and proceed with platform-specific processing and packaging an artifact.
+ 
+ No migration should be necessary for application as the changes are backwards compatible, albeit this requires running compilation twice.
+
+## `generated/package-info` removal
+
+`generated/package-info` was properly removed following its deprecation in 2.5.0. See 2.5.0 [migration guide](./2.5.0.md).

lib/addons/abstract-platform.js

@@ -16,6 +16,7 @@ const Application = require('../application');
 class AbstractPlatform extends AbstractAddon {
 	/**
 	 * Build application in given dir.
+	 * @deprecated
 	 * @abstract
 	 * @param {Application} application
 	 * @param {string} distDir
@@ -24,6 +25,17 @@ class AbstractPlatform extends AbstractAddon {
 	buildApp(application, distDir) {
 		throw new Error(`AbstractPlatform.buildApp is not implemented in ${this.getName()}`);
 	}
+
+	/**
+	 * Packages application that was built in distDir
+	 * @abstract
+	 * @param {Application} application
+	 * @param {string} distDir
+	 * @return {Promise}
+	 */
+	async pack(application, distDir) {
+		throw new Error(`AbstractPlatform.pack is not implemented in ${this.getName()}`);
+	}
 }
 
 

lib/addons/loader.js

@@ -14,6 +14,7 @@ const {findPackageJson} = require('../utils');
 const AbstractAddon = require('./abstract-addon');
 const AbstractPlatform = require('./abstract-platform');
 const AbstractExtension = require('./abstract-extension');
+const logger = require('../logger').createChild('AddonLoader');
 
 /* eslint-disable global-require */
 
@@ -73,16 +74,21 @@ class AddonLoader {
 	 * @param {Object} packageJson
 	 */
 	loadFromPackageJson(packageJson) {
-		Object.keys(packageJson['dependencies'] || {})
-			.filter((packageName) => packageName.startsWith(PACKAGE_PREFIX))
-			.map((packageName) => this._resolvePackagePath(packageName))
+		const dependencies = Object.keys(packageJson['dependencies'] || {})
+			.filter((packageName) => packageName.startsWith(PACKAGE_PREFIX));
+
+		logger.debug(`Addons found in package.json: \n\t${dependencies.join('\n\t')}`);
+
+		dependencies.map((packageName) => this._resolvePackagePath(packageName))
 			.forEach((packagePath) => this.loadAddon(packagePath));
 	}
 
 	/**
 	 * @param {string} addonPath
 	 */
 	loadAddon(addonPath) {
+		logger.debug(`Loading addon from ${chalk.underline(addonPath)}`);
+
 		const Addon = require(addonPath);
 
 		const addon = /** @type {AbstractAddon} */ (new Addon());
@@ -109,11 +115,11 @@ class AddonLoader {
 		this._loadedAddons.push({instance: addon, packageJson});
 
 		const type =
-			addon instanceof AbstractPlatform ? 'Platform' :
-				addon instanceof AbstractExtension ? 'Extension' :
-					'Addon';
+			addon instanceof AbstractPlatform ? 'platform' :
+				addon instanceof AbstractExtension ? 'extension' :
+					'addon';
 
-		console.log(`${type} ${chalk.green(addon.getName())} loaded`);
+		logger.info(`Loaded ${type} ${chalk.green(addon.getName())}`);
 	}
 
 	/**