chore(nsconfig): export constants and getDefautNConfig to public API

KristianDD · KristianDD · commit d84fcb0a0b31 · 2018-03-14T10:35:21.000+02:00
diff --git a/PublicAPI.md b/PublicAPI.md
@@ -40,6 +40,7 @@ const tns = require("nativescript");
 	* [events](#events)
 * [analyticsSettingsService](#analyticsSettingsService)
 	* [getClientId](#getClientId)
+* [constants](#constants)
 
 
 ## Module projectService
@@ -187,6 +188,17 @@ Returns an IProjectData object that is initialized with the provided package.jso
 getProjectDataFromContent(packageJsonContent: string, nsconfigContent: string, projectDir?: string): IProjectData
 ```
 
+### getNsConfigDefaultContent
+Returns the default content of "nsconfig.json" merged with the properties provided by the the `data` argument.
+* Definition:
+```TypeScript
+/**
+ * Returns the default content of "nsconfig.json" merged with the properties provided by the "data" argument.
+ * @param {Object} data Properties that should not be defaulted.
+ */
+ getNsConfigDefaultContent(data: Object): string
+```
+
 ## extensibilityService
 `extensibilityService` module gives access to methods for working with CLI's extensions - list, install, uninstall, load them. The extensions add new functionality to CLI, so once an extension is loaded, all methods added to it's public API are accessible directly through CLI when it is used as a library. Extensions may also add new commands, so they are accessible through command line when using NativeScript CLI.
 
@@ -998,6 +1010,8 @@ tns.analyticsSettingsService.getPlaygroundInfo("/my/project/path")
 		console.log(playgroundInfo.usedTutorial);
 	});
 ```
+## constants
+Contains various constants related to NativeScript.
 
 ## How to add a new method to Public API
 CLI is designed as command line tool and when it is used as a library, it does not give you access to all of the methods. This is mainly implementation detail. Most of the CLI's code is created to work in command line, not as a library, so before adding method to public API, most probably it will require some modification.
diff --git a/lib/bootstrap.ts b/lib/bootstrap.ts
@@ -5,6 +5,7 @@ $injector.require("options", "./options");
 // note: order above is important!
 $injector.require("nativescript-cli", "./nativescript-cli");
 
+$injector.requirePublicClass("constants", "./constants-provider");
 $injector.require("projectData", "./project-data");
 $injector.requirePublic("projectDataService", "./services/project-data-service");
 $injector.requirePublic("projectService", "./services/project-service");
diff --git a/lib/constants-provider.ts b/lib/constants-provider.ts
@@ -0,0 +1,9 @@
+import * as constants from './constants';
+
+export class Constants implements IDictionary<any> {
+	constructor () {
+		Object.assign(this, constants);
+	}
+}
+
+$injector.register("constants", Constants);
diff --git a/lib/project-data.ts b/lib/project-data.ts
@@ -37,7 +37,7 @@ export class ProjectData implements IProjectData {
 	public projectFilePath: string;
 	public projectId: string;
 	public projectName: string;
-	public nsConfig: any;
+	public nsConfig: INsConfig;
 	public appDirectoryPath: string;
 	public appResourcesDirectoryPath: string;
 	public dependencies: any;
@@ -160,7 +160,7 @@ export class ProjectData implements IProjectData {
 			return null;
 		}
 
-		const configNSFilePath = path.join(projectDir, constants.CONFIG_NS_FILE_NAME);
+		const configNSFilePath = path.join(projectDir, this.getNsConfigRelativePath());
 
 		if (!this.$fs.exists(configNSFilePath)) {
 			return null;
@@ -169,6 +169,10 @@ export class ProjectData implements IProjectData {
 		return this.$fs.readText(configNSFilePath);
 	}
 
+	public getNsConfigRelativePath(): string {
+		return  constants.CONFIG_NS_FILE_NAME;
+	}
+
 	private resolveToProjectDir(pathToResolve: string, projectDir?: string): string {
 		if (!projectDir) {
 			projectDir = this.projectDir;
diff --git a/lib/services/project-data-service.ts b/lib/services/project-data-service.ts
@@ -124,5 +124,13 @@ export class ProjectDataService implements IProjectDataService {
 			projectFilePath
 		};
 	}
+
+	@exported("projectDataService")
+	public getNsConfigDefaultContent(data: Object): string {
+		const config: INsConfig = {};
+		Object.assign(config, data);
+
+		return JSON.stringify(config);
+	}
 }
 $injector.register("projectDataService", ProjectDataService);
diff --git a/test/nativescript-cli-lib.ts b/test/nativescript-cli-lib.ts
@@ -16,7 +16,8 @@ describe("nativescript-cli-lib", () => {
 		settingsService: ["setSettings"],
 		deviceEmitter: null,
 		projectService: ["createProject", "isValidNativeScriptProject"],
-		projectDataService: ["getProjectData", "getProjectDataFromContent"],
+		projectDataService: ["getProjectData", "getProjectDataFromContent", "getNsConfigDefaultContent"],
+		constants: ["CONFIG_NS_APP_RESOURCES_ENTRY", "CONFIG_NS_APP_ENTRY", "CONFIG_NS_FILE_NAME"],
 		localBuildService: ["build"],
 		deviceLogProvider: null,
 		npm: ["install", "uninstall", "view", "search"],

Original file line number	Diff line number	Diff line change
`@@ -124,5 +124,13 @@ export class ProjectDataService implements IProjectDataService {`
`124`	`124`	`projectFilePath`
`125`	`125`	`};`
`126`	`126`	`}`
	`127`	`+`
	`128`	`+ @exported("projectDataService")`
	`129`	`+ public getNsConfigDefaultContent(data: Object): string {`
	`130`	`+ const config: INsConfig = {};`
	`131`	`+ Object.assign(config, data);`
	`132`	`+`
	`133`	`+ return JSON.stringify(config);`
	`134`	`+ }`
`127`	`135`	`}`
`128`	`136`	`$injector.register("projectDataService", ProjectDataService);`