wiseengineering/crispy-cli

CLI to communicate with `crispy-api`.

crispy-cli's Issues

Register `crispy-cli` in npm and add publish workflow

based on #1
First of all, we need steps on how we would like to deploy our app to npm.
So far I know, there is a too to manage it https://docs.npm js.com/cli/update.html
we can use it and have both git tags and package.json with specified version

As a second step, we need to add a workflow to publish this package based on the version in package.json, here is the link
https://docs.npmjs.com/creating-and-publishing-scoped-public-packages

Let's start from npm commands we have to run to publish app and going to automate this workflow with CircleCI (WiseEngineering/crispy#4)

Describe list of commands

We need to describe CLI interface and actions we will rely to crispy-cli

add clispy-cli examples

As this tool will be used by developers we need a few examples of how to setup/use

Implement crispy-cli migrations up command

this command should receive a migration name and run query in a particular runner in database.
before this we have to impleemnt #9 , #7 , #2
to properly define interface first

Send information about running migration to API

To be able to show everything about running migration we have to implement functionality that will send API requests about this and store that data in API. The next step will be to show all the data in web

Init project

We need command-line interface for this app.

For start, we have to look into a simple Typescript app based on the command line library.

Let's move from point to point and consider about:

• linting
• formatting
• versions management
• CI/CD
• tests
• commands doc

convert database DataRow into MigrationType format

Now, we've responded with Promise<object> from database
https://github.com/WiseEngineering/crispy-cli/blob/master/src/models/migrations.ts#L14-L22

Will be good to have Typescript types like Promise or array of migration

Add check what kind of migrations should be run

Now, we running only migration that was passed.

This is not good, as we have to protect from running :

• migrations that have been run
• there are migrations between ran and provided

Add list of possible migration operations

Might be for later, but what is the list of possible operations? The query is DROP but the operation is delete?

Originally posted by @xTNTx in #7

Consider about integration with https://typeorm.io/

Describe interface & user stories for migrations sync commands

We have to describe proper API -> CLI communication and what kind of commands have to be used
now, we have sync, publish, unpublish described in PR

Originally posted by @xTNTx in #7

Add config interface for crispy-cli

it should cover few points for start:

• MySQL connection as crispy should be able to handle migration versions and running commands
• where migrations should be stored -> directory in repo and table in db
• where API is hosted. As crispy-cli should be able to make requests to API, we need to be able to define where this API

add logging library

we haven't implemented any of logger module, will be good to have one

here is one of code pointers where it can be used:

https://github.com/WiseEngineering/crispy-cli/blob/master/src/commands/migrations/migrate.ts#L48

during implementation, let's think about:

• how to show errors to user
• how to show log lines to user
• how to .to show everything in development mode

To cover all those points we might use some command line formatter library like https://www.npmjs.com/package/js-beautify

Add migrations runner

Now, we have the only stub for migration run: https://github.com/WiseEngineering/crispy-cli/blob/add-tests-command/src/commands/migrations/migrate.ts#L15

I think, we have to consider about running them based on runnner option from migration schema and use transactions for mysql runner.

If to speak about runners, I believe, we might start from default mysql runner and then move forward and think about it more

Key points to think/to look:

• use runners module in migrate/rollback commands
• use rollback when migration failed
• add tests for this flow as it's important one

Add unit tests

Most critical functionality is migration-schema where we selecting migrations that should be run

but we need to cover as much as possible to be sure everything is okay