knex-migrator 6.0.0 → 6.1.0

package/README.md

@@ -42,6 +42,17 @@ The `mysql` client name is accepted for backwards compatibility and is mapped to
 
 Add `MigratorConfig.js` to the project root that will run migrations. CLI commands load this file from the current working directory by default, or from the directory passed with `--mgpath`.
 
+`MigratorConfig.cjs` and `MigratorConfig.mjs` are also supported and are resolved in that order after `MigratorConfig.js`. ESM configs (`.mjs`, or `.js`/`.cjs` in a `"type": "module"` package) are loaded synchronously, so they must export the config as the `default` export and must not use top-level `await`:
+
+```js
+// MigratorConfig.mjs
+export default {
+    database: { /* ... */ },
+    migrationPath: '/path/to/project/migrations',
+    currentVersion: '2.0'
+};
+```
+
 ```js
 module.exports = {
     database: {

package/lib/utils.js

@@ -5,11 +5,39 @@ const resolve = require('util').promisify(require('resolve'));
 const debug = require('debug')('knex-migrator:utils');
 const errors = require('./errors');
 
+/**
+ * @description The config file basenames we look for, in resolution order.
+ *
+ * `.mjs` and `.cjs` are supported alongside the historical `.js`. ESM configs
+ * are loaded synchronously via `require()` (Node >= 22.13 / >= 24), so they must
+ * not use top-level await.
+ */
+const CONFIG_FILENAMES = ['MigratorConfig.js', 'MigratorConfig.cjs', 'MigratorConfig.mjs'];
+
+/**
+ * @description Unwrap the config from a loaded module.
+ *
+ * `require()`-ing an ESM module (a `.mjs` file, or a `.js`/`.cjs` file in a
+ * `"type": "module"` package) returns a Module namespace object whose config
+ * lives on the `default` export. CommonJS modules return `module.exports`
+ * directly.
+ *
+ * @param {*} loaded
+ * @returns {*}
+ */
+function interopConfig(loaded) {
+    if (loaded && loaded[Symbol.toStringTag] === 'Module' && 'default' in loaded) {
+        return loaded.default;
+    }
+
+    return loaded;
+}
+
 /**
  * @description This helper function offers two ways of loading the knex-migrator configuration.
  *
  * 1. via JS object
- * 2. via file location
+ * 2. via file location (`MigratorConfig.js`, `MigratorConfig.cjs`, or `MigratorConfig.mjs`)
  *
  * The expected format is:
  *
@@ -27,25 +55,33 @@ module.exports.loadConfig = function loadConfig(options) {
         return options.knexMigratorConfig;
     }
 
-    const knexMigratorFilePath = options.knexMigratorFilePath || process.cwd();
-    const configPath = path.join(path.resolve(knexMigratorFilePath), 'MigratorConfig.js');
+    const knexMigratorFilePath = path.resolve(options.knexMigratorFilePath || process.cwd());
     let resolvedConfigPath;
 
-    try {
-        resolvedConfigPath = require.resolve(configPath);
-    } catch (err) {
-        if (err.code === 'MODULE_NOT_FOUND') {
-            throw new errors.KnexMigrateError({
-                message: 'Please provide a file named MigratorConfig.js in your project root.',
-                help: 'Read through the README.md to see which values are expected.',
-            });
+    for (const filename of CONFIG_FILENAMES) {
+        try {
+            resolvedConfigPath = require.resolve(path.join(knexMigratorFilePath, filename));
+            break;
+        } catch (err) {
+            // CASE: this candidate does not exist, try the next one.
+            if (err.code === 'MODULE_NOT_FOUND') {
+                continue;
+            }
+
+            throw new errors.KnexMigrateError({ err: err });
         }
+    }
 
-        throw new errors.KnexMigrateError({ err: err });
+    if (!resolvedConfigPath) {
+        throw new errors.KnexMigrateError({
+            message:
+                'Please provide a file named MigratorConfig.js, MigratorConfig.cjs, or MigratorConfig.mjs in your project root.',
+            help: 'Read through the README.md to see which values are expected.',
+        });
     }
 
     try {
-        return require(resolvedConfigPath);
+        return interopConfig(require(resolvedConfigPath));
     } catch (err) {
         throw new errors.KnexMigrateError({ err: err });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex-migrator",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Database migrations with knex.",
   "keywords": [
     "ghost",
@@ -41,7 +41,7 @@
     "@tryghost/database-info": "2.3.1",
     "@tryghost/errors": "3.3.1",
     "@tryghost/logging": "5.1.1",
-    "@tryghost/pro-ship": "1.1.4",
+    "@tryghost/pro-ship": "1.1.5",
     "@tryghost/promise": "2.3.1",
     "commander": "15.0.0",
     "compare-ver": "2.0.2",