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

100 lines
2.7 KiB
JavaScript
Raw Normal View History

const path = require('path');
const sortBy = require('lodash/sortBy');
const { readdir } = require('../../util/fs');
const DEFAULT_LOAD_EXTENSIONS = Object.freeze([
'.co',
'.coffee',
'.eg',
'.iced',
'.js',
'.cjs',
'.litcoffee',
'.ls',
'.ts',
]);
class FsMigrations {
constructor(migrationDirectories, sortDirsSeparately, loadExtensions) {
this.sortDirsSeparately = sortDirsSeparately;
if (!Array.isArray(migrationDirectories)) {
migrationDirectories = [migrationDirectories];
}
this.migrationsPaths = migrationDirectories;
this.loadExtensions = loadExtensions || DEFAULT_LOAD_EXTENSIONS;
}
/**
* 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(migration) {
const absoluteDir = path.resolve(process.cwd(), migration.directory);
const _path = path.join(absoluteDir, migration.file);
const importFile = require('../../util/import-file'); // late import
return importFile(_path);
}
}
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 = {
DEFAULT_LOAD_EXTENSIONS,
FsMigrations,
};