Skip to content

Commit 86a2f5a

Browse files
committed
docs: update name and glossary
1 parent f3502fd commit 86a2f5a

File tree

32 files changed

+75
-78
lines changed

32 files changed

+75
-78
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# ESLint x React Contributing Guide
1+
# ESLint React Contributing Guide
22

3-
Hi! We, the maintainers, are really excited that you are interested in contributing to ESLint x React.
3+
Hi! We, the maintainers, are really excited that you are interested in contributing to ESLint React.
44

55
Before submitting your contribution though, please make sure to take a moment and read through the [Code of Conduct](CODE_OF_CONDUCT.md), as well as the appropriate section for the contribution you intend to make:
66

77
Before adding your code to this project, please make sure you are passionate about what this project is doing and agree with the [design philosophy](../README.md#Philosophy) of this project.
88

9-
ESLint x React does not accept contributions of a purely utilitarian nature.
9+
ESLint React does not accept contributions of a purely utilitarian nature.
1010

11-
- [ESLint x React Contributing Guide](#eslint-x-react-contributing-guide)
11+
- [ESLint React Contributing Guide](#eslint-react-contributing-guide)
1212
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
1313
- [Pull Request Guidelines](#pull-request-guidelines)
1414
- [Development Guide](#development-guide)
@@ -24,7 +24,7 @@ ESLint x React does not accept contributions of a purely utilitarian nature.
2424

2525
- Try to search for your issue, it may have already been answered or even fixed in the development branch.
2626

27-
- Check if the issue is reproducible with the latest stable version of ESLint x React packages. If you are using a pre-release, please indicate the specific version you are using.
27+
- Check if the issue is reproducible with the latest stable version of ESLint React packages. If you are using a pre-release, please indicate the specific version you are using.
2828

2929
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.
3030

@@ -52,7 +52,7 @@ ESLint x React does not accept contributions of a purely utilitarian nature.
5252

5353
## Development Guide
5454

55-
**NOTE: ESLint x React is undergoing rapid development right now, and the docs may not reflect the current state of ESLint x React. We are working hard to improve it.**
55+
**NOTE: ESLint React is undergoing rapid development right now, and the docs may not reflect the current state of ESLint React. We are working hard to improve it.**
5656

5757
### Packages Overview
5858

@@ -67,7 +67,7 @@ ESLint x React does not accept contributions of a purely utilitarian nature.
6767
- `@eslint-react/eslint-plugin-react-hooks`: ESLint plugin for React Hooks related rules.
6868
- `@eslint-react/eslint-plugin-debug`: ESLint plugin for debugging related rules.
6969
- `@eslint-react/eslint-plugin-naming-convention`: ESLint plugin for naming convention related rules.
70-
- `@eslint-react/eslint-plugin`: The main ESLint plugin of ESLint x React. Contains all the rules from the above plugins.
70+
- `@eslint-react/eslint-plugin`: The main ESLint plugin of ESLint React. Contains all the rules from the above plugins.
7171

7272
### Developing Documentation
7373

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center"><img src="https://eslint-react.rel1cx.io/logo.svg" alt="logo" width="150" /></p>
22

3-
<h1 align="center" alt="title">ESLint x React</h1>
3+
<h1 align="center" alt="title">ESLint React</h1>
44

55
More than 50 ESLint rules to catch common mistakes and improve your React code. Built (mostly) from scratch.
66

@@ -129,7 +129,7 @@ module.exports = {
129129
- [x] `naming-convention/filename-extension`
130130
- [ ] `naming-convention/boolean-prop`
131131
- [ ] `naming-convention/handler-prop`
132-
- [ ] `naming-convention/use-state`
132+
- [x] `naming-convention/use-state`
133133

134134
### React rules
135135

@@ -171,7 +171,6 @@ module.exports = {
171171
- [x] `react/no-constructed-context-value`
172172
- [ ] `react/no-unused-class-component-methods`
173173
- [ ] `react/no-unused-state`
174-
- [ ] `react/no-access-ref-current-during-rendering`
175174
- [x] `react/prefer-destructuring-assignment`
176175
- [ ] `react/prefer-readonly-props`
177176
- [ ] `react/ban-components`
@@ -214,7 +213,7 @@ Before you start working on something, it's best to check if there is an existin
214213

215214
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request.
216215

217-
Thank you to everyone contributing to ESLint x React!
216+
Thank you to everyone contributing to ESLint React!
218217

219218
## License
220219

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/monorepo",
33
"version": "0.9.3",
4-
"description": "ESLint x React's monorepo. More than 50 ESLint rules to catch common mistakes and improve your React code. Built (mostly) from scratch.",
4+
"description": "ESLint React's monorepo. More than 50 ESLint rules to catch common mistakes and improve your React code. Built (mostly) from scratch.",
55
"keywords": [
66
"eslint",
77
"eslint-plugin",

packages/ast/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# `@eslint-react/ast`
22

3-
> ESLint x React's TSESTree AST primitive utility module.
3+
> ESLint React's TSESTree AST primitive utility module.
44
55
## ✋ Internal Package
66

7-
This is an internal package to the [ESLint x React monorepo](https://github.com/Rel1cx/eslint-react).
7+
This is an internal package to the [ESLint React monorepo](https://github.com/Rel1cx/eslint-react).
88
You likely don't want to use it directly.
99

10-
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint x React.
10+
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint React.

packages/ast/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/ast",
33
"version": "0.9.3",
4-
"description": "ESLint x React's TSESTree AST primitive utility module.",
4+
"description": "ESLint React's TSESTree AST primitive utility module.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {
77
"url": "https://github.com/rel1cx/eslint-react/issues"

packages/core/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# `@eslint-react/core`
22

3-
> ESLint x React's ESLint utility module for static analysis of React core API and Patterns.
3+
> ESLint React's ESLint utility module for static analysis of React core API and Patterns.
44
55
## ✋ Internal Package
66

7-
This is an internal package to the [ESLint x React monorepo](https://github.com/Rel1cx/eslint-react).
7+
This is an internal package to the [ESLint React monorepo](https://github.com/Rel1cx/eslint-react).
88
You likely don't want to use it directly.
99

10-
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint x React.
10+
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint React.

packages/core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/core",
33
"version": "0.9.3",
4-
"description": "ESLint x React's ESLint utility module for static analysis of React core API and Patterns.",
4+
"description": "ESLint React's ESLint utility module for static analysis of React core API and Patterns.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {
77
"url": "https://github.com/rel1cx/eslint-react/issues"
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# `@eslint-react/eslint-plugin-debug`
22

3-
> ESLint x React's ESLint plugin for debugging related rules.
3+
> ESLint React's ESLint plugin for debugging related rules.
44
55
## ✋ Internal Package
66

7-
This is an internal package to the [ESLint x React monorepo](https://github.com/Rel1cx/eslint-react).
7+
This is an internal package to the [ESLint React monorepo](https://github.com/Rel1cx/eslint-react).
88
You likely don't want to use it directly.
99

10-
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint x React.
10+
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint React.

packages/eslint-plugin-debug/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/eslint-plugin-debug",
33
"version": "0.9.3",
4-
"description": "ESLint x React's ESLint plugin for debugging related rules.",
4+
"description": "ESLint React's ESLint plugin for debugging related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {
77
"url": "https://github.com/rel1cx/eslint-react/issues"

packages/eslint-plugin-jsx/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# `@eslint-react/eslint-plugin-jsx`
22

3-
> ESLint x React's ESLint plugin for JSX related rules.
3+
> ESLint React's ESLint plugin for JSX related rules.
44
55
## ✋ Internal Package
66

7-
This is an internal package to the [ESLint x React monorepo](https://github.com/Rel1cx/eslint-react).
7+
This is an internal package to the [ESLint React monorepo](https://github.com/Rel1cx/eslint-react).
88
You likely don't want to use it directly.
99

10-
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint x React.
10+
👉 See **<https://eslint-react.rel1cx.io>** for docs on ESLint React.

0 commit comments

Comments
 (0)