@mikro-orm/cli 6.3.14-dev.8 → 6.4.0

package/CLIConfigurator.d.ts

@@ -14,6 +14,8 @@ export interface BaseCommand<CommandArgs extends BaseArgs = BaseArgs> extends Co
 export declare class CLIConfigurator {
     private static createBasicConfig;
     static configure(): yargs.Argv<{
-        config: string | undefined;
+        config: string[] | undefined;
+    } & {
+        contextName: string;
     }>;
 }

package/CLIConfigurator.js

@@ -27,7 +27,14 @@ class CLIConfigurator {
             .example('$0 schema:update --run', 'Runs schema synchronization')
             .option('config', {
             type: 'string',
+            array: true,
             desc: `Set path to the ORM configuration file`,
+        })
+            .option('contextName', {
+            alias: 'context',
+            type: 'string',
+            desc: 'Set name of config to load out of the ORM configuration file. Used when config file exports an array or a function',
+            default: process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default',
         })
             .alias('v', 'version')
             .alias('h', 'help')
@@ -39,9 +46,9 @@ class CLIConfigurator {
         const settings = core_1.ConfigurationLoader.getSettings();
         const version = core_1.Utils.getORMVersion();
         if (settings.useTsNode !== false) {
-            const tsNode = core_1.ConfigurationLoader.registerTsNode(settings.tsConfigPath);
+            const preferTs = core_1.ConfigurationLoader.registerTsNode(settings.tsConfigPath);
             /* istanbul ignore if */
-            if (!tsNode) {
+            if (!preferTs) {
                 process.env.MIKRO_ORM_CLI_USE_TS_NODE ??= '0';
             }
         }

package/CLIHelper.d.ts

@@ -3,11 +3,12 @@ import { MikroORM, type Configuration, type IDatabaseDriver, type Options } from
  * @internal
  */
 export declare class CLIHelper {
-    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver>(validate?: boolean, options?: Partial<Options>): Promise<Configuration<D>>;
-    static getORM(warnWhenNoEntities?: boolean, opts?: Partial<Options>): Promise<MikroORM>;
-    static isDBConnected(reason?: boolean): Promise<boolean | string>;
+    static getConfiguration<D extends IDatabaseDriver = IDatabaseDriver>(contextName?: string, configPaths?: string[], options?: Partial<Options<D>>): Promise<Configuration<D>>;
+    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(): Promise<string[]>;
+    static getDriverDependencies(config: Configuration): string[];
     static dump(text: string, config?: Configuration): void;
     static getConfigPaths(): string[];
     static dumpDependencies(): Promise<void>;

package/CLIHelper.js

@@ -11,35 +11,40 @@ const core_1 = require("@mikro-orm/core");
  * @internal
  */
 class CLIHelper {
-    static async getConfiguration(validate = true, options = {}) {
+    static async getConfiguration(contextName, configPaths, options = {}) {
         const deps = core_1.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!');
         }
-        return core_1.ConfigurationLoader.getConfiguration(validate, options);
+        core_1.ConfigurationLoader.commonJSCompat(options);
+        core_1.ConfigurationLoader.registerDotenv(options);
+        configPaths ??= core_1.ConfigurationLoader.getConfigPaths();
+        contextName ??= process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default';
+        return core_1.ConfigurationLoader.getConfiguration(contextName, configPaths, options);
     }
-    static async getORM(warnWhenNoEntities, opts = {}) {
-        const options = await CLIHelper.getConfiguration(warnWhenNoEntities, opts);
+    static async getORM(contextName, configPaths, opts = {}) {
+        const options = await CLIHelper.getConfiguration(contextName, configPaths, opts);
         const settings = core_1.ConfigurationLoader.getSettings();
         options.set('allowGlobalContext', true);
         options.set('debug', !!settings.verbose);
         options.getLogger().setDebugMode(!!settings.verbose);
         options.set('connect', false);
         if (settings.useTsNode !== false) {
-            options.set('tsNode', true);
+            options.set('preferTs', true);
         }
-        if (core_1.Utils.isDefined(warnWhenNoEntities)) {
-            options.get('discovery').warnWhenNoEntities = warnWhenNoEntities;
+        // The only times when we don't care to have a warning about no entities is also the time when we ignore entities.
+        if (opts.discovery?.warnWhenNoEntities === false) {
+            options.set('entities', []);
+            options.set('entitiesTs', []);
         }
         return core_1.MikroORM.init(options.getAll());
     }
-    static async isDBConnected(reason = false) {
+    static async isDBConnected(config, reason = false) {
         try {
-            const config = await CLIHelper.getConfiguration();
             await config.getDriver().connect();
             const isConnected = await config.getDriver().getConnection().checkConnection();
             await config.getDriver().close();
-            return isConnected.reason && reason ? isConnected.reason : isConnected.ok;
+            return isConnected.ok || (reason ? isConnected.reason : false);
         }
         catch {
             return false;
@@ -48,9 +53,8 @@ class CLIHelper {
     static getNodeVersion() {
         return process.versions.node;
     }
-    static async getDriverDependencies() {
+    static getDriverDependencies(config) {
         try {
-            const config = await CLIHelper.getConfiguration();
             return config.getDriver().getDependencies();
         }
         catch {
@@ -73,10 +77,6 @@ class CLIHelper {
         CLIHelper.dump(`   - mikro-orm ${core_1.colors.green(version)}`);
         CLIHelper.dump(`   - node ${core_1.colors.green(CLIHelper.getNodeVersion())}`);
         if ((0, fs_extra_1.pathExistsSync)(process.cwd() + '/package.json')) {
-            const drivers = await CLIHelper.getDriverDependencies();
-            for (const driver of drivers) {
-                CLIHelper.dump(`   - ${driver} ${await CLIHelper.getModuleVersion(driver)}`);
-            }
             /* istanbul ignore next */
             if (process.versions.bun) {
                 CLIHelper.dump(`   - typescript via bun`);

package/commands/ClearCacheCommand.js

@@ -10,7 +10,7 @@ class ClearCacheCommand {
      * @inheritDoc
      */
     async handler(args) {
-        const config = await CLIHelper_1.CLIHelper.getConfiguration();
+        const config = await CLIHelper_1.CLIHelper.getConfiguration(args.contextName, args.config);
         if (!config.get('metadataCache').enabled) {
             CLIHelper_1.CLIHelper.dump(core_1.colors.red('Metadata cache is disabled in your configuration. Set cache.enabled to true to use this command.'));
             return;

package/commands/CreateDatabaseCommand.js

@@ -9,7 +9,7 @@ class CreateDatabaseCommand {
      * @inheritDoc
      */
     async handler(args) {
-        const orm = await CLIHelper_1.CLIHelper.getORM();
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config);
         const schemaGenerator = orm.getSchemaGenerator();
         await schemaGenerator.ensureDatabase();
         await orm.close(true);

package/commands/CreateSeederCommand.js

@@ -9,8 +9,8 @@ class CreateSeederCommand {
     builder = (args) => {
         args.positional('seeder', {
             describe: 'Name for the seeder class. (e.g. "test" will generate "TestSeeder" or "TestSeeder" will generate "TestSeeder")',
+            demandOption: true,
         });
-        args.demandOption('seeder');
         return args;
     };
     /**
@@ -18,7 +18,7 @@ class CreateSeederCommand {
      */
     async handler(args) {
         const className = CreateSeederCommand.getSeederClassName(args.seeder);
-        const orm = await CLIHelper_1.CLIHelper.getORM();
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config);
         const seeder = orm.getSeeder();
         const path = await seeder.createSeeder(className);
         CLIHelper_1.CLIHelper.dump(core_1.colors.green(`Seeder ${args.seeder} successfully created at ${path}`));

package/commands/DatabaseSeedCommand.js

@@ -18,7 +18,7 @@ class DatabaseSeedCommand {
      * @inheritDoc
      */
     async handler(args) {
-        const orm = await CLIHelper_1.CLIHelper.getORM();
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config);
         const className = args.class ?? orm.config.get('seeder').defaultSeeder;
         await orm.getSeeder().seedString(className);
         CLIHelper_1.CLIHelper.dump(core_1.colors.green(`Seeder ${className} successfully executed`));

package/commands/DebugCommand.js

@@ -16,29 +16,35 @@ class DebugCommand {
         if (!process.versions.bun && settings.useTsNode !== false) {
             CLIHelper_1.CLIHelper.dump(' - ts-node ' + core_1.colors.green('enabled'));
         }
-        const configPaths = CLIHelper_1.CLIHelper.getConfigPaths();
+        const configPaths = args.config ?? CLIHelper_1.CLIHelper.getConfigPaths();
         CLIHelper_1.CLIHelper.dump(' - searched config paths:');
         await DebugCommand.checkPaths(configPaths, 'yellow');
+        CLIHelper_1.CLIHelper.dump(` - searched for config name: ${core_1.colors.green(args.contextName)}`);
         try {
-            const config = await CLIHelper_1.CLIHelper.getConfiguration();
+            const config = await CLIHelper_1.CLIHelper.getConfiguration(args.contextName, configPaths);
             CLIHelper_1.CLIHelper.dump(` - configuration ${core_1.colors.green('found')}`);
-            const isConnected = await CLIHelper_1.CLIHelper.isDBConnected(true);
+            const drivers = CLIHelper_1.CLIHelper.getDriverDependencies(config);
+            CLIHelper_1.CLIHelper.dump(' - driver dependencies:');
+            for (const driver of drivers) {
+                CLIHelper_1.CLIHelper.dump(`   - ${driver} ${await CLIHelper_1.CLIHelper.getModuleVersion(driver)}`);
+            }
+            const isConnected = await CLIHelper_1.CLIHelper.isDBConnected(config, true);
             if (isConnected === true) {
                 CLIHelper_1.CLIHelper.dump(` - ${core_1.colors.green('database connection successful')}`);
             }
             else {
                 CLIHelper_1.CLIHelper.dump(` - ${core_1.colors.yellow(`database connection failed (${isConnected})`)}`);
             }
-            const tsNode = config.get('tsNode');
-            if ([true, false].includes(tsNode)) {
-                const warning = tsNode ? ' (this value should be set to `false` when running compiled code!)' : '';
-                CLIHelper_1.CLIHelper.dump(` - \`tsNode\` flag explicitly set to ${tsNode}, will use \`entities${tsNode ? 'Ts' : ''}\` array${warning}`);
+            const preferTs = config.get('preferTs');
+            if ([true, false].includes(preferTs)) {
+                const warning = preferTs ? ' (this value should be set to `false` when running compiled code!)' : '';
+                CLIHelper_1.CLIHelper.dump(` - \`preferTs\` flag explicitly set to ${preferTs}, will use \`entities${preferTs ? 'Ts' : ''}\` array${warning}`);
             }
             const entities = config.get('entities', []);
             if (entities.length > 0) {
                 const refs = entities.filter(p => !core_1.Utils.isString(p));
                 const paths = entities.filter(p => core_1.Utils.isString(p));
-                const will = !config.get('tsNode') ? 'will' : 'could';
+                const will = !config.get('preferTs') ? 'will' : 'could';
                 CLIHelper_1.CLIHelper.dump(` - ${will} use \`entities\` array (contains ${refs.length} references and ${paths.length} paths)`);
                 if (paths.length > 0) {
                     await DebugCommand.checkPaths(paths, 'red', config.get('baseDir'));
@@ -49,7 +55,7 @@ class DebugCommand {
                 const refs = entitiesTs.filter(p => !core_1.Utils.isString(p));
                 const paths = entitiesTs.filter(p => core_1.Utils.isString(p));
                 /* istanbul ignore next */
-                const will = config.get('tsNode') ? 'will' : 'could';
+                const will = config.get('preferTs') ? 'will' : 'could';
                 CLIHelper_1.CLIHelper.dump(` - ${will} use \`entitiesTs\` array (contains ${refs.length} references and ${paths.length} paths)`);
                 /* istanbul ignore else */
                 if (paths.length > 0) {

package/commands/GenerateCacheCommand.js

@@ -23,7 +23,7 @@ class GenerateCacheCommand {
      */
     async handler(args) {
         const options = args.combined ? { combined: './metadata.json' } : {};
-        const config = await CLIHelper_1.CLIHelper.getConfiguration(true, {
+        const config = await CLIHelper_1.CLIHelper.getConfiguration(args.contextName, args.config, {
             metadataCache: { enabled: true, adapter: core_1.FileCacheAdapter, options },
         });
         config.getMetadataCacheAdapter().clear();

package/commands/GenerateEntitiesCommand.js

@@ -37,7 +37,7 @@ class GenerateEntitiesCommand {
         if (!args.save && !args.dump) {
             return CLIHelper_1.CLIHelper.showHelp();
         }
-        const orm = await CLIHelper_1.CLIHelper.getORM(false);
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config, { discovery: { warnWhenNoEntities: false } });
         const dump = await orm.entityGenerator.generate({
             save: args.save,
             path: args.path,

package/commands/ImportCommand.d.ts

@@ -1,10 +1,14 @@
 import type { ArgumentsCamelCase } from 'yargs';
 import type { BaseArgs, BaseCommand } from '../CLIConfigurator';
-export declare class ImportCommand implements BaseCommand {
+type ImportArgs = BaseArgs & {
+    file: string;
+};
+export declare class ImportCommand implements BaseCommand<ImportArgs> {
     command: string;
     describe: string;
     /**
      * @inheritDoc
      */
-    handler(args: ArgumentsCamelCase<BaseArgs>): Promise<void>;
+    handler(args: ArgumentsCamelCase<ImportArgs>): Promise<void>;
 }
+export {};

package/commands/ImportCommand.js

@@ -10,7 +10,7 @@ class ImportCommand {
      * @inheritDoc
      */
     async handler(args) {
-        const orm = await CLIHelper_1.CLIHelper.getORM();
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config, { multipleStatements: true });
         await orm.em.getConnection().loadFile(args.file);
         CLIHelper_1.CLIHelper.dump(core_1.colors.green(`File ${args.file} successfully imported`));
         await orm.close(true);

package/commands/MigrationCommandFactory.js

@@ -82,7 +82,7 @@ class MigrationCommandFactory {
     static async handleMigrationCommand(args, method) {
         // to be able to run have a master transaction, but run marked migrations outside of it, we need a second connection
         const options = { pool: { min: 1, max: 2 } };
-        const orm = await CLIHelper_1.CLIHelper.getORM(undefined, options);
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config, options);
         const migrator = orm.getMigrator();
         switch (method) {
             case 'create':

package/commands/SchemaCommandFactory.js

@@ -82,7 +82,7 @@ class SchemaCommandFactory {
         if (!args.run && !args.dump) {
             return CLIHelper_1.CLIHelper.showHelp();
         }
-        const orm = await CLIHelper_1.CLIHelper.getORM();
+        const orm = await CLIHelper_1.CLIHelper.getORM(args.contextName, args.config);
         const generator = orm.getSchemaGenerator();
         const params = { wrap: args.fkChecks == null ? undefined : !args.fkChecks, ...args };
         if (args.dump) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/cli",
-  "version": "6.3.14-dev.8",
+  "version": "6.4.0",
   "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.",
   "main": "index.js",
   "module": "index.mjs",
@@ -63,15 +63,15 @@
   },
   "dependencies": {
     "@jercle/yargonaut": "1.1.5",
-    "@mikro-orm/core": "6.3.14-dev.8",
-    "@mikro-orm/knex": "6.3.14-dev.8",
+    "@mikro-orm/core": "6.4.0",
+    "@mikro-orm/knex": "6.4.0",
     "fs-extra": "11.2.0",
     "tsconfig-paths": "4.2.0",
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@mikro-orm/entity-generator": "^6.3.13",
-    "@mikro-orm/migrations": "^6.3.13",
-    "@mikro-orm/seeder": "^6.3.13"
+    "@mikro-orm/entity-generator": "^6.4.0",
+    "@mikro-orm/migrations": "^6.4.0",
+    "@mikro-orm/seeder": "^6.4.0"
   }
 }