Skip to content

fix(schema-error-property-style): correct typos in schema property descriptions #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcalexiei merged 4 commits into from
Dec 30, 2025
Merged

fix(schema-error-property-style): correct typos in schema property descriptions #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd666f9
fix(docs): fix typos
ShayanTheNerd Dec 30, 2025
2c0a2e4
chore: add changeset
marcalexiei Dec 30, 2025
9c760d8
chore: correct format
marcalexiei Dec 30, 2025
d1dcdbe
fix: update docs
marcalexiei Dec 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/thin-dots-approve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'eslint-plugin-zod-x': patch
---

fix(schema-error-property-style): correct typos in schema property descriptions
8 changes: 4 additions & 4 deletions docs/rules/schema-error-property-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

<!-- begin auto-generated rule options list -->

| 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 |

<!-- end auto-generated rule options list -->

Expand Down
4 changes: 2 additions & 2 deletions src/rules/schema-error-property-style.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
},
},
Expand Down