@sabzidev/eslint-rules 1.0.1 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -8
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,10 +7,12 @@ A collection of custom ESLint rules for improving code quality, consistency, and
|
|
|
7
7
|
## 👀 Overview
|
|
8
8
|
|
|
9
9
|
<div align="center">
|
|
10
|
-
<img src="https://img.shields.io/npm/dm/@sabzidev/eslint-rules?style=flat-square&&color=16A34A&label=DOWNLOADS" alt="DOWNLOADS"/>
|
|
11
|
-
<img src="https://img.shields.io/npm/v/@sabzidev/eslint-rules?style=flat-square&color=16A34A&label=VERSION" alt="VERSION"/>
|
|
10
|
+
<img src="https://img.shields.io/npm/dm/@sabzidev/eslint-rules?style=flat-square&&color=16A34A&label=DOWNLOADS" alt="DOWNLOADS" />
|
|
11
|
+
<img src="https://img.shields.io/npm/v/@sabzidev/eslint-rules?style=flat-square&color=16A34A&label=VERSION" alt="VERSION" />
|
|
12
|
+
|
|
12
13
|
<br />
|
|
13
|
-
|
|
14
|
+
|
|
15
|
+
<img src="./docs/images/logo.webp" alt="SabziDev logo" height="300" width="70%" />
|
|
14
16
|
|
|
15
17
|
[GITHUB](https://github.com/SabziDev/eslint-rules) | [NPM](https://npmjs.com/package/@sabzidev/eslint-rules)
|
|
16
18
|
</div>
|
|
@@ -29,18 +31,18 @@ A collection of custom ESLint rules for improving code quality, consistency, and
|
|
|
29
31
|
Install the package as a development dependency:
|
|
30
32
|
|
|
31
33
|
```bash
|
|
32
|
-
|
|
34
|
+
pnpm i -D @sabzidev/eslint-rules
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
---
|
|
36
38
|
|
|
37
39
|
## 🚀 Usage
|
|
38
40
|
|
|
39
|
-
Choose **one** of the following configuration methods.
|
|
41
|
+
Choose **one** of the following configuration methods for your existing `eslint.config.js` file:
|
|
40
42
|
|
|
41
43
|
### ● Recommended Configuration
|
|
42
44
|
|
|
43
|
-
Add the recommended configuration
|
|
45
|
+
Add the recommended configuration:
|
|
44
46
|
|
|
45
47
|
```js
|
|
46
48
|
import sabzidev from "@sabzidev/eslint-rules";
|
|
@@ -56,7 +58,7 @@ This enables all rules included in the recommended configuration with their pred
|
|
|
56
58
|
|
|
57
59
|
### ● Custom Configuration
|
|
58
60
|
|
|
59
|
-
Alternatively, register the plugin and configure each rule individually
|
|
61
|
+
Alternatively, register the plugin and configure each rule individually:
|
|
60
62
|
|
|
61
63
|
```js
|
|
62
64
|
import sabzidev from "@sabzidev/eslint-rules";
|
|
@@ -90,6 +92,8 @@ For a more comprehensive linting setup, combine `@sabzidev/eslint-rules` with [`
|
|
|
90
92
|
|
|
91
93
|
This combination brings together code-quality rules, bug detection, maintainability checks, and custom linting rules.
|
|
92
94
|
|
|
95
|
+
**Configuration for `eslint.config.js`:**
|
|
96
|
+
|
|
93
97
|
```js
|
|
94
98
|
import { defineConfig } from "@fullstacksjs/eslint-config";
|
|
95
99
|
import sabzidev from "@sabzidev/eslint-rules";
|
|
@@ -160,5 +164,5 @@ export default config;
|
|
|
160
164
|
|
|
161
165
|
Developed by **Abolfazl Sabzmohammadi**.
|
|
162
166
|
|
|
163
|
-
- GitHub: [SabziDev](https://github.com/SabziDev)
|
|
167
|
+
- GitHub: [github.com/SabziDev](https://github.com/SabziDev)
|
|
164
168
|
- Website: [Sabzi.Dev](https://Sabzi.Dev)
|
package/dist/index.js
CHANGED
package/package.json
CHANGED