Method getConfiguration

packages/cli/src/CLIHelper.ts:31–70

* Gets a named configuration * * @param contextName Load a config with the given `contextName` value. Used when config file exports array or factory function. Setting it to "default" matches also config objects without `contextName` set. * @param paths Array of possible paths for a configur

(contextName?: string, paths?: string[], options: Partial<Options<D>> = {})

   * @param options Additional options to augment the final configuration with.
   */
  static async getConfiguration<
    D extends IDatabaseDriver = IDatabaseDriver,
    EM extends D[typeof EntityManagerType] & EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>,
  >(contextName?: string, paths?: string[], options: Partial<Options<D>> = {}): Promise<Configuration<D, EM>> {
    this.commonJSCompat(options);
    paths ??= await this.getConfigPaths();
    const deps = fs.getORMPackages();

    if (!deps.has('@mikro-orm/cli') && !process.env.MIKRO_ORM_ALLOW_GLOBAL_CLI && !process.versions.deno) {
      throw new Error('@mikro-orm/cli needs to be installed as a local dependency!');
    }

    contextName ??= process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default';
    const env = await this.loadEnvironmentVars();

    const result = await this.getConfigFile(paths);
    if (!result[0]) {
      if (Utils.hasObjectKeys(env)) {
        const merged = Utils.mergeConfig(
          { contextName },
          options.preferEnvVars ? options : env,
          options.preferEnvVars ? env : options,
        );
        await loadOptionalDependencies(merged);
        return new Configuration(merged);
      }
      throw new Error(`MikroORM config file not found in ['${paths.join(`', '`)}']`);
    }

    const [path, configExports] = result;
    const tmp = await searchConfiguration(configExports, contextName, path);

    const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {};
    await loadOptionalDependencies(tmp);

    const preferEnvVars = options.preferEnvVars ?? tmp.preferEnvVars;
    return new Configuration(
      Utils.mergeConfig({}, esmConfigOptions, tmp, preferEnvVars ? options : env, preferEnvVars ? env : options),
    );
  }

  static commonJSCompat(options: Partial<Options>): void {
    if (this.isESM()) {