@mikro-orm/migrations 7.0.0-dev.77 → 7.0.0-dev.78

package/MigrationGenerator.js

@@ -1,4 +1,5 @@
 import { Utils, } from '@mikro-orm/core';
+import { fs } from '@mikro-orm/core/fs-utils';
 import { writeFile } from 'node:fs/promises';
 export class MigrationGenerator {
     driver;
@@ -16,7 +17,7 @@ export class MigrationGenerator {
         /* v8 ignore next */
         const defaultPath = this.options.emit === 'ts' && this.options.pathTs ? this.options.pathTs : this.options.path;
         path = Utils.normalizePath(this.driver.config.get('baseDir'), path ?? defaultPath);
-        Utils.ensureDir(path);
+        fs.ensureDir(path);
         const timestamp = new Date().toISOString().replace(/[-T:]|\.\d{3}z$/ig, '');
         const className = this.namingStrategy.classToMigrationName(timestamp, name);
         const fileName = `${this.options.fileName(timestamp, name)}.${this.options.emit}`;

package/Migrator.d.ts

@@ -17,6 +17,15 @@ export declare class Migrator implements IMigrator {
     private readonly absolutePath;
     private readonly snapshotPath;
     constructor(em: EntityManager);
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    private detectSourceFolder;
     static register(orm: MikroORM): void;
     /**
      * @inheritDoc

package/Migrator.js

@@ -2,6 +2,7 @@ import { Umzug, } from 'umzug';
 import { basename, join } from 'node:path';
 import { existsSync, writeFileSync } from 'node:fs';
 import { t, Type, UnknownType, Utils, } from '@mikro-orm/core';
+import { fs } from '@mikro-orm/core/fs-utils';
 import { DatabaseSchema, DatabaseTable, } from '@mikro-orm/knex';
 import { MigrationRunner } from './MigrationRunner.js';
 import { MigrationStorage } from './MigrationStorage.js';
@@ -25,6 +26,7 @@ export class Migrator {
         this.config = this.em.config;
         this.options = this.config.get('migrations');
         this.schemaGenerator = this.config.getExtension('@mikro-orm/schema-generator');
+        this.detectSourceFolder();
         /* v8 ignore next */
         const key = (this.config.get('preferTs', Utils.detectTypeScriptSupport()) && this.options.pathTs) ? 'pathTs' : 'path';
         this.absolutePath = Utils.absolutePath(this.options[key], this.config.get('baseDir'));
@@ -37,6 +39,33 @@ export class Migrator {
         this.snapshotPath = Utils.normalizePath(absoluteSnapshotPath, `${snapshotName}.json`);
         this.createUmzug();
     }
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    detectSourceFolder() {
+        const baseDir = this.config.get('baseDir');
+        const defaultPath = './migrations';
+        if (!fs.pathExists(baseDir + '/src')) {
+            this.options.path ??= defaultPath;
+            return;
+        }
+        const exists = fs.pathExists(`${baseDir}/${defaultPath}`);
+        const distDir = fs.pathExists(baseDir + '/dist');
+        const buildDir = fs.pathExists(baseDir + '/build');
+        // if neither `dist` nor `build` exist, we use the `src` folder as it might be a JS project without building, but with `src` folder
+        /* v8 ignore next */
+        const path = distDir ? './dist' : (buildDir ? './build' : './src');
+        // only if the user did not provide any values and if the default path does not exist
+        if (!this.options.path && !this.options.pathTs && !exists) {
+            this.options.path = `${path}/migrations`;
+            this.options.pathTs = './src/migrations';
+        }
+    }
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/migrator', () => new Migrator(orm.em));
     }
@@ -117,6 +146,7 @@ export class Migrator {
             logger: undefined,
             migrations,
         });
+        /* v8 ignore else */
         if (!this.options.silent) {
             const logger = this.config.getLogger();
             this.umzug.on('migrating', event => logger.log('migrator', `Processing '${event.name}'`, { enabled: true }));
@@ -227,7 +257,7 @@ export class Migrator {
         if (!this.options.snapshot || !existsSync(this.snapshotPath)) {
             return undefined;
         }
-        const data = Utils.readJSONSync(this.snapshotPath);
+        const data = fs.readJSONSync(this.snapshotPath);
         const schema = new DatabaseSchema(this.driver.getPlatform(), this.config.get('schema'));
         const { tables, namespaces, ...rest } = data;
         const tableInstances = tables.map((tbl) => {
@@ -333,7 +363,7 @@ export class Migrator {
     }
     ensureMigrationsDirExists() {
         if (!this.options.migrationsList) {
-            Utils.ensureDir(this.absolutePath);
+            fs.ensureDir(this.absolutePath);
         }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/migrations",
   "type": "module",
-  "version": "7.0.0-dev.77",
+  "version": "7.0.0-dev.78",
   "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",
@@ -50,13 +50,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/knex": "7.0.0-dev.77",
+    "@mikro-orm/knex": "7.0.0-dev.78",
     "umzug": "3.8.2"
   },
   "devDependencies": {
     "@mikro-orm/core": "^6.6.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.77"
+    "@mikro-orm/core": "7.0.0-dev.78"
   }
 }

package/typings.d.ts

@@ -1 +1 @@
-export { UmzugMigration, MigrateOptions, MigrationResult, MigrationRow } from '@mikro-orm/core';
+export type { UmzugMigration, MigrateOptions, MigrationResult, MigrationRow } from '@mikro-orm/core';