Expose proper CLI for commands about govflow HOT 4 CLOSED

The minimal approach was to just expose the tools we already have for (i) migrations, and (ii) starting a default server, using npm's bin functionality, so:

npx govflow-migrate
npx govflow-start

See https://github.com/govflow/govflow/tree/5fe9deca10e18eafa4623c4813992b6b0bda3312#getting-started and 5fe9dec

Kind of hard to verify properly without transpiring the typescript and releasing a version, so will close this issue only when I have also done that.

from govflow.

@amirozer

Nope.

I'm not sure I 100% tracked down the issue - current problem in 0.0.18-alpha may just be because of missing file extension - but in any event I now see even fixing that won't work as I them need to make the file executable, but, I don't know how to do that on the relevant output file after typescript transpile to javascript (I could force it when we build on CI, but feels wrong).

I guess there is a reason why using a tool like https://github.com/oclif/oclif which is built around typescript will be the best choice here.

Meanwhile, until we dive into using a fully fledged framework for typescript CLIs, the solution is that codebases with govflow as a dependency, that need to run migrations, can write a file like the following and call it as the migration script:

# from https://github.com/govflow/govflow/blob/main/src/cli/migrate.ts

# save as my-migrator.ts

import { initConfig } from '../config';
import { initMigrator } from '../db/engine';
import type { DatabaseEngine } from '../types';

(async () => {
    const config = await initConfig();
    const { database, settings } = config;
    const migrator = initMigrator(database as DatabaseEngine, settings?.databaseExtraMigrationPaths as string);
    migrator.runAsCLI();
})();

And run like:

ts-node my-migrator.ts

from govflow.

Should be resolved in 1318330 but I will verify with a build from NPM (did verify locally with global install)

from govflow.

Confirmed working with 0.0.19-alpha. CLI commands listed in https://github.com/govflow/govflow#getting-started

from govflow.