Command-line interface

[mmkal]

@papb this is a draft for the CLI I've been playing around with.

It's using ts-command-line for argument-parsing/help-text generation so it's pretty well documented and handles errors and typos well.

It's technically not a CLI though. It adds a runAsCLI() method to the Umzug prototype so that users can create their own CLIs easily.

CC @ceelogre this could provide an alternative to sequelize cli for your use case in #360. There's a prerelease package published to npm which can be installed with npm i umzug@beta-cli.

Usage:

Set up an umzug instance and call .runAsCLI():

// migrator.js

const { Umzug } = require('umzug')

const umzug = new Umzug({
  migrations: { glob: 'migrations/*.js' },
  logger: console,
})

umzug.runAsCLI()

Now that file is a runnable CLI script:

node migrator --help # shows all commands and documentation
node migrator up  # applies migrations
node migrator down # reverts last migration
node migrator pending # lists pending migrations
node migrator executed # lists executed migrations
node migrator create --name foo.js # creates a new migration file with timestamp prefix and suffix foo.js

node migrator up -- help # shows help and parameters for the up command
node migrator down -- help # shows help and parameters for the down command
node migrator pending -- help # shows help and parameters for the pending command
node migrator executed --help # shows help and parameters for the executed command
node migrator create --help # shows help and parameters for the create command

[papb]

Hi @mmkal! This looks awesome! Thank you so much. Sorry for taking long. Today I plan on taking a closer look on everything here in Umzug.

[papb]

(to be continued)

[papb]

🎉