@mikro-orm/cli 7.0.0-dev.76 → 7.0.0-dev.77

package/CLIConfigurator.js

@@ -36,12 +36,12 @@ function createBasicConfig() {
         .strict();
 }
 export async function configure() {
-    ConfigurationLoader.checkPackageVersion();
-    const settings = CLIHelper.getSettings();
+    await ConfigurationLoader.checkPackageVersion();
+    const settings = await CLIHelper.getSettings();
     const version = Utils.getORMVersion();
     if (settings.preferTs !== false) {
         const preferTs = await CLIHelper.registerTypeScriptSupport(settings.tsConfigPath, settings.tsLoader);
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!preferTs) {
             process.env.MIKRO_ORM_CLI_PREFER_TS ??= '0';
         }

package/CLIHelper.d.ts

@@ -14,11 +14,10 @@ export declare class CLIHelper {
     static getORM<D extends IDatabaseDriver = IDatabaseDriver>(contextName?: string, configPaths?: string[], opts?: Partial<Options<D>>): Promise<MikroORM<D>>;
     static isDBConnected(config: Configuration, reason?: false): Promise<boolean>;
     static isDBConnected(config: Configuration, reason: true): Promise<true | string>;
-    static getNodeVersion(): string;
     static getDriverDependencies(config: Configuration): string[];
     static dump(text: string, config?: Configuration): void;
-    static getSettings(): Settings;
-    static getConfigPaths(): string[];
+    static getSettings(): Promise<Settings>;
+    static getConfigPaths(): Promise<string[]>;
     private static getConfigFile;
     private static loadEnvironmentVars;
     static dumpDependencies(): Promise<void>;
@@ -40,7 +39,7 @@ export declare class CLIHelper {
      * This method is used only in CLI context.
      */
     static registerTypeScriptSupport(configPath?: string, tsLoader?: 'swc' | 'tsx' | 'jiti' | 'tsimp' | 'auto'): Promise<boolean>;
-    static isESM(): boolean;
+    static isESM(): Promise<boolean>;
     static showHelp(): void;
 }
 export interface Settings {

package/CLIHelper.js

@@ -1,8 +1,7 @@
-import { readFile } from 'node:fs/promises';
-import { createRequire } from 'node:module';
-import { extname, join, resolve } from 'node:path';
+import { extname, join } from 'node:path';
+import { pathToFileURL } from 'node:url';
 import yargs from 'yargs';
-import { colors, ConfigurationLoader, MikroORM, Utils, Configuration, } from '@mikro-orm/core';
+import { colors, ConfigurationLoader, MikroORM, Utils, Configuration, lookupExtensions, } from '@mikro-orm/core';
 /**
  * @internal
  */
@@ -14,13 +13,15 @@ export class CLIHelper {
      * @param paths Array of possible paths for a configuration file. Files will be checked in order, and the first existing one will be used. Defaults to the output of {@link ConfigurationLoader.getConfigPaths}.
      * @param options Additional options to augment the final configuration with.
      */
-    static async getConfiguration(contextName, paths = this.getConfigPaths(), options = {}) {
-        const deps = ConfigurationLoader.getORMPackages();
+    static async getConfiguration(contextName, paths, options = {}) {
+        paths ??= await this.getConfigPaths();
+        const deps = await ConfigurationLoader.getORMPackages();
         if (!deps.has('@mikro-orm/cli') && !process.env.MIKRO_ORM_ALLOW_GLOBAL_CLI) {
             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();
+        await lookupExtensions(options);
         const configFinder = (cfg) => {
             return typeof cfg === 'object' && cfg !== null && ('contextName' in cfg ? cfg.contextName === contextName : (contextName === 'default'));
         };
@@ -78,12 +79,12 @@ export class CLIHelper {
                 }
             }
         }
-        const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {};
+        const esmConfigOptions = await this.isESM() ? { entityGenerator: { esmImport: true } } : {};
         return new Configuration(Utils.mergeConfig({}, esmConfigOptions, tmp, options, env));
     }
     static async getORM(contextName, configPaths, opts = {}) {
         const options = await this.getConfiguration(contextName, configPaths, opts);
-        const settings = this.getSettings();
+        const settings = await this.getSettings();
         options.set('allowGlobalContext', true);
         options.set('debug', !!settings.verbose);
         options.getLogger().setDebugMode(!!settings.verbose);
@@ -108,9 +109,6 @@ export class CLIHelper {
             return false;
         }
     }
-    static getNodeVersion() {
-        return process.versions.node;
-    }
     static getDriverDependencies(config) {
         try {
             return config.getDriver().getDependencies();
@@ -126,8 +124,8 @@ export class CLIHelper {
         // eslint-disable-next-line no-console
         console.log(text);
     }
-    static getSettings() {
-        const config = ConfigurationLoader.getPackageConfig();
+    static async getSettings() {
+        const config = await ConfigurationLoader.getPackageConfig();
         const settings = { ...config['mikro-orm'] };
         const bool = (v) => ['true', 't', '1'].includes(v.toLowerCase());
         settings.preferTs = process.env.MIKRO_ORM_CLI_PREFER_TS != null ? bool(process.env.MIKRO_ORM_CLI_PREFER_TS) : settings.preferTs;
@@ -139,8 +137,8 @@ export class CLIHelper {
         }
         return settings;
     }
-    static getConfigPaths() {
-        const settings = this.getSettings();
+    static async getConfigPaths() {
+        const settings = await this.getSettings();
         const typeScriptSupport = settings.preferTs ?? Utils.detectTypeScriptSupport();
         const paths = [];
         if (process.env.MIKRO_ORM_CLI_CONFIG) {
@@ -174,20 +172,29 @@ export class CLIHelper {
     }
     static async loadEnvironmentVars() {
         const ret = ConfigurationLoader.loadEnvironmentVars();
-        // only to keep some sort of back compatibility with those using env vars only, to support `MIKRO_ORM_TYPE`
-        const PLATFORMS = {
-            mongo: { className: 'MongoDriver', module: '@mikro-orm/mongodb' },
-            mysql: { className: 'MySqlDriver', module: '@mikro-orm/mysql' },
-            mssql: { className: 'MsSqlDriver', module: '@mikro-orm/mssql' },
-            mariadb: { className: 'MariaDbDriver', module: '@mikro-orm/mariadb' },
-            postgresql: { className: 'PostgreSqlDriver', module: '@mikro-orm/postgresql' },
-            sqlite: { className: 'SqliteDriver', module: '@mikro-orm/sqlite' },
-            libsql: { className: 'LibSqlDriver', module: '@mikro-orm/libsql' },
-        };
-        if (process.env.MIKRO_ORM_TYPE) {
-            const val = process.env.MIKRO_ORM_TYPE;
-            const driver = await import(PLATFORMS[val].module);
-            ret.driver = driver[PLATFORMS[val].className];
+        /* v8 ignore next */
+        switch (process.env.MIKRO_ORM_TYPE) {
+            case 'mongo':
+                ret.driver ??= await import('@mikro-orm/sqlite').then(m => m.SqliteDriver);
+                break;
+            case 'mysql':
+                ret.driver ??= await import('@mikro-orm/mysql').then(m => m.MySqlDriver);
+                break;
+            case 'mssql':
+                ret.driver ??= await import('@mikro-orm/mssql').then(m => m.MsSqlDriver);
+                break;
+            case 'mariadb':
+                ret.driver ??= await import('@mikro-orm/mariadb').then(m => m.MariaDbDriver);
+                break;
+            case 'postgresql':
+                ret.driver ??= await import('@mikro-orm/postgresql').then(m => m.PostgreSqlDriver);
+                break;
+            case 'sqlite':
+                ret.driver ??= await import('@mikro-orm/sqlite').then(m => m.SqliteDriver);
+                break;
+            case 'libsql':
+                ret.driver ??= await import('@mikro-orm/libsql').then(m => m.LibSqlDriver);
+                break;
         }
         return ret;
     }
@@ -195,9 +202,9 @@ export class CLIHelper {
         const version = Utils.getORMVersion();
         CLIHelper.dump(' - dependencies:');
         CLIHelper.dump(`   - mikro-orm ${colors.green(version)}`);
-        CLIHelper.dump(`   - node ${colors.green(CLIHelper.getNodeVersion())}`);
+        CLIHelper.dump(`   - node ${colors.green(process.versions.node)}`);
         if (Utils.pathExists(process.cwd() + '/package.json')) {
-            /* v8 ignore next 3 */
+            /* v8 ignore if */
             if (process.versions.bun) {
                 CLIHelper.dump(`   - typescript via bun`);
             }
@@ -212,18 +219,12 @@ export class CLIHelper {
     }
     static async getModuleVersion(name) {
         try {
-            const pkg = Utils.requireFrom(`${name}/package.json`);
+            const path = `${this.resolveModulePath(name)}/package.json`;
+            const pkg = Utils.readJSONSync(path);
             return colors.green(pkg.version);
         }
         catch {
-            try {
-                const path = `${this.resolveModulePath(name)}/package.json`;
-                const pkg = await readFile(path, { encoding: 'utf8' });
-                return colors.green(JSON.parse(pkg).version);
-            }
-            catch {
-                return '';
-            }
+            return '';
         }
     }
     /**
@@ -235,7 +236,7 @@ export class CLIHelper {
         if (!extname(from)) {
             from = join(from, '__fake.js');
         }
-        const path = Utils.normalizePath(createRequire(resolve(from)).resolve(id));
+        const path = Utils.normalizePath(import.meta.resolve(id, pathToFileURL(from)));
         const parts = path.split('/');
         const idx = parts.lastIndexOf(id) + 1;
         parts.splice(idx, parts.length - idx);
@@ -268,16 +269,13 @@ export class CLIHelper {
      * This method is used only in CLI context.
      */
     static async registerTypeScriptSupport(configPath = 'tsconfig.json', tsLoader) {
-        /* v8 ignore next 3 */
+        /* v8 ignore if */
         if (process.versions.bun) {
             return true;
         }
         process.env.SWC_NODE_PROJECT ??= configPath;
         process.env.TSIMP_PROJECT ??= configPath;
         process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS ??= '1';
-        const isEsm = this.isESM();
-        /* v8 ignore next */
-        const importMethod = isEsm ? 'tryImport' : 'tryRequire';
         const explicitLoader = tsLoader ?? process.env.MIKRO_ORM_CLI_TS_LOADER ?? 'auto';
         const loaders = {
             swc: { esm: '@swc-node/register/esm-register', cjs: '@swc-node/register' },
@@ -290,9 +288,10 @@ export class CLIHelper {
                 continue;
             }
             const { esm, cjs, cb } = loaders[loader];
+            const isEsm = await this.isESM();
             /* v8 ignore next */
             const module = isEsm ? esm : cjs;
-            const mod = await Utils[importMethod]({ module });
+            const mod = await Utils.tryImport({ module });
             if (mod) {
                 cb?.(mod);
                 process.env.MIKRO_ORM_CLI_TS_LOADER = loader;
@@ -303,12 +302,12 @@ export class CLIHelper {
         console.warn('Neither `swc`, `tsx`, `jiti` nor `tsimp` found in the project dependencies, support for working with TypeScript files might not work. To use `swc`, you need to install both `@swc-node/register` and `@swc/core`.');
         return false;
     }
-    static isESM() {
-        const config = ConfigurationLoader.getPackageConfig();
+    static async isESM() {
+        const config = await ConfigurationLoader.getPackageConfig();
         const type = config?.type ?? '';
         return type === 'module';
     }
-    /* v8 ignore next 3 */
+    /* v8 ignore next */
     static showHelp() {
         yargs(process.argv.slice(2)).showHelp();
     }

package/commands/DebugCommand.js

@@ -9,12 +9,12 @@ export class DebugCommand {
     async handler(args) {
         CLIHelper.dump(`Current ${colors.cyan('MikroORM')} CLI configuration`);
         await CLIHelper.dumpDependencies();
-        const settings = CLIHelper.getSettings();
+        const settings = await CLIHelper.getSettings();
         if (!process.versions.bun && settings.preferTs !== false) {
             const loader = process.env.MIKRO_ORM_CLI_TS_LOADER ?? 'auto';
             CLIHelper.dump(' - TypeScript support ' + colors.green(`enabled (${loader})`));
         }
-        const configPaths = args.config ?? CLIHelper.getConfigPaths();
+        const configPaths = args.config ?? await CLIHelper.getConfigPaths();
         CLIHelper.dump(' - searched config paths:');
         await DebugCommand.checkPaths(configPaths, 'yellow');
         CLIHelper.dump(` - searched for config name: ${colors.green(args.contextName)}`);

package/commands/MigrationCommandFactory.js

@@ -148,7 +148,7 @@ export class MigrationCommandFactory {
             CLIHelper.dump(colors.green('Creating migration with following queries:'));
             CLIHelper.dump(colors.green('up:'));
             CLIHelper.dump(ret.diff.up.map(sql => '  ' + sql).join('\n'), config);
-            /* v8 ignore next 3 */
+            /* v8 ignore if */
             if (config.getDriver().getPlatform().supportsDownMigrations()) {
                 CLIHelper.dump(colors.green('down:'));
                 CLIHelper.dump(ret.diff.down.map(sql => '  ' + sql).join('\n'), config);

package/commands/SchemaCommandFactory.js

@@ -84,7 +84,7 @@ export class SchemaCommandFactory {
         if (args.dump) {
             const m = `get${method.substr(0, 1).toUpperCase()}${method.substr(1)}SchemaSQL`;
             const dump = await orm.schema[m](params);
-            /* v8 ignore next 3 */
+            /* v8 ignore if */
             if (dump) {
                 CLIHelper.dump(dump, orm.config);
                 successMessage = '';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/cli",
   "type": "module",
-  "version": "7.0.0-dev.76",
+  "version": "7.0.0-dev.77",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "exports": {
     "./package.json": "./package.json",
@@ -53,9 +53,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/core": "7.0.0-dev.76",
-    "@mikro-orm/knex": "7.0.0-dev.76",
-    "mikro-orm": "7.0.0-dev.76",
+    "@mikro-orm/core": "7.0.0-dev.77",
+    "@mikro-orm/knex": "7.0.0-dev.77",
+    "mikro-orm": "7.0.0-dev.77",
     "yargs": "17.7.2"
   },
   "devDependencies": {