joist-codegen 2.0.3-next.32 → 2.0.3-next.34

package/build/docs/parsing.test.js

@@ -0,0 +1,190 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const parsing_1 = require("./parsing");
+describe("parsing", () => {
+    describe("parseEntityJSDocs", () => {
+        it("extracts class-level JSDoc", () => {
+            const source = ["/** The Author entity. */", "export class Author extends AuthorCodegen {}"].join("\n");
+            const { classDoc } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(classDoc).toBe("The Author entity.");
+        });
+        it("extracts class-level JSDoc when no doc present", () => {
+            const source = "export class Author extends AuthorCodegen {}";
+            const { classDoc } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(classDoc).toBeUndefined();
+        });
+        it("extracts field JSDoc from class properties", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** The first name. */",
+                '  readonly firstName: string = "";',
+                '  lastName: string = "";',
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(members).toMatchObject([
+                { name: "firstName", kind: "property", doc: "The first name." },
+                { name: "lastName", kind: "property", doc: undefined },
+            ]);
+        });
+        it("extracts JSDoc from getters, setters, and methods", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** Getter doc. */",
+                '  get fullName(): string { return ""; }',
+                "  /** Setter doc. */",
+                "  set fullName(v: string) {}",
+                "  /** Method doc. */",
+                "  async doStuff(): Promise<void> {}",
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(members).toMatchObject([
+                { name: "fullName", kind: "getter", doc: "Getter doc." },
+                { name: "fullName", kind: "setter", doc: "Setter doc." },
+                { name: "doStuff", kind: "method", doc: "Method doc." },
+            ]);
+        });
+        it("handles multi-line JSDoc", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /**",
+                "   * Line one.",
+                "   * Line two.",
+                "   */",
+                '  readonly notes: string = "";',
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(members[0].doc).toBe("Line one.\nLine two.");
+        });
+    });
+    describe("buildJSDocEdit / applyEdits", () => {
+        it("does not produce trailing spaces on blank lines in multi-line docs", () => {
+            const source = ["export class Author extends AuthorCodegen {", '  readonly notes: string = "";', "}"].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const edit = (0, parsing_1.buildJSDocEdit)(members[0].node, "First paragraph.\n\nSecond paragraph.");
+            const output = (0, parsing_1.applyEdits)(source, [edit]);
+            for (const line of output.split("\n")) {
+                expect(line).toBe(line.trimEnd());
+            }
+            expect(output).toMatch(/\* First paragraph\.\n\s+\*\n\s+\* Second paragraph\./);
+        });
+        it("replaces an existing comment without reformatting other code", () => {
+            const source = [
+                "/** Old class doc. */",
+                "export class Foo {",
+                "  /** Old field doc. */",
+                '  readonly name: string = "";',
+                "}",
+            ].join("\n");
+            const { classNode, members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const edits = [(0, parsing_1.buildJSDocEdit)(classNode, "New class doc."), (0, parsing_1.buildJSDocEdit)(members[0].node, "New field doc.")];
+            const output = (0, parsing_1.applyEdits)(source, edits);
+            expect(output).toBe([
+                "/** New class doc. */",
+                "export class Foo {",
+                "  /** New field doc. */",
+                '  readonly name: string = "";',
+                "}",
+            ].join("\n"));
+        });
+        it("inserts a new comment where none existed", () => {
+            const source = ["export class Foo {", '  readonly name: string = "";', "}"].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const output = (0, parsing_1.applyEdits)(source, [(0, parsing_1.buildJSDocEdit)(members[0].node, "The name.")]);
+            expect(output).toBe(["export class Foo {", "  /** The name. */", '  readonly name: string = "";', "}"].join("\n"));
+        });
+        it("indents multi-line field docs to match the field's indentation", () => {
+            const source = [
+                "export class Invoice extends InvoiceCodegen {",
+                "  /** Old doc. */",
+                "  readonly pocInvoicedToDateInCents: number = 0;",
+                "}",
+            ].join("\n");
+            const { members } = (0, parsing_1.parseEntityJSDocs)(source);
+            const text = "Calculate the POC as of this invoice creation.\nFilter out Void and Rejected invoices.";
+            const output = (0, parsing_1.applyEdits)(source, [(0, parsing_1.buildJSDocEdit)(members[0].node, text)]);
+            expect(output).toBe([
+                "export class Invoice extends InvoiceCodegen {",
+                "  /**",
+                "   * Calculate the POC as of this invoice creation.",
+                "   * Filter out Void and Rejected invoices.",
+                "   */",
+                "  readonly pocInvoicedToDateInCents: number = 0;",
+                "}",
+            ].join("\n"));
+        });
+        it("preserves all original formatting when replacing docs", () => {
+            const source = [
+                "/** The entity. */",
+                "export class Author extends AuthorCodegen {",
+                "  readonly transientFields = {",
+                '    beforeFlushRan: { type: "boolean", default: false },',
+                '    beforeCreateRan: { type: "boolean", default: false },',
+                "  };",
+                "}",
+            ].join("\n");
+            const { classNode } = (0, parsing_1.parseEntityJSDocs)(source);
+            const output = (0, parsing_1.applyEdits)(source, [(0, parsing_1.buildJSDocEdit)(classNode, "Updated entity.")]);
+            expect(output).toBe([
+                "/** Updated entity. */",
+                "export class Author extends AuthorCodegen {",
+                "  readonly transientFields = {",
+                '    beforeFlushRan: { type: "boolean", default: false },',
+                '    beforeCreateRan: { type: "boolean", default: false },',
+                "  };",
+                "}",
+            ].join("\n"));
+        });
+    });
+    describe("fieldDocs", () => {
+        it("prefers getter doc over setter doc for same name", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** The full name. */",
+                '  get fullName(): string { return ""; }',
+                "  /** Set the full name. */",
+                "  set fullName(v: string) {}",
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ fullName: "The full name." });
+        });
+        it("uses setter doc when getter has no doc", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                '  get fullName(): string { return ""; }',
+                "  /** Set the full name. */",
+                "  set fullName(v: string) {}",
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ fullName: "Set the full name." });
+        });
+        it("skips members without docs", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** A doc. */",
+                '  readonly a: string = "";',
+                '  readonly b: string = "";',
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ a: "A doc." });
+        });
+        it("skips methods", () => {
+            const source = [
+                "export class Author extends AuthorCodegen {",
+                "  /** The first name. */",
+                '  readonly firstName: string = "";',
+                "  /** Text representation. */",
+                "  async toDetailString(): Promise<string> { return ''; }",
+                "}",
+            ].join("\n");
+            const { fieldDocs } = (0, parsing_1.parseEntityJSDocs)(source);
+            expect(fieldDocs).toEqual({ firstName: "The first name." });
+        });
+    });
+});
+//# sourceMappingURL=parsing.test.js.map

package/build/docs/parsing.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsing.test.js","sourceRoot":"","sources":["../../src/docs/parsing.test.ts"],"names":[],"mappings":";;AAAA,uCAA0E;AAE1E,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG,CAAC,2BAA2B,EAAE,8CAA8C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxG,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,MAAM,GAAG,8CAA8C,CAAC;YAC9D,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,0BAA0B;gBAC1B,oCAAoC;gBACpC,0BAA0B;gBAC1B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC5B,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,iBAAiB,EAAE;gBAC/D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE;aACvD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,sBAAsB;gBACtB,yCAAyC;gBACzC,sBAAsB;gBACtB,8BAA8B;gBAC9B,sBAAsB;gBACtB,qCAAqC;gBACrC,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC5B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;gBACxD,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;gBACxD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;aACxD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,OAAO;gBACP,gBAAgB;gBAChB,gBAAgB;gBAChB,OAAO;gBACP,gCAAgC;gBAChC,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QAC3C,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;YAC5E,MAAM,MAAM,GAAG,CAAC,6CAA6C,EAAE,gCAAgC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjH,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,uCAAuC,CAAC,CAAC;YACtF,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,uDAAuD,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,MAAM,MAAM,GAAG;gBACb,uBAAuB;gBACvB,oBAAoB;gBACpB,yBAAyB;gBACzB,+BAA+B;gBAC/B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YACzD,MAAM,KAAK,GAAG,CAAC,IAAA,wBAAc,EAAC,SAAU,EAAE,gBAAgB,CAAC,EAAE,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;YAChH,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB;gBACE,uBAAuB;gBACvB,oBAAoB;gBACpB,yBAAyB;gBACzB,+BAA+B;gBAC/B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,MAAM,GAAG,CAAC,oBAAoB,EAAE,+BAA+B,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;YAClF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,+BAA+B,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9F,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,MAAM,GAAG;gBACb,+CAA+C;gBAC/C,mBAAmB;gBACnB,kDAAkD;gBAClD,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,wFAAwF,CAAC;YACtG,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB;gBACE,+CAA+C;gBAC/C,OAAO;gBACP,qDAAqD;gBACrD,6CAA6C;gBAC7C,OAAO;gBACP,kDAAkD;gBAClD,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,MAAM,GAAG;gBACb,oBAAoB;gBACpB,6CAA6C;gBAC7C,gCAAgC;gBAChC,0DAA0D;gBAC1D,2DAA2D;gBAC3D,MAAM;gBACN,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,IAAA,oBAAU,EAAC,MAAM,EAAE,CAAC,IAAA,wBAAc,EAAC,SAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;YACnF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB;gBACE,wBAAwB;gBACxB,6CAA6C;gBAC7C,gCAAgC;gBAChC,0DAA0D;gBAC1D,2DAA2D;gBAC3D,MAAM;gBACN,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,yBAAyB;gBACzB,yCAAyC;gBACzC,6BAA6B;gBAC7B,8BAA8B;gBAC9B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,yCAAyC;gBACzC,6BAA6B;gBAC7B,8BAA8B;gBAC9B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,iBAAiB;gBACjB,4BAA4B;gBAC5B,4BAA4B;gBAC5B,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,MAAM,MAAM,GAAG;gBACb,6CAA6C;gBAC7C,0BAA0B;gBAC1B,oCAAoC;gBACpC,+BAA+B;gBAC/B,0DAA0D;gBAC1D,GAAG;aACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,WAAW,EAAY,MAAM,SAAS,CAAC;AAStD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAI7C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D;AAED,uFAAuF;AACvF,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAsH9F"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,WAAW,EAAY,MAAM,SAAS,CAAC;AAStD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAK7C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D;AAED,uFAAuF;AACvF,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAgI9F"}

package/build/generate.js

@@ -13,6 +13,7 @@ const generateMetadataFile_1 = require("./generateMetadataFile");
 const generatePgEnumFile_1 = require("./generatePgEnumFile");
 const symbols_1 = require("./symbols");
 const utils_1 = require("./utils");
+const docs_1 = require("./docs");
 /** Generates our `${Entity}` and `${Entity}Codegen` files based on the `db` schema. */
 async function generateFiles(config, dbMeta) {
     const { entities, enums, pgEnums } = dbMeta;
@@ -20,6 +21,11 @@ async function generateFiles(config, dbMeta) {
     // skip making test files except for the _first_ time we create an entity. This achieves
     // `.history`-like "create once" behavior without the need for the `.history` file.
     const files = await readExistingFiles(config);
+    // Sync documentation: backfill .md from existing JSDocs, then sync MD -> JSDoc
+    if (config.docs) {
+        const entityNames = entities.map((meta) => meta.entity.name);
+        await (0, docs_1.syncDocs)(config.entitiesDirectory, entityNames);
+    }
     const entityFiles = entities
         .map((meta) => {
         const entityName = meta.entity.name;
@@ -107,6 +113,8 @@ async function generateFiles(config, dbMeta) {
         const plugin = require(p);
         return plugin.run(config, dbMeta);
     }))).flat();
+    // Generate metadata-docs.ts if enabled
+    const docsFile = config.outputDocs ? await (0, docs_1.generateMetadataDocsFile)(config, dbMeta) : undefined;
     return [
         ...entityFiles,
         ...enumFiles,
@@ -114,6 +122,7 @@ async function generateFiles(config, dbMeta) {
         entitiesFile,
         ...factoriesFiles,
         metadataFile,
+        ...(docsFile ? [docsFile] : []),
         indexFile,
         ...pluginFiles,
     ];

package/build/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":";;AAwBA,sCAsHC;AA9ID,0CAAsC;AACtC,qCAAsD;AACtD,iEAA8D;AAC9D,2EAAmF;AACnF,6DAA0D;AAC1D,qEAAkE;AAClE,yDAAsD;AACtD,qEAAkE;AAClE,iEAA8D;AAC9D,6DAA0D;AAE1D,uCAA4F;AAC5F,mCAAmD;AAWnD,uFAAuF;AAChF,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAkB;IACpE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAE5C,2FAA2F;IAC3F,wFAAwF;IACxF,mFAAmF;IACnF,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE9C,MAAM,WAAW,GAAG,QAAQ;SACzB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpC,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,KAAK,CAAC,CAAC;QACzD,OAAO;YACL;gBACE,IAAI,EAAE,aAAa,UAAU,YAAY;gBACzC,QAAQ,EAAE,IAAA,qDAAyB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;gBACzD,SAAS,EAAE,IAAI;aAChB;YACD,GAAG,CAAC,aAAa;gBACf,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC;oBACE,EAAE,IAAI,EAAE,GAAG,UAAU,KAAK,EAAE,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;oBAC1F,EAAE,IAAI,EAAE,GAAG,UAAU,UAAU,EAAE,QAAQ,EAAE,IAAA,+CAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;iBACpG,CAAC;SACP,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACnC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,KAAK;gBAC9B,QAAQ,EAAE,IAAA,mCAAgB,EAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;gBACtD,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IACrB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACvC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,CAAC,IAAI,KAAK;gBACnC,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,QAAQ,CAAC;gBAC9C,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAExF,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,IAAA,cAAI,EAAA;QACV,0BAAgB;oBACJ,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO;;;qBAGhH,IAAA,aAAG,EAAC,eAAe,CAAC,YAAY,4BAAkB,IAAI,WAAW,aAAa,OAAO;;yBAEjF,IAAA,aAAG,EAAC,QAAQ,CAAC,YAAY,gBAAM;cAC1C,IAAA,qCAAS,EAAC,MAAM,CAAC;;;;QAIvB,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2CAAoB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;;oCAEtC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACnF,2BAAiB;KACpB;QACD,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE;KACpD,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACrC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,IAAA,2CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrF,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,+BAA+B,EAAE,UAAU,EAAE,EAAE;KACjF,CAAC;IAEF,MAAM,cAAc,GAAkB,IAAA,+CAAsB,EAAC,QAAQ,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrF,MAAM,SAAS,GAAgB;QAC7B,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAA,cAAI,EAAA,4BAA4B,MAAM,GAAG;QACnD,SAAS,EAAE,KAAK;KACjB,CAAC;IAEF,kFAAkF;IAClF,MAAM,WAAW,GAAkB,CACjC,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAkB,CAAC;QAC3C,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CACH,CACF,CAAC,IAAI,EAAE,CAAC;IAET,OAAO;QACL,GAAG,WAAW;QACd,GAAG,SAAS;QACZ,GAAG,WAAW;QACd,YAAY;QACZ,GAAG,cAAc;QACjB,YAAY;QACZ,SAAS;QACT,GAAG,WAAW;KACf,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,KAAK,UAAU,iBAAiB,CAAC,MAAc;IAC7C,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,kBAAO,EAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":";;AAyBA,sCAgIC;AAzJD,0CAAsC;AACtC,qCAAsD;AACtD,iEAA8D;AAC9D,2EAAmF;AACnF,6DAA0D;AAC1D,qEAAkE;AAClE,yDAAsD;AACtD,qEAAkE;AAClE,iEAA8D;AAC9D,6DAA0D;AAE1D,uCAA4F;AAC5F,mCAAmD;AACnD,iCAA4D;AAW5D,uFAAuF;AAChF,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,MAAkB;IACpE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAE5C,2FAA2F;IAC3F,wFAAwF;IACxF,mFAAmF;IACnF,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE9C,+EAA+E;IAC/E,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,IAAA,eAAQ,EAAC,MAAM,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ;SACzB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpC,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,KAAK,CAAC,CAAC;QACzD,OAAO;YACL;gBACE,IAAI,EAAE,aAAa,UAAU,YAAY;gBACzC,QAAQ,EAAE,IAAA,qDAAyB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;gBACzD,SAAS,EAAE,IAAI;aAChB;YACD,GAAG,CAAC,aAAa;gBACf,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC;oBACE,EAAE,IAAI,EAAE,GAAG,UAAU,KAAK,EAAE,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;oBAC1F,EAAE,IAAI,EAAE,GAAG,UAAU,UAAU,EAAE,QAAQ,EAAE,IAAA,+CAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;iBACpG,CAAC;SACP,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACnC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,KAAK;gBAC9B,QAAQ,EAAE,IAAA,mCAAgB,EAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;gBACtD,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IACrB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACvC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,OAAO;YACL;gBACE,IAAI,EAAE,WAAW,QAAQ,CAAC,IAAI,KAAK;gBACnC,QAAQ,EAAE,IAAA,uCAAkB,EAAC,MAAM,EAAE,QAAQ,CAAC;gBAC9C,SAAS,EAAE,IAAI;aAChB;SACF,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,aAAK,EAAE,EAAE,CAAC,CAAC;IAErB,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAExF,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,IAAA,cAAI,EAAA;QACV,0BAAgB;oBACJ,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO;;;qBAGhH,IAAA,aAAG,EAAC,eAAe,CAAC,YAAY,4BAAkB,IAAI,WAAW,aAAa,OAAO;;yBAEjF,IAAA,aAAG,EAAC,QAAQ,CAAC,YAAY,gBAAM;cAC1C,IAAA,qCAAS,EAAC,MAAM,CAAC;;;;QAIvB,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2CAAoB,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;;oCAEtC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACnF,2BAAiB;KACpB;QACD,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE;KACpD,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;SACrC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,MAAM,YAAY,GAAgB;QAChC,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,IAAA,2CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrF,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE,aAAa,EAAE,EAAE,+BAA+B,EAAE,UAAU,EAAE,EAAE;KACjF,CAAC;IAEF,MAAM,cAAc,GAAkB,IAAA,+CAAsB,EAAC,QAAQ,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrF,MAAM,SAAS,GAAgB;QAC7B,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAA,cAAI,EAAA,4BAA4B,MAAM,GAAG;QACnD,SAAS,EAAE,KAAK;KACjB,CAAC;IAEF,kFAAkF;IAClF,MAAM,WAAW,GAAkB,CACjC,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAkB,CAAC;QAC3C,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CACH,CACF,CAAC,IAAI,EAAE,CAAC;IAET,uCAAuC;IACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,IAAA,+BAAwB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEhG,OAAO;QACL,GAAG,WAAW;QACd,GAAG,SAAS;QACZ,GAAG,WAAW;QACd,YAAY;QACZ,GAAG,cAAc;QACjB,YAAY;QACZ,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,SAAS;QACT,GAAG,WAAW;KACf,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,KAAK,UAAU,iBAAiB,CAAC,MAAc;IAC7C,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,kBAAO,EAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joist-codegen",
-  "version": "2.0.3-next.32",
+  "version": "2.0.3-next.34",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -17,7 +17,7 @@
     "build"
   ],
   "peerDependencies": {
-    "joist-utils": "2.0.3-next.32",
+    "joist-utils": "2.0.3-next.34",
     "knex": "^3.1.0",
     "pg": "^8.16.3"
   },