diff --git a/.changeset/thin-dots-approve.md b/.changeset/thin-dots-approve.md new file mode 100644 index 0000000..18fb913 --- /dev/null +++ b/.changeset/thin-dots-approve.md @@ -0,0 +1,5 @@ +--- +'eslint-plugin-zod-x': patch +--- + +fix(schema-error-property-style): correct typos in schema property descriptions diff --git a/docs/rules/schema-error-property-style.md b/docs/rules/schema-error-property-style.md index c23364e..b6c4a16 100644 --- a/docs/rules/schema-error-property-style.md +++ b/docs/rules/schema-error-property-style.md @@ -6,10 +6,10 @@ -| Name | Description | Type | -| :--------- | :--------------------------------------------------------- | :----- | -| `example` | Example code to help user understands the required pattern | String | -| `selector` | A ESQuery string to match the required pattern | String | +| Name | Description | Type | +| :--------- | :------------------------------------------------------------ | :----- | +| `example` | Example code to help the user understand the required pattern | String | +| `selector` | An ESQuery string to match the required pattern | String | diff --git a/src/rules/schema-error-property-style.ts b/src/rules/schema-error-property-style.ts index d723d2d..d36b58b 100644 --- a/src/rules/schema-error-property-style.ts +++ b/src/rules/schema-error-property-style.ts @@ -27,12 +27,12 @@ export const schemaErrorPropertyStyle = ESLintUtils.RuleCreator(getRuleURL)< type: 'object', properties: { selector: { - description: 'A ESQuery string to match the required pattern', + description: 'An ESQuery string to match the required pattern', type: 'string', }, example: { description: - 'Example code to help user understands the required pattern', + 'Example code to help the user understand the required pattern', type: 'string', }, },