introduce yargs-parser to be compatible with xcodebuild -create-xcframework

Author: shirakaba

build_nativescript.sh

@@ -148,46 +148,33 @@ cmake_build macos-cli
 
 fi
 
-# Due to inconvenient design choices on both sides, we have to choose between
-# either long flags or short flags based on whether we're calling
-# `xcodebuild -create-xcframework` or `scripts/build_xcframework.mts`.
-if [[ "$TARGET_ENGINE" == "none" ]]; then
-  # Node.js parseArgs() supports short flags, but only if they're single-letter.
-  FRAMEWORK_FLAG="--framework"
-  DSYM_FLAG="--debug-symbols"
-else
-  # xcodebuild doesn't implement any single-letter short flags like -f and -d.
-  FRAMEWORK_FLAG="-framework"
-  DSYM_FLAG="-debug-symbols"
-fi
-
 XCFRAMEWORKS=()
 if $BUILD_CATALYST; then
-  FRAMEWORK="$DIST/intermediates/catalyst/$CONFIG_BUILD-maccatalyst/NativeScript.framework"
-  XCFRAMEWORKS+=( "$FRAMEWORK_FLAG" "$FRAMEWORK" "$DSYM_FLAG" "$FRAMEWORK.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/catalyst/$CONFIG_BUILD-maccatalyst/NativeScript.framework"
+                  -debug-symbols "$DIST/intermediates/catalyst/$CONFIG_BUILD-maccatalyst/NativeScript.framework.dSYM" )
 fi
 
 if $BUILD_SIMULATOR; then
-  FRAMEWORK="$DIST/intermediates/ios-sim/$CONFIG_BUILD-iphonesimulator/NativeScript.framework"
-  XCFRAMEWORKS+=( "$FRAMEWORK_FLAG" "$FRAMEWORK" "$DSYM_FLAG" "$FRAMEWORK.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/ios-sim/$CONFIG_BUILD-iphonesimulator/NativeScript.framework"
+                  -debug-symbols "$DIST/intermediates/ios-sim/$CONFIG_BUILD-iphonesimulator/NativeScript.framework.dSYM" )
 fi
 
 if $BUILD_IPHONE; then
-  FRAMEWORK="$DIST/intermediates/ios/$CONFIG_BUILD-iphoneos/NativeScript.framework"
-  XCFRAMEWORKS+=( "$FRAMEWORK_FLAG" "$FRAMEWORK" "$DSYM_FLAG" "$FRAMEWORK.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/ios/$CONFIG_BUILD-iphoneos/NativeScript.framework"
+                  -debug-symbols "$DIST/intermediates/ios/$CONFIG_BUILD-iphoneos/NativeScript.framework.dSYM" )
 fi
 
 if $BUILD_MACOS; then
-  FRAMEWORK="$DIST/intermediates/macos/$CONFIG_BUILD/NativeScript.framework"
-  XCFRAMEWORKS+=( "$FRAMEWORK_FLAG" "$FRAMEWORK" "$DSYM_FLAG" "$FRAMEWORK.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/macos/$CONFIG_BUILD/NativeScript.framework"
+                  -debug-symbols "$DIST/intermediates/macos/$CONFIG_BUILD/NativeScript.framework.dSYM" )
 fi
 
 if $BUILD_VISION; then
-  FRAMEWORK="$DIST/intermediates/visionos/$CONFIG_BUILD-xros/NativeScript.framework"
-  XCFRAMEWORKS+=( "$FRAMEWORK_FLAG" "$FRAMEWORK" "$DSYM_FLAG" "$FRAMEWORK.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/visionos/$CONFIG_BUILD-xros/NativeScript.framework"
+                  -debug-symbols "$DIST/intermediates/visionos/$CONFIG_BUILD-xros/NativeScript.framework.dSYM" )
 
-  FRAMEWORK="$DIST/intermediates/visionos-sim/$CONFIG_BUILD-xros/NativeScript.framework"
-  XCFRAMEWORKS+=( "$FRAMEWORK_FLAG" "$FRAMEWORK" "$DSYM_FLAG" "$FRAMEWORK.dSYM" )
+  XCFRAMEWORKS+=( -framework "$DIST/intermediates/visionos-sim/$CONFIG_BUILD-xros/NativeScript.framework"
+                  -debug-symbols "$DIST/intermediates/visionos-sim/$CONFIG_BUILD-xros/NativeScript.framework.dSYM" )
 fi
 
 if [[ -n "${XCFRAMEWORKS[@]}" ]]; then

scripts/build_xcframework.mts

@@ -1,6 +1,6 @@
 import path from "node:path";
 import process from "node:process";
-import { parseArgs } from "node:util";
+import yargsParser from "yargs-parser";
 import { createXCframework } from "react-native-node-api";
 
 main();
@@ -13,41 +13,32 @@ async function main() {
 
   const monorepoRoot = path.resolve(__dirname, "..");
 
-  const args = parseArgs({
-    args: process.argv.slice(2),
-    options: {
-      output: {
-        type: "string",
-      },
-      framework: {
-        multiple: true,
-        type: "string",
-      },
-      "debug-symbols": {
-        multiple: true,
-        type: "string",
-      },
-      help: {
-        short: "h",
-        type: "boolean",
-        default: false,
-      },
+  const args = yargsParser(process.argv.slice(2), {
+    configuration: {
+      "short-option-groups": false,
+    },
+    string: ["output", "framework", "debug-symbols"],
+    array: ["framework", "debug-symbols"],
+    boolean: ["help"],
+    alias: {
+      h: "help",
+    },
+    default: {
+      help: false,
     },
   });
 
   const {
-    values: {
-      output,
-      framework: frameworks,
-      "debug-symbols": debugSymbols,
-      help,
-    },
+    output,
+    framework: frameworks = new Array<string>(),
+    "debug-symbols": debugSymbols = new Array<string>(),
+    help,
   } = args;
 
   const helpText = `
 Typical usage:
 
-$ deno run -A ./scripts/build_xcframework.ts --output packages/ios/build/Release/NativeScript.apple.node --framework dist/intermediates/ios/RelWithDebInfo-iphoneos/NativeScript.framework
+$ deno run -A ./scripts/build_xcframework.mts --output packages/ios/build/Release/NativeScript.apple.node -framework dist/intermediates/ios/RelWithDebInfo-iphoneos/NativeScript.framework -debug-symbols dist/intermediates/ios/RelWithDebInfo-iphoneos/NativeScript.framework.dSYM
 `.trim();
 
   if (help) {
@@ -62,9 +53,16 @@ $ deno run -A ./scripts/build_xcframework.ts --output packages/ios/build/Release
     process.exit(1);
   }
 
+  if (!isStringArray(frameworks) || !isStringArray(debugSymbols)) {
+    console.log(
+      `Expected -framework and -debug-symbols to be parsed as arrays.\n\n${helpText}`
+    );
+    process.exit(1);
+  }
+
   if (!frameworks?.length) {
     console.log(
-      `Please specify at least one framework to bundle into the xcframework by passing the \`--framework\` arg one or more times.\n\n${helpText}`
+      `Please specify at least one framework to bundle into the xcframework by passing the \`-framework\` arg one or more times.\n\n${helpText}`
     );
     process.exit(1);
   }
@@ -97,3 +95,17 @@ $ deno run -A ./scripts/build_xcframework.ts --output packages/ios/build/Release
     )}\x1b[22m`
   );
 }
+
+function isStringArray(value: unknown): value is Array<string> {
+  if (!Array.isArray(value)) {
+    return false;
+  }
+
+  for (const element of value) {
+    if (typeof element !== "string") {
+      return false;
+    }
+  }
+
+  return true;
+}

scripts/package.json

@@ -11,7 +11,8 @@
   "type": "commonjs",
   "description": "",
   "dependencies": {
-    "@nativescript/core": "^8.8.6"
+    "@nativescript/core": "^8.8.6",
+    "yargs-parser": "^22.0.0"
   },
   "devDependencies": {
     "react-native-node-api": "^0.3.2"