Add support for different templates

Add support for --template option when creating new project.
The value for `--template` can be anything that you can `npm install`. For example valid calls are:
* `tns create app1 --template tns-template-hello-world`
* `tns create app1 --template https://github.com/NativeScript/template-hello-world-ts/tarball/master`
* `tns create app1 --template ../myTemplate`

In case you use:
`tns create app1 --template typescript` or `tns create app1 --template tsc`, CLI will try to install `tns-template-hello-world-ts` template.
In case you use `tns create app1 --template [email protected]` we will install version 1.2.0 of `tns-template-hello-world-ts`.

When a custom template is used, CLI will extend its App_Resources with the ones from default template in case any of them is missing.

Author: rosen-vladimirov

lib/commands/create-project.ts

@@ -26,13 +26,14 @@ export class CreateProjectCommand implements ICommand {
 	constructor(private $projectService: IProjectService,
 		private $errors: IErrors,
 		private $logger: ILogger,
-		private $projectNameValidator: IProjectNameValidator) { }
+		private $projectNameValidator: IProjectNameValidator,
+		private $options: ICommonOptions) { }
 
 	public enableHooks = false;
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
-			this.$projectService.createProject(args[0]).wait();
+			this.$projectService.createProject(args[0], this.$options.template).wait();
 		}).future<void>()();
 	}
 

lib/common

@@ -1,6 +1,6 @@
 
 interface IProjectService {
-	createProject(projectName: string): IFuture<void>;
+	createProject(projectName: string, selectedTemplate?: string): IFuture<void>;
 }
 
 interface IProjectData {
@@ -22,8 +22,24 @@ interface IProjectDataService {
 	removeDependency(dependencyName: string): IFuture<void>;
 }
 
+/**
+ * Describes working with templates.
+ */
 interface IProjectTemplatesService {
+	/**
+	 * Defines the path where unpacked default template can be found.
+	 */
 	defaultTemplatePath: IFuture<string>;
+
+	/**
+	 * Prepares template for project creation.
+	 * In case templateName is not provided, use defaultTemplatePath.
+	 * In case templateName is a special word, validated from us (for ex. typescript), resolve the real template name and add it to npm cache.
+	 * In any other cases try to `npm install` the specified templateName to temp directory.
+	 * @param {string} templateName The name of the template.
+	 * @return {string} Path to the directory where extracted template can be found.
+	 */
+	prepareTemplate(templateName: string): IFuture<string>;
 }
 
 interface IPlatformProjectServiceBase {

lib/definitions/project.d.ts

@@ -18,7 +18,8 @@ export class NpmInstallationManager implements INpmInstallationManager {
 	private packageSpecificDirectories: IStringDictionary = {
 		"tns-android": constants.PROJECT_FRAMEWORK_FOLDER_NAME,
 		"tns-ios": constants.PROJECT_FRAMEWORK_FOLDER_NAME,
-		"tns-template-hello-world": constants.APP_RESOURCES_FOLDER_NAME
+		"tns-template-hello-world": constants.APP_RESOURCES_FOLDER_NAME,
+		"tns-template-hello-world-ts": constants.APP_RESOURCES_FOLDER_NAME
 	};
 
 	constructor(private $npm: INodePackageManager,

lib/npm-installation-manager.ts

@@ -4,7 +4,7 @@
 import * as constants from "../constants";
 import * as osenv from "osenv";
 import * as path from "path";
-import * as shell from "shelljs";
+import * as shelljs from "shelljs";
 
 export class ProjectService implements IProjectService {
 
@@ -18,7 +18,7 @@ export class ProjectService implements IProjectService {
 		private $projectTemplatesService: IProjectTemplatesService,
 		private $options: IOptions) { }
 
-	public createProject(projectName: string): IFuture<void> {
+	public createProject(projectName: string, selectedTemplate?: string): IFuture<void> {
 		return(() => {
 			if (!projectName) {
 				this.$errors.fail("You must specify <App name> when creating a new project.");
@@ -51,7 +51,6 @@ export class ProjectService implements IProjectService {
 
 			let appDirectory = path.join(projectDir, constants.APP_FOLDER_NAME);
 			let appPath: string = null;
-
 			if (customAppPath) {
 				this.$logger.trace("Using custom app from %s", customAppPath);
 
@@ -68,25 +67,69 @@ export class ProjectService implements IProjectService {
 				this.$logger.trace("Copying custom app into %s", appDirectory);
 				appPath = customAppPath;
 			} else {
-				// No custom app - use nativescript hello world application
-				this.$logger.trace("Using NativeScript hello world application");
-				let defaultTemplatePath = this.$projectTemplatesService.defaultTemplatePath.wait();
-				this.$logger.trace("Copying NativeScript hello world application into %s", appDirectory);
+				let defaultTemplatePath = this.$projectTemplatesService.prepareTemplate(selectedTemplate).wait();
+				this.$logger.trace(`Copying application from '${defaultTemplatePath}' into '${appDirectory}'.`);
 				appPath = defaultTemplatePath;
 			}
 
 			try {
 				this.createProjectCore(projectDir, appPath, projectId).wait();
+				//update dependencies and devDependencies of newly created project with data from template
+				this.mergeProjectAndTemplateProperties(projectDir, appPath).wait();
+				this.updateAppResourcesDir(appDirectory).wait();
 			} catch (err) {
 				this.$fs.deleteDirectory(projectDir).wait();
 				throw err;
 			}
-
 			this.$logger.out("Project %s was successfully created", projectName);
 
 		}).future<void>()();
 	}
 
+	private mergeProjectAndTemplateProperties(projectDir: string, templatePath: string): IFuture<any> {
+		return ((): any => {
+			let projectPackageJsonPath = path.join(projectDir, constants.PACKAGE_JSON_FILE_NAME);
+			let projectPackageJsonData = this.$fs.readJson(projectPackageJsonPath).wait();
+			this.$logger.trace("Initial project package.json data: ", projectPackageJsonData);
+			let templatePackageJsonData = this.$fs.readJson(path.join(templatePath, constants.PACKAGE_JSON_FILE_NAME)).wait();
+			if(projectPackageJsonData.dependencies || templatePackageJsonData.dependencies) {
+				projectPackageJsonData.dependencies = this.mergeDependencies(projectPackageJsonData.dependencies, templatePackageJsonData.dependencies);
+			}
+
+			if(projectPackageJsonData.devDependencies || templatePackageJsonData.devDependencies) {
+				projectPackageJsonData.devDependencies = this.mergeDependencies(projectPackageJsonData.devDependencies, templatePackageJsonData.devDependencies);
+			}
+
+			this.$logger.trace("New project package.json data: ", projectPackageJsonData);
+			this.$fs.writeJson(projectPackageJsonPath, projectPackageJsonData).wait();
+		}).future<any>()();
+	}
+
+	private updateAppResourcesDir(appDirectory: string): IFuture<any> {
+		return ((): any => {
+			let defaultAppResourcesDir = path.join(this.$projectTemplatesService.defaultTemplatePath.wait(), constants.APP_RESOURCES_FOLDER_NAME);
+			let targetAppResourcesDir = path.join(appDirectory, constants.APP_RESOURCES_FOLDER_NAME);
+			this.$logger.trace(`Updating AppResources values from ${defaultAppResourcesDir} to ${targetAppResourcesDir}`);
+			(<any>shelljs).config.silent = true;
+			shelljs.cp("-R", path.join(defaultAppResourcesDir, "*"), targetAppResourcesDir);
+		}).future<any>()();
+	}
+
+	private mergeDependencies(projectDependencies: IStringDictionary, templateDependencies: IStringDictionary): IStringDictionary {
+		// Cast to any when logging as logger thinks it can print only string.
+		// Cannot use toString() because we want to print the whole objects, not [Object object]
+		this.$logger.trace("Merging dependencies, projectDependencies are: ", <any>projectDependencies, " templateDependencies are: ", <any>templateDependencies);
+		projectDependencies = projectDependencies || {};
+		_.extend(projectDependencies, templateDependencies || {});
+		let sortedDeps: IStringDictionary = {};
+		let dependenciesNames = _.keys(projectDependencies).sort();
+		_.each(dependenciesNames, (key: string) => {
+			sortedDeps[key] = projectDependencies[key];
+		});
+		this.$logger.trace("Sorted merged dependencies are: ", <any>sortedDeps);
+		return sortedDeps;
+	}
+
 	private createProjectCore(projectDir: string, appSourcePath: string, projectId: string): IFuture<void> {
 		return (() => {
 			this.$fs.ensureDirectoryExists(projectDir).wait();
@@ -97,7 +140,7 @@ export class ProjectService implements IProjectService {
 			if(this.$options.symlink) {
 				this.$fs.symlink(appSourcePath, appDestinationPath).wait();
 			} else {
-				shell.cp('-R', path.join(appSourcePath, "*"), appDestinationPath);
+				shelljs.cp('-R', path.join(appSourcePath, "*"), appDestinationPath);
 			}
 
 			this.createBasicProjectStructure(projectDir,  projectId).wait();

lib/services/project-service.ts

@@ -1,13 +1,87 @@
 ///<reference path="../.d.ts"/>
 "use strict";
+import * as path from "path";
+import * as temp from "temp";
+import * as constants from "../constants";
+temp.track();
 
 export class ProjectTemplatesService implements IProjectTemplatesService {
 	private static NPM_DEFAULT_TEMPLATE_NAME = "tns-template-hello-world";
+	private static RESERVED_TEMPLATE_NAMES: IStringDictionary = {
+		"typescript": "tns-template-hello-world-ts",
+		"tsc": "tns-template-hello-world-ts"
+	};
 
-	public constructor(private $npmInstallationManager: INpmInstallationManager) { }
+	public constructor(private $errors: IErrors,
+						private $fs: IFileSystem,
+						private $logger: ILogger,
+						private $npm: INodePackageManager,
+						private $npmInstallationManager: INpmInstallationManager) { }
 
 	public get defaultTemplatePath(): IFuture<string> {
-		return this.$npmInstallationManager.install(ProjectTemplatesService.NPM_DEFAULT_TEMPLATE_NAME);
+		return this.prepareNativeScriptTemplate(ProjectTemplatesService.NPM_DEFAULT_TEMPLATE_NAME);
+	}
+
+	public prepareTemplate(originalTemplateName: string): IFuture<string> {
+		return ((): string => {
+			if(!originalTemplateName) {
+				return this.defaultTemplatePath.wait();
+			}
+
+			let templateName = originalTemplateName.toLowerCase();
+
+			// support <resreved_name>@<version> syntax
+			let [name, version] = templateName.split("@");
+			if(ProjectTemplatesService.RESERVED_TEMPLATE_NAMES[name]) {
+				return this.prepareNativeScriptTemplate(ProjectTemplatesService.RESERVED_TEMPLATE_NAMES[name], version).wait();
+			}
+
+			let tempDir = temp.mkdirSync("nativescript-template-dir");
+			try {
+				this.$npm.install(templateName, tempDir, {production: true, silent: true}).wait();
+			} catch(err) {
+				this.$logger.trace(err);
+				this.$errors.failWithoutHelp(`Unable to use template ${originalTemplateName}. Make sure you've specified valid name, github URL or path to local dir.` +
+											` Error is: ${err.message}.`);
+			}
+
+			let tempDirContents = this.$fs.readDirectory(tempDir).wait();
+			let realTemplatePath: string;
+			// We do not know the name of the package that will be installed, so after installation to temp dir, there should be node_modules dir there and its only subdir should be our package.
+			// In case there's some other dir instead of node_modules, consider it as our package.
+			if(tempDirContents && tempDirContents.length === 1) {
+				let tempDirSubdir = _.first(tempDirContents);
+				if(tempDirSubdir === constants.NODE_MODULES_FOLDER_NAME) {
+					let templateDirName = _.first(this.$fs.readDirectory(path.join(tempDir, constants.NODE_MODULES_FOLDER_NAME)).wait());
+					if(templateDirName) {
+						realTemplatePath = path.join(tempDir, tempDirSubdir, templateDirName);
+					}
+				} else {
+					realTemplatePath = path.join(tempDir, tempDirSubdir);
+				}
+			}
+
+			if(realTemplatePath) {
+				this.$fs.deleteDirectory(path.join(realTemplatePath, constants.NODE_MODULES_FOLDER_NAME)).wait();
+				return realTemplatePath;
+			}
+
+			this.$errors.failWithoutHelp("Unable to find the template in temp directory. " +
+				`Please open an issue at https://github.com/NativeScript/nativescript-cli/issues and send the output of the same command executed with --log trace.`);
+		}).future<string>()();
+	}
+
+	/**
+	 * Install verified NativeScript template in the npm cache.
+	 * The "special" here is that npmInstallationManager will check current CLI version and will instal best matching version of the template.
+	 * For example in case CLI is version 10.12.8, npmInstallationManager will try to find latest 10.12.x version of the template.
+	 * @param {string} templateName The name of the verified NativeScript template.
+	 * @param {string} version The version of the template specified by user.
+	 * @return {string} Path to the directory where the template is installed.
+	 */
+	private prepareNativeScriptTemplate(templateName: string, version?: string): IFuture<string> {
+		this.$logger.trace(`Using NativeScript verified template: ${templateName} with version ${version}.`);
+		return this.$npmInstallationManager.install(templateName, version);
 	}
 }
 $injector.register("projectTemplatesService", ProjectTemplatesService);

lib/services/project-templates-service.ts

@@ -386,6 +386,10 @@ export class ProjectTemplatesService implements IProjectTemplatesService {
 	get defaultTemplatePath(): IFuture<string> {
 		return Future.fromResult("");
 	}
+
+	prepareTemplate(templateName: string): IFuture<string> {
+		return Future.fromResult("");
+	}
 }
 
 export class HooksServiceStub implements IHooksService {