Migrate to v4 (#247)

Author: samchungy

README.md

@@ -30,7 +30,7 @@ Add the following configuration to your `.eslintrc` file
 ```js
 {
   "rules": {
-    "zod-openapi/require-openapi": "error"
+    "zod-openapi/require-meta": "error"
     "zod-openapi/require-comment": "error",
     "zod-openapi/prefer-zod-default": "warn",
   }
@@ -44,7 +44,7 @@ You may wish to use overrides as this plugin by default will assume that all Zod
     {
       "files": ["src/api-types/*.ts"],
       "rules": {
-        "zod-openapi/require-openapi": "error"
+        "zod-openapi/require-meta": "error"
       }
     }
   ]
@@ -54,13 +54,13 @@ You may wish to use overrides as this plugin by default will assume that all Zod
 
 🔧 This rule is automatically fixable by the [--fix CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-| Name                                                       | Description                                                                   | 🔧  |
-| ---------------------------------------------------------- | ----------------------------------------------------------------------------- | :-: |
-| [require-openapi](./docs/rules/require-openapi.md)         | Requires that all ZodTypes have an `.openapi()` method.                       |     |
-| [require-comment](./docs/rules/require-comment.md)         | Requires that all ZodTypes have a `description` and matching JSDoc comment.   | ✅  |
-| [require-example](./docs/rules/require-example.md)         | Requires that all ZodTypes have an `example` or `examples` field.             |     |
-| [prefer-openapi-last](./docs/rules/prefer-openapi-last.md) | Prefers that the `.openapi()` method be the last method in the ZodType chain. |     |
-| [prefer-zod-default](./docs/rules/prefer-zod-default.md)   | Provides an error when `default` in `.openapi()` is used                      |     |
+| Name                                                     | Description                                                                 | 🔧  |
+| -------------------------------------------------------- | --------------------------------------------------------------------------- | :-: |
+| [require-meta](./docs/rules/require-meta.md)             | Requires that all ZodTypes have an `.meta()` method.                        |     |
+| [require-comment](./docs/rules/require-comment.md)       | Requires that all ZodTypes have a `description` and matching JSDoc comment. | ✅  |
+| [require-example](./docs/rules/require-example.md)       | Requires that all ZodTypes have an `example` or `examples` field.           |     |
+| [prefer-meta-last](./docs/rules/prefer-meta-last.md)     | Prefers that the `.meta()` method be the last method in the ZodType chain.  |     |
+| [prefer-zod-default](./docs/rules/prefer-zod-default.md) | Provides an error when `default` in `.meta()` is used                       |     |
 
 ## Development
 

docs/rules/prefer-meta-last.md

@@ -0,0 +1,11 @@
+# Prefers that the `.meta()` method be the last method (`prefer-meta-last`)
+
+Prefers that the `.meta()` method be the last method in a Zod Schema chain. This is done mainly out of consistency but also because there are some methods that can override the `.meta()` method. eg. pick, omit
+
+A simple example
+
+```ts
+const NameSchema = z.string().meta({ example: 'Fred' }).length(5); // ❌ error
+
+const NameSchema = z.string().length(5).meta({ example: 'Fred' }); // ✅ correct
+```

docs/rules/prefer-openapi-last.md

@@ -1,10 +1,10 @@
-# Prefer `.default()` over `default` in `.openapi()` (`prefer-zod-default`)
+# Prefer `.default()` over `default` in `.meta()` (`prefer-zod-default`)
 
-Provides an error when `default` is used in `.openapi()` option. ZodDefault `.default()` should be used instead.
+Provides an error when `default` is used in `.meta()` option. ZodDefault `.default()` should be used instead.
 
 A simple example
 
 ```ts
-const NameSchema = z.string().openapi({ example: 'Fred', default: 'Fred' }); // ❌ error
-const NameSchema = z.string().default('Fred').openapi({ example: 'Fred' }); // ✅ correct
+const NameSchema = z.string().meta({ example: 'Fred', default: 'Fred' }); // ❌ error
+const NameSchema = z.string().default('Fred').meta({ example: 'Fred' }); // ✅ correct
 ```

docs/rules/prefer-zod-default.md

@@ -9,14 +9,14 @@ In order for your IDE to display descriptions in inferred types, it requires JSD
 A simple example
 
 ```ts
-const NameSchema = z.string().openapi({ example: 'Fred' }); // ❌ error (no description or comment)
+const NameSchema = z.string().meta({ example: 'Fred' }); // ❌ error (no description or comment)
 
 /**
  * A user's name
  **/
 const NameSchema = z
   .string()
-  .openapi({ description: "A user's name", example: 'Fred' }); // ✅ correct
+  .meta({ description: "A user's name", example: 'Fred' }); // ✅ correct
 ```
 
 This rule is also able to infer JSDoc comments from other variables and automatically copies the comments across where otherwise you would gain no type comments.
@@ -29,7 +29,7 @@ A more complex example:
  **/
 const NameSchema = z
   .string()
-  .openapi({ description: "A user's name", example: 'Fred', deprecated: true }); // ✅ correct
+  .meta({ description: "A user's name", example: 'Fred', deprecated: true }); // ✅ correct
 
 /**
  * Person
@@ -47,9 +47,9 @@ const PersonSchema = z
       .number()
       .positive()
       .int()
-      .openapi({ description: "A user's age", example: 12 }),
+      .meta({ description: "A user's age", example: 12 }),
   })
-  .openapi({ description: 'Person' });
+  .meta({ description: 'Person' });
 
 /**
  * Person

docs/rules/require-comment.md

@@ -1,6 +1,6 @@
 # Requires an `example` on Zod Types (`require-example`)
 
-Requires that the `.openapi()` method contains an `example`, `examples` key for Zod primatives. This makes our generated documentation much nicer. This includes:
+Requires that the `.meta()` method contains an `example`, `examples` key for Zod primatives. This makes our generated documentation much nicer. This includes:
 
 - ZodBoolean
 - ZodNumber
@@ -13,7 +13,7 @@ const UserIdSchema = z.string().uuid(); // ❌ error (no example)
 const UserIdSchema = z
   .string()
   .uuid()
-  .openapi({ example: '48948579-f117-47e4-bc05-12f28e7fdccd' }); // ✅ correct
+  .meta({ example: '48948579-f117-47e4-bc05-12f28e7fdccd' }); // ✅ correct
 ```
 
 ## Options

docs/rules/require-example.md

@@ -1,23 +1,23 @@
-# Require `.openapi()` on ZodTypes (`require-openapi`)
+# Require `.meta()` on ZodTypes (`require-meta`)
 
-Requires that all Zod schemas have an `.openapi()` method. In order for your generated documentation to appear nice, you need to provide metadata for your types.
+Requires that all Zod schemas have an `.meta()` method. In order for your generated documentation to appear nice, you need to provide metadata for your types.
 
 A simple example
 
 ```ts
 const NameSchema = z.string(); // ❌ error
-const NameSchema = z.string().openapi({ description: "A user's name" }); // ✅ correct
+const NameSchema = z.string().meta({ description: "A user's name" }); // ✅ correct
 ```
 
-This rule is best used in conjunction with the require-comment rule. To avoid costly traversal we use the Typescript compiler to check the type and also consider any referenced variable which has a JSDoc comment as having an `.openapi()` field.
+This rule is best used in conjunction with the require-comment rule. To avoid costly traversal we use the Typescript compiler to check the type and also consider any referenced variable which has a JSDoc comment as having an `.meta()` field.
 
 A complex example
 
 ```ts
 /**
  * A user's name
  **/
-const NameSchema = z.string().openapi({ description: "A user's name" });
+const NameSchema = z.string().meta({ description: "A user's name" });
 
 const IdSchema = z.string().uuid();
 
@@ -29,9 +29,9 @@ const OtherSchema = z
     /**
      * A user's age
      **/
-    age: z.number().openapi({ description: "A user's age" }),
+    age: z.number().meta({ description: "A user's age" }),
   })
-  .openapi({ description: 'Other Schema' });
+  .meta({ description: 'Other Schema' });
 
 const PersonSchema = z
   .object({
@@ -45,5 +45,5 @@ const PersonSchema = z
      **/
     age: OtherSchema.shape.age, // ✅ correct
   })
-  .openapi({ description: 'Person' });
+  .meta({ description: 'Person' });
 ```

docs/rules/require-openapi.md renamed to docs/rules/require-meta.md

@@ -38,8 +38,8 @@
     "@typescript-eslint/rule-tester": "^8.7.0",
     "skuba": "9.1.0",
     "typescript": "5.7.2",
-    "zod": "3.24.1",
-    "zod-openapi": "4.2.2"
+    "zod": "3.25.67",
+    "zod-openapi": "5.0.0-beta.3"
   },
   "packageManager": "pnpm@8.15.1",
   "engines": {

package.json

@@ -2,7 +2,7 @@ import { RuleTester } from '@typescript-eslint/rule-tester';
 
 import { setupHelpers } from '../../tests/helper';
 
-const ruleName = 'prefer-openapi-last';
+const ruleName = 'prefer-meta-last';
 
 const { test } = setupHelpers(ruleName);