feat(config): implement configuration with .dynamitrc

Added an ability to provide config with .dynamitrc file of different format

close #3, fix #6

Author: floydspace

.plop/plopfile.js

@@ -4,7 +4,7 @@ module.exports = function (plop) {
   plop.setGenerator('migration', {
     actions: () => [{
       type: 'add',
-      path: path.resolve(process.cwd(), './migrations/{{timestamp}}-{{name}}.js'),
+      path: path.resolve(process.cwd(), './{{migrationsPath}}/{{timestamp}}-{{name}}.js'),
       templateFile: path.join(__dirname, './migration.js.hbs'),
     }],
   });

package-lock.json

@@ -67,6 +67,7 @@
   "dependencies": {
     "aws-sdk": "^2.673.0",
     "cli-color": "^2.0.0",
+    "cosmiconfig": "^6.0.0",
     "node-plop": "^0.25.0",
     "ramda": "^0.27.0",
     "umzug": "^2.3.0",

package.json

@@ -22,7 +22,7 @@ export default {
 
     logger.log(
       'New migration was created at',
-      clc.blueBright(path.resolve(process.cwd(), 'migrations', args.name)),
+      clc.blueBright(path.resolve(process.cwd(), args.migrationsPath, args.name)),
       '.'
     );
 

src/commands/migration-generate.ts

@@ -17,6 +17,7 @@ export interface MigratorOptions {
   dynamodb?: DocumentClient;
   tableName?: string;
   attributeName?: string;
+  migrationsPath?: string;
 }
 
 interface Generator {
@@ -25,6 +26,7 @@ interface Generator {
 
 export class Migrator extends Umzug implements Generator {
   private generator;
+  private migrationsPath: string;
 
   /**
    * Migrator factory function, creates an umzug instance with dynamodb storage.
@@ -51,10 +53,15 @@ export class Migrator extends Umzug implements Generator {
 
     const plop = nodePlop(path.join(__dirname, '../../.plop/plopfile.js'));
     this.generator = plop.getGenerator('migration');
+    this.migrationsPath = options.migrationsPath || 'migrations';
   }
 
   async generate(migrationName: string) {
-    await this.generator.runActions({timestamp: getCurrentYYYYMMDDHHmms(), name: migrationName});
+    await this.generator.runActions({
+      migrationsPath: this.migrationsPath,
+      timestamp: getCurrentYYYYMMDDHHmms(),
+      name: migrationName
+    });
   }
 }
 

src/core/migrator.ts

@@ -16,10 +16,6 @@ export interface BaseCliOptions {
 
 export function baseOptions(yargs: Argv<BaseCliOptions>) {
   return yargs
-    .option('options-path', {
-      describe: 'The path to a JSON file with additional options',
-      type: 'string'
-    })
     .option('migrations-path', {
       describe: 'The path to the migrations folder',
       default: 'migrations',
@@ -59,6 +55,7 @@ export function baseHandler<T extends BaseCliOptions>(callback: (args: Arguments
       ...pick(['region', 'accessKeyId', 'secretAccessKey'], args),
       tableName: args.tableName,
       attributeName: args.attributeName,
+      migrationsPath: args.migrationsPath,
     });
 
     callback(args, migrator);

src/core/yargs.ts

@@ -2,6 +2,7 @@
 
 import clc from 'cli-color';
 import yargs from 'yargs';
+import {cosmiconfigSync} from 'cosmiconfig';
 
 import migrate from './commands/migrate';
 import migrateUndo from './commands/migrate-undo';
@@ -10,6 +11,7 @@ import migrationGenerate from './commands/migration-generate';
 import logger from './helpers/logger';
 import version from './helpers/version';
 
+const moduleName = 'dynamit';
 const versions = [
   'Node: ' + version.getNodeVersion(),
   'CLI: '  + version.getCliVersion(),
@@ -30,6 +32,13 @@ const cli = yargs
   .wrap(yargs.terminalWidth())
   .strict();
 
+const cosminstance = cosmiconfigSync(moduleName);
+const cosmic = cosminstance.search();
+
+if (cosmic?.config) {
+  cli.config(cosmic.config);
+}
+
 const args = cli.argv;
 
 // if no command then show help