moved command to npx react-native update/init/sync

Author: chrfalch

packages/react-native/react-native.config.js

@@ -112,6 +112,96 @@ const codegenCommand /*: Command */ = {
 
 commands.push(codegenCommand);
 
+const spmCommand /*: Command */ = {
+  name: 'spm [action]',
+  description:
+    'Set up or maintain Swift Package Manager support for the iOS/macOS app. ' +
+    'Actions: init, update, sync, clean, codegen, download. ' +
+    'With no action: runs init if Package.swift is missing, otherwise update.',
+  options: [
+    {
+      name: '--version <string>',
+      description:
+        'React Native version (e.g. 0.80.0). Defaults to the version in node_modules/react-native/package.json.',
+    },
+    {
+      name: '--localXcframework <path>',
+      description: 'Use a local React.xcframework instead of downloading.',
+    },
+    {
+      name: '--artifactsDir <path>',
+      description: 'Override the artifact cache directory.',
+    },
+    {
+      name: '--flavor <string>',
+      description: 'Artifact flavor: debug or release.',
+    },
+    {
+      name: '--skipCodegen',
+      description: 'Skip react-native codegen step.',
+    },
+    {
+      name: '--skipDownload',
+      description: 'Skip automatic artifact download.',
+    },
+    {
+      name: '--forceDownload',
+      description: 'Clear cached artifacts and re-download from Maven.',
+    },
+    {
+      name: '--skipXcodeproj',
+      description: 'Skip .xcodeproj generation.',
+    },
+    {
+      name: '--bundleIdentifier <string>',
+      description: 'Override CFBundleIdentifier in the generated Info.plist.',
+    },
+    {
+      name: '--productName <string>',
+      description: 'Override PRODUCT_NAME in the generated Info.plist.',
+    },
+    {
+      name: '--entryFile <path>',
+      description:
+        'JS entry file relative to app root (default: package.json "main" or index.js).',
+    },
+  ],
+  func: async (argv, _config, args) => {
+    const passthrough /*: Array<string> */ = [];
+    if (argv.length > 0) {
+      passthrough.push(argv[0]);
+    }
+    const stringOpts /*: Array<[string, string]> */ = [
+      ['version', '--version'],
+      ['localXcframework', '--local-xcframework'],
+      ['artifactsDir', '--artifacts-dir'],
+      ['flavor', '--flavor'],
+      ['bundleIdentifier', '--bundle-identifier'],
+      ['productName', '--product-name'],
+      ['entryFile', '--entry-file'],
+    ];
+    for (const [key, flag] of stringOpts) {
+      if (args[key] != null) {
+        passthrough.push(flag, String(args[key]));
+      }
+    }
+    const boolOpts /*: Array<[string, string]> */ = [
+      ['skipCodegen', '--skip-codegen'],
+      ['skipDownload', '--skip-download'],
+      ['forceDownload', '--force-download'],
+      ['skipXcodeproj', '--skip-xcodeproj'],
+    ];
+    for (const [key, flag] of boolOpts) {
+      if (args[key]) {
+        passthrough.push(flag);
+      }
+    }
+    await require('./scripts/setup-apple-spm').main(passthrough);
+  },
+};
+
+commands.push(spmCommand);
+
 const config = {
   commands,
   platforms: {} /*:: as {[string]: Readonly<{

packages/react-native/scripts/setup-apple-spm.js

@@ -24,6 +24,10 @@
  *                              generated packages, artifacts, and .xcodeproj.
  *   update                     Regenerate generated packages/artifacts/project
  *                              without overwriting root Package.swift.
+ *   sync                       Lightweight sync invoked by the Xcode auto-sync
+ *                              build phase: regenerates autolinking and
+ *                              xcframeworks sub-packages and writes the
+ *                              .spm-sync-stamp file. Skips .xcodeproj regen.
  *   clean                      Remove generated SPM state only.
  *   codegen                    Run only codegen and install the SPM template.
  *   download                   Download/check xcframework artifacts only.
@@ -83,6 +87,7 @@ const {log, warn: logError} = makeLogger('setup-apple-spm');
 const VALID_ACTIONS = new Set([
   'init',
   'update',
+  'sync',
   'clean',
   'codegen',
   'download',
@@ -104,7 +109,7 @@ function parseArgs(argv /*: Array<string> */) /*: SetupArgs */ {
       type: 'string',
       choices: Array.from(VALID_ACTIONS),
       describe:
-        'Action to run: init, update, clean, codegen, or download. Defaults to init when Package.swift is missing, otherwise update.',
+        'Action to run: init, update, sync, clean, codegen, or download. Defaults to init when Package.swift is missing, otherwise update.',
     })
     .option('version', {
       type: 'string',
@@ -255,7 +260,7 @@ function cleanGeneratedState(appRoot /*: string */) {
 function resolveAction(
   requestedAction /*: SetupArgs['action'] */,
   appRoot /*: string */,
-) /*: 'init' | 'update' | 'clean' | 'codegen' | 'download' */ {
+) /*: 'init' | 'update' | 'sync' | 'clean' | 'codegen' | 'download' */ {
   if (requestedAction != null) {
     return requestedAction;
   }
@@ -511,10 +516,7 @@ function generateXcframeworksPackage(
   generatePackage(packageArgs);
 }
 
-function warnForMissingPackageSwift(
-  appRoot /*: string */,
-  scriptsDir /*: string */,
-) {
+function warnForMissingPackageSwift(appRoot /*: string */) {
   const mainPackageSwift = path.join(appRoot, 'Package.swift');
   if (fs.existsSync(mainPackageSwift)) {
     return;
@@ -524,9 +526,7 @@ function warnForMissingPackageSwift(
   log(
     '\x1b[33mWARNING: Package.swift not found.\x1b[0m Run init to generate an initial one:',
   );
-  log(
-    `  node ${path.relative(appRoot, path.join(scriptsDir, 'setup-apple-spm.js'))} init`,
-  );
+  log('  react-native spm init');
   log('');
 }
 
@@ -622,7 +622,8 @@ async function main(argv /*:: ?: Array<string> */) /*: Promise<void> */ {
     return;
   }
 
-  const needsCliConfig = action === 'init' || action === 'update';
+  const needsCliConfig =
+    action === 'init' || action === 'update' || action === 'sync';
   const autolinkingConfigResult = needsCliConfig
     ? loadAutolinkingConfig(projectRoot, appRoot)
     : null;
@@ -644,6 +645,22 @@ async function main(argv /*:: ?: Array<string> */) /*: Promise<void> */ {
     return;
   }
 
+  if (action === 'sync') {
+    const {main: runSync} = require('./spm/sync-spm-autolinking');
+    try {
+      await runSync([
+        '--app-root',
+        appRoot,
+        '--react-native-root',
+        reactNativeRoot,
+      ]);
+    } catch (e) {
+      logError(`SPM sync failed: ${e.message}`);
+      process.exitCode = 1;
+    }
+    return;
+  }
+
   let resolvedArtifactsDir = null;
   if (action === 'download') {
     try {
@@ -702,7 +719,7 @@ async function main(argv /*:: ?: Array<string> */) /*: Promise<void> */ {
   if (action === 'init') {
     ensureGitignoreSpmEntries(appRoot);
   } else {
-    warnForMissingPackageSwift(appRoot, scriptsDir);
+    warnForMissingPackageSwift(appRoot);
   }
   warnForMissingVfsOverlayFlags(appRoot);
 

packages/react-native/scripts/spm/__doc__/rfc-spm-xcframework.md

@@ -26,14 +26,14 @@ open MyApp-SPM.xcodeproj
 ```
 
 A future CLI integration (e.g., an `--ios-build-system spm` flag on
-`react-native init`) could run `setup-apple-spm.js --init` automatically as part
+`react-native init`) could run `react-native spm init` automatically as part
 of project creation.
 
 ### Existing project
 
 ```bash
 cd MyApp/ios
-node ../node_modules/react-native/scripts/setup-apple-spm.js --init
+react-native spm init
 # CocoaPods setup continues to work — both can coexist
 open MyApp-SPM.xcodeproj
 ```
@@ -118,7 +118,8 @@ goes read-only in December 2026.
 
 ### Pipeline
 
-`setup-apple-spm.js` orchestrates five steps:
+`react-native spm` orchestrates five steps (the underlying script is
+`scripts/setup-apple-spm.js`):
 
 | # | Step | Script | Output |
 |---|------|--------|--------|
@@ -129,15 +130,15 @@ goes read-only in December 2026.
 | 5 | Xcodeproj | `spm/generate-spm-xcodeproj.js` | `AppName-SPM.xcodeproj` |
 | — | Sync (build-time) | `spm/sync-spm-autolinking.js` | Re-runs steps 1–4 when inputs change (downloads artifacts if missing) |
 
-When run with `--init`, the script also appends SPM-specific entries to the
+When run with the `init` action, the script also appends SPM-specific entries to the
 project's `.gitignore` (e.g., `autolinked/`, `build/generated/ios/`,
 `build/xcframeworks/`, `.build/`, `Package.resolved`). Entries that already
 exist are not duplicated. This ensures generated artifacts are not accidentally
 committed.
 
 ### Auto-sync build phase
 
-After initial setup, developers shouldn't need to re-run `setup-apple-spm.js`
+After initial setup, developers shouldn't need to re-run `react-native spm`
 manually when dependencies change. The generated `.xcodeproj` includes a
 **Sync SPM Autolinking** pre-build phase (ordered first, before VFS overlay)
 that:
@@ -165,8 +166,8 @@ new version's cache directory.
 The sync step is **self-healing**: if xcframework artifacts are missing (e.g.,
 the local cache at `~/Library/Caches/com.facebook.ReactNative/` was deleted,
 or the project was freshly cloned), it automatically downloads them before
-proceeding with autolinking and package generation. This means `setup-apple-spm.js`
-is only strictly required for initial project scaffolding (`--init`); subsequent
+proceeding with autolinking and package generation. This means `react-native spm`
+is only strictly required for initial project scaffolding (`init`); subsequent
 builds recover automatically.
 
 ### Cleaning generated SPM state
@@ -178,17 +179,15 @@ Xcode provides no hook to run custom scripts during GUI clean actions.
 To fully reset SPM state, run:
 
 ```bash
-node setup-apple-spm.js --clean
+react-native spm clean
 ```
 
 This removes `build/xcframeworks/`, `build/generated/ios/`, `autolinked/`, and
-`.build/`, then re-runs the full setup (codegen, download, autolinking, package
-generation). After it completes, open the `.xcodeproj` in Xcode and build.
-
-The `--clean` flag performs a full re-setup rather than just deleting files
-because SPM package resolution is locked for the duration of a build — if only
-stubs were left in place, Xcode would resolve stubs and never pick up the real
-packages generated by the sync build phase.
+`.build/`. Then run `react-native spm update` (or open the checked-in
+`.xcodeproj` and build) to regenerate state. SPM package resolution is locked
+for the duration of a build — if only stubs were left in place, Xcode would
+resolve stubs and never pick up the real packages generated by the sync build
+phase.
 
 ### Stub packages for fresh clones
 
@@ -241,16 +240,16 @@ AppName-SPM.xcodeproj
         └── build/generated/ios/ (codegen source path)
 ```
 
-The root `Package.swift` is generated once (`--init`) and committed. Developers
+The root `Package.swift` is generated once (`react-native spm init`) and committed. Developers
 can customize it — add dependencies, adjust settings, or add new targets.
 Subsequent runs only regenerate the sub-packages (`autolinked/` and
 `build/xcframeworks/`).
 
 Both `Package.swift` and `AppName-SPM.xcodeproj` are generated once during
-`--init` and committed. This is typically done by project scaffolding tools
-(`react-native init`, `expo init`) rather than by developers manually. After
-initial generation, these files are user-owned — subsequent `setup-apple-spm.js`
-runs (without `--init`) only regenerate the sub-packages, not the root
+`react-native spm init` and committed. This is typically done by project
+scaffolding tools (`react-native init`, `expo init`) rather than by developers
+manually. After initial generation, these files are user-owned — subsequent
+`react-native spm update` runs only regenerate the sub-packages, not the root
 `Package.swift` or `.xcodeproj`. Teammates can clone the repo and open Xcode
 immediately — stub packages allow package resolution to succeed, and the
 auto-sync build phase downloads artifacts and handles autolinking on the first
@@ -349,7 +348,7 @@ module.exports = {
 };
 ```
 
-**Planned (Phase 2):** When `setup-apple-spm.js` gains third-party library
+**Planned (Phase 2):** When `react-native spm` gains third-party library
 support, it will:
 1. If `spm.xcframework` is declared, download the prebuilt binary (fast path).
 2. If the download fails or the `--source` flag is passed, fall back to
@@ -486,7 +485,7 @@ compilation support is a goal for specific use cases:
 
 The source compilation path would reuse the same SPM package structure but
 replace binary xcframework targets with source targets. This is planned as a
-`--source` flag to `setup-apple-spm.js`.
+`--source` flag to `react-native spm`.
 
 ### SPM build tool plugins
 
@@ -542,7 +541,7 @@ required; libraries that don't provide them fall back to source compilation.
 
 ### Migration path for existing apps
 
-1. Run `setup-apple-spm.js --init` in the `ios/` directory.
+1. Run `react-native spm init` in the `ios/` directory.
 2. Commit the generated `Package.swift` and `AppName-SPM.xcodeproj`.
 3. Open the new `.xcodeproj` and build.
 4. Once validated, optionally remove CocoaPods files (`Podfile`, `Pods/`,
@@ -559,7 +558,7 @@ Xcode build and re-runs the sync step automatically. This downloads the new
 version's xcframeworks, regenerates the sub-packages, and updates autolinking.
 No manual edits to `Package.swift` are needed — the root `Package.swift` only
 references sub-packages by relative path, and those sub-packages are fully
-regenerated each run. Developers can also run `setup-apple-spm.js` manually to
+regenerated each run. Developers can also run `react-native spm` manually to
 trigger the update before building.
 
 ## How we teach this
@@ -576,10 +575,10 @@ trigger the update before building.
 
 ### CLI discoverability
 
-- `setup-apple-spm.js --help` should provide clear usage instructions and
+- `react-native spm --help` should provide clear usage instructions and
   explain each step.
-- Error messages should include actionable suggestions (e.g., "Run with --init
-  for first-time setup").
+- Error messages should include actionable suggestions (e.g., "Run
+  `react-native spm init` for first-time setup").
 - The auto-sync build phase should surface warnings in Xcode's issue navigator
   when autolinking state is stale.
 
@@ -623,7 +622,7 @@ trigger the update before building.
    sources compile as an SPM target without producing a full release artifact.
    This would be useful for CI checks on pull requests.
 
-5. **Hardening `--init` for existing projects.** Running `--init` on a project
+5. **Hardening `init` for existing projects.** Running `init` on a project
    that already has `Package.swift` or `.xcodeproj` should detect existing
    files and avoid overwriting user modifications. The current `.xcodeproj`
    generation uses a simple template-based approach; adopting a proper Xcode