default migration file number format changed to dateTime

CHANGELOG.md

@@ -16,6 +16,7 @@ and `MigrationManager` class)
 - Builtin TypeScript migration template file
 
 ### Changed
+- *Breaking change:* Default migration file number format changed to "dateTime"
 - *Breaking change:* Default migration template now uses `async` functions
 - *Breaking change:* `MigrationManager` `onSkipMigration` event reasons are
 renamed: canNotMigrateAlreadyExecuted -> cannotMigrateAlreadyExecuted,

README.md

@@ -191,25 +191,17 @@ or you can use a special adapter for database (see [adapters](#adapters) section
 
 #### Migration file number format
 
-The default format for migration file names is to prepend a number to the
-filename which is incremented with every new file. This creates migration files
-such as "migrations/1_doSomething.js", "migrations/2_doSomethingElse.js".
+East supports following migration file number formats (`migrationNumberFormat`
+option):
 
-If you prefer your files to be created with a date-time instead of sequential
-numbers, you can set the `migrationNumberFormat` configuration parameter in
-your `.eastrc` to "dateTime":
+* "dateTime" - will create migration files with date-time prefix in `YYYYMMDDhhmmss`
+format (e.g. "migrations/20190720172730_doSomething.js")
+* "sequentialNumber" - prepend a number to the filename which is incremented
+with every new file. This creates migration files such as
+"migrations/1_doSomething.js", "migrations/2_doSomethingElse.js".
 
-```json
-{
-    "migrationNumberFormat": "dateTime"
-}
-```
-
-This will create migration files with date-time prefix in `YYYYMMDDhhmmss`
-format (e.g. "migrations/20190720172730_doSomething.js").
-
-For the default behavior, you can omit the `migrationNumberFormat`
-configuration option or set it to:
+Default format is "dateTime", you can change `migrationNumberFormat` via your
+`.eastrc` e.g.:
 
 ```json
 {

lib/migrator/methods/configure.js

@@ -20,7 +20,7 @@ module.exports = function configure(params = {}) {
 				// db url
 				url: null,
 				// number format for migration filenames
-				migrationNumberFormat: 'sequentialNumber',
+				migrationNumberFormat: 'dateTime',
 				trace: false,
 				// whether to load or not config file
 				loadConfig: _(params).has('loadConfig') ? params.loadConfig : true,

test/01-migrator/create/withDateTimeMigrationNumberFormat.js

@@ -13,7 +13,13 @@ describe('migrator create with date time migration number format', () => {
 		return Promise.resolve()
 			.then(() => {
 				return testUtils.createEnv({
-					migratorParams: {init: true, connect: true}
+					migratorParams: {
+						init: true,
+						connect: true,
+						configureParams: {
+							migrationNumberFormat: 'dateTime'
+						}
+					}
 				});
 			})
 			.then((createdTestEnv) => {
@@ -29,14 +35,6 @@ describe('migrator create with date time migration number format', () => {
 
 	after(() => testUtils.destroyEnv(testEnv));
 
-	before(() => {
-		migrator.params.migrationNumberFormat = 'dateTime';
-	});
-
-	after(() => {
-		migrator.params.migrationNumberFormat = 'sequentialNumber';
-	});
-
 	it('should create migrations without errors', () => {
 		return Promise.resolve()
 			.then(() => testUtils.createMigrations({migrator, baseNames}))

test/01-migrator/create/withSequentialMigrationNumberFormat.js

@@ -13,7 +13,13 @@ describe('migrator create with sequential migration number format', () => {
 		return Promise.resolve()
 			.then(() => {
 				return testUtils.createEnv({
-					migratorParams: {init: true, connect: true}
+					migratorParams: {
+						init: true,
+						connect: true,
+						configureParams: {
+							migrationNumberFormat: 'sequentialNumber'
+						}
+					}
 				});
 			})
 			.then((createdTestEnv) => {

testUtils/createEnv.js

@@ -58,7 +58,13 @@ module.exports = (params = {}) => {
 		.then(() => {
 			const migrationsDir = pathUtils.join(dir, 'migrations');
 
-			return createEastrc({dir, configParams: {dir: migrationsDir}});
+			return createEastrc({
+				dir,
+				configParams: {
+					dir: migrationsDir,
+					migrationNumberFormat: 'sequentialNumber'
+				}
+			});
 		})
 		.then((createdConfigPath) => {
 			configPath = createdConfigPath;

testUtils/createMigrator.js

@@ -1,3 +1,4 @@
+const _ = require('underscore');
 const Migrator = require('../lib/migrator');
 const removeMigratorDir = require('./removeMigratorDir');
 
@@ -10,7 +11,9 @@ module.exports = ({
 	const migrator = new Migrator();
 
 	return Promise.resolve()
-		.then(() => migrator.configure(configureParams))
+		.then(() => migrator.configure(_({
+			migrationNumberFormat: 'sequentialNumber'
+		}).extend(configureParams)))
 		// always connect migrator coz `removeDirBefore` makes unmark executed
 		.then(() => migrator.connect())
 		.then(() => {