feat: Add skipParseJSDoc option (#62)

* Update oclif * Add `skipParseJSDoc` option * Fix jest snapshot generation * Test generation without jsDoc * Add unit test on validateGeneratedTypes * Fix default value
fabien0102 · Dec 3, 2021 · e48c5fe · e48c5fe
1 parent 1d9d8c4
commit e48c5fe
Show file tree

Hide file tree

Showing 11 changed files with 1,114 additions and 1,695 deletions.
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@oclif/command": "^1.8.4",
+    "@oclif/command": "^1.8.6",
     "@oclif/config": "^1.17.1",
     "@oclif/plugin-help": "^3.2.7",
     "@typescript/vfs": "^1.3.5",
@@ -49,7 +49,7 @@
     "lodash": "^4.17.21",
     "lz-string": "^1.4.4",
     "ora": "^5.4.0",
-    "prettier": "^2.5.0",
+    "prettier": "2.2.1",
     "rxjs": "^7.4.0",
     "slash": "^3.0.0",
     "threads": "^1.7.0",
@@ -74,10 +74,10 @@
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "husky": "^5.2.0",
-    "jest": "^26.6.3",
+    "jest": "^27.4.3",
     "pretty-quick": "^3.1.0",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.5.3",
+    "ts-jest": "^27.0.7",
     "ts-node": "^9.1.1"
   },
   "jest": {

diff --git a/src/cli.ts b/src/cli.ts
@@ -80,6 +80,10 @@ class TsToZod extends Command {
       char: "i",
       description: "Create a ts-to-zod.config.js file",
     }),
+    skipParseJSDoc: flags.boolean({
+      default: false,
+      description: "Skip the creation of zod validators from JSDoc annotations",
+    }),
     skipValidation: flags.boolean({
       default: false,
       description: "Skip the validation step (not recommended)",
@@ -240,6 +244,9 @@ See more help with --help`,
     if (typeof flags.keepComments === "boolean") {
       generateOptions.keepComments = flags.keepComments;
     }
+    if (typeof flags.skipParseJSDoc === "boolean") {
+      generateOptions.skipParseJSDoc = flags.skipParseJSDoc;
+    }
 
     const {
       errors,
@@ -275,6 +282,7 @@ See more help with --help`,
           sourceText: getZodSchemasFile("./source"),
           relativePath: "./source.zod.ts",
         },
+        skipParseJSDoc: Boolean(generateOptions.skipParseJSDoc),
       });
 
       generationErrors.length

diff --git a/src/config.ts b/src/config.ts
@@ -37,6 +37,13 @@ export type Config = {
    * @default false
    */
   keepComments?: boolean;
+
+  /**
+   * Skip the creation of zod validators from JSDoc annotations
+   *
+   * @default false
+   */
+  skipParseJSDoc?: boolean;
 };
 
 export type Configs = Array<

diff --git a/src/config.zod.ts b/src/config.zod.ts
@@ -19,6 +19,7 @@ export const configSchema = z.object({
   nameFilter: nameFilterSchema.optional(),
   getSchemaName: getSchemaNameSchema.optional(),
   keepComments: z.boolean().optional().default(false),
+  skipParseJSDoc: z.boolean().optional().default(false),
 });
 
 export const configsSchema = z.array(

diff --git a/src/core/generate.ts b/src/core/generate.ts
@@ -32,6 +32,13 @@ export interface GenerateProps {
    * @default false
    */
   keepComments?: boolean;
+
+  /**
+   * Skip the creation of zod validators from JSDoc annotations
+   *
+   * @default false
+   */
+  skipParseJSDoc?: boolean;
 }
 
 /**
@@ -45,6 +52,7 @@ export function generate({
   nameFilter = () => true,
   getSchemaName = (id) => camel(id) + "Schema",
   keepComments = false,
+  skipParseJSDoc = false,
 }: GenerateProps) {
   // Create a source file and deal with modules
   const sourceFile = resolveModules(sourceText);
@@ -77,6 +85,7 @@ export function generate({
       sourceFile,
       varName,
       getDependencyName: getSchemaName,
+      skipParseJSDoc,
     });
 
     return { typeName, varName, ...zodSchema };

diff --git a/src/core/generateZodSchema.test.ts b/src/core/generateZodSchema.test.ts
@@ -807,6 +807,28 @@ describe("generateZodSchema", () => {
       `"export const theLastTestSchema = zod.literal(true);"`
     );
   });
+
+  it("should not generate any zod validation if `skipParseJSDoc` is `true`", () => {
+    const source = `export interface A {
+      /** @minimum 0 */
+      a: number | null;
+      /** @minLength 1 */
+      b: string | null;
+      /** @pattern ^c$ */
+      c: string | null;
+    }`;
+
+    expect(generate(source, "z", true)).toMatchInlineSnapshot(`
+      "export const aSchema = z.object({
+          /** @minimum 0 */
+          a: z.number().nullable(),
+          /** @minLength 1 */
+          b: z.string().nullable(),
+          /** @pattern ^c$ */
+          c: z.string().nullable()
+      });"
+    `);
+  });
 });
 
 /**
@@ -815,7 +837,7 @@ describe("generateZodSchema", () => {
  * @param sourceText Typescript interface or type
  * @returns Generated Zod schema
  */
-function generate(sourceText: string, z?: string) {
+function generate(sourceText: string, z?: string, skipParseJSDoc?: boolean) {
   const sourceFile = ts.createSourceFile(
     "index.ts",
     sourceText,
@@ -844,6 +866,7 @@ function generate(sourceText: string, z?: string) {
     node: declaration,
     sourceFile,
     varName: zodConstName,
+    skipParseJSDoc,
   });
   return ts
     .createPrinter({ newLine: ts.NewLineKind.LineFeed })