feat(project): project config buildPath option for custom build directory (#6131)

Author: farfromrefug

lib/commands/clean.ts

@@ -6,6 +6,7 @@ import {
 	IProjectCleanupResult,
 	IProjectCleanupService,
 	IProjectConfigService,
+	IProjectData,
 	IProjectService,
 } from "../definitions/project";
 
@@ -83,6 +84,7 @@ export class CleanCommand implements ICommand {
 	constructor(
 		private $projectCleanupService: IProjectCleanupService,
 		private $projectConfigService: IProjectConfigService,
+		private $projectData: IProjectData,
 		private $terminalSpinnerService: ITerminalSpinnerService,
 		private $projectService: IProjectService,
 		private $prompter: IPrompter,
@@ -108,7 +110,7 @@ export class CleanCommand implements ICommand {
 
 		let pathsToClean = [
 			constants.HOOKS_DIR_NAME,
-			constants.PLATFORMS_DIR_NAME,
+			this.$projectData.getBuildRelativeDirectoryPath(),
 			constants.NODE_MODULES_FOLDER_NAME,
 		];
 

lib/commands/typings.ts

@@ -161,8 +161,7 @@ export class TypingsCommand implements ICommand {
 		);
 
 		const dtsGeneratorPath = path.resolve(
-			this.$projectData.projectDir,
-			"platforms",
+			this.$projectData.platformsDir,
 			"android",
 			"build-tools",
 			"dts-generator.jar",

lib/controllers/migrate-controller.ts

@@ -722,7 +722,7 @@ export class MigrateController
 	private async cleanUpProject(projectData: IProjectData): Promise<void> {
 		await this.$projectCleanupService.clean([
 			constants.HOOKS_DIR_NAME,
-			constants.PLATFORMS_DIR_NAME,
+			projectData.getBuildRelativeDirectoryPath(),
 			constants.NODE_MODULES_FOLDER_NAME,
 			constants.PACKAGE_LOCK_JSON_FILE_NAME,
 		]);

lib/controllers/update-controller.ts

@@ -109,7 +109,7 @@ export class UpdateController
 		// clean up project files
 		this.spinner.info("Cleaning up project files before update");
 
-		await this.cleanUpProject();
+		await this.cleanUpProject(projectData);
 
 		this.spinner.succeed("Project files have been cleaned up");
 
@@ -293,10 +293,10 @@ export class UpdateController
 		}
 	}
 
-	private async cleanUpProject(): Promise<void> {
+	private async cleanUpProject(projectData: IProjectData): Promise<void> {
 		await this.$projectCleanupService.clean([
 			constants.HOOKS_DIR_NAME,
-			constants.PLATFORMS_DIR_NAME,
+			projectData.getBuildRelativeDirectoryPath(),
 			constants.NODE_MODULES_FOLDER_NAME,
 			constants.PACKAGE_LOCK_JSON_FILE_NAME,
 		]);

lib/definitions/project.d.ts

@@ -191,6 +191,11 @@ interface INsConfig {
 	main?: string;
 	appPath?: string;
 	appResourcesPath?: string;
+	/**
+	 * Where the native projects are generated, relative to the project root.
+	 * Defaults to `platforms`.
+	 */
+	buildPath?: string;
 	shared?: boolean;
 	overridePods?: string;
 	webpackConfigPath?: string;

lib/project-data.ts

@@ -169,14 +169,18 @@ export class ProjectData implements IProjectData {
 				nsConfig && nsConfig.projectName
 					? nsConfig.projectName
 					: this.$projectHelper.sanitizeName(path.basename(projectDir));
-			this.platformsDir = path.join(projectDir, constants.PLATFORMS_DIR_NAME);
+			// read before `platformsDir`, which is derived from it
+			this.nsConfig = nsConfig;
+			this.platformsDir = path.join(
+				projectDir,
+				this.getBuildRelativeDirectoryPath(),
+			);
 			this.projectFilePath = projectFilePath;
 			this.projectIdentifiers = this.initializeProjectIdentifiers(nsConfig);
 			this.packageJsonData = packageJsonData;
 			this.dependencies = packageJsonData.dependencies;
 			this.devDependencies = packageJsonData.devDependencies;
 			this.projectType = this.getProjectType();
-			this.nsConfig = nsConfig;
 			this.ignoredDependencies = nsConfig?.ignoredNativeDependencies;
 			this.appDirectoryPath = this.getAppDirectoryPath();
 			this.appResourcesDirectoryPath = this.getAppResourcesDirectoryPath();
@@ -276,6 +280,18 @@ export class ProjectData implements IProjectData {
 		// );
 	}
 
+	/**
+	 * Where the native projects are generated, relative to the project root.
+	 * `buildPath` in the project config overrides the default `platforms`.
+	 */
+	public getBuildRelativeDirectoryPath(): string {
+		if (this.nsConfig && this.nsConfig[constants.CONFIG_NS_BUILD_ENTRY]) {
+			return this.nsConfig[constants.CONFIG_NS_BUILD_ENTRY];
+		}
+
+		return constants.PLATFORMS_DIR_NAME;
+	}
+
 	public getAppDirectoryPath(projectDir?: string): string {
 		const appRelativePath = this.getAppDirectoryRelativePath();
 

test/controllers/update-controller.ts

@@ -20,6 +20,7 @@ function createTestInjector(projectDir: string = projectFolder): IInjector {
 		initializeProjectData: () => {
 			/* empty */
 		},
+		getBuildRelativeDirectoryPath: () => "platforms",
 		dependencies: {
 			"@nativescript/core": "next",
 		},

test/project-data.ts

@@ -59,6 +59,7 @@ describe("projectData", () => {
 			bundlerConfigPath?: string;
 			projectName?: string;
 			bundler?: string;
+			buildPath?: string;
 		};
 	}): IProjectData => {
 		const testInjector = createTestInjector();
@@ -96,6 +97,36 @@ describe("projectData", () => {
 		return projectData;
 	};
 
+	describe("buildPath", () => {
+		it("defaults to the platforms directory", () => {
+			const projectData = prepareTest();
+
+			assert.deepStrictEqual(
+				projectData.getBuildRelativeDirectoryPath(),
+				"platforms",
+			);
+			assert.deepStrictEqual(
+				projectData.platformsDir,
+				path.join(projectDir, "platforms"),
+			);
+		});
+
+		it("is read from the project config", () => {
+			const projectData = prepareTest({
+				configData: { buildPath: "build/native" },
+			});
+
+			assert.deepStrictEqual(
+				projectData.getBuildRelativeDirectoryPath(),
+				"build/native",
+			);
+			assert.deepStrictEqual(
+				projectData.platformsDir,
+				path.join(projectDir, "build/native"),
+			);
+		});
+	});
+
 	describe("projectType", () => {
 		const assertProjectType = (
 			dependencies: any,

test/stubs.ts

@@ -735,6 +735,10 @@ export class ProjectDataStub implements IProjectData {
 	public getAppDirectoryRelativePath(): string {
 		return "app";
 	}
+
+	public getBuildRelativeDirectoryPath(): string {
+		return constants.PLATFORMS_DIR_NAME;
+	}
 }
 
 export class AndroidPluginBuildServiceStub implements IAndroidPluginBuildService {