@react-native-community/cli-config 7.0.1 → 8.0.0

package/src/errors.ts

@@ -1,31 +0,0 @@
-import {CLIError} from '@react-native-community/cli-tools';
-import {ValidationError} from 'joi';
-
-export class JoiError extends CLIError {
-  constructor(joiError: ValidationError) {
-    const message = joiError.details
-      .map((error) => {
-        const name = error.path.join('.');
-        switch (error.type) {
-          case 'object.allowUnknown': {
-            const value = JSON.stringify(error.context && error.context.value);
-            return `
-              Unknown option ${name} with value "${value}" was found.
-              This is either a typing error or a user mistake. Fixing it will remove this message.
-            `;
-          }
-          default:
-            return error.message;
-        }
-      })
-      .join()
-      .trim();
-
-    super(message);
-    this.name = 'Config Validation Error';
-
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, JoiError);
-    }
-  }
-}

package/src/findAssets.ts

@@ -1,28 +0,0 @@
-import glob from 'glob';
-import path from 'path';
-
-const findAssetsInFolder = (folder: string): string[] => {
-  const assets = glob.sync(path.join(folder, '**'), {nodir: true});
-  if (process.platform === 'win32') {
-    return assets.map((asset) => asset.split('/').join('\\'));
-  }
-  return assets;
-};
-
-/**
- * Given an array of assets folders, e.g. ['Fonts', 'Images'],
- * it globs in them to find all files that can be copied.
- *
- * It returns an array of absolute paths to files found.
- */
-export default function findAssets(
-  folder: string,
-  assets: Array<string>,
-): Array<string> {
-  return (assets || [])
-    .map((asset) => path.join(folder, asset))
-    .reduce(
-      (acc, assetPath) => acc.concat(findAssetsInFolder(assetPath)),
-      [] as string[],
-    );
-}

package/src/findDependencies.ts

@@ -1,24 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-
-/**
- * Returns an array of dependencies from project's package.json
- */
-export default function findDependencies(root: string): Array<string> {
-  let pjson;
-
-  try {
-    pjson = JSON.parse(
-      fs.readFileSync(path.join(root, 'package.json'), 'UTF-8'),
-    );
-  } catch (e) {
-    return [];
-  }
-
-  const deps = [
-    ...Object.keys(pjson.dependencies || {}),
-    ...Object.keys(pjson.devDependencies || {}),
-  ];
-
-  return deps;
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-import config from './commands/config';
-
-export {default} from './loadConfig';
-
-export const commands = [config];

package/src/loadConfig.ts

@@ -1,157 +0,0 @@
-import path from 'path';
-import chalk from 'chalk';
-import {
-  UserDependencyConfig,
-  ProjectConfig,
-  Dependency,
-  UserConfig,
-  Config,
-} from '@react-native-community/cli-types';
-import {
-  logger,
-  inlineString,
-  findProjectRoot,
-  resolveNodeModuleDir,
-} from '@react-native-community/cli-tools';
-import findDependencies from './findDependencies';
-import resolveReactNativePath from './resolveReactNativePath';
-import findAssets from './findAssets';
-import {
-  readConfigFromDisk,
-  readDependencyConfigFromDisk,
-} from './readConfigFromDisk';
-import assign from './assign';
-import merge from './merge';
-
-function getDependencyConfig(
-  root: string,
-  dependencyName: string,
-  finalConfig: Config,
-  config: UserDependencyConfig,
-  userConfig: UserConfig,
-  isPlatform: boolean,
-): Dependency {
-  return merge(
-    {
-      root,
-      name: dependencyName,
-      platforms: Object.keys(finalConfig.platforms).reduce(
-        (dependency, platform) => {
-          const platformConfig = finalConfig.platforms[platform];
-          dependency[platform] =
-            // Linking platforms is not supported
-            isPlatform || !platformConfig
-              ? null
-              : platformConfig.dependencyConfig(
-                  root,
-                  config.dependency.platforms[platform],
-                );
-          return dependency;
-        },
-        {} as Config['platforms'],
-      ),
-      assets: findAssets(root, config.dependency.assets),
-      hooks: config.dependency.hooks,
-      params: config.dependency.params,
-    },
-    userConfig.dependencies[dependencyName] || {},
-  ) as Dependency;
-}
-
-/**
- * Loads CLI configuration
- */
-function loadConfig(projectRoot: string = findProjectRoot()): Config {
-  let lazyProject: ProjectConfig;
-  const userConfig = readConfigFromDisk(projectRoot);
-
-  const initialConfig: Config = {
-    root: projectRoot,
-    get reactNativePath() {
-      return userConfig.reactNativePath
-        ? path.resolve(projectRoot, userConfig.reactNativePath)
-        : resolveReactNativePath(projectRoot);
-    },
-    dependencies: userConfig.dependencies,
-    commands: userConfig.commands,
-    get assets() {
-      return findAssets(projectRoot, userConfig.assets);
-    },
-    healthChecks: [],
-    platforms: userConfig.platforms,
-    get project() {
-      if (lazyProject) {
-        return lazyProject;
-      }
-
-      lazyProject = {};
-      for (const platform in finalConfig.platforms) {
-        const platformConfig = finalConfig.platforms[platform];
-        if (platformConfig) {
-          lazyProject[platform] = platformConfig.projectConfig(
-            projectRoot,
-            userConfig.project[platform] || {},
-          );
-        }
-      }
-
-      return lazyProject;
-    },
-  };
-
-  const finalConfig = Array.from(
-    new Set([
-      ...Object.keys(userConfig.dependencies),
-      ...findDependencies(projectRoot),
-    ]),
-  ).reduce((acc: Config, dependencyName) => {
-    const localDependencyRoot =
-      userConfig.dependencies[dependencyName] &&
-      userConfig.dependencies[dependencyName].root;
-    let root: string;
-    let config: UserDependencyConfig;
-    try {
-      root =
-        localDependencyRoot ||
-        resolveNodeModuleDir(projectRoot, dependencyName);
-      config = readDependencyConfigFromDisk(root);
-    } catch (error) {
-      logger.warn(
-        inlineString(`
-          Package ${chalk.bold(
-            dependencyName,
-          )} has been ignored because it contains invalid configuration.
-
-          Reason: ${chalk.dim(error.message)}`),
-      );
-      return acc;
-    }
-
-    const isPlatform = Object.keys(config.platforms).length > 0;
-
-    return assign({}, acc, {
-      dependencies: assign({}, acc.dependencies, {
-        get [dependencyName](): Dependency {
-          return getDependencyConfig(
-            root,
-            dependencyName,
-            finalConfig,
-            config,
-            userConfig,
-            isPlatform,
-          );
-        },
-      }),
-      commands: [...acc.commands, ...config.commands],
-      platforms: {
-        ...acc.platforms,
-        ...config.platforms,
-      },
-      healthChecks: [...acc.healthChecks, ...config.healthChecks],
-    }) as Config;
-  }, initialConfig);
-
-  return finalConfig;
-}
-
-export default loadConfig;

package/src/merge.ts

@@ -1,12 +0,0 @@
-import deepmerge from 'deepmerge';
-
-/**
- * `deepmerge` concatenates arrays by default instead of overwriting them.
- * We define custom merging function for arrays to change that behaviour
- */
-export default function merge<X, Y>(x: X, y: Y) {
-  return deepmerge(x, y, {
-    arrayMerge: (_destinationArray: any[], sourceArray: any[]): any[] =>
-      sourceArray,
-  });
-}

package/src/readConfigFromDisk.ts

@@ -1,68 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,201 +0,0 @@
-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

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