@faasjs/lint 3.5.0 → 3.5.1
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 +31 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,47 @@
|
|
|
1
1
|
# @faasjs/lint
|
|
2
2
|
|
|
3
|
-
Lint tool for FaasJS.
|
|
3
|
+
Lint tool for FaasJS, based on [Biome](https://biomejs.dev).
|
|
4
4
|
|
|
5
5
|
[](https://github.com/faasjs/faasjs/blob/main/packages/lint/LICENSE)
|
|
6
6
|
[](https://www.npmjs.com/package/@faasjs/lint)
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
10
|
-
1. Install `@faasjs/lint`:
|
|
10
|
+
1. Install `@faasjs/lint`:
|
|
11
|
+
```bash
|
|
12
|
+
npm install @faasjs/lint
|
|
13
|
+
```
|
|
11
14
|
2. Create `biome.json` with content:
|
|
12
15
|
```json
|
|
13
16
|
{
|
|
14
17
|
"extends": ["@faasjs/lint/biome"]
|
|
15
18
|
}
|
|
16
19
|
```
|
|
17
|
-
3. Add
|
|
20
|
+
3. Add the following script to `package.json`:
|
|
21
|
+
```json
|
|
22
|
+
"scripts": {
|
|
23
|
+
"lint": "biome lint"
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Tips for VSCode
|
|
28
|
+
|
|
29
|
+
1. Install [Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome).
|
|
30
|
+
2. Update your `.vscode/settings.json` with the following content:
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"editor.codeActionsOnSave": {
|
|
34
|
+
"source.fixAll": "explicit",
|
|
35
|
+
"quickfix.biome": "explicit"
|
|
36
|
+
},
|
|
37
|
+
"editor.formatOnSave": true
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## References
|
|
42
|
+
|
|
43
|
+
- [Biome CLI](https://biomejs.dev/reference/cli/).
|
|
18
44
|
|
|
19
|
-
##
|
|
45
|
+
## Troubleshooting
|
|
20
46
|
|
|
21
|
-
|
|
47
|
+
- If you encounter any issues, please refer to the [FaasJS documentation](https://faasjs.com) or open an issue on [GitHub](https://github.com/faasjs/faasjs/issues).
|