knex 2.5.0 → 3.0.0

package/lib/migrations/migrate/migrate-stub.js

@@ -1,17 +1,17 @@
-// Stub Migrate:
-// Used for now in browser builds, where filesystem access isn't
-// available.
-const StubMigrate = (module.exports = function () {});
-
-const noSuchMethod = async function () {
-  throw new Error('Migrations are not supported');
-};
-
-StubMigrate.prototype = {
-  make: noSuchMethod,
-  latest: noSuchMethod,
-  rollback: noSuchMethod,
-  currentVersion: noSuchMethod,
-  up: noSuchMethod,
-  down: noSuchMethod,
-};
+// Stub Migrate:
+// Used for now in browser builds, where filesystem access isn't
+// available.
+const StubMigrate = (module.exports = function () {});
+
+const noSuchMethod = async function () {
+  throw new Error('Migrations are not supported');
+};
+
+StubMigrate.prototype = {
+  make: noSuchMethod,
+  latest: noSuchMethod,
+  rollback: noSuchMethod,
+  currentVersion: noSuchMethod,
+  up: noSuchMethod,
+  down: noSuchMethod,
+};

package/lib/migrations/migrate/migration-list-resolver.js

@@ -1,33 +1,33 @@
-const { getTableName } = require('./table-resolver');
-const { ensureTable } = require('./table-creator');
-
-// Lists all available migration versions, as a sorted array.
-function listAll(migrationSource, loadExtensions) {
-  return migrationSource.getMigrations(loadExtensions);
-}
-
-// Lists all migrations that have been completed for the current db, as an
-// array.
-async function listCompleted(tableName, schemaName, trxOrKnex) {
-  await ensureTable(tableName, schemaName, trxOrKnex);
-
-  return await trxOrKnex
-    .from(getTableName(tableName, schemaName))
-    .orderBy('id')
-    .select('name');
-}
-
-// Gets the migration list from the migration directory specified in config, as well as
-// the list of completed migrations to check what should be run.
-function listAllAndCompleted(config, trxOrKnex) {
-  return Promise.all([
-    listAll(config.migrationSource, config.loadExtensions),
-    listCompleted(config.tableName, config.schemaName, trxOrKnex),
-  ]);
-}
-
-module.exports = {
-  listAll,
-  listAllAndCompleted,
-  listCompleted,
-};
+const { getTableName } = require('./table-resolver');
+const { ensureTable } = require('./table-creator');
+
+// Lists all available migration versions, as a sorted array.
+function listAll(migrationSource, loadExtensions) {
+  return migrationSource.getMigrations(loadExtensions);
+}
+
+// Lists all migrations that have been completed for the current db, as an
+// array.
+async function listCompleted(tableName, schemaName, trxOrKnex) {
+  await ensureTable(tableName, schemaName, trxOrKnex);
+
+  return await trxOrKnex
+    .from(getTableName(tableName, schemaName))
+    .orderBy('id')
+    .select('name');
+}
+
+// Gets the migration list from the migration directory specified in config, as well as
+// the list of completed migrations to check what should be run.
+function listAllAndCompleted(config, trxOrKnex) {
+  return Promise.all([
+    listAll(config.migrationSource, config.loadExtensions),
+    listCompleted(config.tableName, config.schemaName, trxOrKnex),
+  ]);
+}
+
+module.exports = {
+  listAll,
+  listAllAndCompleted,
+  listCompleted,
+};

package/lib/migrations/migrate/migrator-configuration-merger.js

@@ -1,58 +1,58 @@
-const { FsMigrations } = require('./sources/fs-migrations');
-const Logger = require('../../logger');
-const { DEFAULT_LOAD_EXTENSIONS } = require('../common/MigrationsLoader');
-const defaultLogger = new Logger();
-
-const CONFIG_DEFAULT = Object.freeze({
-  extension: 'js',
-  loadExtensions: DEFAULT_LOAD_EXTENSIONS,
-  tableName: 'knex_migrations',
-  schemaName: null,
-  directory: './migrations',
-  disableTransactions: false,
-  disableMigrationsListValidation: false,
-  sortDirsSeparately: false,
-});
-
-function getMergedConfig(config, currentConfig, logger = defaultLogger) {
-  // config is the user specified config, mergedConfig has defaults and current config
-  // applied to it.
-  const mergedConfig = Object.assign(
-    {},
-    CONFIG_DEFAULT,
-    currentConfig || {},
-    config
-  );
-
-  if (
-    config &&
-    // If user specifies any FS related config,
-    // clear specified migrationSource to avoid ambiguity
-    (config.directory ||
-      config.sortDirsSeparately !== undefined ||
-      config.loadExtensions)
-  ) {
-    if (config.migrationSource) {
-      logger.warn(
-        'FS-related option specified for migration configuration. This resets migrationSource to default FsMigrations'
-      );
-    }
-    mergedConfig.migrationSource = null;
-  }
-
-  // If the user has not specified any configs, we need to
-  // default to fs migrations to maintain compatibility
-  if (!mergedConfig.migrationSource) {
-    mergedConfig.migrationSource = new FsMigrations(
-      mergedConfig.directory,
-      mergedConfig.sortDirsSeparately,
-      mergedConfig.loadExtensions
-    );
-  }
-
-  return mergedConfig;
-}
-
-module.exports = {
-  getMergedConfig,
-};
+const { FsMigrations } = require('./sources/fs-migrations');
+const Logger = require('../../logger');
+const { DEFAULT_LOAD_EXTENSIONS } = require('../common/MigrationsLoader');
+const defaultLogger = new Logger();
+
+const CONFIG_DEFAULT = Object.freeze({
+  extension: 'js',
+  loadExtensions: DEFAULT_LOAD_EXTENSIONS,
+  tableName: 'knex_migrations',
+  schemaName: null,
+  directory: './migrations',
+  disableTransactions: false,
+  disableMigrationsListValidation: false,
+  sortDirsSeparately: false,
+});
+
+function getMergedConfig(config, currentConfig, logger = defaultLogger) {
+  // config is the user specified config, mergedConfig has defaults and current config
+  // applied to it.
+  const mergedConfig = Object.assign(
+    {},
+    CONFIG_DEFAULT,
+    currentConfig || {},
+    config
+  );
+
+  if (
+    config &&
+    // If user specifies any FS related config,
+    // clear specified migrationSource to avoid ambiguity
+    (config.directory ||
+      config.sortDirsSeparately !== undefined ||
+      config.loadExtensions)
+  ) {
+    if (config.migrationSource) {
+      logger.warn(
+        'FS-related option specified for migration configuration. This resets migrationSource to default FsMigrations'
+      );
+    }
+    mergedConfig.migrationSource = null;
+  }
+
+  // If the user has not specified any configs, we need to
+  // default to fs migrations to maintain compatibility
+  if (!mergedConfig.migrationSource) {
+    mergedConfig.migrationSource = new FsMigrations(
+      mergedConfig.directory,
+      mergedConfig.sortDirsSeparately,
+      mergedConfig.loadExtensions
+    );
+  }
+
+  return mergedConfig;
+}
+
+module.exports = {
+  getMergedConfig,
+};

package/lib/migrations/migrate/sources/fs-migrations.js

@@ -1,74 +1,74 @@
-const path = require('path');
-const sortBy = require('lodash/sortBy');
-
-const { readdir } = require('../../util/fs');
-const { AbstractMigrationsLoader } = require('../../common/MigrationsLoader');
-
-class FsMigrations extends AbstractMigrationsLoader {
-  /**
-   * Gets the migration names
-   * @returns Promise<string[]>
-   */
-  getMigrations(loadExtensions) {
-    // Get a list of files in all specified migration directories
-    const readMigrationsPromises = this.migrationsPaths.map((configDir) => {
-      const absoluteDir = path.resolve(process.cwd(), configDir);
-      return readdir(absoluteDir).then((files) => ({
-        files,
-        configDir,
-        absoluteDir,
-      }));
-    });
-
-    return Promise.all(readMigrationsPromises).then((allMigrations) => {
-      const migrations = allMigrations.reduce((acc, migrationDirectory) => {
-        // When true, files inside the folder should be sorted
-        if (this.sortDirsSeparately) {
-          migrationDirectory.files = migrationDirectory.files.sort();
-        }
-
-        migrationDirectory.files.forEach((file) =>
-          acc.push({ file, directory: migrationDirectory.configDir })
-        );
-
-        return acc;
-      }, []);
-
-      // If true we have already sorted the migrations inside the folders
-      // return the migrations fully qualified
-      if (this.sortDirsSeparately) {
-        return filterMigrations(
-          this,
-          migrations,
-          loadExtensions || this.loadExtensions
-        );
-      }
-
-      return filterMigrations(
-        this,
-        sortBy(migrations, 'file'),
-        loadExtensions || this.loadExtensions
-      );
-    });
-  }
-
-  getMigrationName(migration) {
-    return migration.file;
-  }
-
-  getMigration(migrationInfo) {
-    return this.getFile(migrationInfo);
-  }
-}
-
-function filterMigrations(migrationSource, migrations, loadExtensions) {
-  return migrations.filter((migration) => {
-    const migrationName = migrationSource.getMigrationName(migration);
-    const extension = path.extname(migrationName);
-    return loadExtensions.includes(extension);
-  });
-}
-
-module.exports = {
-  FsMigrations,
-};
+const path = require('path');
+const sortBy = require('lodash/sortBy');
+
+const { readdir } = require('../../util/fs');
+const { AbstractMigrationsLoader } = require('../../common/MigrationsLoader');
+
+class FsMigrations extends AbstractMigrationsLoader {
+  /**
+   * Gets the migration names
+   * @returns Promise<string[]>
+   */
+  getMigrations(loadExtensions) {
+    // Get a list of files in all specified migration directories
+    const readMigrationsPromises = this.migrationsPaths.map((configDir) => {
+      const absoluteDir = path.resolve(process.cwd(), configDir);
+      return readdir(absoluteDir).then((files) => ({
+        files,
+        configDir,
+        absoluteDir,
+      }));
+    });
+
+    return Promise.all(readMigrationsPromises).then((allMigrations) => {
+      const migrations = allMigrations.reduce((acc, migrationDirectory) => {
+        // When true, files inside the folder should be sorted
+        if (this.sortDirsSeparately) {
+          migrationDirectory.files = migrationDirectory.files.sort();
+        }
+
+        migrationDirectory.files.forEach((file) =>
+          acc.push({ file, directory: migrationDirectory.configDir })
+        );
+
+        return acc;
+      }, []);
+
+      // If true we have already sorted the migrations inside the folders
+      // return the migrations fully qualified
+      if (this.sortDirsSeparately) {
+        return filterMigrations(
+          this,
+          migrations,
+          loadExtensions || this.loadExtensions
+        );
+      }
+
+      return filterMigrations(
+        this,
+        sortBy(migrations, 'file'),
+        loadExtensions || this.loadExtensions
+      );
+    });
+  }
+
+  getMigrationName(migration) {
+    return migration.file;
+  }
+
+  getMigration(migrationInfo) {
+    return this.getFile(migrationInfo);
+  }
+}
+
+function filterMigrations(migrationSource, migrations, loadExtensions) {
+  return migrations.filter((migration) => {
+    const migrationName = migrationSource.getMigrationName(migration);
+    const extension = path.extname(migrationName);
+    return loadExtensions.includes(extension);
+  });
+}
+
+module.exports = {
+  FsMigrations,
+};

package/lib/migrations/migrate/stub/cjs.stub

@@ -1,15 +1,15 @@
-
-exports.up = function(knex) {
-  <% if (d.tableName) { %>
-  return knex.schema.createTable("<%= d.tableName %>", function(t) {
-    t.increments();
-    t.timestamp();
-  });
-  <% } %>
-};
-
-exports.down = function(knex) {
-  <% if (d.tableName) { %>
-  return knex.schema.dropTable("<%= d.tableName %>");
-  <% } %>
-};
+
+exports.up = function(knex) {
+  <% if (d.tableName) { %>
+  return knex.schema.createTable("<%= d.tableName %>", function(t) {
+    t.increments();
+    t.timestamp();
+  });
+  <% } %>
+};
+
+exports.down = function(knex) {
+  <% if (d.tableName) { %>
+  return knex.schema.dropTable("<%= d.tableName %>");
+  <% } %>
+};

package/lib/migrations/migrate/stub/coffee.stub

@@ -1,13 +1,13 @@
-
-exports.up = (knex) ->
-  <% if (d.tableName) { %>
-  knex.schema.createTable "<%= d.tableName %>", (t) ->
-    t.increments()
-    t.timestamp()
-  <% } %>
-
-
-exports.down = (knex) ->
-  <% if (d.tableName) { %>
-  knex.schema.dropTable "<%= d.tableName %>"
-  <% } %>
+
+exports.up = (knex) ->
+  <% if (d.tableName) { %>
+  knex.schema.createTable "<%= d.tableName %>", (t) ->
+    t.increments()
+    t.timestamp()
+  <% } %>
+
+
+exports.down = (knex) ->
+  <% if (d.tableName) { %>
+  knex.schema.dropTable "<%= d.tableName %>"
+  <% } %>

package/lib/migrations/migrate/stub/eg.stub

@@ -1,14 +1,14 @@
-provide: up, down
-
-up = (knex) ->
-  <% if (d.tableName) { %>
-  knex.schema.createTable "<%= d.tableName %>": t ->
-    t.increments()
-    t.timestamp()
-  <% } %>
-
-
-down = (knex) ->
-  <% if (d.tableName) { %>
-  knex.schema.dropTable("<%= d.tableName %>")
-  <% } %>
+provide: up, down
+
+up = (knex) ->
+  <% if (d.tableName) { %>
+  knex.schema.createTable "<%= d.tableName %>": t ->
+    t.increments()
+    t.timestamp()
+  <% } %>
+
+
+down = (knex) ->
+  <% if (d.tableName) { %>
+  knex.schema.dropTable("<%= d.tableName %>")
+  <% } %>

package/lib/migrations/migrate/stub/js-schema.stub

@@ -1,22 +1,22 @@
-/**
- * @param { import("knex").Knex } knex
- * @returns { Promise<void> }
- */
-exports.up = function({schema}) {
-  <% if (d.tableName) { %>
-  return schema.createTable("<%= d.tableName %>", function(t) {
-    t.increments();
-    t.timestamp();
-  });
-  <% } %>
-};
-
-/**
- * @param { import("knex").Knex } knex
- * @returns { Promise<void> }
- */
-exports.down = function({schema}) {
-  <% if (d.tableName) { %>
-  return schema.dropTable("<%= d.tableName %>");
-  <% } %>
-};
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function({schema}) {
+  <% if (d.tableName) { %>
+  return schema.createTable("<%= d.tableName %>", function(t) {
+    t.increments();
+    t.timestamp();
+  });
+  <% } %>
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function({schema}) {
+  <% if (d.tableName) { %>
+  return schema.dropTable("<%= d.tableName %>");
+  <% } %>
+};

package/lib/migrations/migrate/stub/js.stub

@@ -1,22 +1,22 @@
-/**
- * @param { import("knex").Knex } knex
- * @returns { Promise<void> }
- */
-exports.up = function(knex) {
-  <% if (d.tableName) { %>
-  return knex.schema.createTable("<%= d.tableName %>", function(t) {
-    t.increments();
-    t.timestamp();
-  });
-  <% } %>
-};
-
-/**
- * @param { import("knex").Knex } knex
- * @returns { Promise<void> }
- */
-exports.down = function(knex) {
-  <% if (d.tableName) { %>
-  return knex.schema.dropTable("<%= d.tableName %>");
-  <% } %>
-};
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+  <% if (d.tableName) { %>
+  return knex.schema.createTable("<%= d.tableName %>", function(t) {
+    t.increments();
+    t.timestamp();
+  });
+  <% } %>
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+  <% if (d.tableName) { %>
+  return knex.schema.dropTable("<%= d.tableName %>");
+  <% } %>
+};

package/lib/migrations/migrate/stub/knexfile-coffee.stub

@@ -1,34 +1,34 @@
-# Update with your config settings.
-
-module.exports =
-
-  development:
-    client: 'sqlite3'
-    connection:
-      filename: './dev.sqlite3'
-    migrations:
-      tableName: 'knex_migrations'
-
-  staging:
-    client: 'postgresql'
-    connection:
-      database: 'my_db'
-      user:     'username'
-      password: 'password'
-    pool:
-      min: 2
-      max: 10
-    migrations:
-      tableName: 'knex_migrations'
-
-  production:
-    client: 'postgresql'
-    connection:
-      database: 'my_db'
-      user:     'username'
-      password: 'password'
-    pool:
-      min: 2
-      max: 10
-    migrations:
-      tableName: 'knex_migrations'
+# Update with your config settings.
+
+module.exports =
+
+  development:
+    client: 'sqlite3'
+    connection:
+      filename: './dev.sqlite3'
+    migrations:
+      tableName: 'knex_migrations'
+
+  staging:
+    client: 'postgresql'
+    connection:
+      database: 'my_db'
+      user:     'username'
+      password: 'password'
+    pool:
+      min: 2
+      max: 10
+    migrations:
+      tableName: 'knex_migrations'
+
+  production:
+    client: 'postgresql'
+    connection:
+      database: 'my_db'
+      user:     'username'
+      password: 'password'
+    pool:
+      min: 2
+      max: 10
+    migrations:
+      tableName: 'knex_migrations'