Merge remote-tracking branch 'origin/master' into tdermendzhiev/objc-source-support

Author: mbektchiev

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!--
+We, the rest of the NativeScript community, thank you for your
+contribution! 
+To help the rest of the community review your change, please follow the instructions in the template.
+-->
+
+<!-- PULL REQUEST TEMPLATE -->
+<!-- (Update "[ ]" to "[x]" to check a box) -->
+
+## PR Checklist
+
+- [ ] The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages.
+- [ ] There is an issue for the bug/feature this PR is for. To avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it.
+- [ ] You have signed the [CLA](http://www.nativescript.org/cla).
+- [ ] All existing tests are passing: https://github.com/NativeScript/nativescript-cli/blob/master/CONTRIBUTING.md#contribute-to-the-code-base
+- [ ] Tests for the changes are included.
+
+## What is the current behavior?
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+## What is the new behavior?
+<!-- Describe the changes. -->
+
+Fixes/Implements/Closes #[Issue Number].
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
+
+<!-- 
+BREAKING CHANGES:
+
+
+[Describe the impact of the changes here.]
+
+Migration steps:
+[Provide a migration path for existing applications.]
+-->
+

CHANGELOG.md

@@ -1,6 +1,29 @@
 NativeScript CLI Changelog
 ================
 
+4.0.0 (2018, April 10)
+==
+
+### New
+* [Implemented #2632](https://github.com/NativeScript/nativescript-cli/issues/2632) Guidance for new CLI users
+* [Implemented #3243](https://github.com/NativeScript/nativescript-cli/issues/3243) 'Scss' file changes trigger app refresh instead reloading the view and apply generated 'css'
+* [Implemented #3248](https://github.com/NativeScript/nativescript-cli/issues/3248) Support JDK_HOME and JAVA_HOME
+* [Implemented #3257](https://github.com/NativeScript/nativescript-cli/issues/3257) Make {N} project structure configurable
+* [Implemented #3317](https://github.com/NativeScript/nativescript-cli/issues/3317) Support livesync with webpack
+* [Implemented #3449](https://github.com/NativeScript/nativescript-cli/pull/3449) Track Vue.js project type
+* [Implemented #3496](https://github.com/NativeScript/nativescript-cli/issues/3496) Generate assets for the mobile application
+* [Implemented #3497](https://github.com/NativeScript/nativescript-cli/issues/3497) Command to migrate Android resources to 4.0.0 structure
+* [Implemented #3516](https://github.com/NativeScript/nativescript-cli/issues/3516) Improve Getting Started Experience
+
+### Fixed
+* [Fixed #3151](https://github.com/NativeScript/nativescript-cli/issues/3151): Install fails if user setting file is not valid json
+* [Fixed #3324](https://github.com/NativeScript/nativescript-cli/issues/3324): Error when iOS simulator's window is closed
+* [Fixed #3442](https://github.com/NativeScript/nativescript-cli/issues/3442): Unnecessary second build upon `tns run android`
+* [Fixed #3451](https://github.com/NativeScript/nativescript-cli/issues/3451): `tns plugin remove` fails with : Cannot convert undefined or null to object
+* [Fixed #3470](https://github.com/NativeScript/nativescript-cli/issues/3470): Error when we are publishing to AppStore
+* [Fixed #3481](https://github.com/NativeScript/nativescript-cli/issues/3481): Cannot log in users on iOS simulator with kinvey-nativescript-sdk
+* [Fixed #3514](https://github.com/NativeScript/nativescript-cli/pull/3514): Incorrect error is shown when xcrun simctl is not configured
+
 3.4.3 (2018, March 02)
 ==
 

PublicAPI.md

@@ -48,6 +48,8 @@ const tns = require("nativescript");
 * [assetsGenerationService](#assetsgenerationservice)
 	* [generateIcons](#generateicons)
 	* [generateSplashScreens](#generatesplashscreens)
+* [androidProcessService](#androidprocessservice)
+	* [getAppProcessId](#getappprocessid)
 
 ## Module projectService
 
@@ -1125,6 +1127,29 @@ tns.assetsGenerationService.generateSplashScreens({ projectDir: "/Users/username
 	});
 ```
 
+## androidProcessService
+The `androidProcessService` exposes methods for getting information about the applications working on Android devices.
+
+### getAppProcessId
+The `getAppProcessId` returns the PID of the specified application. If the app is not running on device, the method will return null.
+
+* Definition
+```TypeScript
+/**
+ * Gets the PID of a running application.
+ * @param deviceIdentifier {string} The identifier of the device.
+ * @param appIdentifier The identifier of the application.
+ * @return {string} Returns the process id matching the application identifier in the device process list.
+ */
+getAppProcessId(deviceIdentifier: string, appIdentifier: string): Promise<string>;
+```
+
+* Usage
+```JavaScript
+tns.androidProcessService.getAppProcessId("4df18f307d8a8f1b", "org.nativescript.demoapp")
+	.then(pid => console.log(`The PID is ${pid}`))
+	.catch(err => console.error(`Error while checking for PID: ${err}`));
+```
 
 
 ## How to add a new method to Public API

docs/man_pages/project/configuration/resources/resources-generate-splashes.md

@@ -6,13 +6,16 @@ position: 12
 
 Usage | Synopsis
 ------|-------
-`$ tns resources generate splashes <Path to image> [<background>]` | Generate all splashscreens for Android and iOS based on the specified image.
+`$ tns resources generate splashes <Path to image> [--background <Color>]` | Generate all splashscreens for Android and iOS based on the specified image.
 
-Generates all icons for Android and iOS platforms and places the generated images in the correct directories under `App_Resources/<platform>` directory.
+Generates all splashscreens for Android and iOS platforms and places the generated images in the correct directories under `App_Resources/<platform>` directory.
+
+### Options
+* `--background` Sets the background color of the splashscreen. Defaults to white in case it is not specified.
 
 ### Attributes
 * `<Path to image>` is a valid path to an image that will be used to generate all splashscreens.
-* `<background>` is a valid path to an image that will be used as a background of the splashscreen. Defaults to white in case it is not specified.
+* `<Color>` is a valid color. It can be represented with string, like `white`, `black`, `blue`, etc. or its HEX representation, for example `#FFFFFF`, `#000000`, `#0000FF`. NOTE: As the `#` is special symbol in some terminals, make sure to place the value in quotes, for example `$ tns resources generate splashes ../myImage.png --background "#FF00FF"`.
 
 <% if(isHtml) { %>
 ### Related Commands

docs/man_pages/project/testing/run-ios.md

@@ -8,8 +8,10 @@ position: 11
 Usage | Synopsis
 ---|---
 Run on all connected devices | `$ tns run ios [--release] [--justlaunch] [--bundle [<value>] [--env.*]]`
-Run on a selected connected device. Will start simulator with specified `Device Identifier`, if not already running. | `$ tns run ios [--device <Device ID>] [--release] [--justlaunch] [--bundle [<value>] [--env.*]]`
+Run on a selected connected device. Will start simulator with specified `Device Identifier` or `Device Name`, if not already running. | `$ tns run ios [--device <Device ID>] [--release] [--justlaunch] [--bundle [<value>] [--env.*]]`
 Start an emulator and run the app inside it | `$ tns run ios --emulator [--release] [--bundle [<value>] [--env.*]]`
+Start an emulator with specified device name and sdk | `$ tns run ios [--device <Device Name>] [--sdk <sdk>]`
+Start an emulator with specified device identifier and sdk | `$ tns run ios [--device <Device Identifier>] [--sdk <sdk>]`
 
 Runs your project on a connected iOS device or in the iOS Simulator, if configured. This is shorthand for prepare, build and deploy. While your app is running, prints the output from the application in the console and watches for changes in your code. Once a change is detected, it synchronizes the change with all selected devices and restarts/refreshes the application.
 
@@ -20,6 +22,7 @@ Runs your project on a connected iOS device or in the iOS Simulator, if configur
 ### Options
 * `--device` - Specifies a connected device/simulator to start and run the app.
 * `--emulator` - If set, runs the app in all available and configured ios simulators. It will start a simulator if none are already running.
+* `--sdk` - Specifies the target simulator's sdk.
 * `--justlaunch` - If set, does not print the application output in the console.
 * `--clean` - If set, forces rebuilding the native application.
 * `--no-watch` - If set, changes in your code will not be reflected during the execution of this command.
@@ -30,6 +33,7 @@ Runs your project on a connected iOS device or in the iOS Simulator, if configur
 
 ### Attributes
 * `<Device ID>` is the index or `Device Identifier` of the target device as listed by `$ tns device ios --available-devices`
+* `<Device Name>` is the name of the target simulator as listed by `$ tns device ios --available-devices`
 <% } %>
 <% if(isHtml) { %>
 ### Prerequisites

lib/bootstrap.ts

@@ -160,7 +160,7 @@ $injector.require("terminalSpinnerService", "./services/terminal-spinner-service
 
 $injector.require('playgroundService', './services/playground-service');
 $injector.require("platformEnvironmentRequirements", "./services/platform-environment-requirements");
-$injector.require("nativescriptCloudExtensionService", "./services/nativescript-cloud-extension-service");
+$injector.require("nativeScriptCloudExtensionService", "./services/nativescript-cloud-extension-service");
 
 $injector.requireCommand("resources|generate|icons", "./commands/generate-assets");
 $injector.requireCommand("resources|generate|splashes", "./commands/generate-assets");

lib/commands/create-project.ts

@@ -1,10 +1,14 @@
 import * as constants from "../constants";
+import * as path from "path";
 
 export class CreateProjectCommand implements ICommand {
 	public enableHooks = false;
 	public allowedParameters: ICommandParameter[] = [this.$stringParameterBuilder.createMandatoryParameter("Project name cannot be empty.")];
 
+	private createdProjecData: ICreateProjectData;
+
 	constructor(private $projectService: IProjectService,
+		private $logger: ILogger,
 		private $errors: IErrors,
 		private $options: IOptions,
 		private $stringParameterBuilder: IStringParameterBuilder) { }
@@ -23,7 +27,7 @@ export class CreateProjectCommand implements ICommand {
 			selectedTemplate = this.$options.template;
 		}
 
-		await this.$projectService.createProject({
+		this.createdProjecData = await this.$projectService.createProject({
 			projectName: args[0],
 			template: selectedTemplate,
 			appId: this.$options.appid,
@@ -32,6 +36,13 @@ export class CreateProjectCommand implements ICommand {
 			ignoreScripts: this.$options.ignoreScripts
 		});
 	}
+
+	public async postCommandAction(args: string[]): Promise<void> {
+		const { projectDir } = this.createdProjecData;
+		const relativePath = path.relative(process.cwd(), projectDir);
+		this.$logger.printMarkdown(`Now you can navigate to your project with \`$ cd ${relativePath}\``);
+		this.$logger.printMarkdown(`After that you can run it on device/emulator by executing \`$ tns run <platform>\``);
+	}
 }
 
 $injector.registerCommand("create", CreateProjectCommand);

lib/commands/post-install.ts

@@ -18,6 +18,27 @@ export class PostInstallCliCommand extends PostInstallCommand {
 
 		await this.$subscriptionService.subscribeForNewsletter();
 	}
+
+	public async postCommandAction(args: string[]): Promise<void> {
+		this.$logger.info("You have successfully installed NativeScript CLI.");
+		this.$logger.info("In order to create a new project, you can use:".green);
+		this.$logger.printMarkdown("`tns create <app name>`");
+		this.$logger.info("To build your project locally you can use:".green);
+		this.$logger.printMarkdown("`tns build <platform>`");
+		this.$logger.printMarkdown("NOTE: Local builds require additional setup of your environment. You can find more information here: `https://docs.nativescript.org/start/quick-setup`");
+
+		// Add a new line just to ensure separation between local builds and cloud builds info.
+		this.$logger.info("");
+		this.$logger.info("To build your project in the cloud you can use:".green);
+		this.$logger.printMarkdown("`tns cloud build <platform>`");
+		this.$logger.printMarkdown("NOTE: Cloud builds require Telerik account. You can find more information here: `https://docs.nativescript.org/sidekick/intro/requirements`");
+
+		this.$logger.info("");
+		this.$logger.printMarkdown("In case you want to experiment quickly with NativeScript, you can try the Playground: `https://play.nativescript.org`");
+
+		this.$logger.info("");
+		this.$logger.printMarkdown("In case you have any questions, you can check our forum: `https://forum.nativescript.org` and our public Slack channel: `https://nativescriptcommunity.slack.com/`");
+	}
 }
 
 $injector.registerCommand("post-install-cli", PostInstallCliCommand);

lib/commands/run.ts

@@ -28,7 +28,7 @@ export class RunCommandBase implements ICommand {
 			this.platform = this.$devicePlatformsConstants.Android;
 		}
 
-		this.$liveSyncCommandHelper.validatePlatform(this.platform);
+		await this.$liveSyncCommandHelper.validatePlatform(this.platform);
 
 		return true;
 	}

lib/commands/setup.ts

@@ -12,10 +12,10 @@ $injector.registerCommand("setup|*", SetupCommand);
 export class CloudSetupCommand implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
-	constructor(private $nativescriptCloudExtensionService: INativescriptCloudExtensionService) { }
+	constructor(private $nativeScriptCloudExtensionService: INativeScriptCloudExtensionService) { }
 
 	public execute(args: string[]): Promise<any> {
-		return this.$nativescriptCloudExtensionService.install();
+		return this.$nativeScriptCloudExtensionService.install();
 	}
 }
 $injector.registerCommand(["setup|cloud", "cloud|setup"], CloudSetupCommand);

lib/common

@@ -135,7 +135,10 @@ export const enum TrackActionNames {
 	CreateProject = "Create project",
 	Debug = "Debug",
 	Deploy = "Deploy",
-	LiveSync = "LiveSync"
+	LiveSync = "LiveSync",
+	RunSetupScript = "Run Setup Script",
+	CheckLocalBuildSetup = "Check Local Build Setup",
+	CheckEnvironmentRequirements = "Check Environment Requirements"
 }
 
 export const enum BuildStates {

lib/constants.ts

@@ -788,12 +788,17 @@ interface IBundleValidatorHelper {
 	validate(): void;
 }
 
-interface INativescriptCloudExtensionService {
+interface INativeScriptCloudExtensionService {
 	/**
 	 * Installs nativescript-cloud extension
 	 * @return {Promise<IExtensionData>} returns the extension data
 	 */
 	install(): Promise<IExtensionData>;
+	/**
+	 * Checks if nativescript-cloud extension is installed
+	 * @return {boolean} returns true in case when nativescript-cloud extension is installed, false otherwise
+	 */
+	isInstalled(): boolean
 }
 
 /**

lib/declarations.d.ts

@@ -13,3 +13,25 @@ interface IAndroidPluginBuildService {
 	buildAar(options: IBuildOptions): Promise<boolean>;
 	migrateIncludeGradle(options: IBuildOptions): boolean;
 }
+
+/**
+ * Describes data required for building plugin for Android.
+ * The data can be consumed in the buildAndroidPlugin hook.
+ */
+interface IBuildAndroidPluginData {
+	/**
+	 * Directory where the plugin will be build.
+	 * Usually this is the `<project dir>/platforms/tempPlugin/<plugin name>` dir.
+	 */
+	pluginDir: string;
+
+	/**
+	 * The name of the plugin.
+	 */
+	pluginName: string;
+
+	/**
+	 * Information about tools that will be used to build the plugin, for example compile SDK version, build tools version, etc.
+	 */
+	androidToolsInfo: IAndroidToolsInfoData;
+}

lib/definitions/android-plugin-migrator.d.ts

@@ -381,5 +381,5 @@ interface IUpdateAppOptions extends IOptionalFilesToSync, IOptionalFilesToRemove
 }
 
 interface IPlatformEnvironmentRequirements {
-	checkEnvironmentRequirements(platform: string): Promise<boolean>;
+	checkEnvironmentRequirements(platform?: string): Promise<boolean>;
 }

lib/definitions/platform.d.ts

@@ -37,13 +37,21 @@ interface IProjectSettings {
 	ignoreScripts?: boolean;
 }
 
+interface IProjectName {
+	projectName: string;
+}
+
+interface ICreateProjectData extends IProjectDir, IProjectName {
+
+}
+
 interface IProjectService {
 	/**
 	 * Creates new NativeScript application.
 	 * @param {any} projectSettings Options describing new project - its name, appId, path and template from which to be created.
 	 * @returns {Promise<void>}
 	 */
-	createProject(projectSettings: IProjectSettings): Promise<void>;
+	createProject(projectSettings: IProjectSettings): Promise<ICreateProjectData>;
 
 	/**
 	 * Checks if the specified project is valid NativeScript project.
@@ -58,8 +66,7 @@ interface INsConfig {
 	appResourcesPath?: string;
 }
 
-interface IProjectData extends IProjectDir {
-	projectName: string;
+interface IProjectData extends ICreateProjectData {
 	platformsDir: string;
 	projectFilePath: string;
 	projectId?: string;
@@ -394,12 +401,6 @@ interface IPlatformProjectService extends NodeJS.EventEmitter {
 	executeCommand(projectRoot: string, args: any, childProcessOpts?: any, spawnFromEventOptions?: ISpawnFromEventOptions): Promise<ISpawnResult>;
 }
 
-interface IAndroidProjectPropertiesManager {
-	getProjectReferences(): Promise<ILibRef[]>;
-	addProjectReference(referencePath: string): Promise<void>;
-	removeProjectReference(referencePath: string): Promise<void>;
-}
-
 interface ITestExecutionService {
 	startTestRunner(platform: string, projectData: IProjectData, projectFilesConfig: IProjectFilesConfig): Promise<void>;
 	startKarmaServer(platform: string, projectData: IProjectData, projectFilesConfig: IProjectFilesConfig): Promise<void>;

lib/definitions/project.d.ts

@@ -58,6 +58,7 @@ export class AnalyticsService extends AnalyticsServiceBase {
 			gaSettings.customDimensions[GoogleAnalyticsCustomDimensions.client] = this.$options.analyticsClient || (isInteractive() ? AnalyticsClients.Cli : AnalyticsClients.Unknown);
 
 			const googleAnalyticsData: IGoogleAnalyticsTrackingInformation = _.merge({ type: TrackingTypes.GoogleAnalyticsData, category: AnalyticsClients.Cli }, gaSettings);
+			this.$logger.trace("Will send the following information to Google Analytics:", googleAnalyticsData);
 			return this.sendMessageToBroker(googleAnalyticsData);
 		}
 	}
@@ -73,7 +74,7 @@ export class AnalyticsService extends AnalyticsServiceBase {
 
 		// In some cases (like in case action is Build and platform is Android), we do not know if the deviceType is emulator or device.
 		// Just exclude the device_type in this case.
-		if (isForDevice !== null) {
+		if (isForDevice !== null && isForDevice !== undefined) {
 			const deviceType = isForDevice ? DeviceTypes.Device : (this.$mobileHelper.isAndroidPlatform(platform) ? DeviceTypes.Emulator : DeviceTypes.Simulator);
 			label = this.addDataToLabel(label, deviceType);
 		}
@@ -99,8 +100,6 @@ export class AnalyticsService extends AnalyticsServiceBase {
 			customDimensions
 		};
 
-		this.$logger.trace("Will send the following information to Google Analytics:", googleAnalyticsEventData);
-
 		await this.trackInGoogleAnalytics(googleAnalyticsEventData);
 	}