Add bin script for validating files

Author: ThomWright

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Validate migration ordering when loading files (instead of when applying migrations)
 - Expose `loadMigrationFiles` publicly, which can be used to validate files in e.g. a pre-push hook
+- Add `pg-validate-migrations` bin script
 
 ## 5.0.0
 

README.md

@@ -84,18 +84,7 @@ While the migration system will notice this and refuse to apply the migrations,
 
 The `loadMigrationFiles` function can be used to check if the migration files satisfy the rules.
 
-```typescript
-import {loadMigrationFiles} from "postgres-migrations"
-
-async function validateMigrations() {
-  try {
-    await loadMigrationFiles("path/to/migration/files")
-  } catch (e) {
-    // Oh no! Something isn't right with the migration files.
-    throw e
-  }
-}
-```
+Alternatively, use the `pg-validate-migrations` bin script: `pg-validate-migrations "path/to/migration/files"`.
 
 ## Design decisions
 

package.json

@@ -4,6 +4,9 @@
   "description": "Stack Overflow style database migrations for PostgreSQL",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "pg-validate-migrations": "./dist/bin/validate.js"
+  },
   "author": "Thom Wright",
   "keywords": [
     "postgres",

src/__unit__/migration-file/index.ts

@@ -1,19 +1,19 @@
 import test from "ava"
-import {load} from "../../migration-file"
+import {loadMigrationFile} from "../../migration-file"
 
 test("Hashes of JS files should be the same when the SQL is the same", async (t) => {
   const [js1, js2] = await Promise.all([
-    load(__dirname + "/fixtures/different-js-same-sql-1/1_js.js"),
-    load(__dirname + "/fixtures/different-js-same-sql-2/1_js.js"),
+    loadMigrationFile(__dirname + "/fixtures/different-js-same-sql-1/1_js.js"),
+    loadMigrationFile(__dirname + "/fixtures/different-js-same-sql-2/1_js.js"),
   ])
 
   t.is(js1.hash, js2.hash)
 })
 
 test("Hashes of JS files should be different when the SQL is different", async (t) => {
   const [js1, js2] = await Promise.all([
-    load(__dirname + "/fixtures/same-js-different-sql-1/1_js.js"),
-    load(__dirname + "/fixtures/same-js-different-sql-2/1_js.js"),
+    loadMigrationFile(__dirname + "/fixtures/same-js-different-sql-1/1_js.js"),
+    loadMigrationFile(__dirname + "/fixtures/same-js-different-sql-2/1_js.js"),
   ])
 
   t.not(js1.hash, js2.hash)

src/bin/validate.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+// tslint:disable no-console
+
+import {argv} from "process"
+import {loadMigrationFiles} from "../files-loader"
+
+async function main(args: Array<string>) {
+  const directory = args[0]
+
+  await loadMigrationFiles(directory, (x) => console.error(x))
+}
+
+main(argv.slice(2)).catch((e) => {
+  console.error(`ERROR: ${e.message}`)
+  process.exit(1)
+})

src/files-loader.ts

@@ -1,7 +1,7 @@
 import * as fs from "fs"
 import * as path from "path"
 import {promisify} from "util"
-import {load as loadMigrationFile} from "./migration-file"
+import {loadMigrationFile} from "./migration-file"
 import {Logger, Migration} from "./types"
 import {validateMigrationOrdering} from "./validation"
 
@@ -17,7 +17,7 @@ const isValidFile = (fileName: string) => /\.(sql|js)$/gi.test(fileName)
  *
  * No assertions are made about the validity of the SQL.
  */
-export const load = async (
+export const loadMigrationFiles = async (
   directory: string,
   // tslint:disable-next-line no-empty
   log: Logger = () => {},

src/index.ts

@@ -1,6 +1,6 @@
 export {createDb} from "./create"
 export {migrate} from "./migrate"
-export {load as loadMigrationFiles} from "./files-loader"
+export {loadMigrationFiles} from "./files-loader"
 
 export {
   ConnectionParams,

src/migrate.ts

@@ -1,6 +1,6 @@
 import * as pg from "pg"
 import SQL from "sql-template-strings"
-import {load} from "./files-loader"
+import {loadMigrationFiles} from "./files-loader"
 import {runMigration} from "./run-migration"
 import {
   BasicPgClient,
@@ -33,7 +33,7 @@ export async function migrate(
   if (typeof migrationsDirectory !== "string") {
     throw new Error("Must pass migrations directory as a string")
   }
-  const intendedMigrations = await load(migrationsDirectory, log)
+  const intendedMigrations = await loadMigrationFiles(migrationsDirectory, log)
 
   if ("client" in dbConfig) {
     // we have been given a client to use, it should already be connected

src/migration-file.ts

@@ -31,7 +31,7 @@ const getSqlStringLiteral = (
   }
 }
 
-export const load = async (filePath: string) => {
+export const loadMigrationFile = async (filePath: string) => {
   const fileName = getFileName(filePath)
 
   try {