fix: change from require to dynamic import

[rialco]

Summary

Change the way the migrations files are being loaded in the loadMigrations function. Replace from require to a dynamic import await import in order to support ESM projects.

Known issues

In a pure ESM project the node-pg-migrate module is not usable because the loadMigrations function uses require instead of await import.

Current project characteristics:

• Typescript
• package.json : "type" : "module"

tsconfig.json content:

{
  "extends": "@tsconfig/node16/tsconfig.json",
  "compilerOptions": {
    "lib": ["es2021"],
    "module": "es2022",
    "target": "es2022",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "moduleResolution": "node",
    "forceConsistentCasingInFileNames": true,
    "baseUrl": "./src",
    "outDir": "dist",
  },
  "ts-node": {
    "esm": true
  },
  "include": ["./src", "./migrations"]
}

Script used to run the migrations:

"migrate:build" : "./node_modules/.bin/node-pg-migrate -m ./dist/migrations"

Logs

Error: Can't get migration files: Error [ERR_REQUIRE_ESM]: require() of ES Module .../dist/migrations/1652421258856_add-tweets-table.js from .../node_modules/node-pg-migrate/dist/runner.js not supported.
Instead change the require of 1652421258856_add-tweets-table.js in ..../node_modules/node-pg-migrate/dist/runner.js to a dynamic import() which is available in all CommonJS modules.

[lamh85]

Can someone please review this? I too experience this bug.

[Shinigami92]

To all participants subscribed to this PR: please try out v7.0.0-alpha.2 and report if it is still broken.

[rialco]

Will test this in the following days, and provide feedback. thanks