Append an underscore if model name is a reserved word (#562, #570)

Remove 'esmd' lang option and standardize 'useDefine' behavior

Author: steveschmitt

package.json

@@ -73,6 +73,7 @@
     "@types/chai": "^4.2.17",
     "@types/lodash": "^4.14.168",
     "@types/mocha": "^8.2.2",
+    "@types/reserved-words": "0.1.0",
     "chai": "^4.3.4",
     "coveralls": "^3.1.0",
     "crlf": "^1.1.1",
@@ -87,6 +88,7 @@
     "nyc": "^15.1.0",
     "pg": "^8.5.1",
     "pg-hstore": "^2.3.3",
+    "reserved-words": "^0.1.2",
     "rimraf": "^3.0.2",
     "sequelize": "^6.11",
     "sqlite3": "5.0.2",

src/auto-generator.ts

@@ -1,7 +1,7 @@
 import _ from "lodash";
 import { ColumnDescription } from "sequelize/types";
 import { DialectOptions, FKSpec } from "./dialects/dialect-options";
-import { AutoOptions, CaseFileOption, CaseOption, Field, IndexSpec, LangOption, pluralize, qNameJoin, qNameSplit, recase, Relation, singularize, TableData, TSField } from "./types";
+import { AutoOptions, CaseFileOption, CaseOption, Field, IndexSpec, LangOption, makeTableName, pluralize, qNameJoin, qNameSplit, recase, Relation, singularize, TableData, TSField } from "./types";
 
 /** Generates text from each table in TableData */
 export class AutoGenerator {
@@ -69,12 +69,11 @@ export class AutoGenerator {
     } else if (this.options.lang === 'esm') {
       header += "import _sequelize from 'sequelize';\n";
       header += "const { Model, Sequelize } = _sequelize;\n\n";
+      header += "export default class #TABLE# extends Model {\n";
+      header += sp + "static init(sequelize, DataTypes) {\n";
       if (this.options.useDefine) {
-        header += "export default function(sequelize, DataTypes) {\n";
         header += sp + "return sequelize.define('#TABLE#', {\n";
       } else {
-        header += "export default class #TABLE# extends Model {\n";
-        header += sp + "static init(sequelize, DataTypes) {\n";
         header += sp + "return super.init({\n";
       }
     } else {
@@ -94,7 +93,7 @@ export class AutoGenerator {
     tableNames.forEach(table => {
       let str = header;
       const [schemaName, tableNameOrig] = qNameSplit(table);
-      const tableName = recase(this.options.caseModel, tableNameOrig, this.options.singularize);
+      const tableName = makeTableName(this.options.caseModel, tableNameOrig, this.options.singularize, this.options.lang);
 
       if (this.options.lang === 'ts') {
         const associations = this.addTypeScriptAssociationMixins(table);
@@ -173,7 +172,6 @@ export class AutoGenerator {
   private addTable(table: string) {
 
     const [schemaName, tableNameOrig] = qNameSplit(table);
-    const tableName = recase(this.options.caseModel, tableNameOrig, this.options.singularize);
     const space = this.space;
     let timestamps = (this.options.additional && this.options.additional.timestamps === true) || false;
     let paranoid = (this.options.additional && this.options.additional.paranoid === true) || false;

src/auto-writer.ts

@@ -3,7 +3,7 @@ import _ from "lodash";
 import path from "path";
 import util from "util";
 import { FKSpec, TableData } from ".";
-import { AutoOptions, CaseFileOption, CaseOption, LangOption, pluralize, qNameSplit, recase, Relation } from "./types";
+import { AutoOptions, CaseFileOption, CaseOption, LangOption, makeTableName, pluralize, qNameSplit, recase, Relation } from "./types";
 const mkdirp = require('mkdirp');
 
 /** Writes text into files from TableData.text, and writes init-models */
@@ -72,8 +72,6 @@ export class AutoWriter {
         return this.createTsInitString(tableNames, assoc);
       case 'esm':
         return this.createESMInitString(tableNames, assoc);
-      case 'esmd':
-          return this.createESMDInitString(tableNames, assoc);
       case 'es6':
           return this.createES5InitString(tableNames, assoc, "const");
       default:
@@ -127,7 +125,7 @@ export class AutoWriter {
     // import statements
     tables.forEach(t => {
       const fileName = recase(this.options.caseFile, t, this.options.singularize);
-      const modelName = recase(this.options.caseModel, t, this.options.singularize);
+      const modelName = makeTableName(this.options.caseModel, t, this.options.singularize, this.options.lang);
       modelNames.push(modelName);
       str += `import { ${modelName} as _${modelName} } from "./${fileName}";\n`;
       str += `import type { ${modelName}Attributes, ${modelName}CreationAttributes } from "./${fileName}";\n`;
@@ -174,7 +172,7 @@ export class AutoWriter {
     // import statements
     tables.forEach(t => {
       const fileName = recase(this.options.caseFile, t, this.options.singularize);
-      const modelName = recase(this.options.caseModel, t, this.options.singularize);
+      const modelName = makeTableName(this.options.caseModel, t, this.options.singularize, this.options.lang);
       modelNames.push(modelName);
       str += `${vardef} _${modelName} = require("./${fileName}");\n`;
     });
@@ -200,34 +198,7 @@ export class AutoWriter {
     str += 'module.exports.default = initModels;\n';
     return str;
   }
-  // create the ES6 init-models file to load all the models (with define-syntax instead of classes) into Sequelize
-  createESMDInitString(tables: string[], assoc: string) {
-    let str = 'import _sequelize from "sequelize";\n';
-    str += 'const DataTypes = _sequelize.DataTypes;\n';
-    const modelNames: string[] = [];
-    // import statements
-    tables.forEach(t => {
-      const fileName = recase(this.options.caseFile, t, this.options.singularize);
-      const modelName = recase(this.options.caseModel, t, this.options.singularize);
-      modelNames.push(modelName);
-      str += `import _${modelName} from  "./${fileName}.js";\n`;
-    });
-    // create the initialization function
-    str += '\nexport default function initModels(sequelize) {\n';
-    modelNames.forEach(m => {
-        str += `  const ${m} = _${m}(sequelize, DataTypes);\n`;
-    });
-    // add the asociations
-    str += "\n" + assoc;
-    // return the models
-    str += "\n  return {\n";
-    modelNames.forEach(m => {
-        str += `    ${m},\n`;
-    });
-    str += '  };\n';
-    str += '}\n';
-    return str;
-  }
+
   // create the ESM init-models file to load all the models into Sequelize
   private createESMInitString(tables: string[], assoc: string) {
     let str = 'import _sequelize from "sequelize";\n';
@@ -236,18 +207,17 @@ export class AutoWriter {
     // import statements
     tables.forEach(t => {
       const fileName = recase(this.options.caseFile, t, this.options.singularize);
-      const modelName = recase(this.options.caseModel, t, this.options.singularize);
+      const modelName = makeTableName(this.options.caseModel, t, this.options.singularize, this.options.lang);
       modelNames.push(modelName);
       str += `import _${modelName} from  "./${fileName}.js";\n`;
     });
-
     // create the initialization function
     str += '\nexport default function initModels(sequelize) {\n';
     modelNames.forEach(m => {
       str += `  const ${m} = _${m}.init(sequelize, DataTypes);\n`;
     });
 
-    // add the asociations
+    // add the associations
     str += "\n" + assoc;
 
     // return the models

src/types.ts

@@ -1,4 +1,5 @@
 import _ from "lodash";
+import { check as isReserved } from "reserved-words";
 import { Utils } from "sequelize";
 import { ColumnDescription, Dialect } from "sequelize/types";
 import { FKSpec } from "./dialects/dialect-options";
@@ -107,7 +108,7 @@ export function qNameJoin(schema: string | undefined, table: string | undefined)
 }
 
 /** Language of output model files */
-export declare type LangOption = "es5" | "es6" | "esm" | "ts" | "esmd";
+export declare type LangOption = "es5" | "es6" | "esm" | "ts";
 
 /** "c" camelCase |
  * "l" lower_case |
@@ -180,7 +181,7 @@ export interface AutoOptions {
   views?: boolean;
   /** Primary Key Suffixes to trim (default "id") */
   pkSuffixes?: string[];
-  /** Use `sequelize.define` instead of `init` for model initialization */
+  /** Use `sequelize.define` instead of `init` for model initialization.  See issues #527, #559, #573 */
   useDefine: boolean;
 }
 
@@ -227,3 +228,12 @@ export function recase(opt: CaseOption | CaseFileOption | undefined, val: string
   return val;
 }
 
+const tsNames = ["DataTypes", "Model", "Optional", "Sequelize"];
+export function makeTableName(opt: CaseOption | undefined, tableNameOrig: string | null, singular = false, lang = "es5") {
+  let name = recase(opt, tableNameOrig, singular);
+  if (isReserved(name) || (lang == "ts" && tsNames.includes(name))) {
+    name += "_";
+  }
+  return name;
+}
+