Skip to content

Commit 66fc49c

Browse files
committed
fix: correct typos in documentation and changelog entries
1 parent 8bdae79 commit 66fc49c

File tree

14 files changed

+15
-15
lines changed

14 files changed

+15
-15
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ function useAuth() {
183183
### 🐞 Fixes
184184

185185
- fix(plugins/web-api): add 'forEach' support to 'no-leaked-event-listener', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/867>
186-
- fix(plugins/web-api): add 'for of' support to 'no-leaked-event-listenner', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/869>
186+
- fix(plugins/web-api): add 'for of' support to 'no-leaked-event-listener', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/869>
187187
- fix(plugins/x): 'no-array-index-key' mistaking 'foo.bar.map' for 'Rea… by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/868>
188188

189189
### 🪄 Improvements

apps/website/content/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ function useAuth() {
187187
### 🐞 Fixes
188188

189189
- fix(plugins/web-api): add 'forEach' support to 'no-leaked-event-listener', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/867>
190-
- fix(plugins/web-api): add 'for of' support to 'no-leaked-event-listenner', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/869>
190+
- fix(plugins/web-api): add 'for of' support to 'no-leaked-event-listener', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/869>
191191
- fix(plugins/x): 'no-array-index-key' mistaking 'foo.bar.map' for 'Rea… by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/868>
192192

193193
### 🪄 Improvements

apps/website/content/docs/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ function useAuth() {
187187
### 🐞 Fixes
188188

189189
- fix(plugins/web-api): add 'forEach' support to 'no-leaked-event-listener', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/867>
190-
- fix(plugins/web-api): add 'for of' support to 'no-leaked-event-listenner', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/869>
190+
- fix(plugins/web-api): add 'for of' support to 'no-leaked-event-listener', closes #842 by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/869>
191191
- fix(plugins/x): 'no-array-index-key' mistaking 'foo.bar.map' for 'Rea… by @Rel1cx in <https://github.com/Rel1cx/eslint-react/pull/868>
192192

193193
### 🪄 Improvements

apps/website/content/docs/rules/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ full: true
6868
| [`prefer-read-only-props`](./prefer-read-only-props) | 0️⃣ | `🔍` `💭` | Enforces read-only props in components. | |
6969
| [`prefer-shorthand-boolean`](./prefer-shorthand-boolean) | 0️⃣ | `🔍` `🔧` | Enforces using shorthand syntax for boolean attributes. | |
7070
| [`prefer-shorthand-fragment`](./prefer-shorthand-fragment) | 0️⃣ | `🔍` `🔧` | Enforces using shorthand syntax for fragments. | |
71-
| [`use-jsx-vars`](./use-jsx-vars) | 1️⃣ | | Helpes `eslint/no-unused-vars` to correctly detect variables used in JSX. | |
71+
| [`use-jsx-vars`](./use-jsx-vars) | 1️⃣ | | Marks variables used in JSX as used. | |
7272

7373
### Deprecated
7474

examples/next-app/app/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export default function Home() {
8484
>
8585
<button
8686
type="button"
87-
aria-label="Customise options"
87+
aria-label="Customize options"
8888
className="h-8 w-8 inline-flex items-center justify-center shadow-lg"
8989
>
9090
<HamburgerMenuIcon />

packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-direct-set-state-in-use-effect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export default function RemoteContent() {
9696
}
9797
```
9898

99-
The following examples are drived from the [React documentation](https://react.dev/learn/you-might-not-need-an-effect):
99+
The following examples are derived from the [React documentation](https://react.dev/learn/you-might-not-need-an-effect):
100100

101101
### Failing
102102

packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-direct-set-state-in-use-layout-effect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export default function RemoteContent() {
9090
}
9191
```
9292

93-
The following examples are drived from the [React documentation](https://react.dev/learn/you-might-not-need-an-effect):
93+
The following examples are derived from the [React documentation](https://react.dev/learn/you-might-not-need-an-effect):
9494

9595
### Failing
9696

packages/plugins/eslint-plugin-react-x/src/rules/no-array-index-key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ function MyComponent({ items }: MyComponentProps) {
8888

8989
- [`no-missing-key`](./no-missing-key)\
9090
Prevents missing `key` on items in list rendering.
91-
- [`no-dupecate-key`](./no-duplicate-key)\
91+
- [`no-duplicate-key`](./no-duplicate-key)\
9292
Prevents duplicate `key` on elements in the same array or a list of `children`.
9393
- [`no-implicit-key`](./no-implicit-key)\
9494
Prevents `key` from not being explicitly specified (e.g. spreading `key` from objects).

packages/plugins/eslint-plugin-react-x/src/rules/no-implicit-key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ function MyComponent({ items }: MyComponentProps) {
9191

9292
- [`no-missing-key`](./no-missing-key)\
9393
Prevents missing `key` on items in list rendering.
94-
- [`no-dupecate-key`](./no-duplicate-key)\
94+
- [`no-duplicate-key`](./no-duplicate-key)\
9595
Prevents duplicate `key` on elements in the same array or a list of `children`.
9696
- [`no-array-index-key`](./no-array-index-key)\
9797
Warns when an array `index` is used as a `key` prop.

packages/plugins/eslint-plugin-react-x/src/rules/no-missing-key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ function MyComponent({ items }: MyComponentProps) {
8686

8787
## See Also
8888

89-
- [`no-dupecate-key`](./no-duplicate-key)\
89+
- [`no-duplicate-key`](./no-duplicate-key)\
9090
Prevents duplicate `key` on elements in the same array or a list of `children`.
9191
- [`no-implicit-key`](./no-implicit-key)\
9292
Prevents `key` from not being explicitly specified (e.g. spreading `key` from objects).

packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ export default createRule<[], MessageID>({
114114
continue;
115115
}
116116
const parentComponent = AST.findParentNode(component, isFunctionComponent);
117-
const isParnetComponentNotDirectValueOfRenderProperty = parentComponent != null
117+
const isParentComponentNotDirectValueOfRenderProperty = parentComponent != null
118118
&& !isDirectValueOfRenderPropertyLoose(parentComponent);
119-
if (isParnetComponentNotDirectValueOfRenderProperty) {
119+
if (isParentComponentNotDirectValueOfRenderProperty) {
120120
context.report({
121121
messageId: isInsideProperty
122122
? "nestedComponentInProps"

packages/plugins/eslint-plugin-react-x/src/rules/no-useless-fragment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Prevents the use of useless fragments.
3131

3232
A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a [keyed fragment](https://react.dev/reference/react/Fragment#caveats).
3333

34-
Moreoever, rendering fragments with multiple levels of depth can cause React to not retain the state of components nested within the fragment after [certain re-renders](https://gist.github.com/clemmy/b3ef00f9507909429d8aa0d3ee4f986b), which may lead to unexpected [state resetting](https://react.dev/learn/preserving-and-resetting-state).
34+
Moreover, rendering fragments with multiple levels of depth can cause React to not retain the state of components nested within the fragment after [certain re-renders](https://gist.github.com/clemmy/b3ef00f9507909429d8aa0d3ee4f986b), which may lead to unexpected [state resetting](https://react.dev/learn/preserving-and-resetting-state).
3535

3636
## Examples
3737

packages/plugins/eslint-plugin-react-x/src/rules/use-jsx-vars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ react-x/use-jsx-vars
2121

2222
## What it does
2323

24-
Helpes `eslint/no-unused-vars` to correctly detect variables used in JSX.
24+
Marks variables used in JSX as used.
2525

2626
Since 0.17.0 the eslint `no-unused-vars` rule does not detect variables used in JSX (see details). This rule will find variables used in JSX and mark them as used.
2727
This rule only has an effect when the `no-unused-vars` rule is enabled.

packages/plugins/eslint-plugin-react-x/src/rules/use-jsx-vars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export default createRule<[], MessageID>({
1414
meta: {
1515
type: "problem",
1616
docs: {
17-
description: "helpes `eslint/no-unused-vars` to correctly mark JSX variables as used.",
17+
description: "marks variables used in JSX as used",
1818
[Symbol.for("rule_features")]: RULE_FEATURES,
1919
},
2020
messages: {

0 commit comments

Comments
 (0)