Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add import prop @ FileMigrationProvider. #994

Open
wants to merge 1 commit into
base: v0.28
Choose a base branch
from

Conversation

igalklebanov
Copy link
Member

@igalklebanov igalklebanov commented May 18, 2024

Hey 👋

This PR allows passing an optional custom import function @ FileMigrationProvider.
e.g. this would allow consumers to pass a function that uses tsImport by tsx to import TS files without the need to precompile them when using Node.js or a similar JavaScript runtime that doesn't have built-in TS file support.

Also adds onDiscarded optional prop, so external tooling can warn users about files that were ignored by the migration provider.

Also extracts file extension check to a protected method - can be overridden to only support TS files by an extending class.
Also adds cjs & cts support.

These changes were inspired by https://github.com/kysely-org/kysely-ctl/blob/main/src/kysely/ts-file-migration-provider.mts , a custom provider implementation in kysely-ctl that only works with TS migration files, on all runtimes.

Copy link

vercel bot commented May 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kysely ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 11:06pm

@igalklebanov igalklebanov changed the title add import prop @ file migration provider. add import prop @ FileMigrationProvider. May 18, 2024
@igalklebanov igalklebanov force-pushed the pass-import-fn-migration-provider branch from d3cf478 to ddfe24e Compare May 18, 2024 23:16
@igalklebanov igalklebanov marked this pull request as ready for review May 18, 2024 23:20
@igalklebanov igalklebanov added enhancement New feature or request migrations Related to migrations labels May 18, 2024
@@ -2,7 +2,8 @@
"extends": "../../tsconfig-base.json",
"include": ["src/**/*"],
"compilerOptions": {
"module": "CommonJS",
"outDir": "dist"
"module": "NodeNext",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

necessary to allow importing tsx/*.

Comment on lines +2 to +7
import chaiAsPromised from 'chai-as-promised'
import chaiSubset from 'chai-subset'
import Cursor from 'pg-cursor'
import { Pool, PoolConfig } from 'pg'
import { createPool } from 'mysql2'
import * as Database from 'better-sqlite3'
import Database from 'better-sqlite3'
Copy link
Member Author

@igalklebanov igalklebanov May 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

necessary after tsconfig changes.

@vladshcherbin
Copy link
Contributor

This would help so much!

..

add FileMigrationProvider test suite.

..
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request migrations Related to migrations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants