Skip to content

Commit 4355255

Browse files
Rel1cxRel1cx
committed
docs: improve faq
1 parent 684bb1c commit 4355255

File tree

19 files changed

+39
-20
lines changed

19 files changed

+39
-20
lines changed

‎README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ export default [
9898

9999
[Rules Overview ↗](https://eslint-react.xyz/rules/overview)
100100

101+
## FAQ
102+
103+
[Frequently Asked Questions ↗](https://eslint-react.xyz/docs/faq)
104+
101105
## Contributing
102106

103107
Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to reach the maintainer and confirm if it makes sense or if someone else is already working on it.

‎VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.5.17-next.5
1+
1.5.17-next.6

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/monorepo",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"private": true,
55
"description": "A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",
66
"keywords": [

‎packages/core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/core",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/plugins/eslint-plugin-react-debug/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-react-debug",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's ESLint plugin for debugging related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/plugins/eslint-plugin-react-dom/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-react-dom",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's ESLint plugin for React DOM related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/plugins/eslint-plugin-react-hooks-extra/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-react-hooks-extra",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's ESLint plugin for React Hooks related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/plugins/eslint-plugin-react-naming-convention/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-react-naming-convention",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's ESLint plugin for naming convention related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/plugins/eslint-plugin-react-x/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-react-x",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's ESLint plugin for React related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/plugins/eslint-plugin/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ export default [
9898

9999
[Rules Overview ↗](https://eslint-react.xyz/rules/overview)
100100

101+
## FAQ
102+
103+
[Frequently Asked Questions ↗](https://eslint-react.xyz/docs/faq)
104+
101105
## Contributing
102106

103107
Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to reach the maintainer and confirm if it makes sense or if someone else is already working on it.

‎packages/plugins/eslint-plugin/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/eslint-plugin",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
55
"keywords": [
66
"eslint",

‎packages/shared/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/shared",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's Shared constants and functions.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/tools/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/tools",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's std library and primitives.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/types/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/types",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's type definitions.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/utilities/ast/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/ast",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's TSESTree AST primitive utility module.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/utilities/jsx/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/jsx",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "ESLint React's TSESTree AST utility module for static analysis of JSX.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎packages/utilities/var/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eslint-react/var",
3-
"version": "1.5.17-next.5",
3+
"version": "1.5.17-next.6",
44
"description": "TSESTree AST utility module for static analysis of variables",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

‎website/next.config.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ const nextConfig = {
2727
unoptimized: true,
2828
},
2929
output: "standalone",
30+
redirects: {
31+
source: "/faq",
32+
destination: "/docs/faq",
33+
permanent: true,
34+
},
3035
};
3136

3237
export default withVanillaExtract(withNextra(nextConfig));

‎website/pages/docs/faq.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,21 @@
22

33
## What is the purpose of `eslint-react`?
44

5-
The purpose of `eslint-react` is to provide ESLint rules for not just for React DOM but also other libraries and frameworks that use React as a runtime.
5+
The purpose of `eslint-react` is to provide ESLint plugins for not just for React DOM but also other libraries and frameworks that use React as a runtime. Currently, it provides:
66

7-
## What are the differences between `@eslint-react/eslint-plugin` and `eslint-plugin-react`?
7+
- `eslint-plugin-react-x` - Core rules (DOM Irrelevant, Render Target Agnostic, Formatting Independent).
8+
- `eslint-plugin-react-dom` - DOM specific rules for React DOM.
9+
- `eslint-plugin-react-debug` - Debugging rules.
10+
- `eslint-plugin-react-hooks-extra` - Extra React Hooks rules.
11+
- `eslint-plugin-react-naming-convention` - Naming convention rules.
812

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 (You can learn more through encounters like [1] in [2]).
13+
## What are the differences between `eslint-plugin-react-x` and `eslint-plugin-react`?
1014

11-
## Is `@eslint-react/eslint-plugin` a replacement for `eslint-plugin-react`?
15+
The main difference is when using `eslint-plugin-react-x` 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 (You can learn more through encounters like [1] in [2]).
1216

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. Keep in mind that certain rules may behave differently, and the rules provided by `eslint-react` are more adhere to [react.dev](https://react.dev/).
17+
## Is `eslint-plugin-react-x` a replacement for `eslint-plugin-react`?
18+
19+
No, `eslint-plugin-react-x` 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. Keep in mind that certain rules may behave differently, and the rules provided by `eslint-react` are more adhere to [react.dev](https://react.dev/).
1420

1521
[1]: https://github.com/pmndrs/react-three-fiber/discussions/2487
1622
[2]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3423#issuecomment-1930936266

0 commit comments

Comments
 (0)