Add support to inject raw content

Author: lorefnon

src/generator-options.ts

@@ -271,6 +271,16 @@ export const CommonOptionsSchema = z.object({
 
 export interface CommonOptions extends z.TypeOf<typeof CommonOptionsSchema> {}
 
+export const RawContentSchema = z.object({
+    /** Raw content injected before generated code in each file */
+    before: z.string().nullish(),
+
+    /** Raw content injected after generated code in each file */
+    after: z.string().nullish()
+});
+
+export interface RawContent extends z.TypeOf<typeof RawContentSchema> {}
+
 export const GeneratorOptsSchema = z.object({
     /** Simulate the generation and print the outcome without actually modifying any files */
     dryRun: z.boolean().nullish(),
@@ -356,7 +366,15 @@ export const GeneratorOptsSchema = z.object({
         'never',
         'interactively',
         'all'
-    ]).nullish()
+    ]).nullish(),
+
+    /**
+     * Support injection of raw content in the generated files.
+     * This is useful for adding things like eslint-ignore, additional exports etc.
+     *
+     * @see RawContent
+     */
+    rawContent: RawContentSchema.nullish(),
 });
 
 /**

src/generator.ts

@@ -406,7 +406,14 @@ export class Generator {
   }
 
   protected async postProcessOutput(output: string, _table: Table) {
-    return output;
+    const sections = [output];
+    if (this.opts.rawContent?.before) {
+      sections.unshift(this.opts.rawContent.before)
+    }
+    if (this.opts.rawContent?.after) {
+      sections.push(this.opts.rawContent.after)
+    }
+    return sections.join('\n');
   }
 
   protected getClassNameFromTableName(tableName: string, tableKind: TableKind) {
@@ -586,4 +593,4 @@ export class Generator {
 }
 
 
-type TableKind = "Table" | "View"
+type TableKind = "Table" | "View"

test/__snapshots__/Generator/supports-injection-of-raw-content-in-generated-files.expected.txt

@@ -0,0 +1,26 @@
+// AuthorsTable.ts :
+/* eslint-disable */
+/**
+ * DO NOT EDIT:
+ *
+ * This file has been auto-generated from database schema using ts-sql-codegen.
+ * Any changes will be overwritten.
+ */
+import { Table } from "ts-sql-query/Table";
+import type { DBConnection } from "../helpers/connection-source";
+
+export class AuthorsTable extends Table<DBConnection, 'AuthorsTable'> {
+    id = this.primaryKey('id', 'int');
+    name = this.optionalColumn('name', 'string');
+    dob = this.optionalColumn('dob', 'localDate');
+    createdAt = this.columnWithDefaultValue('created_at', 'localDateTime');
+    updatedAt = this.columnWithDefaultValue('updated_at', 'localDateTime');
+
+    constructor() {
+        super('authors')
+    }
+}
+
+
+
+/* Generated on: 2020-10-10 */

test/test.ts

@@ -525,6 +525,23 @@ describe("Generator", function () {
     await generator.generate();
     await snap(await readAllGenerated());
   })
+
+  it("supports injection of raw content in generated files", async () => {
+    const generator = new Generator({
+      schemaPath,
+      connectionSourcePath,
+      outputDirPath,
+      tables: {
+        include: ["authors"],
+      },
+      rawContent: {
+        before: `/* eslint-disable */`,
+        after: `/* Generated on: 2020-10-10 */`
+      }
+    });
+    await generator.generate();
+    await snap(await readAllGenerated());
+  })
 });
 
 const readAllGenerated = async () => {