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

fix: typo in --help description for migrate:make #175

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

justsml
Copy link

@justsml justsml commented Mar 4, 2025

A tiny typo–which I suspect was confusing my AI coding bot. 😅

@justsml justsml changed the title fix: fix --help description for migrate:make fix: typo in --help description for migrate:make Mar 4, 2025
Copy link

pkg-pr-new bot commented Mar 5, 2025

Open in Stackblitznode-esm

npm i https://pkg.pr.new/kysely-org/kysely-ctl@175

commit: e21b910

@igalklebanov
Copy link
Member

igalklebanov commented Mar 5, 2025

Hey 👋

Thanks! 🙏

If you look at https://github.com/search?q=repo%3Akysely-org%2Fkysely-ctl%20createMigrationNameArg&type=code, this argument is used in migrate up and migrate down to migrate to a certain migration by name. So the current changes introduce confusion elsewhere.

We could make the description dynamic, by receiving something via an argument in createMigrationNameArg. Or simpler, throw away createMigrationNameArg, in favor of defining this argument locally in each command - de-DRY.

migrate up would say 'The name of a migration to which the database will be migrated (inclusive).'.
migrate down would say 'The name of a migration to which the database will be reverted (exclusive).'.
migrate make would say 'The name of the migration'.
..or something like that.

WDYT?

@igalklebanov igalklebanov added documentation Improvements or additions to documentation enhancement New feature or request migrate Migrate module related and removed enhancement New feature or request labels Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation migrate Migrate module related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants