aboviq/emigrate
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

feat(types): simplify the EmigrateReporter interface by removing the "remove" specific methods

Browse source
This commit is contained in:
Joakim Carlstein 2024-01-26 15:05:06 +01:00 • committed by Joakim Carlstein
parent f2d4bb346e
commit 94ad9feae9
2 changed files with 12 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.changeset/eleven-files-love.md Normal file
View file

@ -0,0 +1,5 @@
---
'@emigrate/types': minor
---
Remove the "remove" command specific reporter methods. So instead of using `onMigrationRemoveStart`, `onMigrationRemoveSuccess` and `onMigrationRemoveError` the `onMigrationStart`, `onMigrationSuccess` and `onMigrationError` methods should be used and the reporter can still format the output differently depending on the current command (which it receives in the `onInit` method). This is a BREAKING CHANGE.

29
packages/types/src/index.ts
View file

@ -272,36 +272,20 @@ export type EmigrateReporter = Partial<{
* This is only called when the command is 'new'. * This is only called when the command is 'new'.
*/ */
onNewMigration(migration: MigrationMetadata, content: string): Awaitable<void>; onNewMigration(migration: MigrationMetadata, content: string): Awaitable<void>;
/**
* Called when a migration is about to be removed from the migration history.
*
* This is only called when the command is 'remove'.
*/
onMigrationRemoveStart(migration: MigrationMetadata): Awaitable<void>;
/**
* Called when a migration is successfully removed from the migration history.
*
* This is only called when the command is 'remove'.
*/
onMigrationRemoveSuccess(migration: SuccessfulMigrationMetadata): Awaitable<void>;
/**
* Called when a migration couldn't be removed from the migration history.
*
* This is only called when the command is 'remove'.
*/
onMigrationRemoveError(migration: FailedMigrationMetadata, error: Error): Awaitable<void>;
/** /**
* Called when a migration is about to be executed. * Called when a migration is about to be executed.
* *
* Will only be called for each migration when the command is "up". * Will be called for each migration when the command is "up",
* or before removing each migration from the history when the command is "remove".
* *
* @param migration Information about the migration that is about to be executed. * @param migration Information about the migration that is about to be executed/removed.
*/ */
onMigrationStart(migration: MigrationMetadata): Awaitable<void>; onMigrationStart(migration: MigrationMetadata): Awaitable<void>;
/** /**
* Called when a migration has been successfully executed. * Called when a migration has been successfully executed.
* *
* Will be called after a successful migration when the command is "up" * Will be called after a successful migration when the command is "up",
* or after a successful removal of a migration from the history when the command is "remove",
* or for each successful migration from the history when the command is "list". * or for each successful migration from the history when the command is "list".
* *
* @param migration Information about the migration that was executed. * @param migration Information about the migration that was executed.
@ -310,7 +294,8 @@ export type EmigrateReporter = Partial<{
/** /**
* Called when a migration has failed. * Called when a migration has failed.
* *
* Will be called after a failed migration when the command is "up" * Will be called after a failed migration when the command is "up",
* or after a failed removal of a migration from the history when the command is "remove",
* or for each failed migration from the history when the command is "list" (will be at most one in this case). * or for each failed migration from the history when the command is "list" (will be at most one in this case).
* *
* @param migration Information about the migration that failed. * @param migration Information about the migration that failed.