@react-native-community/cli-config 7.0.1

package/src/readConfigFromDisk.ts

@@ -0,0 +1,68 @@
+import cosmiconfig from 'cosmiconfig';
+import {JoiError} from './errors';
+import * as schema from './schema';
+import {
+  UserConfig,
+  UserDependencyConfig,
+} from '@react-native-community/cli-types';
+
+/**
+ * Places to look for the configuration file.
+ */
+const searchPlaces = ['react-native.config.js'];
+
+/**
+ * Reads a project configuration as defined by the user in the current
+ * workspace.
+ */
+export function readConfigFromDisk(rootFolder: string): UserConfig {
+  const explorer = cosmiconfig('react-native', {
+    searchPlaces,
+    stopDir: rootFolder,
+  });
+
+  const searchResult = explorer.searchSync(rootFolder);
+  const config = searchResult ? searchResult.config : undefined;
+  const result = schema.projectConfig.validate(config);
+
+  if (result.error) {
+    throw new JoiError(result.error);
+  }
+
+  return result.value as UserConfig;
+}
+
+/**
+ * Reads a dependency configuration as defined by the developer
+ * inside `node_modules`.
+ */
+export function readDependencyConfigFromDisk(
+  rootFolder: string,
+): UserDependencyConfig {
+  const explorer = cosmiconfig('react-native', {
+    stopDir: rootFolder,
+    searchPlaces,
+  });
+
+  const searchResult = explorer.searchSync(rootFolder);
+  const config = searchResult ? searchResult.config : emptyDependencyConfig;
+
+  const result = schema.dependencyConfig.validate(config);
+
+  if (result.error) {
+    throw new JoiError(result.error);
+  }
+
+  return result.value as UserDependencyConfig;
+}
+
+const emptyDependencyConfig = {
+  dependency: {
+    platforms: {},
+    assets: [],
+    hooks: {},
+    params: [],
+  },
+  commands: [],
+  platforms: {},
+};

package/src/resolveReactNativePath.ts

@@ -0,0 +1,25 @@
+import {
+  CLIError,
+  resolveNodeModuleDir,
+} from '@react-native-community/cli-tools';
+
+/**
+ * Finds path to React Native inside `node_modules` or throws
+ * an error otherwise.
+ */
+export default function resolveReactNativePath(root: string) {
+  try {
+    return resolveNodeModuleDir(root, 'react-native');
+  } catch (_ignored) {
+    throw new CLIError(`
+      Unable to find React Native files looking up from ${root}. Make sure "react-native" module is installed
+      in your project dependencies.
+
+      If you are using React Native from a non-standard location, consider setting:
+      {
+        reactNativePath: "./path/to/react-native"
+      }
+      in your \`react-native.config.js\`.
+    `);
+  }
+}

package/src/schema.ts

@@ -0,0 +1,201 @@
+import t, {SchemaLike} from 'joi';
+
+const map = (key: RegExp | SchemaLike, value: SchemaLike) =>
+  t.object().unknown(true).pattern(key, value);
+
+/**
+ * Schema for CommandT
+ */
+const command = t.object({
+  name: t.string().required(),
+  description: t.string(),
+  usage: t.string(),
+  func: t.func().required(),
+  options: t.array().items(
+    t
+      .object({
+        name: t.string().required(),
+        description: t.string(),
+        parse: t.func(),
+        default: t
+          .alternatives()
+          .try(t.bool(), t.number(), t.string().allow(''), t.func()),
+      })
+      .rename('command', 'name', {ignoreUndefined: true}),
+  ),
+  examples: t.array().items(
+    t.object({
+      desc: t.string().required(),
+      cmd: t.string().required(),
+    }),
+  ),
+});
+
+/**
+ * Schema for HealthChecksT
+ */
+const healthCheck = t.object({
+  label: t.string().required(),
+  healthchecks: t.array().items(
+    t.object({
+      label: t.string().required(),
+      isRequired: t.bool(),
+      description: t.string(),
+      getDiagnostics: t.func(),
+      win32AutomaticFix: t.func(),
+      darwinAutomaticFix: t.func(),
+      linuxAutomaticFix: t.func(),
+      runAutomaticFix: t.func().required(),
+    }),
+  ),
+});
+
+/**
+ * Schema for UserDependencyConfigT
+ */
+export const dependencyConfig = t
+  .object({
+    dependency: t
+      .object({
+        platforms: map(t.string(), t.any())
+          .keys({
+            ios: t
+              .object({
+                project: t.string(),
+                podspecPath: t.string(),
+                sharedLibraries: t.array().items(t.string()),
+                libraryFolder: t.string(),
+                scriptPhases: t.array().items(t.object()),
+                configurations: t.array().items(t.string()).default([]),
+              })
+              .default({}),
+            android: t
+              .object({
+                sourceDir: t.string(),
+                manifestPath: t.string(),
+                packageImportPath: t.string(),
+                packageInstance: t.string(),
+                dependencyConfiguration: t.string(),
+                buildTypes: t.array().items(t.string()).default([]),
+              })
+              .default({}),
+          })
+          .default(),
+        assets: t.array().items(t.string()).default([]),
+        hooks: map(t.string(), t.string()).default({}),
+        params: t
+          .array()
+          .items(
+            t.object({
+              name: t.string(),
+              type: t.string(),
+              message: t.string(),
+            }),
+          )
+          .default([]),
+      })
+      .default(),
+    platforms: map(
+      t.string(),
+      t.object({
+        npmPackageName: t.string().optional(),
+        dependencyConfig: t.func(),
+        projectConfig: t.func(),
+        linkConfig: t.func(),
+      }),
+    ).default({}),
+    commands: t.array().items(command).default([]),
+    healthChecks: t.array().items(healthCheck).default([]),
+  })
+  .unknown(true)
+  .default();
+
+/**
+ * Schema for ProjectConfigT
+ */
+export const projectConfig = t
+  .object({
+    dependencies: map(
+      t.string(),
+      t
+        .object({
+          root: t.string(),
+          platforms: map(t.string(), t.any()).keys({
+            ios: t
+              .object({
+                sourceDir: t.string(),
+                folder: t.string(),
+                pbxprojPath: t.string(),
+                podfile: t.string(),
+                podspecPath: t.string(),
+                projectPath: t.string(),
+                projectName: t.string(),
+                libraryFolder: t.string(),
+                sharedLibraries: t.array().items(t.string()),
+                configurations: t.array().items(t.string()).default([]),
+              })
+              .allow(null),
+            android: t
+              .object({
+                sourceDir: t.string(),
+                folder: t.string(),
+                packageImportPath: t.string(),
+                packageInstance: t.string(),
+                dependencyConfiguration: t.string(),
+                buildTypes: t.array().items(t.string()).default([]),
+              })
+              .allow(null),
+          }),
+          assets: t.array().items(t.string()),
+          hooks: map(t.string(), t.string()),
+          params: t.array().items(
+            t.object({
+              name: t.string(),
+              type: t.string(),
+              message: t.string(),
+            }),
+          ),
+        })
+        .allow(null),
+    ).default({}),
+    reactNativePath: t.string(),
+    project: map(t.string(), t.any())
+      .keys({
+        ios: t
+          .object({
+            project: t.string(),
+            sharedLibraries: t.array().items(t.string()),
+            libraryFolder: t.string(),
+          })
+          .default({}),
+        android: t
+          .object({
+            sourceDir: t.string(),
+            manifestPath: t.string(),
+            packageName: t.string(),
+            packageFolder: t.string(),
+            mainFilePath: t.string(),
+            stringsPath: t.string(),
+            settingsGradlePath: t.string(),
+            assetsPath: t.string(),
+            buildGradlePath: t.string(),
+            appName: t.string(),
+            dependencyConfiguration: t.string(),
+          })
+          .default({}),
+      })
+      .default(),
+    assets: t.array().items(t.string()).default([]),
+    commands: t.array().items(command).default([]),
+    platforms: map(
+      t.string(),
+      t.object({
+        npmPackageName: t.string().optional(),
+        dependencyConfig: t.func(),
+        projectConfig: t.func(),
+        linkConfig: t.func(),
+      }),
+    ).default({}),
+  })
+  .unknown(true)
+  .default();

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build"
+  },
+  "references": [{"path": "../tools"}, {"path": "../cli-types"}]
+}