feat: modernize assets & skeleton files (#909)

.github/stale.yml

@@ -0,0 +1,16 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+ - bug
+ - feature
+ - semver:major
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+ This issue has been automatically marked as stale because it has not had
+ recent activity. It will be closed if no further activity occurs. Thank you
+ for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

package.json

@@ -30,15 +30,14 @@
  "gulp": "^4.0.0",
  "mocha": "^6.0.0",
  "mysql2": "latest",
- "nodeify": "^1.0.1",
  "pg": "latest",
  "pg-hstore": "latest",
  "sequelize": "latest",
  "sqlite3": "latest",
  "through2": "^3.0.0"
  },
  "options": {
- "mocha": "--require scripts/mocha-bootload.js --check-leaks --exit --timeout 30000 --colors --recursive --reporter spec"
+ "mocha": "--require scripts/mocha-bootload.js --bail --check-leaks --exit --timeout 30000 --colors --recursive --reporter spec"
  },
  "eslintIgnore": [
  "test/support",

src/assets/migrations/create-table.js

@@ -1,35 +1,34 @@
 'use strict';
 
 module.exports = {
- up: (queryInterface, Sequelize) => {
- return queryInterface
- .createTable('<%= tableName %>', {
- id: {
- allowNull: false,
- autoIncrement: true,
- primaryKey: true,
- type: Sequelize.INTEGER
- },
-
- <% attributes.forEach(function(attribute) { %>
- <%= attribute.fieldName %>: {
- type: Sequelize.<%= attribute.dataFunction ? `${attribute.dataFunction.toUpperCase()}(Sequelize.${attribute.dataType.toUpperCase()})` : attribute.dataValues ? `${attribute.dataType.toUpperCase()}(${attribute.dataValues})` : attribute.dataType.toUpperCase() %>
- },
- <% }) %>
+ up: async (queryInterface, Sequelize) => {
+ await queryInterface.createTable('<%= tableName %>', {
+ id: {
+ allowNull: false,
+ autoIncrement: true,
+ primaryKey: true,
+ type: Sequelize.INTEGER
+ },
 
-  <%= createdAt %>: {
-  allowNull: false,
- type: Sequelize.DATE
+ <% attributes.forEach(function(attribute) { %>
+ <%= attribute.fieldName %>: {
+ type: Sequelize.<%= attribute.dataFunction ? `${attribute.dataFunction.toUpperCase()}(Sequelize.${attribute.dataType.toUpperCase()})` : attribute.dataValues ? `${attribute.dataType.toUpperCase()}(${attribute.dataValues})` : attribute.dataType.toUpperCase() %>
  },
+ <% }) %>
+
+ <%= createdAt %>: {
+ allowNull: false,
+ type: Sequelize.DATE
+ },
 
-  <%= updatedAt %>: {
-  allowNull: false,
-  type: Sequelize.DATE
-  }
-  });
+ <%= updatedAt %>: {
+ allowNull: false,
+ type: Sequelize.DATE
+ }
+ });
  },
 
- down: (queryInterface, Sequelize) => {
- return queryInterface.dropTable('<%= tableName %>');
+ down: async (queryInterface, Sequelize) => {
+ await queryInterface.dropTable('<%= tableName %>');
  }
 };

src/assets/migrations/skeleton.js

@@ -1,23 +1,21 @@
 'use strict';
 
 module.exports = {
- up: (queryInterface, Sequelize) => {
- /*
- Add altering commands here.
- Return a promise to correctly handle asynchronicity.
-
- Example:
- return queryInterface.createTable('users', { id: Sequelize.INTEGER });
- */
+ up: async (queryInterface, Sequelize) => {
+ /**
+ * Add altering commands here.
+ *
+ * Example:
+ * await queryInterface.createTable('users', { id: Sequelize.INTEGER });
+ */
  },
 
- down: (queryInterface, Sequelize) => {
- /*
- Add reverting commands here.
- Return a promise to correctly handle asynchronicity.
-
- Example:
- return queryInterface.dropTable('users');
- */
+ down: async (queryInterface, Sequelize) => {
+ /**
+ * Add reverting commands here.
+ *
+ * Example:
+ * await queryInterface.dropTable('users');
+ */
  }
 };

src/assets/models/model.js

@@ -1,18 +1,29 @@
 'use strict';
 
+const { Model } = require('sequelize');
+
 module.exports = (sequelize, DataTypes) => {
- const <%= name %> = sequelize.define('<%= name %>', {
+ class <%= name %> extends Model {
+ /**
+ * Helper method for defining associations.
+ * This method is not part of Sequelize lifecycle.
+ * The `models/index` file will call this method automatically.
+ */
+ static associate (models) {
+ // define association here
+ }
+ };
+
+ <%= name %>.init({
  <% attributes.forEach(function(attribute, index) { %>
  <%= attribute.fieldName %>: DataTypes.<%= attribute.dataFunction ? `${attribute.dataFunction.toUpperCase()}(DataTypes.${attribute.dataType.toUpperCase()})` : attribute.dataValues ? `${attribute.dataType.toUpperCase()}(${attribute.dataValues})` : attribute.dataType.toUpperCase() %>
  <%= (Object.keys(attributes).length - 1) > index ? ',' : '' %>
  <% }) %>
  }, {
+ sequelize,
+ modelName: '<%= name %>',
  <%= underscored ? 'underscored: true,' : '' %>
  });
 
- <%= name %>.associate = function(models) {
- // associations can be defined here
- };
-
  return <%= name %>;
 };

src/assets/seeders/skeleton.js

@@ -1,26 +1,24 @@
 'use strict';
 
 module.exports = {
- up: (queryInterface, Sequelize) => {
- /*
- Add altering commands here.
- Return a promise to correctly handle asynchronicity.
-
- Example:
- return queryInterface.bulkInsert('People', [{
- name: 'John Doe',
- isBetaMember: false
- }], {});
+ up: async (queryInterface, Sequelize) => {
+ /**
+ * Add seed commands here.
+ *
+ * Example:
+ * await queryInterface.bulkInsert('People', [{
+ * name: 'John Doe',
+ * isBetaMember: false
+ * }], {});
  */
  },
 
- down: (queryInterface, Sequelize) => {
- /*
- Add reverting commands here.
- Return a promise to correctly handle asynchronicity.
-
- Example:
- return queryInterface.bulkDelete('People', null, {});
- */
+ down: async (queryInterface, Sequelize) => {
+ /**
+ * Add commands to revert seed here.
+ *
+ * Example:
+ * await queryInterface.bulkDelete('People', null, {});
+ */
  }
 };

src/commands/model_generate.js

@@ -30,7 +30,6 @@ exports.handler = function (args) {
  ensureMigrationsFolder();
  checkModelFileExistence(args);
 
-
  try {
  helpers.model.generateFile(args);
  } catch (err) {

src/core/migrator.js

@@ -1,6 +1,5 @@
 import Umzug from 'umzug';
 import _ from 'lodash';
-import { promisify } from 'util';
 import pTry from 'p-try';
 
 import helpers from '../helpers/index';
@@ -34,10 +33,7 @@ function getSequelizeInstance () {
 export function getMigrator (type, args) {
  return pTry(() => {
  if (!(helpers.config.configFileExists() || args.url)) {
- helpers.view.error(
- 'Cannot find "' + helpers.config.getConfigFile() +
- '". Have you run "sequelize init"?'
- );
+ helpers.view.error(`Cannot find "${helpers.config.getConfigFile()}". Have you run "sequelize init"?`);
  process.exit(1);
  }
 
@@ -49,14 +45,7 @@ export function getMigrator (type, args) {
  migrations: {
  params: [sequelize.getQueryInterface(), Sequelize],
  path: helpers.path.getPath(type),
- pattern: /\.c?js$/,
- wrap: fun => {
- if (fun.length === 3) {
- return promisify(fun);
- } else {
- return fun;
- }
- }
+ pattern: /\.c?js$/
  }
  });
 

src/sequelize.js

@@ -19,7 +19,7 @@ import helpers from './helpers/index';
 
 helpers.view.teaser();
 
-const cli = yargs
+yargs
  .help()
  .version()
  .command('db:migrate', 'Run pending migrations', migrate)
@@ -42,11 +42,7 @@ const cli = yargs
  .command(['model:generate', 'model:create'], 'Generates a model and its migration', modelGenerate)
  .command(['seed:generate', 'seed:create'], 'Generates a new seed file', seedGenerate)
  .wrap(yargs.terminalWidth())
- .strict();
-
-const args = cli.argv;
-
-// if no command then show help
-if (!args._[0]) {
- cli.showHelp();
-}
+ .demandCommand(1, 'Please specify a command')
+ .help()
+ .strict()
+ .argv;

test/db/migrate-json.test.js

@@ -111,8 +111,7 @@ const _ = require('lodash');
  done();
  });
  }, {
- migrationFile: 'new/*createPerson',
- config: { promisifyMigrations: false }
+ migrationFile: 'new/*createPerson'
  });
  });
  });

test/db/migrate.test.js

@@ -124,8 +124,7 @@ const _ = require('lodash');
  done();
  });
  }, {
- migrationFile: 'new/*createPerson',
- config: { promisifyMigrations: false }
+ migrationFile: 'new/*createPerson'
  });
  });
  });

test/migration/create.test.js

@@ -46,8 +46,8 @@ const gulp = require('gulp');
  .src(Support.resolveSupportPath('tmp', 'migrations'))
  .pipe(helpers.readFile('*-' + migrationFile))
  .pipe(helpers.expect(stdout => {
- expect(stdout).to.contain('up: (queryInterface, Sequelize) => {');
- expect(stdout).to.contain('down: (queryInterface, Sequelize) => {');
+ expect(stdout).to.contain('up: async (queryInterface, Sequelize) => {');
+ expect(stdout).to.contain('down: async (queryInterface, Sequelize) => {');
  }))
  .pipe(helpers.teardown(done));
  });

test/model/create.test.js

@@ -117,7 +117,7 @@ const _ = require('lodash');
  gulp
  .src(Support.resolveSupportPath('tmp', 'models'))
  .pipe(helpers.readFile('user.js'))
- .pipe(helpers.ensureContent('sequelize.define(\'User\''))
+ .pipe(helpers.ensureContent('class User extends Model {'))
  .pipe(helpers.ensureContent('first_name: DataTypes.STRING'))
  .pipe(helpers.ensureContent('last_name: DataTypes.STRING'))
  .pipe(helpers.ensureContent('bio: DataTypes.TEXT'))
@@ -160,7 +160,7 @@ const _ = require('lodash');
  gulp
  .src(Support.resolveSupportPath('tmp', 'migrations'))
  .pipe(helpers.readFile('*-create-user.js'))
- .pipe(helpers.ensureContent('return queryInterface'))
+ .pipe(helpers.ensureContent('await queryInterface'))
  .pipe(helpers.ensureContent('.createTable(\'Users\', {'))
  .pipe(helpers.ensureContent(
  'first_name: {\n type: Sequelize.STRING\n },'
@@ -209,9 +209,9 @@ const _ = require('lodash');
  attributes
  };
 
- const targetContent = attrUnd.underscored ?
- 'underscored: true'
- : '{});';
+ const targetContent = attrUnd.underscored
+ ? 'modelName: \'User\',\n underscored: true,\n });'
+ : 'modelName: \'User\',\n });';
 
  if ( attrUnd.underscored ) {
  flags.underscored = attrUnd.underscored;
@@ -224,7 +224,7 @@ const _ = require('lodash');
  .src(Support.resolveSupportPath('tmp', 'models'))
  .pipe(helpers.readFile('user.js'))
  .pipe(helpers.ensureContent(targetContent))
- .pipe(helpers.ensureContent('.associate'))
+ .pipe(helpers.ensureContent('static associate'))
  .pipe(helpers.teardown(done));
  });
  });

test/seed/create.test.js

@@ -48,8 +48,8 @@ const gulp = require('gulp');
  .src(Support.resolveSupportPath('tmp', 'seeders'))
  .pipe(helpers.readFile('*-' + seedFile))
  .pipe(helpers.expect(stdout => {
- expect(stdout).to.contain('up: (queryInterface, Sequelize) => {');
- expect(stdout).to.contain('down: (queryInterface, Sequelize) => {');
+ expect(stdout).to.contain('up: async (queryInterface, Sequelize) => {');
+ expect(stdout).to.contain('down: async (queryInterface, Sequelize) => {');
  }))
  .pipe(helpers.teardown(done));
  });

test/support/assets/migrations/20111117063700-createPerson.js

@@ -1,21 +1,18 @@
-'use strict';
-
-var nodeify = require('nodeify');
+"use strict";
 
 module.exports = {
- up: function (migration, DataTypes, done) {
- nodeify(migration
- .createTable('Person', {
- name: DataTypes.STRING,
- isBetaMember: {
- type: DataTypes.BOOLEAN,
- defaultValue: false,
- allowNull: false
- }
- }), done);
+ up: function (migration, DataTypes) {
+ return migration.createTable("Person", {
+ name: DataTypes.STRING,
+ isBetaMember: {
+ type: DataTypes.BOOLEAN,
+ defaultValue: false,
+ allowNull: false,
+ },
+ });
  },
 
- down: function (migration, DataTypes, done) {
- nodeify(migration.dropTable('Person'), done);
- }
+ down: function (migration, DataTypes) {
+ return migration.dropTable("Person");
+ },
 };