bundo-appgen 0.0.1-beta.7

package/src/_bin/_main/_xcodegen/_create-project-spec/create-project-spec.mts

@@ -0,0 +1,216 @@
+import * as node_fs from "node:fs"
+import * as node_module from "node:module"
+import * as node_path from "node:path"
+
+import type * as Config from "../../../../config/index.mts"
+
+import {
+	GlobalVars,
+} from "../../../_global-vars/index.mts"
+
+import {
+	ConfigHelpers,
+} from "../../_helpers/index.mts"
+
+import {
+	initResources,
+} from "./_init-resources.mts"
+
+/**
+ * Create `project.json` file in the "<project>/macos" directory.
+ */
+export function createProjectSpec(
+	platform: "macos" | "ios",
+	overrideConfig?: {
+		infoPlist?: Config.Apple.Data["infoPlist"],
+	},
+) {
+
+	const
+		projectDirectory =
+			node_path.dirname(GlobalVars.configFilePath.get()),
+
+		nativeProjectDir =
+			node_path.join(projectDirectory, platform)
+
+	// just in case if the projectDirectory doesn't exist
+	if(!node_fs.existsSync(projectDirectory)) {
+		throw new Error(`An unexpected happened. ${projectDirectory} was not found.`)
+	}
+
+	const
+		config =
+			GlobalVars.appConfig.get()
+
+	// TODO : also check for "ios"
+	if(
+		config.macos?.appicon &&
+		(
+			!config.macos.assetCatalogs?.appiconsets?.length ||
+			!config.macos.assetCatalogs.appiconsets.some(set => set.name == config.macos?.appicon)
+		)
+	) {
+		// check if the appicon name is exist
+		throw new Error(`No appicon with the name "${config.macos.appicon}" was found in the appiconsets in Asset Catalogs.`)
+	}
+
+	if(
+		(platform == "macos" && !config.macos)
+		// TODO : "ios"
+	) {
+		throw new Error(`${platform} configuration was not found.`)
+	}
+
+	const
+		requireFromNativeDirectory =
+			node_module.createRequire(nativeProjectDir),
+
+		reactNativeXcodeScriptRelativePath =
+			node_path.relative(
+				nativeProjectDir,
+				platform == "macos"
+					? requireFromNativeDirectory.resolve("react-native-macos/scripts/react-native-xcode.sh")
+					: requireFromNativeDirectory.resolve("react-native/scripts/react-native-xcode.sh"),
+			),
+
+		appleData: Config.Apple.Data =
+			// Intentionally asserted as "macos"
+			// TODO : "ios"
+			{
+				...config[platform as "macos"]!,
+				infoPlist: {
+					...overrideConfig?.infoPlist,
+					...config[platform as "macos"]!.infoPlist, // client's infoPlist takes precedence over the plugin
+				},
+			},
+
+		projectName =
+			ConfigHelpers.getProjectName(config, platform)!, // already validated
+
+		resourcesData =
+			initResources(
+				config.macos?.resources,
+				{
+					platform,
+				},
+			),
+
+		/* eslint-disable @typescript-eslint/no-explicit-any */
+
+		/**
+		 * See https://github.com/yonaskolb/XcodeGen/blob/master/Docs/ProjectSpec.md
+		 */
+		json: Record<string, any> =
+			{
+
+				name: projectName,
+
+				// https://github.com/yonaskolb/XcodeGen/blob/master/Docs/ProjectSpec.md#target
+				targets: {
+					[projectName]: {
+						type: "application",
+						platform: platform == "macos" ? "macOS" : "iOS",
+						deploymentTarget: appleData.minimumDeployment || "15.6",
+						sources: [
+							{
+								path: projectName,
+								type: "syncedFolder",
+							},
+							...(resourcesData?.map(resource => {
+								/**
+								 * The path "Resources" is just our group, and also our custom directory,
+								 * not an actual bundle resource directory content of macOS app, e.g. /Applications/HelloWorld.app/Contents/Resources.
+								 * The naming is purely a coincidence.
+								 * 
+								 * We intentionally to copy user files to our directory called "Resources".
+								 * Any user files will be copied to our "Resources" directory.
+								 * 
+								 * See placing content in a bundle
+								 * https://developer.apple.com/documentation/bundleresources/placing-content-in-a-bundle?language=objc
+								 */
+								return {
+									path: "Resources",
+									buildPhase: {
+										copyFiles: {
+											destination: "resources",
+											subpath: resource.isDirectory
+												? resource.basename
+												: undefined,
+										},
+									},
+								}
+							}) ?? []),
+						],
+						info: {
+							path: `${projectName}/Info.plist`,
+							properties: {
+								CFBundleDisplayName: ConfigHelpers.getName(config, platform),
+								CFBundleShortVersionString: "$(MARKETING_VERSION)",
+								CFBundleVersion: "$(CURRENT_PROJECT_VERSION)",
+								NSAppTransportSecurity: {
+									NSAllowsArbitraryLoads: true,
+									NSExceptionDomains: {
+										localhost: {
+											NSExceptionAllowsInsecureHTTPLoads: true,
+										},
+									},
+								},
+								NSPrincipalClass: "NSApplication",
+								NSSupportsAutomaticTermination: true,
+								NSSupportsSuddenTermination: true,
+								// Let user override these properties
+								...appleData.infoPlist,
+							},
+						},
+						postBuildScripts: [
+							{
+								name: "Bundle React Native code and images",
+								script: `export NODE_BINARY=node\n${reactNativeXcodeScriptRelativePath}`,
+							},
+						],
+
+						scheme: {},
+
+						settings: {
+							ASSETCATALOG_COMPILER_APPICON_NAME: appleData.appicon,
+						},
+					},
+				},
+
+				/**
+				 * Settings correspond to Build Settings tab in Xcode.
+				 * 
+				 * See {@link https://developer.apple.com/documentation/xcode/build-settings-reference|Build settings reference} for complete detailed list of individual Xcode build settings that control or change the way a target is built.
+				 * 
+				 * @see https://github.com/yonaskolb/XcodeGen/blob/master/Docs/ProjectSpec.md#settings
+				 */
+				settings: {
+					base: {
+						ASSETCATALOG_COMPILER_INCLUDE_ALL_APPICON_ASSETS: true,
+						CODE_SIGN_STYLE: "Automatic",
+						CURRENT_PROJECT_VERSION: appleData.buildVersion || "1",
+						GENERATE_INFOPLIST_FILE: true,
+						LD_RUNPATH_SEARCH_PATHS: "$(inherited) @executable_path/Frameworks",
+						MARKETING_VERSION: appleData.version || "1.0.0",
+						OTHER_LDFLAGS: "$(inherited) -ObjC -lc++",
+						PRODUCT_BUNDLE_IDENTIFIER: appleData.bundleIdentifier,
+					},
+				},
+
+				options: {
+					useBaseInternationalization: false,
+				},
+
+			}
+
+	/* eslint-enable @typescript-eslint/no-explicit-any */
+
+	node_fs.writeFileSync(
+		node_path.join(
+			nativeProjectDir, "project.json",
+		),
+		JSON.stringify(json, null, 2),
+		"utf8",
+	)
+
+}

package/src/_bin/_main/_xcodegen/_create-project-spec/index.mts

@@ -0,0 +1 @@
+export * from "./create-project-spec.mts"

package/src/_bin/_main/_xcodegen/_mod-known-regions/index.ts

@@ -0,0 +1 @@
+export * from "./mod-known-regions.mts"

package/src/_bin/_main/_xcodegen/_mod-known-regions/mod-known-regions.mts

@@ -0,0 +1,52 @@
+import * as node_fs from "node:fs"
+import * as node_path from "node:path"
+
+import {
+	GlobalVars,
+} from "../../../_global-vars/index.mts"
+
+import {
+	ConfigHelpers,
+} from "../../_helpers/index.mts"
+
+export function modKnownRegions(
+	platform: "macos" | "ios",
+) {
+	const
+		config =
+			GlobalVars.appConfig.get(),
+
+		appleData =
+			config[platform as "macos"] // TODO : ios
+
+	if(!appleData?.locales?.length) {
+		return
+	}
+
+	const
+		projectName =
+			ConfigHelpers.getProjectName(config, platform),
+
+		pbxprojPath =
+			node_path.join(
+				node_path.dirname(GlobalVars.configFilePath.get()),
+				platform,
+				`${projectName}.xcodeproj`,
+				"project.pbxproj",
+			)
+
+	let file = node_fs.readFileSync(pbxprojPath, "utf8")
+
+	let strReplacer = "knownRegions = ("
+	appleData.locales.forEach(locale => {
+		strReplacer += `\n$2${locale},`
+	})
+	strReplacer += "$3"
+
+	file = file.replace(
+		/knownRegions = \((\n(\t+)\w+,)+(\n\t+\);)/,
+		strReplacer,
+	)
+
+	node_fs.writeFileSync(pbxprojPath, file, "utf8")
+}

package/src/_bin/_main/_xcodegen/index.mts

@@ -0,0 +1 @@
+export * from "./xcodegen.mts"

package/src/_bin/_main/_xcodegen/xcodegen.mts

@@ -0,0 +1,46 @@
+import * as node_childProcess from "node:child_process"
+import * as node_path from "node:path"
+
+import {
+	GlobalVars,
+} from "../../_global-vars/index.mts"
+
+import {
+	createProjectSpec,
+} from "./_create-project-spec/index.mts"
+
+import {
+	modKnownRegions,
+} from "./_mod-known-regions/mod-known-regions.mts"
+
+export function xcodegen(
+	platform: "macos" | "ios",
+	overrideConfig?: Parameters<typeof createProjectSpec>[1],
+) {
+	createProjectSpec(platform, overrideConfig)
+
+	const
+		xcodegenPath =
+			GlobalVars.argv.get().xcodegenPath,
+
+		nativeProjectDir =
+			node_path.join(node_path.dirname(GlobalVars.configFilePath.get()), platform)
+
+	node_childProcess.execSync(
+		`${xcodegenPath} --spec project.json`,
+		{
+			cwd: nativeProjectDir,
+			stdio: "inherit",
+		},
+	)
+
+	modKnownRegions(platform)
+
+	node_childProcess.execSync(
+		`pod install`,
+		{
+			cwd: nativeProjectDir,
+			stdio: "inherit",
+		},
+	)
+}

package/src/_bin/_main/index.mts

@@ -0,0 +1 @@
+export * from "./main.mts"

package/src/_bin/_main/main.mts

@@ -0,0 +1,160 @@
+import * as node_fs from "node:fs"
+import * as node_path from "node:path"
+
+import {
+	GlobalVars,
+} from "../_global-vars/index.mts"
+
+import {
+	checkConfigValidity,
+} from "./_check-config-validity.mts"
+
+import {
+	evaluatePluginRegistry,
+} from "./_evaluate-plugin-registry.mts"
+
+import {
+	execPluginRunner,
+} from "./_exec-plugin-runner/index.mts"
+
+import {
+	getConfig,
+} from "./_get-config.mts"
+
+import {
+	PlatformHelpers,
+} from "./_helpers/index.mts"
+
+import {
+	initTemplate,
+} from "./_init-template/index.mts"
+
+import {
+	modPlugin,
+} from "./_mod-plugin/index.mts"
+
+import {
+	xcodegen,
+} from "./_xcodegen/index.mts"
+
+/**
+ * Perform actions in this order
+ * 
+ * - Bundo Config
+ * 	- Get the config object from file (e.g. bundo.config.ts)
+ * 	- Get the path file of plugin main function including its parameter (all the plugins)
+ * 
+ * - Init template directory
+ * 	- Copy the directory
+ * 	- Modify template regarding project name and other config related
+ *  - (Apple)
+ * 		- Init Asset Catalogs from Config
+ *  - (Windows): TODO
+
+ * - Plugin runner
+ * 	- Retrieve the result
+ * 
+ * - (Apple) XcodeGen
+ * 	- Create XcodeGen project spec file
+ * 	- Run XcodeGen to generate Xcode project
+ * 	- Pod installation
+ */
+export async function main() {
+
+	PlatformHelpers.getData()
+
+	let configFilePath: string = ""
+
+	const argv = GlobalVars.argv.get()
+
+	if(argv.path) {
+		const isValidExt = isValidConfigFileExt(argv.path)
+		if(!isValidExt) {
+			throw new Error(`App config file only compatible with ${configFileExts.join(" | ")}`)
+		}
+
+		// Check if the file is existed
+		const targetConfigFilePath = node_path.resolve(process.cwd(), argv.path)
+		if(!node_fs.existsSync(targetConfigFilePath)) {
+			throw new Error(`${targetConfigFilePath} file doesn't exist.`)
+		}
+
+		configFilePath = node_path.resolve(process.cwd(), argv.path)
+	} else {
+		// Find default config file
+		for(let i = 0; i < configFileExts.length; i++) {
+			const targetConfigFilePath = node_path.join(process.cwd(), `bundo.config.${configFileExts[i]}`)
+
+			if(node_fs.existsSync(targetConfigFilePath)) {
+				configFilePath = targetConfigFilePath
+				break
+			} else if(i == configFileExts.length - 1) {
+				throw new Error("Cannot found bundo config file.")
+			}
+		}
+	}
+
+	GlobalVars.configFilePath.set(configFilePath)
+
+	console.log("Retrieving config")
+	const config = await getConfig(configFilePath)
+
+	console.log("Validating config")
+	checkConfigValidity(config)
+
+	// Now, user app config is available globally in this appgen script at runtime
+	GlobalVars.appConfig.set(config)
+
+	console.log("Evaluating the plugin registry if any")
+	const pluginRegistry = evaluatePluginRegistry(config.plugins)
+	const unrestrictedPluginRegistry = evaluatePluginRegistry(config.lessRestrictivePlugins)
+
+	initTemplate()
+
+	const pluginSandboxedContextResult = await execPluginRunner(
+		pluginRegistry,
+		{
+			mode: "restricted",
+		},
+	)
+	const pluginContextResult = await execPluginRunner(
+		unrestrictedPluginRegistry,
+		{
+			mode: "lessRestrictive",
+		},
+	)
+	if(pluginSandboxedContextResult) {
+		modPlugin(pluginSandboxedContextResult)
+	}
+	if(pluginContextResult) {
+		modPlugin(pluginContextResult)
+	}
+
+	// TODO : "ios"
+	xcodegen(
+		"macos",
+		{
+			infoPlist: {
+				...pluginSandboxedContextResult?.macos.infoPlist,
+				...pluginContextResult?.macos.infoPlist,
+			},
+		},
+	)
+
+}
+
+const configFileExts: string[] = [
+	"ts",
+	"mts",
+	"mjs",
+	"js",
+]
+
+function isValidConfigFileExt(filePath: string): boolean {
+	const ext = node_path.extname(filePath)
+	if(!ext) {
+		// empty string from extname returned
+		return false
+	}
+	return configFileExts.indexOf(ext.slice(1)) > -1
+}

package/src/_bin/bin.mts

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+
+import yargs from "yargs"
+import * as YargsHelper from "yargs/helpers"
+
+import {
+	GlobalVars,
+} from "./_global-vars/index.mts"
+
+import {
+	main,
+} from "./_main/index.mts"
+
+/**
+ * @param bundoAppgenRoot We need the `bundoAppgenRoot` as file path to get the templates files.
+ */
+export async function bin(
+	bundoAppgenRoot: string,
+) {
+
+	GlobalVars.appgenRoot.set(bundoAppgenRoot)
+
+	try {
+		const
+			argv =
+				yargs(YargsHelper.hideBin(process.argv))
+					.options({
+						"clean": {
+							type: "boolean",
+							description: "Perform clean app generation.",
+						},
+						"force-cross-platform": {
+							type: "boolean",
+							description: "Experimentally force the script to init native app in non compatible OS.",
+						},
+						"path": {
+							alias: "p",
+							type: "string",
+							description: "Use specific configuration file target.",
+						},
+						"xcodegen-path": {
+							type: "string",
+							description: "Use specific XcodeGen binary.",
+						},
+					})
+					.parseSync()
+
+		GlobalVars.argv.set({
+			clean: !!argv.clean,
+			forceCrossPlatform: !!argv["force-cross-platform"],
+			path: argv.path || "",
+			xcodegenPath: argv["xcodegen-path"] || "xcodegen",
+		})
+
+		await main()
+	} catch(err) {
+		if(err instanceof Error && err.message) {
+			console.error(
+				"\x1b[31mError\x1b[0m: " +
+				err.message,
+			)
+			process.exitCode = 1
+		} else {
+			console.error("Unknown error. Please report it to https://github.com/RakaDoank/bundo.rn", { cause: err })
+			process.exitCode = 1
+		}
+	}
+}

package/src/_bin/plugin-sandbox-runner/_exec-plugins.mts

@@ -0,0 +1,135 @@
+import * as node_fs from "node:fs"
+import * as node_path from "node:path"
+
+import type {
+	Plugin,
+} from "../../index.mts"
+
+import type {
+	ArgvJSON,
+} from "./argv-json.ts"
+
+import type {
+	PluginRunnerContextResult,
+} from "./plugin-runner-context-result.ts"
+
+export async function execPlugins({
+	projectDirectory,
+	projectName,
+	registry,
+}: {
+	projectDirectory: ArgvJSON["projectDirectory"],
+	projectName: ArgvJSON["projectName"],
+	registry: ArgvJSON["evaluatedPluginRegistry"],
+}): Promise<PluginRunnerContextResult> {
+
+	if(!registry?.length) {
+		throw new Error("Not a valid Evaluated Plugin Registry array.")
+	}
+
+	const
+		paths =
+			{
+				templates: {
+					macos: node_path.join(
+						projectDirectory,
+						"macos",
+					),
+				},
+			},
+
+		contextResult: PluginRunnerContextResult =
+			{
+				macos: {
+					files: {
+						Podfile: node_fs.readFileSync(
+							node_path.join(paths.templates.macos, "Podfile"),
+							"utf8",
+						),
+						Project: {
+							"AppDelegate.swift": node_fs.readFileSync(
+								node_path.join(paths.templates.macos, projectName, "AppDelegate.swift"),
+								"utf8",
+							),
+						},
+					},
+					infoPlist: {},
+				},
+			}
+
+	for(const plugin of registry) {
+		const pluginMainFn = await import(plugin.mainPath).then((
+			mod: {
+				default: ((ctx: Plugin.Context) => Promise<void> | void),
+			},
+		) => {
+			return mod.default
+		})
+
+		try {
+			await pluginMainFn({
+
+				get macos() {
+					return {
+						get files() {
+							return {
+								// add(filename, source) {
+								// 	contextResult.macos.files.pluginFiles.push({
+								// 		filename,
+								// 		source,
+								// 	})
+								// },
+
+								get Podfile() {
+									return contextResult.macos.files.Podfile
+								},
+								set Podfile(value) {
+									contextResult.macos.files.Podfile = value
+								},
+
+								get Project() {
+									return {
+										get "AppDelegate.swift"() {
+											return contextResult.macos.files.Project["AppDelegate.swift"]
+										},
+										set "AppDelegate.swift"(value) {
+											contextResult.macos.files.Project["AppDelegate.swift"] = value
+										},
+
+										// add(filename, source) {
+										// 	contextResult.macos.files.Project.pluginFiles.push({
+										// 		filename,
+										// 		source,
+										// 	})
+										// },
+									} satisfies Plugin.Context["macos"]["files"]["Project"]
+								},
+							} satisfies Plugin.Context["macos"]["files"]
+						},
+						infoPlist: contextResult.macos.infoPlist,
+						// get Podfile() {
+						// 	return {
+						// 		pod: contextResult.macos.Podfile.pod,
+						// 	} satisfies Plugin.Context["macos"]["Podfile"]
+						// },
+					} satisfies Plugin.Context["macos"]
+				},
+
+				parameter: plugin.parameter,
+
+			})
+		} catch(err) {
+			if(err instanceof Error) {
+				// eslint-disable-next-line preserve-caught-error
+				throw new Error(
+					plugin.name +
+					`${err.stack ? "\n" + err.stack : ""}`,
+				)
+			}
+			throw err
+		}
+	}
+
+	return contextResult
+
+}

package/src/_bin/plugin-sandbox-runner/argv-json.ts

@@ -0,0 +1,20 @@
+import type {
+	EvaluatedPluginRegistry,
+} from "./evaluated-plugin-registry"
+
+export interface ArgvJSON {
+	/**
+	 * Root directory of `bundo-appgen`.
+	 * We cannot use the GlobalVars.configFilePath here, because this is already in different JavaScript process/runtime.
+	 */
+	// bundoAppgenRoot: string,
+	projectDirectory: string,
+	/**
+	 * Project name, not the app display name.
+	 */
+	projectName: string,
+
+	evaluatedPluginRegistry: EvaluatedPluginRegistry | undefined,
+
+	messageID: string,
+}