Merge pull request #82 from Soomgo-Mobile/v12-cli-init-command

feat(CLI): add initialization command for CodePush setup

Author: floydkim

README.md

@@ -35,7 +35,20 @@ The following changes are optional but recommended for cleaning up the old confi
 npm install @bravemobile/react-native-code-push
 ```
 
-### 2. iOS Setup
+### 2. Run init command
+
+Run the following command to automatically configure your project for CodePush.
+
+```bash
+npx code-push init
+```
+
+This command will automatically edit your `AppDelegate` and `MainApplication` files to integrate CodePush.
+
+<details><summary>Click to see the manual setup instructions.</summary>
+<p>
+
+### iOS Setup
 
 #### (1) Install CocoaPods Dependencies
 
@@ -54,7 +67,7 @@ Run `cd ios && pod install && cd ..`
 
 1. Open your project with Xcode (e.g. CodePushDemoApp.xcworkspace)
 2. File → New → File from Template
-3. Select 'Objective-C File' and click 'Next' and write any name as you like.  
+3. Select 'Objective-C File' and click 'Next' and write any name as you like.
 4. Then Xcode will ask you to create a bridging header file. Click 'Create'.
 5. Delete the file created in step 3.
 
@@ -110,7 +123,7 @@ Then, edit `AppDelegate.swift` like below.
 ```
 
 
-### 3. Android Setup
+### Android Setup
 
 #### (1) Edit `android/app/build.gradle`
 
@@ -161,7 +174,10 @@ Add the following line to the end of the file.
   }
 ```
 
-### 4. Expo Setup
+</p>
+</details>
+
+### 3. Expo Setup
 For Expo projects, you can use the automated config plugin instead of manual setup.
 
 **Add plugin to your Expo configuration:**
@@ -185,7 +201,7 @@ npx expo prebuild
 **Requirements**
 Expo SDK: 50.0.0 or higher
 
-### 5. "CodePush-ify" Your App
+### 4. "CodePush-ify" Your App
 
 The root component of your app should be wrapped with a higher-order component.
 
@@ -199,8 +215,8 @@ At runtime, the library fetches this information to keep the app up to date.
 
 ```typescript
 import CodePush, {
-    ReleaseHistoryInterface,
-    UpdateCheckRequest,
+  ReleaseHistoryInterface,
+  UpdateCheckRequest,
 } from "@bravemobile/react-native-code-push";
 
 // ... MyApp Component
@@ -229,7 +245,7 @@ export default CodePush({
 > The URL for fetching the release history should point to the resource location generated by the CLI tool.
 
 
-#### 5-1. Telemetry Callbacks
+#### 4-1. Telemetry Callbacks
 
 Please refer to the [CodePushOptions](https://github.com/Soomgo-Mobile/react-native-code-push/blob/f0d26f7614af41c6dd4daecd9f7146e2383b2b0d/typings/react-native-code-push.d.ts#L76-L95) type for more details.
 - **onUpdateSuccess:** Triggered when the update bundle is executed successfully.
@@ -239,7 +255,7 @@ Please refer to the [CodePushOptions](https://github.com/Soomgo-Mobile/react-nat
 - **onSyncError:** Triggered when an unknown error occurs during the update process. (`CodePush.SyncStatus.UNKNOWN_ERROR` status)
 
 
-### 6. Configure the CLI Tool
+### 5. Configure the CLI Tool
 
 > [!TIP]
 > For a more detailed and practical example, refer to the `CodePushDemoApp` in `example` directory. ([link](https://github.com/Soomgo-Mobile/react-native-code-push/tree/master/Examples/CodePushDemoApp))
@@ -352,7 +368,7 @@ Create a new release history for a specific binary app version.
   This ensures that the library runtime recognizes the binary app as the latest version and determines that no CodePush update is available for it.
 
 **Example:**
-- Create a new release history for the binary app version `1.0.0`. 
+- Create a new release history for the binary app version `1.0.0`.
 
 ```bash
 npx code-push create-history --binary-version 1.0.0 --platform ios --identifier staging

cli/commands/initCommand/index.js

@@ -0,0 +1,14 @@
+const { initAndroid } = require('./initAndroid');
+const { initIos } = require('./initIos');
+const { program } = require('commander');
+
+program
+    .command('init')
+    .description('Automatically performs iOS/Android native configurations to initialize the CodePush project.')
+    .action(async () => {
+        console.log('log: Start initializing CodePush...');
+        await initAndroid();
+        await initIos();
+        console.log('log: CodePush has been successfully initialized.');
+    });
+

cli/commands/initCommand/initAndroid.js

@@ -0,0 +1,48 @@
+const path = require('path');
+const fs = require('fs');
+const { EOL } = require('os');
+
+function modifyMainApplicationKt(mainApplicationContent) {
+    if (mainApplicationContent.includes('CodePush.getJSBundleFile()')) {
+        console.log('log: MainApplication.kt already has CodePush initialized.');
+        return mainApplicationContent;
+    }
+    return mainApplicationContent
+        .replace('import com.facebook.react.ReactApplication', `import com.facebook.react.ReactApplication${EOL}import com.microsoft.codepush.react.CodePush`)
+        .replace('override fun getJSMainModuleName(): String = "index"', `override fun getJSMainModuleName(): String = "index"${EOL}        override fun getJSBundleFile(): String = CodePush.getJSBundleFile()`)
+}
+
+async function initAndroid() {
+    console.log('log: Running Android setup...');
+    await applyMainApplication();
+}
+
+async function applyMainApplication() {
+    const mainApplicationPath = await findMainApplication();
+    if (!mainApplicationPath) {
+        console.log('log: Could not find MainApplication.kt');
+        return;
+    }
+
+    if (mainApplicationPath.endsWith('.java')) {
+        console.log('log: MainApplication.java is not supported. Please migrate to MainApplication.kt.');
+        return;
+    }
+
+    const mainApplicationContent = fs.readFileSync(mainApplicationPath, 'utf-8');
+    const newContent = modifyMainApplicationKt(mainApplicationContent);
+    fs.writeFileSync(mainApplicationPath, newContent);
+    console.log('log: Successfully updated MainApplication.kt.');
+}
+
+async function findMainApplication() {
+    const searchPath = path.join(process.cwd(), 'android', 'app', 'src', 'main', 'java');
+    const files = fs.readdirSync(searchPath, { recursive: true });
+    const mainApplicationFile = files.find(file => file.endsWith('MainApplication.java') || file.endsWith('MainApplication.kt'));
+    return mainApplicationFile ? path.join(searchPath, mainApplicationFile) : null;
+}
+
+module.exports = {
+    initAndroid: initAndroid,
+    modifyMainApplicationKt: modifyMainApplicationKt,
+};

cli/commands/initCommand/initIos.js

@@ -0,0 +1,128 @@
+const path = require('path');
+const fs = require('fs');
+const xcode = require('xcode');
+
+async function initIos() {
+    console.log('log: Running iOS setup...');
+    const projectDir = path.join(process.cwd(), 'ios');
+    const files = fs.readdirSync(projectDir);
+    const xcodeprojFile = files.find(file => file.endsWith('.xcodeproj'));
+    if (!xcodeprojFile) {
+        console.log('log: Could not find .xcodeproj file in ios directory');
+        return;
+    }
+    const projectName = xcodeprojFile.replace('.xcodeproj', '');
+    const appDelegatePath = findAppDelegate(path.join(projectDir, projectName));
+
+    if (!appDelegatePath) {
+        console.log('log: Could not find AppDelegate file');
+        return;
+    }
+
+    if (appDelegatePath.endsWith('.swift')) {
+        await setupSwift(appDelegatePath, projectDir, projectName);
+    } else {
+        await setupObjectiveC(appDelegatePath);
+    }
+
+    console.log('log: Please run `cd ios && pod install` to complete the setup.');
+}
+
+function findAppDelegate(searchPath) {
+    if (!fs.existsSync(searchPath)) return null;
+    const files = fs.readdirSync(searchPath);
+    const appDelegateFile = files.find(file => file.startsWith('AppDelegate') && (file.endsWith('.m') || file.endsWith('.mm') || file.endsWith('.swift')));
+    return appDelegateFile ? path.join(searchPath, appDelegateFile) : null;
+}
+
+function modifyObjectiveCAppDelegate(appDelegateContent) {
+    const IMPORT_STATEMENT = '#import <CodePush/CodePush.h>';
+    if (appDelegateContent.includes(IMPORT_STATEMENT)) {
+        console.log('log: AppDelegate already has CodePush imported.');
+        return appDelegateContent;
+    }
+
+    return appDelegateContent
+        .replace('#import "AppDelegate.h"\n', `#import "AppDelegate.h"\n${IMPORT_STATEMENT}\n`)
+        .replace('[[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];', '[CodePush bundleURL];');
+}
+
+function modifySwiftAppDelegate(appDelegateContent) {
+    const CODEPUSH_CALL_STATEMENT = 'CodePush.bundleURL()';
+    if (appDelegateContent.includes(CODEPUSH_CALL_STATEMENT)) {
+        console.log('log: AppDelegate.swift already configured for CodePush.');
+        return appDelegateContent;
+    }
+
+    return appDelegateContent
+        .replace('Bundle.main.url(forResource: "main", withExtension: "jsbundle")', CODEPUSH_CALL_STATEMENT);
+}
+
+async function setupObjectiveC(appDelegatePath) {
+    const appDelegateContent = fs.readFileSync(appDelegatePath, 'utf-8');
+    const newContent = modifyObjectiveCAppDelegate(appDelegateContent);
+    fs.writeFileSync(appDelegatePath, newContent);
+    console.log('log: Successfully updated AppDelegate.m/mm.');
+}
+
+async function setupSwift(appDelegatePath, projectDir, projectName) {
+    const bridgingHeaderPath = await ensureBridgingHeader(projectDir, projectName);
+    if (!bridgingHeaderPath) {
+        console.log('log: Failed to create or find bridging header.');
+        return;
+    }
+
+    const appDelegateContent = fs.readFileSync(appDelegatePath, 'utf-8');
+    const newContent = modifySwiftAppDelegate(appDelegateContent);
+    fs.writeFileSync(appDelegatePath, newContent);
+    console.log('log: Successfully updated AppDelegate.swift.');
+}
+
+async function ensureBridgingHeader(projectDir, projectName) {
+    const projectPath = path.join(projectDir, `${projectName}.xcodeproj`, 'project.pbxproj');
+    const myProj = xcode.project(projectPath);
+
+    return new Promise((resolve, reject) => {
+        myProj.parse(function (err) {
+            if (err) {
+                console.error(`Error parsing Xcode project: ${err}`);
+                return reject(err);
+            }
+
+            const bridgingHeaderRelativePath = `${projectName}/${projectName}-Bridging-Header.h`;
+            const bridgingHeaderAbsolutePath = path.join(projectDir, bridgingHeaderRelativePath);
+
+            const configurations = myProj.pbxXCBuildConfigurationSection();
+            for (const name in configurations) {
+                const config = configurations[name];
+                if (config.buildSettings) {
+                    config.buildSettings.SWIFT_OBJC_BRIDGING_HEADER = `"${bridgingHeaderRelativePath}"`;
+                }
+            }
+
+            if (!fs.existsSync(bridgingHeaderAbsolutePath)) {
+                fs.mkdirSync(path.dirname(bridgingHeaderAbsolutePath), { recursive: true });
+                fs.writeFileSync(bridgingHeaderAbsolutePath, '#import <CodePush/CodePush.h>\n');
+                console.log(`log: Created bridging header at ${bridgingHeaderAbsolutePath}`);
+                const groupKey = myProj.findPBXGroupKey({ name: projectName });
+                myProj.addHeaderFile(bridgingHeaderRelativePath, { public: true }, groupKey);
+            } else {
+                const headerContent = fs.readFileSync(bridgingHeaderAbsolutePath, 'utf-8');
+                if (!headerContent.includes('#import <CodePush/CodePush.h>')) {
+                    fs.appendFileSync(bridgingHeaderAbsolutePath, '\n#import <CodePush/CodePush.h>\n');
+                    console.log(`log: Updated bridging header at ${bridgingHeaderAbsolutePath}`);
+                }
+            }
+
+            fs.writeFileSync(projectPath, myProj.writeSync());
+            console.log('log: Updated Xcode project with bridging header path.');
+            resolve(bridgingHeaderAbsolutePath);
+        });
+    });
+}
+
+module.exports = {
+    initIos: initIos,
+    modifyObjectiveCAppDelegate: modifyObjectiveCAppDelegate,
+    modifySwiftAppDelegate: modifySwiftAppDelegate,
+}

cli/commands/initCommand/test/initAndroid.test.js

@@ -0,0 +1,85 @@
+const fs = require('fs');
+const path = require('path');
+const { initAndroid, modifyMainApplicationKt } = require('../initAndroid');
+
+const tempDir = path.join(__dirname, 'temp');
+
+// https://github.com/react-native-community/template/blob/0.80.2/template/android/app/src/main/java/com/helloworld/MainApplication.kt
+const ktTemplate = `
+package com.helloworld
+
+import android.app.Application
+import com.facebook.react.PackageList
+import com.facebook.react.ReactApplication
+import com.facebook.react.ReactHost
+import com.facebook.react.ReactNativeApplicationEntryPoint.loadReactNative
+import com.facebook.react.ReactNativeHost
+import com.facebook.react.ReactPackage
+import com.facebook.react.defaults.DefaultReactHost.getDefaultReactHost
+import com.facebook.react.defaults.DefaultReactNativeHost
+
+class MainApplication : Application(), ReactApplication {
+
+  override val reactNativeHost: ReactNativeHost =
+      object : DefaultReactNativeHost(this) {
+        override fun getPackages(): List<ReactPackage> =
+            PackageList(this).packages.apply {
+              // Packages that cannot be autolinked yet can be added manually here, for example:
+              // add(MyReactNativePackage())
+            }
+
+        override fun getJSMainModuleName(): String = "index"
+
+        override fun getUseDeveloperSupport(): Boolean = BuildConfig.DEBUG
+
+        override val isNewArchEnabled: Boolean = BuildConfig.IS_NEW_ARCHITECTURE_ENABLED
+        override val isHermesEnabled: Boolean = BuildConfig.IS_HERMES_ENABLED
+      }
+
+  override val reactHost: ReactHost
+    get() = getDefaultReactHost(applicationContext, reactNativeHost)
+
+  override fun onCreate() {
+    super.onCreate()
+    loadReactNative(this)
+  }
+}
+`;
+
+describe('Android init command', () => {
+    it('should correctly modify Kotlin MainApplication content', () => {
+        const modifiedContent = modifyMainApplicationKt(ktTemplate);
+        expect(modifiedContent).toContain('import com.microsoft.codepush.react.CodePush');
+        expect(modifiedContent).toContain('override fun getJSBundleFile(): String = CodePush.getJSBundleFile()');
+    });
+
+    it('should log a message and exit if MainApplication.java is found', async () => {
+        const originalCwd = process.cwd();
+
+        fs.mkdirSync(tempDir, { recursive: true });
+        process.chdir(tempDir);
+
+        // Arrange
+        const javaAppDir = path.join(tempDir, 'android', 'app', 'src', 'main', 'java', 'com', 'helloworld');
+        fs.mkdirSync(javaAppDir, { recursive: true });
+        const javaFilePath = path.join(javaAppDir, 'MainApplication.java');
+        const originalContent = '// Java file content';
+        fs.writeFileSync(javaFilePath, originalContent);
+
+        const consoleSpy = jest.spyOn(console, 'log').mockImplementation(() => {
+        });
+
+        // Act
+        await initAndroid();
+
+        // Assert
+        expect(consoleSpy).toHaveBeenCalledWith('MainApplication.java is not supported. Please migrate to MainApplication.kt.');
+        const finalContent = fs.readFileSync(javaFilePath, 'utf-8');
+        expect(finalContent).toBe(originalContent); // Ensure file is not modified
+
+        consoleSpy.mockRestore();
+
+        process.chdir(originalCwd);
+        fs.rmSync(tempDir, { recursive: true, force: true });
+    });
+});