hyperloop-init.js

'use strict';

const fs = require('fs');
const path = require('path');

exports.id = 'com.appcelerator.hyperloop.init';
exports.cliVersion = '>=3.2';
exports.init = (logger, config, cli, appc) => {
	cli.on('cli:check-plugins', () => {
		if (!Array.isArray(cli.tiapp.plugins)) {
			return;
		}

		for (const plugin of cli.tiapp.plugins) {
			if (plugin.id === 'hyperloop') {
				logger.error('Legacy Hyperloop plugin detected! Please remove any references to the Hyperloop "<plugin>" tag from your tiapp.xml. Since Hyperloop 3.0 you only need to enable it as a module.');
				process.exit(1);
			}
		}
	});
	cli.on('build.pre.compile', {
		priority: 1300,
		post: (builder, callback) => {
			const factory = new HyperloopBuilderFactory(logger, config, cli, appc, builder);
			const instance = factory.createHyperloopBuilder();
			instance.init(callback);
		}
	});
};

/**
 * Simple factory that creates the platform specific Hyperloop builder instances.
 */
class HyperloopBuilderFactory {
	/**
	 * Constructs a new factory.
	 *
	 * @param {Object} logger - Appc logger instance
	 * @param {Object} config - Config object
	 * @param {Object} cli - Appc cli instance
	 * @param {Object} appc - Appc common node library
	 * @param {Object} builder - App builder for the current platform
	 */
	constructor(logger, config, cli, appc, builder) {
		this.logger = logger;
		this.config = config;
		this.cli = cli;
		this.appc = appc;
		this.builder = builder;
	}

	/**
	 * Creates a new Hyperloop builder for the current platform.
	 *
	 * @return {Object} Hyperloop builder instance
	 */
	createHyperloopBuilder() {
		const hyperloopConfig = this.loadConfiguration();
		const platformHookFile = path.join(__dirname, 'hyperloop.js');

		if (!fs.existsSync(platformHookFile)) {
			this.logger.error(`Hyperloop builder not found at expected path ${platformHookFile}.`);
			process.exit(1);
		}

		var Builder = require(platformHookFile);
		return new Builder(this.logger, this.config, this.cli, this.appc, hyperloopConfig, this.builder);
	}

	/**
	 * Loads Hyperloop specific configuration from available appc.js files.
	 *
	 * @return {Object} Object with loaded config values
	 */
	loadConfiguration() {
		const possibleConfigurationFiles = [
			path.join(this.builder.projectDir, 'appc.js'),
			path.join(this.builder.projectDir, '.appc.js'),
			path.join(process.env.HOME || process.env.USERPROFILE, '.appc.js')
		];
		let config = {};

		for (let configurationFile of possibleConfigurationFiles) {
			if (fs.existsSync(configurationFile)) {
				this.mergeObjectProperties(config, require(configurationFile));
			}
		}

		return config.hyperloop || {};
	}

	/**
	 * Merges two objects in a non-recursive way, replacing only the top level
	 * properties.
	 *
	 * @param {Object} target - Target object where the values will be copied to
	 * @param {[type]} source - Source object where the property value will be taken from
	 */
	mergeObjectProperties(target, source) {
		if (!source) {
			return;
		}

		for (const propertyName in source) {
			if (source.hasOwnProperty(propertyName)) {
				target[propertyName] = source[propertyName];
			}
		}
	}
}