feat: add ley status command

Author: lukeed

bin.js

@@ -33,6 +33,10 @@ sade('ley')
 		.option('-a, --all', 'Run all "down" migrations')
 		.action(wrap('down'))
 
+	.command('status')
+		.describe('Check for migration status. Counts unapplied migrations.')
+		.action(wrap('status'))
+
 	.command('new <filename>')
 		.describe('Create a new migration file.')
 		.option('-t, --timestamp', 'Prefix the filename with a timestamp')
@@ -42,5 +46,4 @@ sade('ley')
 			return wrap('new')(opts);
 		})
 
-
 	.parse(process.argv);

index.js

@@ -67,6 +67,18 @@ exports.down = async function (opts={}) {
 	}
 }
 
+exports.status = async function (opts={}) {
+	let client, { driver, migrations } = await parse(opts);
+
+	try {
+		client = await driver.connect(opts.config);
+		const exists = await driver.setup(client);
+		return $.diff(exists, migrations).map(x => x.name);
+	} finally {
+		if (client) await driver.end(client);
+	}
+}
+
 exports.new = async function (opts={}) {
 	let { migrations } = await parse(opts);
 

ley.d.ts

@@ -31,6 +31,7 @@ declare class MigrationError extends Error {
 
 export function up(opts?: Options.Up): Promise<string[]>;
 export function down(opts?: Options.Down): Promise<string[]>;
+export function status(opts?: Options.Base): Promise<string[]>;
 
 declare function n(opts?: Options.New): Promise<string>;
 export { n as new };

lib/log.js

@@ -1,4 +1,4 @@
-const { cyan, green, underline, red, dim } = require('kleur');
+const { cyan, green, yellow, underline, red, dim } = require('kleur');
 const { MigrationError } = require('./util');
 
 exports.info = msg => {
@@ -12,9 +12,12 @@ exports.done = (type, arr) => {
 		msg += 'Created ' + green('1') + ' file:';
 		msg += green().dim('\n    ⌁ ') + underline().grey(arr);
 	} else if (arr.length > 0) {
-		let i=0, arrow = type === 'up' ? '↑' : '↓';
-		msg += ('Migrated ' + green(arr.length) + (arr.length > 1 ? ' files:' : ' file:'));
-		for (; i < arr.length; i++) msg += (green().dim(`\n    ${arrow} `) + underline().grey(arr[i]));
+		let i=0, len=arr.length;
+		let arrow = type === 'down' ? '↓' : '↑';
+		let cc = type === 'status' ? yellow : green;
+		msg += (type === 'status' ? 'Awaiting ' : 'Migrated ');
+		msg += cc(len) + (len > 1 ? ' files:' : ' file:');
+		for (; i < len; i++) msg += (cc().dim(`\n    ${arrow} `) + underline().grey(arr[i]));
 	} else {
 		msg += 'All caught up! 🎉';
 	}

readme.md

@@ -237,6 +237,37 @@ Enable to apply **all** migration files' `down` task.<br>
 By default, only the most recently-applied migration file is invoked.
 
 
+### ley.status(opts?)
+Returns: `Promise<string[]>`
+
+Returns a list of the _relative filenames_ (eg, `000-users.js`) that have not yet been applied.
+
+#### opts.cwd
+Type: `string`<br>
+Default: `.`
+
+A target location to treat as the current working directory.
+
+> **Note:** This value is `path.resolve()`d from the current `process.cwd()` location.
+
+#### opts.dir
+Type: `string`<br>
+Default: `migrations`
+
+The directory (relative to `opts.cwd`) to find migration files.
+
+#### opts.client
+Type: `string`<br>
+Default: `undefined`
+
+The **name** of your desired client driver; for example, `pg`.<br>
+When unspecified, `ley` searches for all supported client drivers in this order:
+
+```js
+['postgres', 'pg']; // TODO: more
+```
+
+
 ### ley.new(opts?)
 Returns: `Promise<string>`