Adding config file support (klei-migrate.json)

Author: joakimbeng

lib/cli.js

@@ -58,11 +58,13 @@ exports.init = function (args) {
   this._showVersion = parsed.version;
   this._showHelp = parsed.help || this.command() === 'help';
 
+  migrate.loadConfig();
+
   migrate.args(argv);
 
   migrate.limit(parsed.limit);
 
-  migrate.coffee(!!parsed.coffee);
+  migrate.coffee(parsed.coffee);
 
   migrate.env(parsed.env);
 

lib/migrate.js

@@ -172,6 +172,25 @@ exports.coffee = function (newMode) {
   return !!this._coffee;
 };
 
+/**
+ * Getter for config file location
+ */
+exports.config = function () {
+  return join(this.cwd(), 'klei-migrate.json');
+};
+
+exports.loadConfig = function () {
+  if (fs.existsSync(this.config())) {
+    var config = require(this.config());
+    this.timeout(config.timeout * 1000);
+    this.templatePath(config.template);
+    this.env(config.env);
+    this.directory(config.directory);
+    this.coffee(!!config.coffee);
+  }
+  return this;
+};
+
 /**
  * Getter/Setter for migration timeout limit in ms
  *

tests/cli.js

@@ -4,6 +4,15 @@ var should = require('chai').should(),
     join = require('path').join;
 
 describe('klei-migrate cli', function () {
+  beforeEach(function (done) {
+    // Reset some options:
+    cli.migrate.limit(0);
+    cli.migrate.coffee(false);
+    cli.migrate.env('development');
+    cli.migrate.timeout(30000);
+    done();
+  });
+
   describe('init()', function () {
     it('should set limit to 1 if --one is provided', function (done) {
       cli.init(['--one']).migrate.limit().should.equal(1);
@@ -20,6 +29,17 @@ describe('klei-migrate cli', function () {
       done();
     });
 
+    it('should load options from config file if it exists', function (done) {
+      cli.migrate.cwd(join(__dirname, 'config-migrations'));
+      cli.init([]);
+      cli.migrate.coffee().should.equal(true);
+      cli.migrate.templatePath().should.equal(join(__dirname, 'config-migrations', '.migration.tpl.coffee'));
+      cli.migrate.timeout().should.equal(600000);
+      cli.migrate.env().should.equal('stage');
+      cli.migrate.directory().should.equal(join(__dirname, 'config-migrations', 'migs'));
+      done();
+    });
+
     it('should set limit to the provided --limit or -l', function (done) {
       cli.init(['--limit', '10']).migrate.limit().should.equal(10);
       cli.init(['-l', '5']).migrate.limit().should.equal(5);

tests/config-migrations/klei-migrate.json

@@ -0,0 +1,7 @@
+{
+  "directory": "migs",
+  "template": ".migration.tpl.coffee",
+  "coffee": true,
+  "env": "stage",
+  "timeout": 600
+}

tests/migrate.js

@@ -74,6 +74,29 @@ describe('klei-migrate module', function () {
     });
   });
 
+  describe('config()', function () {
+    beforeEach(loadMigrate);
+
+    it('should use process.cwd()+"/klei-migrate.json" by default', function (done) {
+      migrate.config().should.equal(join(process.cwd(), 'klei-migrate.json'));
+      done();
+    });
+  });
+
+  describe('loadConfig()', function () {
+    beforeEach(loadMigrate);
+
+    it('should set klei-migrate options from config file if it exists', function (done) {
+      migrate.cwd(join(__dirname, 'config-migrations')).loadConfig();
+      migrate.directory().should.equal(join(__dirname, 'config-migrations', 'migs'));
+      migrate.env().should.equal('stage');
+      migrate.timeout().should.equal(600000);
+      migrate.coffee().should.equal(true);
+      migrate.templatePath().should.equal(join(__dirname, 'config-migrations', '.migration.tpl.coffee'));
+      done();
+    });
+  });
+
   describe('env()', function () {
     beforeEach(loadMigrate);