knex 0.21.5 → 0.21.6

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Master (Unreleased)
 
+# 0.21.6 - 27 September, 2020
+
+### New features:
+
+- CLI: New config parameter / CLI flag to prefixing seed filename with timestamp #3873
+- CLI: throw an error when specific seed file cannot be found #4011
+- Warn if whereNot is used with 'in' or 'between' #4038
+
+### Bug fixes:
+
+- CLI: Fix double merging of config for migrator #4040
+
+### Typings:
+
+- Unify SeedsConfig and SeederConfig #4003
+- Allow string[] type for directory in SeedsConfig #4033
+
 # 0.21.5 - 17 August, 2020
 
 ### New features:

package/bin/cli.js

@@ -93,7 +93,11 @@ function invoke(env) {
       'environment, default: process.env.NODE_ENV || development'
     )
     .option('--esm', 'Enable ESM interop.')
-    .option('--specific [path]', 'Specify one seed file to execute.');
+    .option('--specific [path]', 'Specify one seed file to execute.')
+    .option(
+      '--timestamp-filename-prefix',
+      'Enable a timestamp prefix on name of generated seed files.'
+    );
 
   commander
     .command('init')
@@ -300,6 +304,11 @@ function invoke(env) {
       `--stub [<relative/path/from/knexfile>|<name>]`,
       'Specify the seed stub to use. If using <name> the file must be located in config.seeds.directory'
     )
+    .option(
+      '--timestamp-filename-prefix',
+      'Enable a timestamp prefix on name of generated seed files.',
+      false
+    )
     .action(async (name) => {
       const opts = commander.opts();
       opts.client = opts.client || 'sqlite3'; // We don't really care about client when creating seeds
@@ -311,6 +320,10 @@ function invoke(env) {
         configOverrides.stub = stub;
       }
 
+      if (opts.timestampFilenamePrefix) {
+        configOverrides.timestampFilenamePrefix = opts.timestampFilenamePrefix;
+      }
+
       instance.seed
         .make(name, configOverrides)
         .then((name) => {

package/lib/migrate/MigrationGenerator.js

@@ -2,6 +2,7 @@ const path = require('path');
 const { writeJsFileUsingTemplate } = require('../util/template');
 const { getMergedConfig } = require('./configuration-merger');
 const { ensureDirectoryExists } = require('../util/fs');
+const { yyyymmddhhmmss } = require('../util/timestamp');
 
 class MigrationGenerator {
   constructor(migrationConfig, logger) {
@@ -79,24 +80,4 @@ class MigrationGenerator {
   }
 }
 
-// Ensure that we have 2 places for each of the date segments.
-function padDate(segment) {
-  segment = segment.toString();
-  return segment[1] ? segment : `0${segment}`;
-}
-
-// Get a date object in the correct format, without requiring a full out library
-// like "moment.js".
-function yyyymmddhhmmss() {
-  const d = new Date();
-  return (
-    d.getFullYear().toString() +
-    padDate(d.getMonth() + 1) +
-    padDate(d.getDate()) +
-    padDate(d.getHours()) +
-    padDate(d.getMinutes()) +
-    padDate(d.getSeconds())
-  );
-}
-
 module.exports = MigrationGenerator;

package/lib/migrate/Migrator.js

@@ -307,8 +307,7 @@ class Migrator {
 
   // Creates a new migration, with a given name.
   make(name, config) {
-    this.config = getMergedConfig(config, this.config, this.knex.client.logger);
-    return this.generator.make(name, this.config, this.knex.client.logger);
+    return this.generator.make(name, config, this.knex.client.logger);
   }
 
   _disableProcessing() {

package/lib/migrate/configuration-merger.js

@@ -29,14 +29,16 @@ function getMergedConfig(config, currentConfig, logger = defaultLogger) {
   if (
     config &&
     // If user specifies any FS related config,
-    // clear existing FsMigrations migrationSource
+    // clear specified migrationSource to avoid ambiguity
     (config.directory ||
       config.sortDirsSeparately !== undefined ||
       config.loadExtensions)
   ) {
-    logger.warn(
-      'FS-related option specified for migration configuration. This resets migrationSource to default FsMigrations'
-    );
+    if (config.migrationSource) {
+      logger.warn(
+        'FS-related option specified for migration configuration. This resets migrationSource to default FsMigrations'
+      );
+    }
     mergedConfig.migrationSource = null;
   }
 

package/lib/query/builder.js

@@ -371,6 +371,13 @@ assign(Builder.prototype, {
 
   // Adds an `not where` clause to the query.
   whereNot() {
+    if (arguments.length >= 2) {
+      if (arguments[1] === 'in' || arguments[1] === 'between') {
+        this.client.logger.warn(
+          'whereNot is not suitable for "in" and "between" type subqueries. You should use "not in" and "not between" instead.'
+        );
+      }
+    }
     return this._not(true).where.apply(this, arguments);
   },
 

package/lib/seed/Seeder.js

@@ -7,6 +7,7 @@ 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);
@@ -25,11 +26,15 @@ class Seeder {
   // Runs seed files for the given environment.
   async run(config) {
     this.config = this.setConfig(config);
-    const all = await this._listAll();
-    const files =
-      config && config.specific
-        ? all.filter((file) => path.basename(file) === config.specific)
-        : all;
+    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);
   }
 
@@ -99,7 +104,12 @@ class Seeder {
 
   _getNewStubFileName(name) {
     if (name[0] === '-') name = name.slice(1);
-    return name + '.' + this.config.extension;
+
+    if (this.config.timestampFilenamePrefix === true) {
+      name = `${yyyymmddhhmmss()}_${name}`;
+    }
+
+    return `${name}.${this.config.extension}`;
   }
 
   _getNewStubFilePath(name) {
@@ -181,6 +191,7 @@ class Seeder {
           '.ls',
           '.ts',
         ],
+        timestampFilenamePrefix: false,
         sortDirsSeparately: false,
         recursive: false,
       },

package/lib/util/timestamp.js

@@ -0,0 +1,16 @@
+// Get a date object in the correct format, without requiring a full out library
+// like "moment.js".
+function yyyymmddhhmmss() {
+  const d = new Date();
+
+  return (
+    d.getFullYear().toString() +
+    (d.getMonth() + 1).toString().padStart(2, '0') +
+    d.getDate().toString().padStart(2, '0') +
+    d.getHours().toString().padStart(2, '0') +
+    d.getMinutes().toString().padStart(2, '0') +
+    d.getSeconds().toString().padStart(2, '0')
+  );
+}
+
+module.exports = { yyyymmddhhmmss };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "0.21.5",
+  "version": "0.21.6",
   "description": "A batteries-included SQL query & schema builder for Postgres, MySQL and SQLite3 and the Browser",
   "main": "knex.js",
   "types": "types/index.d.ts",
@@ -79,7 +79,7 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "^14.0.27",
+    "@types/node": "^14.11.1",
     "JSONStream": "^1.3.5",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
@@ -88,22 +88,22 @@
     "coveralls": "^3.1.0",
     "cross-env": "^7.0.2",
     "dtslint": "3.6.14",
-    "eslint": "^7.6.0",
+    "eslint": "^7.9.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-import": "^2.22.0",
-    "husky": "^4.2.5",
+    "husky": "^4.3.0",
     "jake": "^8.1.1",
-    "lint-staged": "^10.2.11",
-    "mocha": "^8.1.1",
-    "mock-fs": "^4.12.0",
-    "mssql": "^6.2.1",
+    "lint-staged": "^10.4.0",
+    "mocha": "^8.1.3",
+    "mock-fs": "^4.13.0",
+    "mssql": "^6.2.2",
     "mysql": "^2.18.1",
-    "mysql2": "^2.1.0",
+    "mysql2": "^2.2.2",
     "nyc": "^15.1.0",
     "oracledb": "^5.0.0",
-    "pg": "^8.3.0",
-    "pg-query-stream": "^3.2.0",
-    "prettier": "2.0.5",
+    "pg": "^8.3.3",
+    "pg-query-stream": "^3.2.3",
+    "prettier": "2.1.2",
     "rimraf": "^3.0.2",
     "sinon": "^9.0.3",
     "sinon-chai": "^3.5.0",

package/types/index.d.ts

@@ -1699,7 +1699,7 @@ declare namespace Knex {
       origImpl: (value: string) => string,
       queryContext: any
     ) => string;
-    seeds?: SeedsConfig<SV>;
+    seeds?: SeederConfig<SV>;
     acquireConnectionTimeout?: number;
     useNullAsDefault?: boolean;
     searchPath?: string | readonly string[];
@@ -1943,14 +1943,6 @@ declare namespace Knex {
     migrationSource?: MigrationSource<unknown>;
   }
 
-  interface SeedsConfig<V extends {} = any> {
-    directory?: string;
-    extension?: string;
-    loadExtensions?: readonly string[];
-    stub?: string;
-    variables?: V;
-  }
-
   interface Migrator {
     make(name: string, config?: MigratorConfig): Promise<string>;
     latest(config?: MigratorConfig): Promise<any>;
@@ -1963,13 +1955,16 @@ declare namespace Knex {
     forceFreeMigrationsLock(config?: MigratorConfig): Promise<any>;
   }
 
-  interface SeederConfig {
+  interface SeederConfig<V extends {} = any> {
     extension?: string;
-    directory?: string | string[];
+    directory?: string | readonly string[];
     loadExtensions?: readonly string[];
     specific?: string;
+    timestampFilenamePrefix?: boolean;
     recursive?: boolean;
     sortDirsSeparately?: boolean;
+    stub?: string;
+    variables?: V;
   }
 
   class Seeder {