@js-migrations/commander

CLI presenter for JS Migrations

Stats

StarsIssuesVersionUpdatedCreatedSize
@js-migrations/commander
1272.0.93 years ago4 years agoMinified + gzip package size for @js-migrations/commander in KB

Readme

commander

CLI presenter for JS Migrations

Usage

  1. Install it with npm i @js-migrations/commander.
  2. Create the service facade with @js-migrations/core.
  3. Use the factory to create the presenter facade.
  4. Use the CLI.

Use the factory

import commanderMigrationsPresenterFactory from '@js-migrations/commander/dist/factory';
import { Command } from 'commander';

const program = new Command();
const migrationsRepoFacade = commanderMigrationsPresenterFactory({
  // Optional property to exit when migrations are completed. Defaults to `process.exit`.
  exitProcess: () => {
    process.exit();
  },
  // Optional property to handle migration errors. Defaults to "utils/handleError".
  handleError: (err) => {
    console.error(err);
  },
  // Optional property to log output. Defaults to "utils/defaultLog".
  log: (status) => {
    console.log(status);
  },
  program,
  service: migrationsServiceFacade,
});
program.parse(process.argv);

Use the CLI

If you placed the code to use the factory in "./cli.js" you can use the CLI by running node ./cli.js --help. This package contains a demo file showing how this can be used together.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.