[Feat] Add support for .xcode.env file in init and doctor commands

Author: Riccardo Cipolleschi

packages/cli-doctor/src/tools/healthchecks/index.ts

@@ -11,6 +11,7 @@ import cocoaPods from './cocoaPods';
 import iosDeploy from './iosDeploy';
 import {Healthchecks, HealthCheckCategory} from '../../types';
 import loadConfig from '@react-native-community/cli-config';
+import xcodeEnv from './xcodeEnv';
 
 export const HEALTHCHECK_TYPES = {
   ERROR: 'ERROR',
@@ -55,7 +56,7 @@ export const getHealthchecks = ({contributor}: Options): Healthchecks => {
       ? {
           ios: {
             label: 'iOS',
-            healthchecks: [xcode, cocoaPods, iosDeploy],
+            healthchecks: [xcode, cocoaPods, iosDeploy, xcodeEnv],
           },
         }
       : {}),

packages/cli-doctor/src/tools/healthchecks/xcodeEnv.ts

@@ -0,0 +1,61 @@
+import {HealthCheckInterface} from '../../types';
+import fs from 'fs';
+import path from 'path';
+import {promisify} from 'util';
+import {findProjectRoot} from '@react-native-community/cli-tools';
+import {findPodfilePaths} from '@react-native-community/cli-platform-ios';
+
+const xcodeEnvFile = '.xcode.env';
+const pathSeparator = '/';
+
+function removeLastPathComponent(pathString: string): string {
+  const components = pathString.split(pathSeparator);
+  components.splice(components.length - 1, 1);
+  return components.join(pathSeparator);
+}
+
+function pathHasXcodeEnvFile(pathString: string): boolean {
+  const xcodeEnvPath = pathString + pathSeparator + xcodeEnvFile;
+  return fs.existsSync(xcodeEnvPath);
+}
+
+function pathDoesNotHaveXcodeEnvFile(pathString: string): boolean {
+  return !pathHasXcodeEnvFile(pathString);
+}
+
+export default {
+  label: '.xcode.env',
+  description: 'File to customize Xcode environment',
+  getDiagnostics: async () => {
+    const projectRoot = findProjectRoot();
+    const allPathsHasXcodeEnvFile = findPodfilePaths(projectRoot)
+      .map((pathString) => {
+        const basePath = removeLastPathComponent(pathString);
+        return pathHasXcodeEnvFile(basePath);
+      })
+      .reduce((previousValue, currentValue) => previousValue && currentValue);
+    return {
+      needsToBeFixed: !allPathsHasXcodeEnvFile,
+    };
+  },
+  runAutomaticFix: async () => {
+    const templateXcodeEnv = '_xcode.env';
+    const projectRoot = findProjectRoot();
+
+    const templateIosPath = path.dirname(
+      require.resolve('react-native/template/ios'),
+    );
+
+    const src = templateIosPath + templateXcodeEnv;
+    const copyFileAsync = promisify(fs.copyFile);
+
+    findPodfilePaths(projectRoot)
+      .map(removeLastPathComponent)
+      // avoid overriding existing .xcode.env
+      .filter(pathDoesNotHaveXcodeEnvFile)
+      .forEach(async (pathString) => {
+        const destFilePath = pathString + pathSeparator + xcodeEnvFile;
+        await copyFileAsync(src, destFilePath);
+      });
+  },
+} as HealthCheckInterface;

packages/cli-doctor/tsconfig.json

@@ -7,6 +7,7 @@
   "references": [
     {"path": "../tools"},
     {"path": "../cli-types"},
-    {"path": "../cli-config"}
+    {"path": "../cli-config"},
+    {"path": "../platform-ios"}
   ]
 }

packages/cli/src/commands/init/editTemplate.ts

@@ -69,6 +69,7 @@ const UNDERSCORED_DOTFILES = [
   'editorconfig',
   'bundle',
   'ruby-version',
+  'xcode.env',
 ];
 
 async function processDotfiles(filePath: string) {

packages/cli/src/tools/generator/copyProjectTemplateAndReplace.ts

@@ -148,7 +148,8 @@ function translateFilePath(filePath: string) {
     .replace('_prettierrc.js', '.prettierrc.js')
     .replace('_bundle', '.bundle')
     .replace('_ruby-version', '.ruby-version')
-    .replace('_watchmanconfig', '.watchmanconfig');
+    .replace('_watchmanconfig', '.watchmanconfig')
+    .replace('_xcode.env', '.xcode.env');
 }
 
 function upgradeFileContentChangedCallback(

packages/platform-ios/src/config/findAllPodfilePaths.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import glob from 'glob';
+
+// These folders will be excluded from search to speed it up
+const GLOB_EXCLUDE_PATTERN = ['**/@(Pods|node_modules|Carthage)/**'];
+
+export default function findAllPodfilePaths(cwd: string) {
+  return glob.sync('**/Podfile', {
+    cwd,
+    ignore: GLOB_EXCLUDE_PATTERN,
+  });
+}

packages/platform-ios/src/config/findPodfilePath.ts

@@ -7,27 +7,17 @@
  */
 
 import {inlineString, logger} from '@react-native-community/cli-tools';
-import glob from 'glob';
 import path from 'path';
+import findAllPodfilePaths from './findAllPodfilePaths';
 
 // Regexp matching all test projects
 const TEST_PROJECTS = /test|example|sample/i;
 
 // Base iOS folder
 const IOS_BASE = 'ios';
 
-// These folders will be excluded from search to speed it up
-const GLOB_EXCLUDE_PATTERN = ['**/@(Pods|node_modules|Carthage)/**'];
-
 export default function findPodfilePath(cwd: string) {
-  /**
-   * First, we're going to look for all Podfiles within the `cwd`
-   */
-  const podfiles = glob
-    .sync('**/Podfile', {
-      cwd,
-      ignore: GLOB_EXCLUDE_PATTERN,
-    })
+  const podfiles = findAllPodfilePaths(cwd)
     /**
      * Then, we will run a simple test to rule out most example projects,
      * unless they are located in a `ios` folder

packages/platform-ios/src/config/index.ts

@@ -10,6 +10,7 @@ import fs from 'fs';
 import findPodfilePath from './findPodfilePath';
 import findXcodeProject from './findXcodeProject';
 import findPodspec from './findPodspec';
+import findAllPodfilePaths from './findAllPodfilePaths';
 import {
   IOSProjectParams,
   IOSDependencyParams,
@@ -65,3 +66,5 @@ export function dependencyConfig(
     scriptPhases: userConfig.scriptPhases || [],
   };
 }
+
+export const findPodfilePaths = findAllPodfilePaths;

packages/platform-ios/src/index.ts

@@ -3,4 +3,4 @@
  */
 
 export {default as commands} from './commands';
-export {projectConfig, dependencyConfig} from './config';
+export {projectConfig, dependencyConfig, findPodfilePaths} from './config';