knex 0.21.20 → 0.21.21

package/lib/seed/Seeder.js

@@ -1,203 +1,203 @@
-// Seeder
-// -------
-
-const path = require('path');
-const flatten = require('lodash/flatten');
-const extend = require('lodash/extend');
-const includes = require('lodash/includes');
-const { ensureDirectoryExists, getFilepathsInFolder } = require('../util/fs');
-const { writeJsFileUsingTemplate } = require('../util/template');
-const { yyyymmddhhmmss } = require('../util/timestamp');
-
-const filterByLoadExtensions = (extensions) => (value) => {
-  const extension = path.extname(value);
-  return includes(extensions, extension);
-};
-
-// The new seeds we're performing, typically called from the `knex.seed`
-// interface on the main `knex` object. Passes the `knex` instance performing
-// the seeds.
-class Seeder {
-  constructor(knex) {
-    this.knex = knex;
-    this.config = this.setConfig(knex.client.config.seeds);
-  }
-
-  // Runs seed files for the given environment.
-  async run(config) {
-    this.config = this.setConfig(config);
-    let files = await this._listAll();
-    if (config && config.specific) {
-      files = files.filter((file) => path.basename(file) === config.specific);
-      if (files.length === 0) {
-        throw new Error(
-          `Invalid argument provided: the specific seed "${config.specific}" does not exist.`
-        );
-      }
-    }
-    return this._runSeeds(files);
-  }
-
-  // Creates a new seed file, with a given name.
-  async make(name, config) {
-    this.config = this.setConfig(config);
-    if (!name)
-      throw new Error('A name must be specified for the generated seed');
-    await this._ensureFolder(config);
-    const seedPath = await this._writeNewSeed(name);
-    return seedPath;
-  }
-
-  // Lists all available seed files as a sorted array.
-  async _listAll(config) {
-    this.config = this.setConfig(config);
-    const { loadExtensions, recursive } = this.config;
-    const seeds = flatten(
-      await Promise.all(
-        this._absoluteConfigDirs().map((d) =>
-          getFilepathsInFolder(d, recursive)
-        )
-      )
-    );
-    // if true, each dir are already sorted
-    // (getFilepathsInFolderRecursively does this)
-    // if false, we need to sort all the seeds
-    if (this.config.sortDirsSeparately) {
-      return seeds.filter(filterByLoadExtensions(loadExtensions));
-    } else {
-      return seeds.filter(filterByLoadExtensions(loadExtensions)).sort();
-    }
-  }
-
-  // Ensures a folder for the seeds exist, dependent on the
-  // seed config settings.
-  _ensureFolder() {
-    const dirs = this._absoluteConfigDirs();
-    const promises = dirs.map(ensureDirectoryExists);
-    return Promise.all(promises);
-  }
-
-  // Run seed files, in sequence.
-  _runSeeds(seeds) {
-    seeds.forEach((seed) => this._validateSeedStructure(seed));
-    return this._waterfallBatch(seeds);
-  }
-
-  // Validates seed files by requiring and checking for a `seed` function.
-  async _validateSeedStructure(filepath) {
-    const importFile = require('../util/import-file'); // late import
-    const seed = await importFile(filepath);
-    if (typeof seed.seed !== 'function') {
-      throw new Error(
-        `Invalid seed file: ${filepath} must have a seed function`
-      );
-    }
-    return filepath;
-  }
-
-  _getStubPath() {
-    return (
-      this.config.stub ||
-      path.join(__dirname, 'stub', this.config.extension + '.stub')
-    );
-  }
-
-  _getNewStubFileName(name) {
-    if (name[0] === '-') name = name.slice(1);
-
-    if (this.config.timestampFilenamePrefix === true) {
-      name = `${yyyymmddhhmmss()}_${name}`;
-    }
-
-    return `${name}.${this.config.extension}`;
-  }
-
-  _getNewStubFilePath(name) {
-    const fileName = this._getNewStubFileName(name);
-    const dirs = this._absoluteConfigDirs();
-    const dir = dirs.slice(-1)[0]; // Get last specified directory
-    return path.join(dir, fileName);
-  }
-
-  // Write a new seed to disk, using the config and generated filename,
-  // passing any `variables` given in the config to the template.
-  async _writeNewSeed(name) {
-    const seedPath = this._getNewStubFilePath(name);
-    await writeJsFileUsingTemplate(
-      seedPath,
-      this._getStubPath(),
-      { variable: 'd' },
-      this.config.variables || {}
-    );
-    return seedPath;
-  }
-
-  // Runs a batch of seed files.
-  async _waterfallBatch(seeds) {
-    const { knex } = this;
-    const log = [];
-    for (const seedPath of seeds) {
-      const importFile = require('../util/import-file'); // late import
-      const seed = await importFile(seedPath);
-      try {
-        await seed.seed(knex);
-        log.push(seedPath);
-      } catch (originalError) {
-        const error = new Error(
-          `Error while executing "${seedPath}" seed: ${originalError.message}`
-        );
-        error.original = originalError;
-        error.stack =
-          error.stack.split('\n').slice(0, 2).join('\n') +
-          '\n' +
-          originalError.stack;
-        throw error;
-      }
-    }
-    return [log];
-  }
-
-  /**
-   * Return all the config directories
-   * @returns {string[]}
-   */
-  _absoluteConfigDirs() {
-    const directories = Array.isArray(this.config.directory)
-      ? this.config.directory
-      : [this.config.directory];
-    return directories.map((directory) => {
-      if (!directory) {
-        console.warn(
-          'Failed to resolve config file, knex cannot determine where to run or make seeds'
-        );
-      }
-      return path.resolve(process.cwd(), directory);
-    });
-  }
-
-  setConfig(config) {
-    return extend(
-      {
-        extension: 'js',
-        directory: './seeds',
-        loadExtensions: [
-          '.co',
-          '.coffee',
-          '.eg',
-          '.iced',
-          '.js',
-          '.litcoffee',
-          '.ls',
-          '.ts',
-        ],
-        timestampFilenamePrefix: false,
-        sortDirsSeparately: false,
-        recursive: false,
-      },
-      this.config || {},
-      config
-    );
-  }
-}
-
-module.exports = Seeder;
+// Seeder
+// -------
+
+const path = require('path');
+const flatten = require('lodash/flatten');
+const extend = require('lodash/extend');
+const includes = require('lodash/includes');
+const { ensureDirectoryExists, getFilepathsInFolder } = require('../util/fs');
+const { writeJsFileUsingTemplate } = require('../util/template');
+const { yyyymmddhhmmss } = require('../util/timestamp');
+
+const filterByLoadExtensions = (extensions) => (value) => {
+  const extension = path.extname(value);
+  return includes(extensions, extension);
+};
+
+// The new seeds we're performing, typically called from the `knex.seed`
+// interface on the main `knex` object. Passes the `knex` instance performing
+// the seeds.
+class Seeder {
+  constructor(knex) {
+    this.knex = knex;
+    this.config = this.setConfig(knex.client.config.seeds);
+  }
+
+  // Runs seed files for the given environment.
+  async run(config) {
+    this.config = this.setConfig(config);
+    let files = await this._listAll();
+    if (config && config.specific) {
+      files = files.filter((file) => path.basename(file) === config.specific);
+      if (files.length === 0) {
+        throw new Error(
+          `Invalid argument provided: the specific seed "${config.specific}" does not exist.`
+        );
+      }
+    }
+    return this._runSeeds(files);
+  }
+
+  // Creates a new seed file, with a given name.
+  async make(name, config) {
+    this.config = this.setConfig(config);
+    if (!name)
+      throw new Error('A name must be specified for the generated seed');
+    await this._ensureFolder(config);
+    const seedPath = await this._writeNewSeed(name);
+    return seedPath;
+  }
+
+  // Lists all available seed files as a sorted array.
+  async _listAll(config) {
+    this.config = this.setConfig(config);
+    const { loadExtensions, recursive } = this.config;
+    const seeds = flatten(
+      await Promise.all(
+        this._absoluteConfigDirs().map((d) =>
+          getFilepathsInFolder(d, recursive)
+        )
+      )
+    );
+    // if true, each dir are already sorted
+    // (getFilepathsInFolderRecursively does this)
+    // if false, we need to sort all the seeds
+    if (this.config.sortDirsSeparately) {
+      return seeds.filter(filterByLoadExtensions(loadExtensions));
+    } else {
+      return seeds.filter(filterByLoadExtensions(loadExtensions)).sort();
+    }
+  }
+
+  // Ensures a folder for the seeds exist, dependent on the
+  // seed config settings.
+  _ensureFolder() {
+    const dirs = this._absoluteConfigDirs();
+    const promises = dirs.map(ensureDirectoryExists);
+    return Promise.all(promises);
+  }
+
+  // Run seed files, in sequence.
+  _runSeeds(seeds) {
+    seeds.forEach((seed) => this._validateSeedStructure(seed));
+    return this._waterfallBatch(seeds);
+  }
+
+  // Validates seed files by requiring and checking for a `seed` function.
+  async _validateSeedStructure(filepath) {
+    const importFile = require('../util/import-file'); // late import
+    const seed = await importFile(filepath);
+    if (typeof seed.seed !== 'function') {
+      throw new Error(
+        `Invalid seed file: ${filepath} must have a seed function`
+      );
+    }
+    return filepath;
+  }
+
+  _getStubPath() {
+    return (
+      this.config.stub ||
+      path.join(__dirname, 'stub', this.config.extension + '.stub')
+    );
+  }
+
+  _getNewStubFileName(name) {
+    if (name[0] === '-') name = name.slice(1);
+
+    if (this.config.timestampFilenamePrefix === true) {
+      name = `${yyyymmddhhmmss()}_${name}`;
+    }
+
+    return `${name}.${this.config.extension}`;
+  }
+
+  _getNewStubFilePath(name) {
+    const fileName = this._getNewStubFileName(name);
+    const dirs = this._absoluteConfigDirs();
+    const dir = dirs.slice(-1)[0]; // Get last specified directory
+    return path.join(dir, fileName);
+  }
+
+  // Write a new seed to disk, using the config and generated filename,
+  // passing any `variables` given in the config to the template.
+  async _writeNewSeed(name) {
+    const seedPath = this._getNewStubFilePath(name);
+    await writeJsFileUsingTemplate(
+      seedPath,
+      this._getStubPath(),
+      { variable: 'd' },
+      this.config.variables || {}
+    );
+    return seedPath;
+  }
+
+  // Runs a batch of seed files.
+  async _waterfallBatch(seeds) {
+    const { knex } = this;
+    const log = [];
+    for (const seedPath of seeds) {
+      const importFile = require('../util/import-file'); // late import
+      const seed = await importFile(seedPath);
+      try {
+        await seed.seed(knex);
+        log.push(seedPath);
+      } catch (originalError) {
+        const error = new Error(
+          `Error while executing "${seedPath}" seed: ${originalError.message}`
+        );
+        error.original = originalError;
+        error.stack =
+          error.stack.split('\n').slice(0, 2).join('\n') +
+          '\n' +
+          originalError.stack;
+        throw error;
+      }
+    }
+    return [log];
+  }
+
+  /**
+   * Return all the config directories
+   * @returns {string[]}
+   */
+  _absoluteConfigDirs() {
+    const directories = Array.isArray(this.config.directory)
+      ? this.config.directory
+      : [this.config.directory];
+    return directories.map((directory) => {
+      if (!directory) {
+        console.warn(
+          'Failed to resolve config file, knex cannot determine where to run or make seeds'
+        );
+      }
+      return path.resolve(process.cwd(), directory);
+    });
+  }
+
+  setConfig(config) {
+    return extend(
+      {
+        extension: 'js',
+        directory: './seeds',
+        loadExtensions: [
+          '.co',
+          '.coffee',
+          '.eg',
+          '.iced',
+          '.js',
+          '.litcoffee',
+          '.ls',
+          '.ts',
+        ],
+        timestampFilenamePrefix: false,
+        sortDirsSeparately: false,
+        recursive: false,
+      },
+      this.config || {},
+      config
+    );
+  }
+}
+
+module.exports = Seeder;

package/lib/seed/seed-stub.js

@@ -1,13 +1,13 @@
-// Stub Seed:
-// Used for now in browser builds, where filesystem access isn't
-// available.
-const StubSeed = (module.exports = function () {});
-
-const noSuchMethod = async function () {
-  throw new Error('Seeds are not supported');
-};
-
-StubSeed.prototype = {
-  make: noSuchMethod,
-  run: noSuchMethod,
-};
+// Stub Seed:
+// Used for now in browser builds, where filesystem access isn't
+// available.
+const StubSeed = (module.exports = function () {});
+
+const noSuchMethod = async function () {
+  throw new Error('Seeds are not supported');
+};
+
+StubSeed.prototype = {
+  make: noSuchMethod,
+  run: noSuchMethod,
+};

package/lib/seed/stub/coffee.stub

@@ -1,9 +1,9 @@
-exports.seed = (knex) ->
-  knex('table_name').del()
-  .then () ->
-    # Inserts seed entries
-    knex('table_name').insert([
-      {id: 1, colName: 'rowValue'}
-      {id: 2, colName: 'rowValue2'}
-      {id: 3, colName: 'rowValue3'}
-    ])
+exports.seed = (knex) ->
+  knex('table_name').del()
+  .then () ->
+    # Inserts seed entries
+    knex('table_name').insert([
+      {id: 1, colName: 'rowValue'}
+      {id: 2, colName: 'rowValue2'}
+      {id: 3, colName: 'rowValue3'}
+    ])

package/lib/seed/stub/eg.stub

@@ -1,11 +1,11 @@
-provide: seed
-seed = (knex) ->
-  ;; Deletes ALL existing entries
-  knex(.table_name).del()
-  .then(() ->
-    ;; Inserts seed entries
-    knex(.table_name).insert with [
-      { id = 1, col-name = .row-value-1 }
-      { id = 2, col-name = .row-value-2 }
-      { id = 3, col-name = .row-value-3 }
-    ]
+provide: seed
+seed = (knex) ->
+  ;; Deletes ALL existing entries
+  knex(.table_name).del()
+  .then(() ->
+    ;; Inserts seed entries
+    knex(.table_name).insert with [
+      { id = 1, col-name = .row-value-1 }
+      { id = 2, col-name = .row-value-2 }
+      { id = 3, col-name = .row-value-3 }
+    ]

package/lib/seed/stub/js.stub

@@ -1,13 +1,13 @@
-
-exports.seed = function(knex) {
-  // Deletes ALL existing entries
-  return knex('table_name').del()
-    .then(function () {
-      // Inserts seed entries
-      return knex('table_name').insert([
-        {id: 1, colName: 'rowValue1'},
-        {id: 2, colName: 'rowValue2'},
-        {id: 3, colName: 'rowValue3'}
-      ]);
-    });
-};
+
+exports.seed = function(knex) {
+  // Deletes ALL existing entries
+  return knex('table_name').del()
+    .then(function () {
+      // Inserts seed entries
+      return knex('table_name').insert([
+        {id: 1, colName: 'rowValue1'},
+        {id: 2, colName: 'rowValue2'},
+        {id: 3, colName: 'rowValue3'}
+      ]);
+    });
+};

package/lib/seed/stub/ls.stub

@@ -1,11 +1,11 @@
-exports.seed = (knex) ->
-  # Deletes ALL existing entries
-  knex('table_name').del()
-  .then(() ->
-    # Inserts seed entries
-    knex('table_name').insert([
-      {id: 1, colName: 'rowValue1'},
-      {id: 2, colName: 'rowValue2'},
-      {id: 3, colName: 'rowValue3'}
-    ])
-  )
+exports.seed = (knex) ->
+  # Deletes ALL existing entries
+  knex('table_name').del()
+  .then(() ->
+    # Inserts seed entries
+    knex('table_name').insert([
+      {id: 1, colName: 'rowValue1'},
+      {id: 2, colName: 'rowValue2'},
+      {id: 3, colName: 'rowValue3'}
+    ])
+  )

package/lib/seed/stub/ts.stub

@@ -1,13 +1,13 @@
-import * as Knex from "knex";
-
-export async function seed(knex: Knex): Promise<void> {
-    // Deletes ALL existing entries
-    await knex("table_name").del();
-
-    // Inserts seed entries
-    await knex("table_name").insert([
-        { id: 1, colName: "rowValue1" },
-        { id: 2, colName: "rowValue2" },
-        { id: 3, colName: "rowValue3" }
-    ]);
-};
+import * as Knex from "knex";
+
+export async function seed(knex: Knex): Promise<void> {
+    // Deletes ALL existing entries
+    await knex("table_name").del();
+
+    // Inserts seed entries
+    await knex("table_name").insert([
+        { id: 1, colName: "rowValue1" },
+        { id: 2, colName: "rowValue2" },
+        { id: 3, colName: "rowValue3" }
+    ]);
+};