feat: add yaml and jsonMetadata options to TypingsCommand

Author: edusperoni

lib/commands/typings.ts

@@ -219,19 +219,35 @@ export class TypingsCommand implements ICommand {
 			path.resolve(this.$projectData.projectDir, "typings", "ios"),
 		);
 
+		const env: Record<string, string> = {
+			...process.env,
+			TNS_TYPESCRIPT_DECLARATIONS_PATH: path.resolve(
+				this.$projectData.projectDir,
+				"typings",
+				"ios",
+			),
+		};
+
+		if (this.$options.yaml) {
+			const yamlDir = path.resolve(this.$options.yaml);
+			this.$fs.ensureDirectoryExists(yamlDir);
+			env.NS_DEBUG_METADATA_PATH = yamlDir;
+			this.$logger.info(`Metadata YAML output will be written to: ${yamlDir}`);
+		}
+
+		if (this.$options.jsonMetadata) {
+			const jsonDir = path.resolve(this.$options.jsonMetadata);
+			this.$fs.ensureDirectoryExists(jsonDir);
+			env.NS_JSON_METADATA_PATH = jsonDir;
+			this.$logger.info(`Metadata JSON output will be written to: ${jsonDir}`);
+		}
+
 		await this.$childProcess.spawnFromEvent(
 			"node",
 			[this.$staticConfig.cliBinPath, "build", "ios"],
 			"exit",
 			{
-				env: {
-					...process.env,
-					TNS_TYPESCRIPT_DECLARATIONS_PATH: path.resolve(
-						this.$projectData.projectDir,
-						"typings",
-						"ios",
-					),
-				},
+				env,
 				stdio: "inherit",
 			},
 		);

lib/declarations.d.ts

@@ -31,7 +31,7 @@ interface INodePackageManager {
 	install(
 		packageName: string,
 		pathToSave: string,
-		config: INodePackageManagerInstallOptions
+		config: INodePackageManagerInstallOptions,
 	): Promise<INpmInstallResultInfo>;
 
 	/**
@@ -44,7 +44,7 @@ interface INodePackageManager {
 	uninstall(
 		packageName: string,
 		config?: IDictionary<string | boolean>,
-		path?: string
+		path?: string,
 	): Promise<string>;
 
 	/**
@@ -84,7 +84,7 @@ interface INodePackageManager {
 	 */
 	search(
 		filter: string[],
-		config: IDictionary<string | boolean>
+		config: IDictionary<string | boolean>,
 	): Promise<string>;
 
 	/**
@@ -130,7 +130,7 @@ interface IPerformanceService {
 		methodInfo: string,
 		startTime: number,
 		endTime: number,
-		args: any[]
+		args: any[],
 	): void;
 
 	// Will return a reference time in milliseconds
@@ -141,48 +141,47 @@ interface IPackageInstallationManager {
 	install(
 		packageName: string,
 		packageDir: string,
-		options?: INpmInstallOptions
+		options?: INpmInstallOptions,
 	): Promise<any>;
 	uninstall(
 		packageName: string,
 		packageDir: string,
-		options?: IDictionary<string | boolean>
+		options?: IDictionary<string | boolean>,
 	): Promise<any>;
 	getLatestVersion(packageName: string): Promise<string>;
 	getNextVersion(packageName: string): Promise<string>;
 	getLatestCompatibleVersion(
 		packageName: string,
-		referenceVersion?: string
+		referenceVersion?: string,
 	): Promise<string>;
 	getMaxSatisfyingVersion(
 		packageName: string,
-		versionRange: string
+		versionRange: string,
 	): Promise<string>;
 	getLatestCompatibleVersionSafe(
 		packageName: string,
-		referenceVersion?: string
+		referenceVersion?: string,
 	): Promise<string>;
 	getInspectorFromCache(
 		inspectorNpmPackageName: string,
-		projectDir: string
+		projectDir: string,
 	): Promise<string>;
 	clearInspectorCache(): void;
 	getInstalledDependencyVersion(
 		packageName: string,
-		projectDir?: string
+		projectDir?: string,
 	): Promise<string>;
 	getMaxSatisfyingVersionSafe(
 		packageName: string,
-		versionIdentifier: string
+		versionIdentifier: string,
 	): Promise<string>;
 }
 
 /**
  * Describes options that can be passed to manipulate package installation.
  */
 interface INodePackageManagerInstallOptions
-	extends INpmInstallConfigurationOptions,
-		IDictionary<string | boolean> {
+	extends INpmInstallConfigurationOptions, IDictionary<string | boolean> {
 	/**
 	 * Destination of the installation.
 	 * @type {string}
@@ -266,7 +265,7 @@ interface INpmPeerDependencyInfo {
 				 * @type {string}
 				 */
 				requires: string;
-			}
+			},
 		];
 		/**
 		 * Dependencies of the dependency.
@@ -550,8 +549,7 @@ interface INpmInstallConfigurationOptionsBase {
 	ignoreScripts: boolean; //npm flag
 }
 
-interface INpmInstallConfigurationOptions
-	extends INpmInstallConfigurationOptionsBase {
+interface INpmInstallConfigurationOptions extends INpmInstallConfigurationOptionsBase {
 	disableNpmInstall: boolean;
 }
 
@@ -596,8 +594,11 @@ interface ITypingsOptions {
 	filter: string;
 }
 
+yaml: string;
+jsonMetadata: string;
 interface IOptions
-	extends IRelease,
+	extends
+		IRelease,
 		IDeviceIdentifier,
 		IJustLaunch,
 		IAvd,
@@ -622,7 +623,7 @@ interface IOptions
 	argv: IYargArgv;
 	validateOptions(
 		commandSpecificDashedOptions?: IDictionary<IDashedOption>,
-		projectData?: IProjectData
+		projectData?: IProjectData,
 	): void;
 	options: IDictionary<IDashedOption>;
 	shorthands: string[];
@@ -719,26 +720,22 @@ interface IEnvOptions {
 }
 
 interface IAndroidBuildOptionsSettings
-	extends IAndroidReleaseOptions,
-		IRelease,
-		Partial<IHasAndroidBundle> {}
+	extends IAndroidReleaseOptions, IRelease, Partial<IHasAndroidBundle> {}
 
 interface IHasAndroidBundle {
 	androidBundle: boolean;
 }
 
 interface IPlatformBuildData
-	extends IRelease,
-		IHasUseHotModuleReloadOption,
-		IBuildConfig,
-		IEnvOptions {}
+	extends IRelease, IHasUseHotModuleReloadOption, IBuildConfig, IEnvOptions {}
 
 interface IDeviceEmulator extends IHasEmulatorOption, IDeviceIdentifier {}
 
 interface IRunPlatformOptions extends IJustLaunch, IDeviceEmulator {}
 
 interface IDeployPlatformOptions
-	extends IAndroidReleaseOptions,
+	extends
+		IAndroidReleaseOptions,
 		IRelease,
 		IClean,
 		IDeviceEmulator,
@@ -834,7 +831,7 @@ interface IAndroidToolsInfo {
 	 */
 	validateJavacVersion(
 		installedJavaVersion: string,
-		options?: IAndroidToolsInfoOptions
+		options?: IAndroidToolsInfoOptions,
 	): boolean;
 
 	/**
@@ -913,14 +910,14 @@ interface IAppDebugSocketProxyFactory extends NodeJS.EventEmitter {
 		device: Mobile.IiOSDevice,
 		appId: string,
 		projectName: string,
-		projectDir: string
+		projectDir: string,
 	): Promise<any>;
 
 	ensureWebSocketProxy(
 		device: Mobile.IiOSDevice,
 		appId: string,
 		projectName: string,
-		projectDir: string
+		projectDir: string,
 	): Promise<any>;
 
 	removeAllProxies(): void;
@@ -939,12 +936,12 @@ interface IiOSSocketRequestExecutor {
 	executeAttachRequest(
 		device: Mobile.IiOSDevice,
 		timeout: number,
-		projectId: string
+		projectId: string,
 	): Promise<void>;
 	executeRefreshRequest(
 		device: Mobile.IiOSDevice,
 		timeout: number,
-		appId: string
+		appId: string,
 	): Promise<boolean>;
 }
 
@@ -995,7 +992,7 @@ interface IProjectNameService {
 	 */
 	ensureValidName(
 		projectName: string,
-		validateOptions?: { force: boolean }
+		validateOptions?: { force: boolean },
 	): Promise<string>;
 }
 
@@ -1089,7 +1086,7 @@ interface IBundleValidatorHelper {
 	 */
 	getBundlerDependencyVersion(
 		projectData: IProjectData,
-		bundlerName?: string
+		bundlerName?: string,
 	): string;
 }
 
@@ -1171,7 +1168,7 @@ interface IAssetsGenerationService {
 	 * @returns {Promise<void>}
 	 */
 	generateSplashScreens(
-		splashesGenerationData: IResourceGenerationData
+		splashesGenerationData: IResourceGenerationData,
 	): Promise<void>;
 }
 
@@ -1207,7 +1204,7 @@ interface IPlatformValidationService {
 		provision: true | string,
 		teamId: true | string,
 		projectData: IProjectData,
-		platform?: string
+		platform?: string,
 	): Promise<boolean>;
 
 	validatePlatformInstalled(platform: string, projectData: IProjectData): void;
@@ -1220,35 +1217,35 @@ interface IPlatformValidationService {
 	 */
 	isPlatformSupportedForOS(
 		platform: string,
-		projectData: IProjectData
+		projectData: IProjectData,
 	): boolean;
 }
 
 interface IPlatformCommandHelper {
 	addPlatforms(
 		platforms: string[],
 		projectData: IProjectData,
-		frameworkPath?: string
+		frameworkPath?: string,
 	): Promise<void>;
 	cleanPlatforms(
 		platforms: string[],
 		projectData: IProjectData,
-		frameworkPath: string
+		frameworkPath: string,
 	): Promise<void>;
 	removePlatforms(
 		platforms: string[],
-		projectData: IProjectData
+		projectData: IProjectData,
 	): Promise<void>;
 	updatePlatforms(
 		platforms: string[],
-		projectData: IProjectData
+		projectData: IProjectData,
 	): Promise<void>;
 	getInstalledPlatforms(projectData: IProjectData): string[];
 	getAvailablePlatforms(projectData: IProjectData): string[];
 	getPreparedPlatforms(projectData: IProjectData): string[];
 	getCurrentPlatformVersion(
 		platform: string,
-		projectData: IProjectData
+		projectData: IProjectData,
 	): string;
 }