nativescript 8.8.0 → 8.8.1

package/lib/services/platform/add-platform-service.js

@@ -21,7 +21,11 @@ const constants_1 = require("../../constants");
 const decorators_1 = require("../../common/decorators");
 const yok_1 = require("../../common/yok");
 class AddPlatformService {
-    constructor($fs, $logger, $options, $packageManager, $terminalSpinnerService, $analyticsService) {
+    constructor($fs, $logger, $options, 
+    // private $pacoteService: IPacoteService,
+    // private $projectDataService: IProjectDataService,
+    $packageManager, $terminalSpinnerService, $analyticsService // private $tempService: ITempService
+    ) {
         this.$fs = $fs;
         this.$logger = $logger;
         this.$options = $options;
@@ -37,9 +41,13 @@ class AddPlatformService {
             const spinner = this.$terminalSpinnerService.createSpinner();
             try {
                 spinner.start();
+                // const frameworkDirPath = addPlatformData.frameworkPath ?
+                // 	await this.extractPackage(packageToInstall)
+                // 	: await this.installPackage(projectData.projectDir, packageToInstall);
                 const frameworkDirPath = yield this.installPackage(projectData.projectDir, packageToInstall);
                 const frameworkPackageJsonContent = this.$fs.readJson(path.join(frameworkDirPath, "..", "package.json"));
                 const frameworkVersion = frameworkPackageJsonContent.version;
+                // await this.setPlatformVersion(platformData, projectData, frameworkVersion);
                 yield this.trackPlatformVersion(frameworkVersion, platformData);
                 if (!addPlatformData.nativePrepare ||
                     !addPlatformData.nativePrepare.skipNativePrepare) {
@@ -62,10 +70,22 @@ class AddPlatformService {
             yield this.installPackage(projectData.projectDir, `${platformData.frameworkPackageName}@${frameworkVersion}`);
         });
     }
+    // private async extractPackage(pkg: string): Promise<string> {
+    // 	const downloadedPackagePath = await this.$tempService.mkdirSync(
+    // 		"runtimeDir"
+    // 	);
+    // 	await this.$pacoteService.extractPackage(pkg, downloadedPackagePath);
+    // 	const frameworkDir = path.join(
+    // 		downloadedPackagePath,
+    // 		PROJECT_FRAMEWORK_FOLDER_NAME
+    // 	);
+    // 	return path.resolve(frameworkDir);
+    // }
     installPackage(projectDir, packageName) {
         return __awaiter(this, void 0, void 0, function* () {
             const frameworkDir = this.resolveFrameworkDir(projectDir, packageName);
             if (frameworkDir && this.$fs.exists(frameworkDir)) {
+                // don't install if it's already installed
                 return frameworkDir;
             }
             const installedPackage = yield this.$packageManager.install(packageName, projectDir, {
@@ -82,6 +102,30 @@ class AddPlatformService {
     }
     resolveFrameworkDir(projectDir, packageName) {
         try {
+            // strip version info if present <package>@1.2.3-rc.0 -> <package>
+            // tested cases:
+            // @nativescript/ios
+            // @nativescript/ios@1
+            // @nativescript/ios@1.2
+            // @nativescript/ios@1.2.3
+            // @nativescript/ios@1.2.3-
+            // @nativescript/ios@1.2.3-rc
+            // @nativescript/ios@1.2.3-rc.
+            // @nativescript/ios@1.2.3-rc.0
+            // @nativescript/ios@rc
+            // @nativescript/ios@^7.0.0
+            // @nativescript/ios@~7.0.0
+            // tns-ios
+            // tns-ios@1
+            // tns-ios@1.2
+            // tns-ios@1.2.3
+            // tns-ios@1.2.3-
+            // tns-ios@1.2.3-rc
+            // tns-ios@1.2.3-rc.
+            // tns-ios@1.2.3-rc.0
+            // tns-ios@rc
+            // tns-ios@^7.0.0
+            // tns-ios@~7.0.0
             packageName = packageName.replace(/(.+)@.+$/g, "$1");
             const frameworkDir = require
                 .resolve(`${packageName}/package.json`, {
@@ -100,8 +144,10 @@ class AddPlatformService {
     addNativePlatform(platformData, projectData, frameworkDirPath, frameworkVersion) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            // here we should use ios OR android
             const platformDir = (_a = this.$options.hostProjectPath) !== null && _a !== void 0 ? _a : path.join(projectData.platformsDir, platformData.normalizedPlatformName.toLowerCase());
             this.$fs.deleteDirectory(platformDir);
+            //if iosHost - dont create project
             yield platformData.platformProjectService.createProject(path.resolve(frameworkDirPath), frameworkVersion, projectData);
             platformData.platformProjectService.ensureConfigurationFileInAppResources(projectData);
             yield platformData.platformProjectService.interpolateData(projectData);
@@ -111,7 +157,7 @@ class AddPlatformService {
     trackPlatformVersion(frameworkVersion, platformData) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.$analyticsService.trackEventActionInGoogleAnalytics({
-                action: "Add Platform",
+                action: "Add Platform" /* TrackActionNames.AddPlatform */,
                 additionalData: `${platformData.platformNameLowerCase}${constants_1.AnalyticsEventLabelDelimiter}${frameworkVersion}`,
             });
         });
@@ -122,3 +168,4 @@ __decorate([
 ], AddPlatformService.prototype, "addNativePlatform", null);
 exports.AddPlatformService = AddPlatformService;
 yok_1.injector.register("addPlatformService", AddPlatformService);
+//# sourceMappingURL=add-platform-service.js.map

package/lib/services/platform/platform-validation-service.js

@@ -83,3 +83,4 @@ class PlatformValidationService {
 }
 exports.PlatformValidationService = PlatformValidationService;
 yok_1.injector.register("platformValidationService", PlatformValidationService);
+//# sourceMappingURL=platform-validation-service.js.map

package/lib/services/platform/prepare-native-platform-service.js

@@ -59,19 +59,21 @@ class PrepareNativePlatformService {
                 this.$metadataFilteringService.generateMetadataFilters(projectData, platformData.platformNameLowerCase);
             }
             platformData.platformProjectService.interpolateConfigurationFile(projectData);
-            yield this.$projectChangesService.setNativePlatformStatus(platformData, projectData, { nativePlatformStatus: "3" });
+            yield this.$projectChangesService.setNativePlatformStatus(platformData, projectData, { nativePlatformStatus: "3" /* NativePlatformStatus.alreadyPrepared */ });
             return hasChanges;
         });
     }
     cleanProject(platformData, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            // android build artifacts need to be cleaned up
+            // when switching between debug, release and webpack builds
             if (platformData.platformNameLowerCase !== "android") {
                 return;
             }
             const previousPrepareInfo = this.$projectChangesService.getPrepareInfo(platformData);
             if (!previousPrepareInfo ||
                 previousPrepareInfo.nativePlatformStatus !==
-                    "3") {
+                    "3" /* NativePlatformStatus.alreadyPrepared */) {
                 return;
             }
             const { release: previousWasRelease } = previousPrepareInfo;
@@ -88,3 +90,4 @@ __decorate([
 ], PrepareNativePlatformService.prototype, "prepareNativePlatform", null);
 exports.PrepareNativePlatformService = PrepareNativePlatformService;
 yok_1.injector.register("prepareNativePlatformService", PrepareNativePlatformService);
+//# sourceMappingURL=prepare-native-platform-service.js.map

package/lib/services/platform-environment-requirements.js

@@ -20,7 +20,9 @@ const helpers_1 = require("../common/helpers");
 const os_1 = require("os");
 const yok_1 = require("../common/yok");
 class PlatformEnvironmentRequirements {
-    constructor($doctorService, $errors, $analyticsService, $injector) {
+    constructor($doctorService, $errors, $analyticsService, 
+    // @ts-ignore - required by the hook helper!
+    $injector) {
         this.$doctorService = $doctorService;
         this.$errors = $errors;
         this.$analyticsService = $analyticsService;
@@ -32,7 +34,7 @@ class PlatformEnvironmentRequirements {
             const selectedOption = null;
             if (process.env.NS_SKIP_ENV_CHECK) {
                 yield this.$analyticsService.trackEventActionInGoogleAnalytics({
-                    action: "Check Environment Requirements",
+                    action: "Check Environment Requirements" /* TrackActionNames.CheckEnvironmentRequirements */,
                     additionalData: "Skipped: NS_SKIP_ENV_CHECK is set",
                 });
                 return {
@@ -47,8 +49,9 @@ class PlatformEnvironmentRequirements {
                 forceCheck: input.forceCheck,
             });
             if (!canExecute) {
+                // if (!isInteractive()) {
                 yield this.$analyticsService.trackEventActionInGoogleAnalytics({
-                    action: "Check Environment Requirements",
+                    action: "Check Environment Requirements" /* TrackActionNames.CheckEnvironmentRequirements */,
                     additionalData: "Non-interactive terminal, unable to execute local builds.",
                 });
                 this.fail(this.getNonInteractiveConsoleMessage(platform));
@@ -69,6 +72,7 @@ class PlatformEnvironmentRequirements {
         ].join(os_1.EOL);
     }
     getEnvVerificationMessage(platform) {
+        // map process.platform to OS name used in docs
         const os = {
             linux: "linux",
             win32: "windows",
@@ -87,3 +91,4 @@ __decorate([
 ], PlatformEnvironmentRequirements.prototype, "checkEnvironmentRequirements", null);
 exports.PlatformEnvironmentRequirements = PlatformEnvironmentRequirements;
 yok_1.injector.register("platformEnvironmentRequirements", PlatformEnvironmentRequirements);
+//# sourceMappingURL=platform-environment-requirements.js.map

package/lib/services/platform-project-service-base.js

@@ -30,3 +30,4 @@ class PlatformProjectServiceBase extends events_1.EventEmitter {
     }
 }
 exports.PlatformProjectServiceBase = PlatformProjectServiceBase;
+//# sourceMappingURL=platform-project-service-base.js.map

package/lib/services/platforms-data-service.js

@@ -29,3 +29,4 @@ class PlatformsDataService {
 }
 exports.PlatformsDataService = PlatformsDataService;
 yok_1.injector.register("platformsDataService", PlatformsDataService);
+//# sourceMappingURL=platforms-data-service.js.map

package/lib/services/plugins-service.js

@@ -64,6 +64,7 @@ class PluginsService {
             const realNpmPackageJson = this.$fs.readJson(pathToRealNpmPackageJson);
             if (realNpmPackageJson.nativescript) {
                 const pluginData = this.convertToPluginData(realNpmPackageJson, projectData.projectDir);
+                // Validate
                 const action = (pluginDestinationPath, platform, platformData) => __awaiter(this, void 0, void 0, function* () {
                     this.isPluginDataValidForPlatform(pluginData, platform, projectData);
                 });
@@ -152,6 +153,9 @@ class PluginsService {
                     paths: [projectData.projectDir],
                 });
                 if (pathToPackage) {
+                    // return false if the dependency is installed - we'll filter out boolean values
+                    // and end up with an array of dep names that are not installed if we end up
+                    // inside the catch block.
                     return false;
                 }
                 this.$logger.trace(`${dep} is not installed, or couldn't be found`);
@@ -187,6 +191,9 @@ class PluginsService {
         return productionPlugins
             .map((plugin) => this.convertToPluginData(plugin, projectData.projectDir))
             .filter((item, idx, self) => {
+            // Filter out duplicates to speed up build times by not building the same dependency
+            // multiple times. One possible downside is that if there are different versions
+            // of the same native dependency only the first one in the array will be built
             return self.findIndex((p) => p.name === item.name) === idx;
         });
     }
@@ -218,9 +225,11 @@ class PluginsService {
         const dependenciesGroupedByName = _.groupBy(productionDependencies, (p) => p.name);
         _.each(dependenciesGroupedByName, (dependencyOccurrences, dependencyName) => {
             if (dependencyOccurrences.length > 1) {
+                // the dependency exists multiple times in node_modules
                 const dependencyOccurrencesGroupedByVersion = _.groupBy(dependencyOccurrences, (g) => g.version);
                 const versions = _.keys(dependencyOccurrencesGroupedByVersion);
                 if (versions.length === 1) {
+                    // all dependencies with this name have the same version
                     this.$logger.trace(`Detected same versions (${_.first(versions)}) of the ${dependencyName} installed at locations: ${_.map(dependencyOccurrences, (d) => d.directory).join(", ")}`);
                 }
                 else {
@@ -246,9 +255,11 @@ class PluginsService {
             const dependenciesGroupedByFrameworkName = _.groupBy(dependenciesWithFrameworks, (d) => d.frameworkName);
             _.each(dependenciesGroupedByFrameworkName, (dependencyOccurrences, frameworkName) => {
                 if (dependencyOccurrences.length > 1) {
+                    // A framework exists multiple times in node_modules
                     const groupedByName = _.groupBy(dependencyOccurrences, (d) => d.name);
                     const pluginsNames = _.keys(groupedByName);
                     if (pluginsNames.length > 1) {
+                        // fail - the same framework is installed by different dependencies.
                         const locations = dependencyOccurrences.map((d) => d.frameworkLocation);
                         let msg = `Detected the framework ${frameworkName} is installed from multiple plugins at locations:\n${locations.join("\n")}\n`;
                         msg += this.getHelpMessage(projectDir);
@@ -258,6 +269,7 @@ class PluginsService {
                     const dependencyOccurrencesGroupedByVersion = _.groupBy(dependencyOccurrences, (g) => g.version);
                     const versions = _.keys(dependencyOccurrencesGroupedByVersion);
                     if (versions.length === 1) {
+                        // all dependencies with this name have the same version
                         this.$logger.warn(`Detected the framework ${frameworkName} is installed multiple times from the same versions of plugin (${_.first(versions)}) at locations: ${_.map(dependencyOccurrences, (d) => d.directory).join(", ")}`);
                         const selectedPackage = _.minBy(dependencyOccurrences, (d) => d.depth);
                         this.$logger.info(color_1.color.green(`CLI will use only the native code from '${selectedPackage.directory}'.`));
@@ -309,7 +321,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
             pluginData.isPlugin = !!cacheData.nativescript;
             pluginData.pluginPlatformsFolderPath = (platform) => {
                 if (this.$mobileHelper.isvisionOSPlatform(platform)) {
-                    platform = "ios";
+                    platform = "ios" /* constants.PlatformTypes.ios */;
                 }
                 return path.join(pluginData.fullPath, "platforms", platform.toLowerCase());
             };
@@ -366,6 +378,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
         return _.keys(require(packageJsonFilePath).dependencies);
     }
     getNodeModuleData(module, projectDir) {
+        // module can be  modulePath or moduleName
         if (!this.$fs.exists(module) || path.basename(module) !== "package.json") {
             module = this.getPackageJsonFilePathForModule(module, projectDir);
         }
@@ -403,7 +416,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
         });
     }
     parseNpmCommandResult(npmCommandResult) {
-        return npmCommandResult.split("@")[0];
+        return npmCommandResult.split("@")[0]; // returns plugin name
     }
     executeForAllInstalledPlatforms(action, projectData) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -420,6 +433,8 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
     }
     getInstalledFrameworkVersion(platform, projectData) {
         const runtimePackage = this.$projectDataService.getRuntimePackage(projectData.projectDir, platform);
+        // const platformData = this.$platformsDataService.getPlatformData(platform, projectData);
+        // const frameworkData = this.$projectDataService.getNSValue(projectData.projectDir, platformData.frameworkPackageName);
         return runtimePackage.version;
     }
     isPluginDataValidForPlatform(pluginData, platform, projectData) {
@@ -451,6 +466,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
     }
     getAllPluginsNativeHashes(pathToPluginsBuildFile) {
         if (this.$options.hostProjectPath) {
+            // TODO: force rebuild plugins for now until we decide where to put .ns-plugins-build-data.json when embedding
             return {};
         }
         let data = {};
@@ -461,6 +477,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
     }
     setPluginNativeHashes(opts) {
         if (this.$options.hostProjectPath) {
+            // TODO: force rebuild plugins for now until we decide where to put .ns-plugins-build-data.json when embedding
             return;
         }
         opts.allPluginsNativeHashes[opts.pluginData.name] =
@@ -481,3 +498,4 @@ PluginsService.LOCK_FILES = [
 ];
 exports.PluginsService = PluginsService;
 yok_1.injector.register("pluginsService", PluginsService);
+//# sourceMappingURL=plugins-service.js.map

package/lib/services/prepare-data-service.js

@@ -19,3 +19,4 @@ class PrepareDataService {
 }
 exports.PrepareDataService = PrepareDataService;
 yok_1.injector.register("prepareDataService", PrepareDataService);
+//# sourceMappingURL=prepare-data-service.js.map

package/lib/services/project-backup-service.js

@@ -46,6 +46,7 @@ ProjectBackupService.Backup = class Backup {
                 backedUpPaths.push(pathToBackup);
             }
         }
+        // create backup.json
         this.$super.$fs.writeJson(path.resolve(this.backupDir, "_backup.json"), {
             name: this.name,
             paths: backedUpPaths,
@@ -66,6 +67,7 @@ ProjectBackupService.Backup = class Backup {
             }
         }
         this.$super.$logger.trace(backupData);
+        // restore files
         return this;
     }
     isUpToDate() {
@@ -75,6 +77,7 @@ ProjectBackupService.Backup = class Backup {
         }
         for (const pathToBackup of backupData.paths) {
             const sourcePath = path.resolve(this.backupDir, pathToBackup);
+            // if any of the files don't exist the backup is not up-to-date
             if (!this.$super.$fs.exists(sourcePath)) {
                 return false;
             }
@@ -112,3 +115,4 @@ ProjectBackupService.Backup = class Backup {
 };
 exports.ProjectBackupService = ProjectBackupService;
 yok_1.injector.register("projectBackupService", ProjectBackupService);
+//# sourceMappingURL=project-backup-service.js.map

package/lib/services/project-changes-service.js

@@ -74,6 +74,7 @@ class ProjectChangesService {
                     this._prepareInfo.projectFileHash = this.getProjectFileStrippedHash(projectData.projectDir, platformData);
                     this._changesInfo.nativeChanged = this.isProjectFileChanged(projectData.projectDir, platformData);
                 }
+                // If this causes too much rebuilds of the plugins or uncecessary builds for Android, move overrideCocoapods to prepareInfo.
                 this._changesInfo.nsConfigChanged = this.filesChanged([
                     path.join(projectData.projectDir, constants_1.CONFIG_FILE_NAME_JS),
                     path.join(projectData.projectDir, constants_1.CONFIG_FILE_NAME_TS),
@@ -132,6 +133,7 @@ class ProjectChangesService {
     }
     getPrepareInfo(platformData) {
         if (this.$options.hostProjectPath) {
+            // TODO: always prepare for now until we decide where to keep the .nsprepareinfo file when embedding
             return null;
         }
         const prepareInfoFilePath = this.getPrepareInfoFilePath(platformData);
@@ -152,6 +154,7 @@ class ProjectChangesService {
                 yield this.ensurePrepareInfo(platformData, projectData, prepareData);
             }
             if (this.$options.hostProjectPath) {
+                // TODO: do not save for now until we decide where to keep the .nsprepareinfo file when embedding
                 return null;
             }
             const prepareInfoFilePath = this.getPrepareInfoFilePath(platformData);
@@ -163,7 +166,7 @@ class ProjectChangesService {
             this._prepareInfo = this._prepareInfo || this.getPrepareInfo(platformData);
             if (this._prepareInfo &&
                 addedPlatform.nativePlatformStatus ===
-                    "3") {
+                    "3" /* NativePlatformStatus.alreadyPrepared */) {
                 this._prepareInfo.nativePlatformStatus =
                     addedPlatform.nativePlatformStatus;
             }
@@ -189,8 +192,8 @@ class ProjectChangesService {
                 return false;
             }
             const nativePlatformStatus = !prepareData.nativePrepare || !prepareData.nativePrepare.skipNativePrepare
-                ? "2"
-                : "1";
+                ? "2" /* NativePlatformStatus.requiresPrepare */
+                : "1" /* NativePlatformStatus.requiresPlatformAdd */;
             this._prepareInfo = {
                 time: "",
                 nativePlatformStatus,
@@ -214,6 +217,13 @@ class ProjectChangesService {
         const projectFileContents = this.$fs.readJson(projectFilePath);
         const relevantProperties = ["dependencies"];
         const projectFileStrippedContents = _.pick(projectFileContents, relevantProperties);
+        // _(this.$devicePlatformsConstants)
+        // 	.keys()
+        // 	.map(k => k.toLowerCase())
+        // 	.difference([platformData.platformNameLowerCase])
+        // 	.each(otherPlatform => {
+        // 		delete projectFileContents.nativescript[`tns-${otherPlatform}`];
+        // 	});
         return (0, helpers_1.getHash)(JSON.stringify(projectFileStrippedContents));
     }
     isProjectFileChanged(projectDir, platformData) {
@@ -279,3 +289,4 @@ __decorate([
 ], ProjectChangesService.prototype, "checkForChanges", null);
 exports.ProjectChangesService = ProjectChangesService;
 yok_1.injector.register("projectChangesService", ProjectChangesService);
+//# sourceMappingURL=project-changes-service.js.map

package/lib/services/project-cleanup-service.js

@@ -38,6 +38,7 @@ class ProjectCleanupService {
                 success = success && cleanRes.ok;
             }
             if (!(options === null || options === void 0 ? void 0 : options.silent)) {
+                // required to print an empty line for the spinner to not replace the last status... (probably a bug in the spinners)
                 console.log();
             }
             if (stats) {
@@ -100,3 +101,4 @@ class ProjectCleanupService {
 }
 exports.ProjectCleanupService = ProjectCleanupService;
 yok_1.injector.register("projectCleanupService", ProjectCleanupService);
+//# sourceMappingURL=project-cleanup-service.js.map

package/lib/services/project-config-service.js

@@ -44,6 +44,7 @@ class ProjectConfigService {
         return (this.forceUsingLegacyConfig = force);
     }
     requireFromString(src, filename) {
+        // @ts-ignore
         const m = new module.constructor();
         m.paths = module.paths;
         m._compile(src, filename);
@@ -66,6 +67,7 @@ export default {
 } as NativeScriptConfig;`.trim();
     }
     warnUsingLegacyNSConfig() {
+        // todo: remove hack
         const isMigrate = _.get(this.$options, "argv._[0]") === "migrate";
         if (isMigrate) {
             return;
@@ -74,6 +76,7 @@ export default {
     }
     detectProjectConfigs(projectDir) {
         var _a;
+        // allow overriding config name with env variable or --config (or -c)
         let configName = (_a = process.env.NATIVESCRIPT_CONFIG_NAME) !== null && _a !== void 0 ? _a : this.$options.config;
         if (configName === "false") {
             configName = false;
@@ -103,6 +106,7 @@ export default {
         const existingConfigs = possibleConfigPaths.filter((path) => {
             return this.$fs.exists(path);
         });
+        // push the first possible config into the "existing" list
         const hasExistingConfig = !!existingConfigs.length;
         if (!hasExistingConfig) {
             this.$logger.trace(`No config file found - falling back to ${possibleConfigPaths[0]}.`);
@@ -195,15 +199,20 @@ export default {
                     singleQuote: true,
                 };
                 this.$logger.trace("updating config, prettier options: ", prettierOptions);
-                this.$fs.writeFile(configFilePath, (0, prettier_1.format)(newContent, Object.assign(Object.assign({}, prettierOptions), { parser: "typescript", plugins: [] })));
+                this.$fs.writeFile(configFilePath, (0, prettier_1.format)(newContent, Object.assign(Object.assign({}, prettierOptions), { parser: "typescript", 
+                    // note: we don't use plugins here, since we are only formatting ts files, and they are supported by default
+                    // and this also causes issues with certain plugins, like prettier-plugin-tailwindcss.
+                    plugins: [] })));
             }
             catch (error) {
                 this.$logger.error(`Failed to update config.` + error);
             }
             finally {
+                // verify config is updated correctly
                 if (this.getValue(key) !== value) {
                     this.$logger.error(`${os_1.EOL}Failed to update ${hasTSConfig ? constants_1.CONFIG_FILE_NAME_TS : constants_1.CONFIG_FILE_NAME_JS}.${os_1.EOL}`);
                     this.$logger.printMarkdown(`Please manually update \`${hasTSConfig ? constants_1.CONFIG_FILE_NAME_TS : constants_1.CONFIG_FILE_NAME_JS}\` and set \`${key}\` to \`${value}\`.${os_1.EOL}`);
+                    // restore original content
                     this.$fs.writeFile(configFilePath, configContent);
                     return false;
                 }
@@ -233,9 +242,11 @@ export default {
             ? this.$fs.readJson(info.NSConfigPath)
             : {};
         try {
+            // injecting here to avoid circular dependency
             const projectData = this.$injector.resolve("projectData");
             const embeddedPackageJsonPath = path.resolve(this.projectHelper.projectDir, projectData.getAppDirectoryRelativePath(), constants.PACKAGE_JSON_FILE_NAME);
             const embeddedPackageJson = this.$fs.readJson(embeddedPackageJsonPath);
+            // filter only the supported keys
             additionalData.push(_.pick(embeddedPackageJson, [
                 "android",
                 "ios",
@@ -247,9 +258,11 @@ export default {
         }
         catch (err) {
             this.$logger.trace("failed to add embedded package.json data to config", err);
+            // ignore if the file doesn't exist
         }
         try {
             const packageJson = this.$fs.readJson(path.join(this.projectHelper.projectDir, "package.json"));
+            // add app id to additionalData for backwards compatibility
             if (!NSConfig.id &&
                 packageJson &&
                 packageJson.nativescript &&
@@ -273,8 +286,10 @@ export default {
         }
         catch (err) {
             this.$logger.trace("failed to read package.json data for config", err);
+            // ignore if the file doesn't exist
         }
         return _.defaultsDeep({}, ...additionalData, NSConfig);
+        // return Object.assign({}, ...additionalData, NSConfig);
     }
     writeLegacyNSConfigIfNeeded(projectDir, runtimePackage) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -284,6 +299,8 @@ export default {
             }
             if (runtimePackage.version &&
                 semver.gte(semver.coerce(runtimePackage.version), "7.0.0-rc.5")) {
+                // runtimes >= 7.0.0-rc.5 support passing appPath and appResourcesPath through gradle project flags
+                // so writing an nsconfig is not necessary.
                 return;
             }
             const runtimePackageDisplay = `${runtimePackage.name}${runtimePackage.version ? " v" + runtimePackage.version : ""}`;
@@ -300,9 +317,11 @@ You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as
                 appPath: this.getValue("appPath"),
                 appResourcesPath: this.getValue("appResourcesPath"),
             });
+            // mark the file for cleanup after the CLI exits
             yield this.$cleanupService.addCleanupDeleteAction(nsConfigPath);
         });
     }
+    // todo: move into config manipulation
     flattenObjectToPaths(obj, basePath) {
         const toPath = (key) => [basePath, key].filter(Boolean).join(".");
         return Object.keys(obj).reduce((all, key) => {
@@ -320,7 +339,7 @@ You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as
     }
 }
 __decorate([
-    (0, decorators_1.cache)()
+    (0, decorators_1.cache)() // @cache should prevent the message being printed multiple times
 ], ProjectConfigService.prototype, "warnUsingLegacyNSConfig", null);
 __decorate([
     (0, decorators_1.exported)("projectConfigService")
@@ -333,3 +352,4 @@ __decorate([
 ], ProjectConfigService.prototype, "setValue", null);
 exports.ProjectConfigService = ProjectConfigService;
 yok_1.injector.register("projectConfigService", ProjectConfigService);
+//# sourceMappingURL=project-config-service.js.map