knex 3.0.1 → 3.2.0

package/bin/knexfile-runtime-error.js

@@ -0,0 +1,27 @@
+const { inspect } = require('util');
+
+// since we're loading code that's not ours when we read a knexfile, it can throw anything.
+//
+// this small helper class acts as glue between catching an error during knexfile handling
+// and presenting the failure to the user when calling exit() with the result, determining
+// how to format whatever we know about the failure to present a useful error to the user
+//
+// see https://github.com/knex/knex/issues/6082
+
+class KnexfileRuntimeError {
+  constructor(message, configPath, caught) {
+    const strs = [message];
+
+    if (caught instanceof Error) {
+      strs.push(caught.stack ?? caught.message);
+    } else {
+      strs.push(
+        `A non-Error value was thrown\n    at default export (${configPath})`
+      );
+      strs.push(inspect(caught));
+    }
+    this.message = strs.join('\n');
+  }
+}
+
+module.exports = { KnexfileRuntimeError };

package/bin/utils/cli-config-utils.js

@@ -1,212 +1,217 @@
-const { DEFAULT_EXT, DEFAULT_TABLE_NAME } = require('./constants');
-const { resolveClientNameWithAliases } = require('../../lib/util/helpers');
-const path = require('path');
-const escalade = require('escalade/sync');
-const tildify = require('tildify');
-const color = require('colorette');
-const argv = require('getopts')(process.argv.slice(2));
-
-function parseConfigObj(opts) {
-  const config = { migrations: {} };
-
-  if (opts.client) {
-    config.client = opts.client;
-  }
-
-  if (opts.connection) {
-    config.connection = opts.connection;
-  }
-
-  if (opts.migrationsDirectory) {
-    config.migrations.directory = opts.migrationsDirectory;
-  }
-
-  if (opts.migrationsTableName) {
-    config.migrations.tableName = opts.migrationsTableName;
-  }
-
-  return config;
-}
-
-function mkConfigObj(opts) {
-  const envName = opts.env || process.env.NODE_ENV || 'development';
-  const resolvedClientName = resolveClientNameWithAliases(opts.client);
-  const useNullAsDefault = resolvedClientName === 'sqlite3';
-  const parsedConfig = parseConfigObj(opts);
-
-  return {
-    ext: DEFAULT_EXT,
-    [envName]: {
-      ...parsedConfig,
-      useNullAsDefault,
-      tableName: parsedConfig.tableName || DEFAULT_TABLE_NAME,
-    },
-  };
-}
-
-function resolveEnvironmentConfig(opts, allConfigs, configFilePath) {
-  const environment = opts.env || process.env.NODE_ENV || 'development';
-  const result = allConfigs[environment] || allConfigs;
-
-  if (allConfigs[environment]) {
-    console.log('Using environment:', color.magenta(environment));
-  }
-
-  if (!result) {
-    console.log(color.red('Warning: unable to read knexfile config'));
-    process.exit(1);
-  }
-
-  if (argv.debug !== undefined) {
-    result.debug = argv.debug;
-  }
-
-  // It is safe to assume that unless explicitly specified, we would want
-  // migrations, seeds etc. to be generated with same extension
-  if (configFilePath) {
-    result.ext = result.ext || path.extname(configFilePath).replace('.', '');
-  }
-
-  return result;
-}
-
-function exit(text) {
-  if (text instanceof Error) {
-    if (text.message) {
-      console.error(color.red(text.message));
-    }
-    console.error(
-      color.red(`${text.detail ? `${text.detail}\n` : ''}${text.stack}`)
-    );
-  } else {
-    console.error(color.red(text));
-  }
-  process.exit(1);
-}
-
-function success(text) {
-  console.log(text);
-  process.exit(0);
-}
-
-function checkLocalModule(env) {
-  if (!env.modulePath) {
-    console.log(
-      color.red('No local knex install found in:'),
-      color.magenta(tildify(env.cwd))
-    );
-    exit('Try running: npm install knex');
-  }
-}
-
-function checkConfigurationOptions(env, opts) {
-  if (!env.configPath && !opts.client) {
-    throw new Error(
-      `No configuration file found and no commandline connection parameters passed`
-    );
-  }
-}
-
-function getMigrationExtension(env, opts) {
-  const config = resolveEnvironmentConfig(
-    opts,
-    env.configuration,
-    env.configPath
-  );
-
-  let ext = DEFAULT_EXT;
-  if (argv.x) {
-    ext = argv.x;
-  } else if (config.migrations && config.migrations.extension) {
-    ext = config.migrations.extension;
-  } else if (config.ext) {
-    ext = config.ext;
-  }
-  return ext.toLowerCase();
-}
-
-function getSeedExtension(env, opts) {
-  const config = resolveEnvironmentConfig(
-    opts,
-    env.configuration,
-    env.configPath
-  );
-
-  let ext = DEFAULT_EXT;
-  if (argv.x) {
-    ext = argv.x;
-  } else if (config.seeds && config.seeds.extension) {
-    ext = config.seeds.extension;
-  } else if (config.ext) {
-    ext = config.ext;
-  }
-  return ext.toLowerCase();
-}
-
-function getStubPath(configKey, env, opts) {
-  const config = resolveEnvironmentConfig(opts, env.configuration);
-  const stubDirectory = config[configKey] && config[configKey].directory;
-
-  const { stub } = argv;
-  if (!stub) {
-    return null;
-  } else if (stub.includes('/')) {
-    // relative path to stub
-    return stub;
-  }
-
-  // using stub <name> must have config[configKey].directory defined
-  if (!stubDirectory) {
-    console.log(color.red('Failed to load stub'), color.magenta(stub));
-    exit(`config.${configKey}.directory in knexfile must be defined`);
-  }
-
-  return path.join(stubDirectory, stub);
-}
-
-function findUpModulePath(cwd, packageName) {
-  const modulePackagePath = escalade(cwd, (dir, names) => {
-    if (names.includes('package.json')) {
-      return 'package.json';
-    }
-    return false;
-  });
-  try {
-    const modulePackage = require(modulePackagePath);
-    if (modulePackage.name === packageName) {
-      return path.join(
-        path.dirname(modulePackagePath),
-        modulePackage.main || 'index.js'
-      );
-    }
-  } catch (e) {
-    /* empty */
-  }
-}
-
-function findUpConfig(cwd, name, extensions) {
-  return escalade(cwd, (dir, names) => {
-    for (const ext of extensions) {
-      const filename = `${name}.${ext}`;
-      if (names.includes(filename)) {
-        return filename;
-      }
-    }
-    return false;
-  });
-}
-
-module.exports = {
-  parseConfigObj,
-  mkConfigObj,
-  resolveEnvironmentConfig,
-  exit,
-  success,
-  checkLocalModule,
-  checkConfigurationOptions,
-  getSeedExtension,
-  getMigrationExtension,
-  getStubPath,
-  findUpModulePath,
-  findUpConfig,
-};
+const { DEFAULT_EXT, DEFAULT_TABLE_NAME } = require('./constants');
+const { resolveClientNameWithAliases } = require('../../lib/util/helpers');
+const path = require('path');
+const { inspect } = require('util');
+const escalade = require('escalade/sync');
+const tildify = require('tildify');
+const color = require('colorette');
+const { KnexfileRuntimeError } = require('../knexfile-runtime-error');
+const argv = require('getopts')(process.argv.slice(2));
+
+function parseConfigObj(opts) {
+  const config = { migrations: {} };
+
+  if (opts.client) {
+    config.client = opts.client;
+  }
+
+  if (opts.connection) {
+    config.connection = opts.connection;
+  }
+
+  if (opts.migrationsDirectory) {
+    config.migrations.directory = opts.migrationsDirectory;
+  }
+
+  if (opts.migrationsTableName) {
+    config.migrations.tableName = opts.migrationsTableName;
+  }
+
+  return config;
+}
+
+function mkConfigObj(opts) {
+  const envName = opts.env || process.env.NODE_ENV || 'development';
+  const resolvedClientName = resolveClientNameWithAliases(opts.client);
+  const useNullAsDefault = resolvedClientName === 'sqlite3';
+  const parsedConfig = parseConfigObj(opts);
+
+  return {
+    ext: DEFAULT_EXT,
+    [envName]: {
+      ...parsedConfig,
+      useNullAsDefault,
+      tableName: parsedConfig.tableName || DEFAULT_TABLE_NAME,
+    },
+  };
+}
+
+function resolveEnvironmentConfig(opts, allConfigs, configFilePath) {
+  const environment = opts.env || process.env.NODE_ENV || 'development';
+  const result = allConfigs[environment] || allConfigs;
+
+  if (allConfigs[environment]) {
+    console.log('Using environment:', color.magenta(environment));
+  }
+
+  if (!result) {
+    console.log(color.red('Warning: unable to read knexfile config'));
+    process.exit(1);
+  }
+
+  if (argv.debug !== undefined) {
+    result.debug = argv.debug;
+  }
+
+  // It is safe to assume that unless explicitly specified, we would want
+  // migrations, seeds etc. to be generated with same extension
+  if (configFilePath) {
+    result.ext = result.ext || path.extname(configFilePath).replace('.', '');
+  }
+
+  return result;
+}
+
+function exit(reason) {
+  let exitMessage;
+
+  if (reason instanceof KnexfileRuntimeError) {
+    exitMessage = reason.message;
+  } else if (reason instanceof Error) {
+    exitMessage = reason.stack ?? reason.message;
+  } else if (typeof reason === 'string') {
+    exitMessage = reason;
+  } else {
+    exitMessage = inspect(reason);
+  }
+
+  console.error(color.red(exitMessage));
+  process.exit(1);
+}
+
+function success(text) {
+  console.log(text);
+  process.exit(0);
+}
+
+function checkLocalModule(env) {
+  if (!env.modulePath) {
+    console.log(
+      color.red('No local knex install found in:'),
+      color.magenta(tildify(env.cwd))
+    );
+    exit('Try running: npm install knex');
+  }
+}
+
+function checkConfigurationOptions(env, opts) {
+  if (!env.configPath && !opts.client) {
+    throw new Error(
+      `No configuration file found and no commandline connection parameters passed`
+    );
+  }
+}
+
+function getMigrationExtension(env, opts) {
+  const config = resolveEnvironmentConfig(
+    opts,
+    env.configuration,
+    env.configPath
+  );
+
+  let ext = DEFAULT_EXT;
+  if (argv.x) {
+    ext = argv.x;
+  } else if (config.migrations && config.migrations.extension) {
+    ext = config.migrations.extension;
+  } else if (config.ext) {
+    ext = config.ext;
+  }
+  return ext.toLowerCase();
+}
+
+function getSeedExtension(env, opts) {
+  const config = resolveEnvironmentConfig(
+    opts,
+    env.configuration,
+    env.configPath
+  );
+
+  let ext = DEFAULT_EXT;
+  if (argv.x) {
+    ext = argv.x;
+  } else if (config.seeds && config.seeds.extension) {
+    ext = config.seeds.extension;
+  } else if (config.ext) {
+    ext = config.ext;
+  }
+  return ext.toLowerCase();
+}
+
+function getStubPath(configKey, env, opts) {
+  const config = resolveEnvironmentConfig(opts, env.configuration);
+  const stubDirectory = config[configKey] && config[configKey].directory;
+
+  const { stub } = argv;
+  if (!stub) {
+    return null;
+  } else if (stub.includes('/')) {
+    // relative path to stub
+    return stub;
+  }
+
+  // using stub <name> must have config[configKey].directory defined
+  if (!stubDirectory) {
+    console.log(color.red('Failed to load stub'), color.magenta(stub));
+    exit(`config.${configKey}.directory in knexfile must be defined`);
+  }
+
+  return path.join(stubDirectory, stub);
+}
+
+function findUpModulePath(cwd, packageName) {
+  const modulePackagePath = escalade(cwd, (dir, names) => {
+    if (names.includes('package.json')) {
+      return 'package.json';
+    }
+    return false;
+  });
+  try {
+    const modulePackage = require(modulePackagePath);
+    if (modulePackage.name === packageName) {
+      return path.join(
+        path.dirname(modulePackagePath),
+        modulePackage.main || 'index.js'
+      );
+    }
+  } catch (e) {
+    /* empty */
+  }
+}
+
+function findUpConfig(cwd, name, extensions) {
+  return escalade(cwd, (dir, names) => {
+    for (const ext of extensions) {
+      const filename = `${name}.${ext}`;
+      if (names.includes(filename)) {
+        return filename;
+      }
+    }
+    return false;
+  });
+}
+
+module.exports = {
+  parseConfigObj,
+  mkConfigObj,
+  resolveEnvironmentConfig,
+  exit,
+  success,
+  checkLocalModule,
+  checkConfigurationOptions,
+  getSeedExtension,
+  getMigrationExtension,
+  getStubPath,
+  findUpModulePath,
+  findUpConfig,
+};

package/bin/utils/constants.js

@@ -1,7 +1,7 @@
-const DEFAULT_EXT = 'js';
-const DEFAULT_TABLE_NAME = 'knex_migrations';
-
-module.exports = {
-  DEFAULT_EXT,
-  DEFAULT_TABLE_NAME,
-};
+const DEFAULT_EXT = 'js';
+const DEFAULT_TABLE_NAME = 'knex_migrations';
+
+module.exports = {
+  DEFAULT_EXT,
+  DEFAULT_TABLE_NAME,
+};

package/bin/utils/migrationsLister.js

@@ -1,37 +1,37 @@
-const color = require('colorette');
-
-const { success } = require('./cli-config-utils');
-
-function listMigrations(completed, newMigrations) {
-  let message = '';
-
-  if (completed.length === 0) {
-    message += color.red('No Completed Migration files Found.\n');
-  } else {
-    message = color.green(
-      `Found ${completed.length} Completed Migration file/files.\n`
-    );
-
-    for (let i = 0; i < completed.length; i++) {
-      const file = completed[i];
-      message += color.cyan(`${file.name}\n`);
-    }
-  }
-
-  if (newMigrations.length === 0) {
-    message += color.red('No Pending Migration files Found.\n');
-  } else {
-    message += color.green(
-      `Found ${newMigrations.length} Pending Migration file/files.\n`
-    );
-
-    for (let i = 0; i < newMigrations.length; i++) {
-      const file = newMigrations[i];
-      message += color.cyan(`${file.file}\n`);
-    }
-  }
-
-  success(message);
-}
-
-module.exports = { listMigrations };
+const color = require('colorette');
+
+const { success } = require('./cli-config-utils');
+
+function listMigrations(completed, newMigrations) {
+  let message = '';
+
+  if (completed.length === 0) {
+    message += color.red('No Completed Migration files Found.\n');
+  } else {
+    message = color.green(
+      `Found ${completed.length} Completed Migration file/files.\n`
+    );
+
+    for (let i = 0; i < completed.length; i++) {
+      const file = completed[i];
+      message += color.cyan(`${file.name}\n`);
+    }
+  }
+
+  if (newMigrations.length === 0) {
+    message += color.red('No Pending Migration files Found.\n');
+  } else {
+    message += color.green(
+      `Found ${newMigrations.length} Pending Migration file/files.\n`
+    );
+
+    for (let i = 0; i < newMigrations.length; i++) {
+      const file = newMigrations[i];
+      message += color.cyan(`${file.file}\n`);
+    }
+  }
+
+  success(message);
+}
+
+module.exports = { listMigrations };

package/knex.js

@@ -1,23 +1,23 @@
-// Knex.js
-// --------------
-//     (c) 2013-present Tim Griesser
-//     Knex may be freely distributed under the MIT license.
-//     For details and documentation:
-//     http://knexjs.org
-
-const knex = require('./lib/index');
-
-/**
- * These export configurations enable JS and TS developers
- * to consume knex in whatever way best suits their needs.
- * Some examples of supported import syntax includes:
- * - `const knex = require('knex')`
- * - `const { knex } = require('knex')`
- * - `import * as knex from 'knex'`
- * - `import { knex } from 'knex'`
- * - `import knex from 'knex'`
- */
-knex.knex = knex;
-knex.default = knex;
-
-module.exports = knex;
+// Knex.js
+// --------------
+//     (c) 2013-present Tim Griesser
+//     Knex may be freely distributed under the MIT license.
+//     For details and documentation:
+//     http://knexjs.org
+
+const knex = require('./lib/index');
+
+/**
+ * These export configurations enable JS and TS developers
+ * to consume knex in whatever way best suits their needs.
+ * Some examples of supported import syntax includes:
+ * - `const knex = require('knex')`
+ * - `const { knex } = require('knex')`
+ * - `import * as knex from 'knex'`
+ * - `import { knex } from 'knex'`
+ * - `import knex from 'knex'`
+ */
+knex.knex = knex;
+knex.default = knex;
+
+module.exports = knex;

package/knex.mjs

@@ -1,11 +1,11 @@
-// Knex.js
-// --------------
-//     (c) 2013-present Tim Griesser
-//     Knex may be freely distributed under the MIT license.
-//     For details and documentation:
-//     http://knexjs.org
-
-import knex from './lib/index.js';
-
-export { knex };
-export default knex;
+// Knex.js
+// --------------
+//     (c) 2013-present Tim Griesser
+//     Knex may be freely distributed under the MIT license.
+//     For details and documentation:
+//     http://knexjs.org
+
+import knex from './lib/index.js';
+
+export { knex };
+export default knex;