Skip to content

Commit ca58c8b

Browse files
committed
docs: update project description
1 parent 7dfac74 commit ca58c8b

File tree

22 files changed

+38
-71
lines changed

22 files changed

+38
-71
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## v1.5.1-next.0 (Mon Jan 29 2024)
2+
3+
### ✨ New
4+
5+
- Add `off-dom` and `off-dom-legacy` presets to disable all DOM related rules.
6+
17
## v1.5.0 (Mon Jan 29 2024)
28

39
### 💥 Breaking Changes

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
[![Size](https://img.shields.io/bundlephobia/minzip/@eslint-react/eslint-plugin?label=gzip&style=flat&colorA=000000&colorB=000000)](https://bundlephobia.com/package/@eslint-react/eslint-plugin)
77
[![Downloads](https://img.shields.io/npm/dt/@eslint-react/eslint-plugin.svg?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@eslint-react/eslint-plugin)
88

9-
## What is this?
10-
11-
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.
9+
A series of essential ESLint plugins for libraries and frameworks that use React as a UI runtime.
1210

1311
## Roadmap
1412

@@ -17,6 +15,7 @@ It's a platform for creating ESLint rules for not just for ReactDOM but also oth
1715

1816
## Highlights
1917

18+
- Not bound to the ReactDOM, works well with most libraries and frameworks that use React as a UI runtime.
2019
- Well designed rule behaviors and sensible defaults.
2120
- Maximum flexibility through minimum configuration options.
2221
- No auto-fix, Formatting independent, treat your codebase like it's read-only.
@@ -126,19 +125,6 @@ module.exports = {
126125

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

129-
## Philosophy
130-
131-
- **Do what a linter should do**
132-
- **Focus on code rather than style**
133-
- **Rules are better than options**
134-
135-
## Rule introduction or modification principles
136-
137-
1. **No Auto-fix**. Auto-fix is a great feature, but it's not always safe and reliable. We prefer to not to do auto-fix at all than to implement it in a way that can cause more problems than it solves.
138-
2. **Formatting independent**. Rules should check for correctness, not style. We recommend using style focused tools for formatting (e.g. [dprint](https://dprint.dev/)).
139-
3. **Sensible defaults**. Rules should be easy to setup and use with minimal configuration and sensible defaults.
140-
4. **Rules over options [[1]](https://eslint-react.xyz/docs/rules-over-options)**. Each rule should have a single purpose. Make multiple rules work together to achieve more complex behaviors instead of adding options to a single rule.
141-
142128
## Contributing
143129

144130
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.
@@ -153,11 +139,10 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
153139

154140
## Inspiration
155141

156-
- [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
157142
- [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)
158143
- [eslint-plugin-functional](https://github.com/eslint-functional/eslint-plugin-functional)
144+
- [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
159145
- [eslint-plugin-filenames-simple](https://github.com/epaew/eslint-plugin-filenames-simple)
160-
- [@tanstack/eslint-plugin-query](https://github.com/TanStack/query/tree/main/packages/eslint-plugin-query)
161146
- [rome/tools](https://github.com/rome/tools)
162147
- [rust-clippy](https://github.com/rust-lang/rust-clippy)
163148

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.5.0
1+
1.5.1-next.0

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/monorepo",
3-
"version": "1.5.0",
4-
"description": "A platform for creating ESLint rules for not just for ReactDOM but also other libraries and frameworks that use React as a runtime.",
3+
"version": "1.5.1-next.0",
4+
"description": "Essential React Lints for libraries and frameworks that use React as a UI runtime.",
55
"keywords": [
66
"eslint",
77
"eslint-plugin",

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.0",
3+
"version": "1.5.1-next.0",
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-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-plugin-react-core",
3-
"version": "1.5.0",
3+
"version": "1.5.1-next.0",
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-react-core/src/rules/no-children-prop.ts

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,6 @@ export const RULE_NAME = "no-children-prop";
1010

1111
export type MessageID = ConstantCase<typeof RULE_NAME>;
1212

13-
// No need to check because TypeScript does it for us
14-
// function isAttribute(
15-
// prop: TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute,
16-
// ) {
17-
// return (
18-
// "value" in prop
19-
// && prop.value
20-
// && "expression" in prop.value
21-
// && isFunction(prop.value.expression)
22-
// );
23-
// }
24-
25-
// No need to check because TypeScript does it for us
26-
// function isProperty(
27-
// prop:
28-
// | TSESTree.PropertyComputedName
29-
// | TSESTree.PropertyNonComputedName
30-
// | TSESTree.RestElement
31-
// | TSESTree.SpreadElement,
32-
// ) {
33-
// return (
34-
// "value" in prop
35-
// && prop.value
36-
// && "type" in prop.value
37-
// && isFunction(prop.value)
38-
// );
39-
// }
40-
4113
export default createRule<[], MessageID>({
4214
name: RULE_NAME,
4315
meta: {

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.0",
3+
"version": "1.5.1-next.0",
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.0",
3+
"version": "1.5.1-next.0",
44
"description": "ESLint React's ESLint plugin for ReactDOM 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.0",
3+
"version": "1.5.1-next.0",
44
"description": "ESLint React's ESLint plugin for React Hooks related rules.",
55
"homepage": "https://github.com/rel1cx/eslint-react",
66
"bugs": {

0 commit comments

Comments
 (0)