@dvashim/biome-config 1.1.3 → 1.1.4
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 +51 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Biome Configurations
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dvashim/biome-config) [](https://www.npmjs.com/package/@dvashim/biome-config) [](https://biomejs.dev)
|
|
3
|
+
[](https://www.npmjs.com/package/@dvashim/biome-config) [](https://www.npmjs.com/package/@dvashim/biome-config) [](https://biomejs.dev)
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
npm:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
npm install -D @dvashim/biome-config
|
|
@@ -16,19 +16,60 @@ or pnpm:
|
|
|
16
16
|
pnpm add -D @dvashim/biome-config
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Configurations
|
|
20
20
|
|
|
21
21
|
| Name | Path |
|
|
22
22
|
|------|------|
|
|
23
|
-
| [Base recommended
|
|
24
|
-
| [React recommended
|
|
25
|
-
| [React strict
|
|
23
|
+
| [Base recommended](#base-recommended-configuration) | `@dvashim/biome-config` or `@dvashim/biome-config/recommended` |
|
|
24
|
+
| [React recommended](#react-recommended-configuration) | `@dvashim/biome-config/react/recommended` |
|
|
25
|
+
| [React strict](#react-strict-configuration) | `@dvashim/biome-config/react/strict` |
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Use
|
|
28
|
+
|
|
29
|
+
Base recommended configuration
|
|
30
|
+
|
|
31
|
+
```jsonc
|
|
32
|
+
// biome.json (base recommended)
|
|
33
|
+
// This configuration provides a base setup for linting,
|
|
34
|
+
// formatting, and code consistency across JavaScript,
|
|
35
|
+
// JSX, JSON, and HTML files.
|
|
36
|
+
|
|
37
|
+
{
|
|
38
|
+
"extends": ["@dvashim/biome-config"]
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
React recommended configuration
|
|
43
|
+
|
|
44
|
+
```jsonc
|
|
45
|
+
// biome.json (react recommended)
|
|
46
|
+
// This configuration provides setup for linting,
|
|
47
|
+
// formatting, and code consistency across JavaScript,
|
|
48
|
+
// JSX, JSON, and HTML files, optimized for React projects.
|
|
49
|
+
|
|
50
|
+
{
|
|
51
|
+
"extends": ["@dvashim/biome-config/react/recommended"]
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
React strict configuration
|
|
56
|
+
|
|
57
|
+
```jsonc
|
|
58
|
+
// biome.json (react strict)
|
|
59
|
+
// This configuration enforces strict rules for linting,
|
|
60
|
+
// formatting, and code quality across JavaScript,
|
|
61
|
+
// TypeScript, JSX, JSON, and HTML files.
|
|
62
|
+
|
|
63
|
+
{
|
|
64
|
+
"extends": ["@dvashim/biome-config/react/strict"]
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Rules
|
|
28
69
|
|
|
29
70
|
### Base recommended configuration
|
|
30
71
|
|
|
31
|
-
This configuration provides a base setup for linting, formatting, and code consistency across JavaScript, JSX, JSON, and HTML files. Key features include:
|
|
72
|
+
> This configuration provides a base setup for linting, formatting, and code consistency across JavaScript, JSX, JSON, and HTML files. Key features include:
|
|
32
73
|
|
|
33
74
|
* **Linter Rules**
|
|
34
75
|
|
|
@@ -51,18 +92,9 @@ This configuration provides a base setup for linting, formatting, and code consi
|
|
|
51
92
|
|
|
52
93
|
* Includes all project files by default, excluding distribution directories.
|
|
53
94
|
|
|
54
|
-
This setup provides a robust, opinionated baseline for projects, ensuring readable, maintainable, and consistent code while enforcing Biome’s recommended practices.
|
|
55
|
-
|
|
56
|
-
```jsonc
|
|
57
|
-
// biome.json
|
|
58
|
-
{
|
|
59
|
-
"extends": ["@dvashim/biome-config"]
|
|
60
|
-
}
|
|
61
|
-
```
|
|
62
|
-
|
|
63
95
|
### React recommended configuration
|
|
64
96
|
|
|
65
|
-
This configuration provides setup for linting, formatting, and code consistency across JavaScript, JSX, JSON, and HTML files, optimized for React projects. Key features include:
|
|
97
|
+
> This configuration provides setup for linting, formatting, and code consistency across JavaScript, JSX, JSON, and HTML files, optimized for React projects. Key features include:
|
|
66
98
|
|
|
67
99
|
* **Linter Rules**
|
|
68
100
|
|
|
@@ -86,18 +118,9 @@ This configuration provides setup for linting, formatting, and code consistency
|
|
|
86
118
|
|
|
87
119
|
* Includes all project files by default, excluding distribution directories.
|
|
88
120
|
|
|
89
|
-
This setup ensures a clean, maintainable, and React-ready codebase, focusing on recommended best practices and consistent formatting.
|
|
90
|
-
|
|
91
|
-
```jsonc
|
|
92
|
-
// biome.json
|
|
93
|
-
{
|
|
94
|
-
"extends": ["@dvashim/biome-config/react/recommended"]
|
|
95
|
-
}
|
|
96
|
-
```
|
|
97
|
-
|
|
98
121
|
### React strict configuration
|
|
99
122
|
|
|
100
|
-
This configuration enforces strict rules for linting, formatting, and code quality across JavaScript, TypeScript, JSX, JSON, and HTML files. Key features include:
|
|
123
|
+
> This configuration enforces strict rules for linting, formatting, and code quality across JavaScript, TypeScript, JSX, JSON, and HTML files. Key features include:
|
|
101
124
|
|
|
102
125
|
* **Linter Rules**
|
|
103
126
|
|
|
@@ -126,12 +149,3 @@ This configuration enforces strict rules for linting, formatting, and code quali
|
|
|
126
149
|
* **File Management:**
|
|
127
150
|
|
|
128
151
|
* Includes all project files by default, excluding distribution directories.
|
|
129
|
-
|
|
130
|
-
This setup ensures a consistent, maintainable, and high-quality codebase while enforcing best practices across accessibility, performance, security, and style.
|
|
131
|
-
|
|
132
|
-
```jsonc
|
|
133
|
-
// biome.json
|
|
134
|
-
{
|
|
135
|
-
"extends": ["@dvashim/biome-config/react/strict"]
|
|
136
|
-
}
|
|
137
|
-
```
|