chore: config handling

Author: NathanWalker

PublicAPI.md

@@ -221,11 +221,10 @@ Returns an IProjectData object that is initialized with the provided package.jso
 /**
  * Returns an initialized IProjectData object containing data about the NativeScript project in the provided projectDir
  * @param {string} packageJsonContent The content of the project.json file in the root of the project
- * @param {string} nsconfigContent The content of the nsconfig.json file in the root of the project
  * @param {string} projectDir The path to the project
  * @returns {IProjectData} Information about the NativeScript project
  */
-getProjectDataFromContent(packageJsonContent: string, nsconfigContent: string, projectDir?: string): IProjectData
+getProjectDataFromContent(packageJsonContent: string, projectDir?: string): IProjectData
 ```
 
 ### getNsConfigDefaultContent

lib/definitions/project.d.ts

@@ -171,7 +171,7 @@ interface IProjectData extends ICreateProjectData {
 	 * @returns {void}
 	 */
 	initializeProjectData(projectDir?: string): void;
-	initializeProjectDataFromContent(packageJsonContent: string, nsconfigContent: string, projectDir?: string): void;
+	initializeProjectDataFromContent(packageJsonContent: string, projectDir?: string): void;
 	getAppDirectoryPath(projectDir?: string): string;
 	getAppDirectoryRelativePath(): string;
 	getAppResourcesDirectoryPath(projectDir?: string): string;
@@ -275,7 +275,7 @@ interface IProjectConfigService {
    * read the nativescript.config.(js|ts) file
    * @returns {INsConfig} the parsed config data
    */
-  readConfig(): INsConfig;
+  readConfig(projectDir?: string): INsConfig;
   /**
    * Get value for a given config key path
    * @param key the property key path

lib/project-data.ts

@@ -4,10 +4,11 @@ import * as _ from 'lodash';
 import { parseJson } from "./common/helpers";
 import { EOL } from "os";
 import { cache } from "./common/decorators";
-import { IProjectData, INsConfig } from "./definitions/project";
+import { IProjectData, INsConfig, IProjectConfigService } from "./definitions/project";
 import { IAndroidResourcesMigrationService, IStaticConfig, IOptions } from "./declarations";
 import { IStringDictionary, IFileSystem, IErrors, IProjectHelper } from "./common/declarations";
 import { injector } from "./common/yok";
+import { IInjector } from "./common/definitions/yok";
 
 interface IProjectType {
 	type: string;
@@ -82,9 +83,14 @@ export class ProjectData implements IProjectData {
 		private $projectHelper: IProjectHelper,
 		private $staticConfig: IStaticConfig,
 		private $options: IOptions,
-		private $logger: ILogger,
+    private $logger: ILogger,
+    private $injector: IInjector,
 		private $androidResourcesMigrationService: IAndroidResourcesMigrationService,
-		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants) { }
+    private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants) { }
+    
+  get projectConfig(): IProjectConfigService {
+    return this.$injector.resolve('projectConfigService');
+  }
 
 	public initializeProjectData(projectDir?: string): void {
 		projectDir = projectDir || this.$projectHelper.projectDir;
@@ -95,9 +101,8 @@ export class ProjectData implements IProjectData {
 
 			if (this.$fs.exists(projectFilePath)) {
 				const packageJsonContent = this.$fs.readText(projectFilePath);
-				const nsConfigContent = this.getNsConfigContent(projectDir);
 
-				this.initializeProjectDataFromContent(packageJsonContent, nsConfigContent, projectDir);
+				this.initializeProjectDataFromContent(packageJsonContent, projectDir);
 			}
 
 			return;
@@ -106,37 +111,27 @@ export class ProjectData implements IProjectData {
 		this.errorInvalidProject(projectDir);
 	}
 
-	public initializeProjectDataFromContent(packageJsonContent: string, nsconfigContent: string, projectDir?: string): void {
+	public initializeProjectDataFromContent(packageJsonContent: string, projectDir?: string): void {
 		projectDir = projectDir || this.$projectHelper.projectDir || "";
 		const projectFilePath = this.getProjectFilePath(projectDir);
-		// If no project found, projectDir should be null
-		let nsData = null;
-		let nsConfig: INsConfig = null;
+    // If no project found, projectDir should be null
+    let nsConfig: INsConfig = this.projectConfig.readConfig(projectDir);
 		let packageJsonData = null;
 
 		try {
 			packageJsonData = parseJson(packageJsonContent);
-			nsData = packageJsonData[this.$staticConfig.CLIENT_NAME_KEY_IN_PROJECT_FILE];
 		} catch (err) {
 			this.$errors.fail(`The project file ${this.projectFilePath} is corrupted. ${EOL}` +
 				`Consider restoring an earlier version from your source control or backup.${EOL}` +
 				`Additional technical info: ${err.toString()}`);
 		}
 
-		try {
-			nsConfig = nsconfigContent ? <INsConfig>parseJson(nsconfigContent) : null;
-		} catch (err) {
-			this.$errors.fail(`The NativeScript configuration file ${constants.CONFIG_NS_FILE_NAME} is corrupted. ${EOL}` +
-				`Consider restoring an earlier version from your source control or backup.${EOL}` +
-				`Additional technical info: ${err.toString()}`);
-		}
-
-		if (nsData) {
+		if (nsConfig) {
 			this.projectDir = projectDir;
 			this.projectName = this.$projectHelper.sanitizeName(path.basename(projectDir));
 			this.platformsDir = path.join(projectDir, constants.PLATFORMS_DIR_NAME);
 			this.projectFilePath = projectFilePath;
-			this.projectIdentifiers = this.initializeProjectIdentifiers(nsData.id);
+			this.projectIdentifiers = this.initializeProjectIdentifiers(nsConfig);
 			this.dependencies = packageJsonData.dependencies;
 			this.devDependencies = packageJsonData.devDependencies;
 			this.projectType = this.getProjectType();
@@ -207,22 +202,8 @@ export class ProjectData implements IProjectData {
 		return constants.APP_FOLDER_NAME;
 	}
 
-	private getNsConfigContent(projectDir: string): string {
-		if (!projectDir) {
-			return null;
-		}
-
-		const configNSFilePath = path.join(projectDir, this.getNsConfigRelativePath());
-
-		if (!this.$fs.exists(configNSFilePath)) {
-			return null;
-		}
-
-		return this.$fs.readText(configNSFilePath);
-	}
-
 	public getNsConfigRelativePath(): string {
-		return constants.CONFIG_NS_FILE_NAME;
+		return constants.CONFIG_FILE_NAME_JS;
 	}
 
 	private resolveToProjectDir(pathToResolve: string, projectDir?: string): string {
@@ -237,21 +218,17 @@ export class ProjectData implements IProjectData {
 		return path.resolve(projectDir, pathToResolve);
 	}
 
-	private initializeProjectIdentifiers(data: string | Mobile.IProjectIdentifier): Mobile.IProjectIdentifier {
-		let identifier: Mobile.IProjectIdentifier;
-		data = data || "";
-
-		if (typeof data === "string") {
-			identifier = {
-				android: data,
-				ios: data
-			};
-		} else {
-			identifier = {
-				android: data.android || "",
-				ios: data.ios || ""
-			};
-		}
+	private initializeProjectIdentifiers(config: INsConfig): Mobile.IProjectIdentifier {
+		let identifier: Mobile.IProjectIdentifier = {
+      ios: '',
+      android: ''
+    };
+		if (config.ios) {
+      identifier.ios = config.ios.id || config.id;
+    } 
+    if (config.android) {
+      identifier.android = config.android.id || config.id;
+    }
 
 		return identifier;
 	}

lib/services/project-config-service.ts

@@ -5,21 +5,26 @@ import * as ts from 'typescript';
 import { IFileSystem } from "../common/declarations";
 import { injector } from "../common/yok";
 import { IProjectData, INsConfig, IProjectConfigService } from "../definitions/project";
+import { IInjector } from "../common/definitions/yok";
 
 export class ProjectConfigService implements IProjectConfigService {
   private _config: INsConfig;
 
 	constructor(
 		private $fs: IFileSystem,
     private $logger: ILogger,
-    private $projectData: IProjectData,
+    private $injector: IInjector
 	) {
 
   }
 
-  public readConfig(): INsConfig {
-    const configJSFilePath = path.join(this.$projectData.projectDir, CONFIG_FILE_NAME_JS);
-    const configTSFilePath = path.join(this.$projectData.projectDir, CONFIG_FILE_NAME_TS);
+  get projectData(): IProjectData {
+    return this.$injector.resolve('projectData');
+  }
+
+  public readConfig(projectDir?: string): INsConfig {
+    const configJSFilePath = path.join(projectDir || this.projectData.projectDir, CONFIG_FILE_NAME_JS);
+    const configTSFilePath = path.join(projectDir || this.projectData.projectDir, CONFIG_FILE_NAME_TS);
 
     const hasTS = this.$fs.exists(configTSFilePath);
     const hasJS = this.$fs.exists(configJSFilePath);

lib/services/project-data-service.ts

@@ -91,10 +91,10 @@ export class ProjectDataService implements IProjectDataService {
 	}
 
 	@exported("projectDataService")
-	public getProjectDataFromContent(packageJsonContent: string, nsconfigContent: string, projectDir?: string): IProjectData {
+	public getProjectDataFromContent(packageJsonContent: string, projectDir?: string): IProjectData {
 		projectDir = projectDir || this.defaultProjectDir;
 		this.projectDataCache[projectDir] = this.projectDataCache[projectDir] || this.$injector.resolve<IProjectData>(ProjectData);
-		this.projectDataCache[projectDir].initializeProjectDataFromContent(packageJsonContent, nsconfigContent, projectDir);
+		this.projectDataCache[projectDir].initializeProjectDataFromContent(packageJsonContent, projectDir);
 		return this.projectDataCache[projectDir];
 	}
 

test/plugins-service.ts

@@ -5,7 +5,6 @@ import { PackageInstallationManager } from "../lib/package-installation-manager"
 import { NodePackageManager } from "../lib/node-package-manager";
 import { YarnPackageManager } from "../lib/yarn-package-manager";
 import { PnpmPackageManager } from "../lib/pnpm-package-manager";
-import { FileSystem } from "../lib/common/file-system";
 import { ProjectData } from "../lib/project-data";
 import { ChildProcess } from "../lib/common/child-process";
 import { Options } from "../lib/options";
@@ -35,16 +34,18 @@ import StaticConfigLib = require("../lib/config");
 import * as path from "path";
 import * as temp from "temp";
 import * as _ from 'lodash';
-import { PLUGINS_BUILD_DATA_FILENAME } from '../lib/constants';
+import { PLUGINS_BUILD_DATA_FILENAME, CONFIG_FILE_NAME_JS, CONFIG_FILE_NAME_TS } from '../lib/constants';//PACKAGE_JSON_FILE_NAME
 import { GradleCommandService } from '../lib/services/android/gradle-command-service';
 import { GradleBuildService } from '../lib/services/android/gradle-build-service';
 import { GradleBuildArgsService } from '../lib/services/android/gradle-build-args-service';
 import * as util from "util";
 import { IPluginData, IPluginsService } from '../lib/definitions/plugins';
 import { IProjectData } from '../lib/definitions/project';
-import { IStringDictionary } from '../lib/common/declarations';
+import { IStringDictionary, IReadFileOptions } from '../lib/common/declarations';
 import { IInjector } from '../lib/common/definitions/yok';
 import { IEventActionData, IGoogleAnalyticsData } from '../lib/common/definitions/google-analytics';
+import { ProjectConfigService } from '../lib/services/project-config-service';
+// import { basename } from 'path';
 temp.track();
 
 let isErrorThrown = false;
@@ -65,8 +66,20 @@ function createTestInjector() {
 	testInjector.register("packageManager", PackageManager);
 	testInjector.register("npm", NodePackageManager);
 	testInjector.register("yarn", YarnPackageManager);
-	testInjector.register("pnpm", PnpmPackageManager);
-	testInjector.register("fs", FileSystem);
+  testInjector.register("pnpm", PnpmPackageManager);
+  const fileSystemStub = new stubs.FileSystemStub();
+  fileSystemStub.readText = (filename: string, encoding?: IReadFileOptions | string): string => {
+    if (filename.indexOf("package.json") > -1) {
+      return `{}`;//packageJsonContent;
+    } else if (filename.indexOf(CONFIG_FILE_NAME_JS) > -1) {
+      return `module.exports = {}`;
+    } else if (filename.indexOf(CONFIG_FILE_NAME_TS) > -1) {
+      return `export default {}`;
+    }
+  };
+  fileSystemStub.exists = (filePath: string): boolean => true;
+  testInjector.register("fs", fileSystemStub);
+  
 	testInjector.register("adb", {});
 	testInjector.register("androidDebugBridgeResultHandler", {});
 	testInjector.register("projectData", ProjectData);
@@ -167,7 +180,8 @@ function createTestInjector() {
 		setShouldDispose: (shouldDispose: boolean): void => undefined
 	});
 	testInjector.register("nodeModulesDependenciesBuilder", {});
-	testInjector.register("tempService", stubs.TempServiceStub);
+  testInjector.register("tempService", stubs.TempServiceStub);
+  testInjector.register("projectConfigService", ProjectConfigService);
 
 	return testInjector;
 }
@@ -224,7 +238,7 @@ async function addPluginWhenExpectingToFail(testInjector: IInjector, plugin: str
 	assert.isTrue(isErrorThrown);
 }
 
-describe("Plugins service", () => {
+describe.only("Plugins service", () => {
 	let testInjector: IInjector;
 	const commands = ["add", "install"];
 	beforeEach(() => {

test/project-data.ts

@@ -1,4 +1,3 @@
-import { ProjectData } from "../lib/project-data";
 import { Yok } from "../lib/common/yok";
 import { DevicePlatformsConstants } from "../lib/common/mobile/device-platforms-constants";
 import { assert } from "chai";
@@ -7,6 +6,8 @@ import * as path from "path";
 import { IProjectData } from "../lib/definitions/project";
 import { IInjector } from "../lib/common/definitions/yok";
 import { IStringDictionary, IProjectHelper } from "../lib/common/declarations";
+import { ProjectConfigService } from "../lib/services/project-config-service";
+import { ProjectData } from "../lib/project-data";
 
 describe("projectData", () => {
 	const createTestInjector = (): IInjector => {
@@ -15,7 +16,7 @@ describe("projectData", () => {
 		testInjector.register("projectHelper", {
 			projectDir: null,
 			sanitizeName: (name: string) => name
-		});
+    });
 
 		testInjector.register("fs", {
 			exists: () => true,
@@ -39,29 +40,33 @@ describe("projectData", () => {
 		testInjector.register("androidResourcesMigrationService", {
 			hasMigrated: () => true
 		});
-
-		testInjector.register("projectData", ProjectData);
+    testInjector.register("projectData", ProjectData);
+    
+    testInjector.register("projectConfigService", ProjectConfigService);
 
 		return testInjector;
 	};
 
 	const projectDir = "projectDir";
-	const prepareTest = (opts?: { packageJsonData?: { dependencies?: IStringDictionary, devDependencies: IStringDictionary }, nsconfigData?: { shared?: boolean, webpackConfigPath?: string } }): IProjectData => {
+	const prepareTest = (opts?: { packageJsonData?: { dependencies?: IStringDictionary, devDependencies: IStringDictionary }, configData?: { shared?: boolean, webpackConfigPath?: string } }): IProjectData => {
 		const testInjector = createTestInjector();
 		const fs = testInjector.resolve("fs");
-		fs.exists = (filePath: string) => filePath && (path.basename(filePath) === "package.json" || (path.basename(filePath) === "nsconfig.json" && opts && opts.nsconfigData));
+		fs.exists = (filePath: string) => {
+      return filePath && (path.basename(filePath) === "package.json" || path.basename(filePath) === "nativescript.config.js")
+    };
 
 		fs.readText = (filePath: string) => {
 			if (path.basename(filePath) === "package.json") {
 				return JSON.stringify({
-					nativescript: {
-						id: "com.test.testid"
-					},
 					dependencies: opts && opts.packageJsonData && opts.packageJsonData.dependencies,
 					devDependencies: opts && opts.packageJsonData && opts.packageJsonData.devDependencies
 				});
-			} else if (path.basename(filePath) === "nsconfig.json" && opts && opts.nsconfigData) {
-				return JSON.stringify(opts.nsconfigData);
+			} else if (path.basename(filePath) === "nativescript.config.js") {
+        if (opts && opts.configData) {
+          return typeof opts.configData === 'string' ? opts.configData : `module.exports = JSON.parse('${JSON.stringify(opts.configData)}')`;
+        } else {
+          return `module.exports = {}`;
+        }
 			}
 
 			return null;
@@ -83,7 +88,7 @@ describe("projectData", () => {
 				packageJsonData: {
 					dependencies,
 					devDependencies
-				}
+        }
 			});
 			assert.deepEqual(projectData.projectType, expectedProjecType);
 		};
@@ -132,17 +137,17 @@ describe("projectData", () => {
 		});
 
 		it("is false when nsconfig.json exists, but shared value is not populated", () => {
-			const projectData = prepareTest({ nsconfigData: { shared: undefined } });
+			const projectData = prepareTest({ configData: { shared: undefined } });
 			assert.isFalse(projectData.isShared);
 		});
 
 		it("is false when nsconfig.json exists and shared value is false", () => {
-			const projectData = prepareTest({ nsconfigData: { shared: false } });
+			const projectData = prepareTest({ configData: { shared: false } });
 			assert.isFalse(projectData.isShared);
 		});
 
 		it("is true when nsconfig.json exists and shared value is true", () => {
-			const projectData = prepareTest({ nsconfigData: { shared: true } });
+			const projectData = prepareTest({ configData: { shared: true } });
 			assert.isTrue(projectData.isShared);
 		});
 	});
@@ -155,13 +160,13 @@ describe("projectData", () => {
 
 		it("returns correct path when full path is set in nsconfig.json", () => {
 			const pathToConfig = path.resolve(path.join("/testDir", "innerDir", "mywebpack.config.js"));
-			const projectData = prepareTest({ nsconfigData: { webpackConfigPath: pathToConfig } });
+			const projectData = prepareTest({ configData: { webpackConfigPath: pathToConfig } });
 			assert.equal(projectData.webpackConfigPath, pathToConfig);
 		});
 
 		it("returns correct path when relative path is set in nsconfig.json", () => {
 			const pathToConfig = path.resolve(path.join("projectDir", "innerDir", "mywebpack.config.js"));
-			const projectData = prepareTest({ nsconfigData: { webpackConfigPath: path.join("./innerDir", "mywebpack.config.js") } });
+			const projectData = prepareTest({ configData: { webpackConfigPath: path.join("./innerDir", "mywebpack.config.js") } });
 			assert.equal(projectData.webpackConfigPath, pathToConfig);
 		});
 	});