Skip to content

Commit 177c5b8

Browse files
committed
docs: add faq page
1 parent c698e47 commit 177c5b8

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@
1010

1111
It's a platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.
1212

13+
## Why?
14+
15+
The purpose of `eslint-react` is to provide a platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.
16+
17+
### What are the differences between `@eslint-react/eslint-plugin` and `eslint-plugin-react`?
18+
19+
The main difference is when using `@eslint-react/eslint-plugin` you can customize the behavior of the rules depending on the what render target you are using. While `eslint-plugin-react` will always assume you are using React DOM even if you are working with a project that only uses React Three Fiber.
20+
21+
### Is `@eslint-react/eslint-plugin` a replacement for `eslint-plugin-react`?
22+
23+
No, `@eslint-react/eslint-plugin` is not meant to be a drop-in replacement for `eslint-plugin-react`. But you can still using it as a replacement if you want to. Just keep in mind that some rules may behave differently, the rules provided by `@eslint-react/eslint-plugin` are designed to be more strict than `eslint-plugin-react`.
24+
1325
## Highlights
1426

1527
- Well designed rule behaviors and sensible defaults.

website/pages/docs/_meta.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
"configuration": {
1010
"title": "Configuration"
1111
},
12+
"faq": {
13+
"title": "FAQ"
14+
},
1215
"-Other": {
1316
"title": "Other",
1417
"type": "separator"

website/pages/docs/faq.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Fequently Asked Questions
2+
3+
## Why?
4+
5+
The purpose of `eslint-react` is to provide a platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.
6+
7+
### What are the differences between `@eslint-react/eslint-plugin` and `eslint-plugin-react`?
8+
9+
The main difference is when using `@eslint-react/eslint-plugin` you can customize the behavior of the rules depending on the what render target you are using. While `eslint-plugin-react` will always assume you are using React DOM even if you are working with a project that only uses React Three Fiber.
10+
11+
### Is `@eslint-react/eslint-plugin` a replacement for `eslint-plugin-react`?
12+
13+
No, `@eslint-react/eslint-plugin` is not meant to be a drop-in replacement for `eslint-plugin-react`. But you can still using it as a replacement if you want to. Just keep in mind that some rules may behave differently, the rules provided by `@eslint-react/eslint-plugin` are designed to be more strict than `eslint-plugin-react`.

0 commit comments

Comments
 (0)