feat: config manipulation

Author: rigor789

lib/commands/clean.ts

@@ -8,10 +8,10 @@ export class CleanCommand implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
 	constructor(
-    private $fs: IFileSystem,
-    private $logger: ILogger,
-    private $projectHelper: IProjectHelper
-  ) {}
+		private $fs: IFileSystem,
+		private $logger: ILogger,
+		private $projectHelper: IProjectHelper
+	) {}
 
 	public async execute(args: string[]): Promise<void> {
 		this.$fs.deleteDirectory(
@@ -21,10 +21,16 @@ export class CleanCommand implements ICommand {
 			path.join(this.$projectHelper.projectDir, constants.PLATFORMS_DIR_NAME)
 		);
 		this.$fs.deleteDirectory(
-			path.join(this.$projectHelper.projectDir, constants.NODE_MODULES_FOLDER_NAME)
+			path.join(
+				this.$projectHelper.projectDir,
+				constants.NODE_MODULES_FOLDER_NAME
+			)
 		);
 		this.$fs.deleteFile(
-			path.join(this.$projectHelper.projectDir, constants.PACKAGE_LOCK_JSON_FILE_NAME)
+			path.join(
+				this.$projectHelper.projectDir,
+				constants.PACKAGE_LOCK_JSON_FILE_NAME
+			)
 		);
 
 		this.$logger.info("Project successfully cleaned.");

lib/commands/update.ts

@@ -27,6 +27,7 @@ export class UpdateCommand implements ICommand {
 
 	public async execute(args: string[]): Promise<void> {
 		if (this.$options.markingMode) {
+			// ns update --markingMode
 			await this.$markingModeService.handleMarkingModeFullDeprecation({
 				projectDir: this.$projectData.projectDir,
 				forceSwitch: true,

lib/definitions/project.d.ts

@@ -16,6 +16,7 @@ import {
 	IDependencyInformation,
 	ISpawnResult,
 } from "../common/declarations";
+import { SupportedConfigValues } from "../tools/config-manipulation/config-transformer";
 
 interface IProjectName {
 	/**
@@ -302,6 +303,12 @@ interface IProjectConfigService {
 	 * @param key the property key path
 	 */
 	getValue(key: string): any;
+	/**
+	 * Set value for a given config key path
+	 * @param key the property key path
+	 * @param value
+	 */
+	setValue(key: string, value: SupportedConfigValues): any;
 
 	detectInfo(
 		projectDir?: string

lib/project-data.ts

@@ -5,20 +5,20 @@ import { parseJson } from "./common/helpers";
 import { EOL } from "os";
 import { cache } from "./common/decorators";
 import {
-	IProjectData,
 	INsConfig,
 	IProjectConfigService,
+	IProjectData,
 } from "./definitions/project";
 import {
 	IAndroidResourcesMigrationService,
-	IStaticConfig,
 	IOptions,
+	IStaticConfig,
 } from "./declarations";
 import {
-	IStringDictionary,
-	IFileSystem,
 	IErrors,
+	IFileSystem,
 	IProjectHelper,
+	IStringDictionary,
 } from "./common/declarations";
 import { injector } from "./common/yok";
 import { IInjector } from "./common/definitions/yok";
@@ -68,16 +68,19 @@ export class ProjectData implements IProjectData {
 	public platformsDir: string;
 	public projectFilePath: string;
 	public projectIdentifiers: Mobile.IProjectIdentifier;
+
 	get projectId(): string {
 		this.warnProjectId();
 		return this.projectIdentifiers.ios;
 	}
+
 	//just in case hook/extension modifies it.
 	set projectId(identifier: string) {
 		this.warnProjectId();
 		this.projectIdentifiers.ios = identifier;
 		this.projectIdentifiers.android = identifier;
 	}
+
 	public projectName: string;
 	public packageJsonData: any;
 	public nsConfig: INsConfig;
@@ -137,16 +140,23 @@ export class ProjectData implements IProjectData {
 	): void {
 		projectDir = projectDir || this.$projectHelper.projectDir || "";
 		const projectFilePath = this.getProjectFilePath(projectDir);
-    // If no project found, projectDir should be null
-    // handle migration cases
-    let isMigrate = false;
-    if (this.$options.argv && this.$options.argv._ && this.$options.argv._.length) {
-      this.$logger.info('this.$options.argv._[0]:', this.$options.argv._[0]);
-      isMigrate = this.$options.argv._[0] === 'migrate';
-    }
-    this.$logger.info('about to call readConfig...')
-    this.$logger.info('isMigrate:', isMigrate);
-		const nsConfig: INsConfig = isMigrate ? null : this.projectConfig.readConfig(projectDir);
+		// If no project found, projectDir should be null
+		// handle migration cases
+		let isMigrate = false;
+		if (
+			this.$options.argv &&
+			this.$options.argv._ &&
+			this.$options.argv._.length
+		) {
+			this.$logger.debug(
+				"the value of this.$options.argv._[0] is: " + this.$options.argv._[0]
+			);
+			isMigrate = this.$options.argv._[0] === "migrate";
+		}
+		this.$logger.debug(`'initializingProjectData, isMigrate is ${isMigrate}.`);
+		const nsConfig: INsConfig = isMigrate
+			? null
+			: this.projectConfig.readConfig(projectDir);
 		let packageJsonData = null;
 
 		try {
@@ -272,15 +282,14 @@ export class ProjectData implements IProjectData {
 	public getAppDirectoryRelativePath(): string {
 		if (this.nsConfig && this.nsConfig[constants.CONFIG_NS_APP_ENTRY]) {
 			return this.nsConfig[constants.CONFIG_NS_APP_ENTRY];
-    }
-    
-    if (this.$fs.exists(path.resolve(this.projectDir, constants.SRC_DIR))) {
-      return constants.SRC_DIR;
-    } else {
-      // legacy project setup often uses app folder
-      return constants.APP_FOLDER_NAME;
-    }
+		}
 
+		if (this.$fs.exists(path.resolve(this.projectDir, constants.SRC_DIR))) {
+			return constants.SRC_DIR;
+		} else {
+			// legacy project setup often uses app folder
+			return constants.APP_FOLDER_NAME;
+		}
 	}
 
 	public getNsConfigRelativePath(): string {
@@ -305,27 +314,27 @@ export class ProjectData implements IProjectData {
 	private initializeProjectIdentifiers(
 		config: INsConfig
 	): Mobile.IProjectIdentifier {
-    if (config) {
-      const identifier: Mobile.IProjectIdentifier = {
-        ios: config.id,
-        android: config.id,
-      };
-  
-      if (config.ios && config.ios.id) {
-        identifier.ios = config.ios.id;
-      }
-      if (config.android && config.android.id) {
-        identifier.android = config.android.id;
-      }
-  
-      return identifier;
-    } else {
-      // when migrating projects this can be ignored
-      return {
-        ios: '',
-        android: ''
-      };
-    }
+		if (config) {
+			const identifier: Mobile.IProjectIdentifier = {
+				ios: config.id,
+				android: config.id,
+			};
+
+			if (config.ios && config.ios.id) {
+				identifier.ios = config.ios.id;
+			}
+			if (config.android && config.android.id) {
+				identifier.android = config.android.id;
+			}
+
+			return identifier;
+		} else {
+			// when migrating projects this can be ignored
+			return {
+				ios: "",
+				android: "",
+			};
+		}
 	}
 
 	private getProjectType(): string {
@@ -360,4 +369,5 @@ export class ProjectData implements IProjectData {
 		);
 	}
 }
+
 injector.register("projectData", ProjectData, true);

lib/services/marking-mode-service.ts

@@ -1,9 +1,7 @@
 import * as helpers from "../common/helpers";
-import * as path from "path";
 import { EOL } from "os";
-import { PACKAGE_JSON_FILE_NAME, LoggerConfigData } from "../constants";
-import { IProjectDataService } from "../definitions/project";
-import { IFileSystem } from "../common/declarations";
+import { LoggerConfigData } from "../constants";
+import { IProjectConfigService } from "../definitions/project";
 import { injector } from "../common/yok";
 
 const enum MarkingMode {
@@ -17,47 +15,23 @@ const MARKING_MODE_NONE_CONFIRM_MSG = `Do you want to switch your app to the rec
 More info about the reasons for this change can be found in the link below:
 https://www.nativescript.org/blog/markingmode-none-is-official-boost-android-performance-while-avoiding-memory-issues`;
 
-// TODO: update to work with new configs!
 export class MarkingModeService implements IMarkingModeService {
 	constructor(
-		private $fs: IFileSystem,
 		private $logger: ILogger,
-		private $projectDataService: IProjectDataService,
+		private $projectConfigService: IProjectConfigService,
 		private $prompter: IPrompter
 	) {}
 
 	public async handleMarkingModeFullDeprecation(
 		options: IMarkingModeFullDeprecationOptions
 	): Promise<void> {
-		this.$logger.error(
-			"handleMarkingModeFullDeprecation has not yet been updated to the new config handling!!!!"
+		let markingModeValue = this.$projectConfigService.getValue(
+			"android.markingMode"
 		);
-		return;
-
-		const { projectDir, skipWarnings, forceSwitch } = options;
-		const projectData = this.$projectDataService.getProjectData(projectDir);
-		const innerPackageJsonPath = path.join(
-			projectData.getAppDirectoryPath(projectDir),
-			PACKAGE_JSON_FILE_NAME
-		);
-		if (!this.$fs.exists(innerPackageJsonPath)) {
-			return;
-		}
-
-		const innerPackageJson = this.$fs.readJson(innerPackageJsonPath);
-		let markingModeValue =
-			(innerPackageJson &&
-				innerPackageJson.android &&
-				typeof innerPackageJson.android[MARKING_MODE_PROP] === "string" &&
-				innerPackageJson.android[MARKING_MODE_PROP]) ||
-			"";
+		const { skipWarnings, forceSwitch } = options;
 
 		if (forceSwitch) {
-			this.setMarkingMode(
-				innerPackageJsonPath,
-				innerPackageJson,
-				MarkingMode.None
-			);
+			this.setMarkingMode(MarkingMode.None);
 			return;
 		}
 
@@ -73,27 +47,16 @@ __Improve your app by switching to "${MARKING_MODE_PROP}:${MarkingMode.None}".__
 			);
 
 			markingModeValue = hasSwitched ? MarkingMode.None : MarkingMode.Full;
-			this.setMarkingMode(
-				innerPackageJsonPath,
-				innerPackageJson,
-				markingModeValue
-			);
+			this.setMarkingMode(markingModeValue);
 		}
 
 		if (!skipWarnings && markingModeValue.toLowerCase() !== MarkingMode.None) {
 			this.showMarkingModeFullWarning();
 		}
 	}
 
-	private setMarkingMode(
-		packagePath: string,
-		packageValue: any,
-		newMode: string
-	) {
-		packageValue = packageValue || {};
-		packageValue.android = packageValue.android || {};
-		packageValue.android[MARKING_MODE_PROP] = newMode;
-		this.$fs.writeJson(packagePath, packageValue);
+	private setMarkingMode(newMode: string) {
+		this.$projectConfigService.setValue("android.markingMode", newMode);
 	}
 
 	private showMarkingModeFullWarning() {

lib/services/project-config-service.ts

@@ -7,11 +7,17 @@ import * as path from "path";
 import * as _ from "lodash";
 import * as ts from "typescript";
 import { IFileSystem, IProjectHelper } from "../common/declarations";
-import { injector } from "../common/yok";
 import { INsConfig, IProjectConfigService } from "../definitions/project";
 import { IInjector } from "../common/definitions/yok";
+import {
+	ConfigTransformer,
+	IConfigTransformer,
+	SupportedConfigValues,
+} from "../tools/config-manipulation/config-transformer";
 import { IBasePluginData } from "../definitions/plugins";
 import semver = require("semver/preload");
+import { injector } from "../common/yok";
+import { EOL } from "os";
 
 export class ProjectConfigService implements IProjectConfigService {
 	constructor(
@@ -119,6 +125,39 @@ export default {
 		return _.get(this.readConfig(), key);
 	}
 
+	public setValue(key: string, value: SupportedConfigValues) {
+		const { hasTS, configJSFilePath, configTSFilePath } = this.detectInfo();
+		const configFilePath = configTSFilePath || configJSFilePath;
+		const configContent = this.$fs.readText(configFilePath);
+
+		try {
+			const transformer: IConfigTransformer = new ConfigTransformer(
+				configContent
+			);
+			const newContent = transformer.setValue(key, value);
+			this.$fs.writeFile(configFilePath, newContent);
+		} catch (error) {
+			this.$logger.error(`Failed to update config.` + error);
+		} finally {
+			// verify config is updated correctly
+			if (this.getValue(key) !== value) {
+				this.$logger.error(
+					`${EOL}Failed to update ${
+						hasTS ? CONFIG_FILE_NAME_TS : CONFIG_FILE_NAME_JS
+					}.${EOL}`
+				);
+				this.$logger.printMarkdown(
+					`Please manually update \`${
+						hasTS ? CONFIG_FILE_NAME_TS : CONFIG_FILE_NAME_JS
+					}\` and set \`${key}\` to \`${value}\`.${EOL}`
+				);
+
+				// restore original content
+				this.$fs.writeFile(configFilePath, configContent);
+			}
+		}
+	}
+
 	public writeDefaultConfig(projectDir: string, appId?: string) {
 		const configTSFilePath = path.join(
 			projectDir || this.projectHelper.projectDir,