feat(cli): rename extension short option from -e to -x

BREAKING CHANGE: if you've been using the `-e` short option you should change it to `-x` or use the long option name `--extension`
This commit is contained in:
Joakim Carlstein 2023-12-20 09:22:42 +01:00 committed by Joakim Carlstein
parent f9a16d87a1
commit e6e4433018
5 changed files with 28 additions and 11 deletions

View file

@ -2,6 +2,8 @@
Emigrate is a tool for managing database migrations. It is designed to be simple yet support advanced setups, modular and extensible.
📖 Read the [documentation](https://emigrate.dev) for more information!
## Installation
Install the Emigrate CLI in your project:
@ -21,7 +23,13 @@ bun add @emigrate/cli
Create a new migration:
```bash
emigrate new -d migrations -e .js create some fancy table
npx emigrate new -d migrations create some fancy table
# or
pnpm emigrate new -d migrations create some fancy table
# or
yarn emigrate new -d migrations create some fancy table
# or
bunx --bun emigrate new -d migrations create some fancy table
```
Will create a new empty JavaScript migration file with the name "YYYYMMDDHHmmssuuu_create_some_fancy_table.js" in the `migrations` directory.

View file

@ -123,7 +123,7 @@ const newMigration: Action = async (args) => {
},
extension: {
type: 'string',
short: 'e',
short: 'x',
},
plugin: {
type: 'string',
@ -157,7 +157,7 @@ Options:
-p, --plugin The plugin(s) to use (can be specified multiple times)
-t, --template A template file to use as contents for the new migration file
(if the extension option is not provided the template file's extension will be used)
-e, --extension The extension to use for the new migration file
-x, --extension The extension to use for the new migration file
(if no template or plugin is provided an empty migration file will be created with the given extension)
--color Force color output (this option is passed to the reporter)
--no-color Disable color output (this option is passed to the reporter)
@ -168,8 +168,8 @@ Examples:
emigrate new -d src/migrations -t migration-template.js create users table
emigrate new --directory ./migrations --plugin @emigrate/postgres create_users_table
emigrate new -d ./migrations -e .sql create_users_table
emigrate new -d ./migrations -t .migration-template -e .sql "drop some table"
emigrate new -d ./migrations -x .sql create_users_table
emigrate new -d ./migrations -t .migration-template -x .sql "drop some table"
`;
if (values.help) {