pr-checkmate 1.19.2 → 1.19.3
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 +60 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,65 @@
|
|
|
15
15
|
<br>
|
|
16
16
|
> ⚠️ **Note:** Currently, PR CheckMate only supports **Node.js projects**.
|
|
17
17
|
|
|
18
|
+
## 🚀 Zero-Config by Default
|
|
19
|
+
You don’t need to install or configure:
|
|
20
|
+
- ESLint
|
|
21
|
+
- Prettier
|
|
22
|
+
- cspell
|
|
23
|
+
- Security scanning tools
|
|
24
|
+
Everything works out of the box.
|
|
25
|
+
<br>
|
|
26
|
+
|
|
27
|
+
### 🧩 Fully Customizable
|
|
28
|
+
Users can override:
|
|
29
|
+
- ESLint rules and ignore patterns
|
|
30
|
+
- Prettier rules
|
|
31
|
+
- CSpell dictionary and ignore lists
|
|
32
|
+
- Which checks run
|
|
33
|
+
- Source code path
|
|
34
|
+
|
|
35
|
+
User configuration is stored in:
|
|
36
|
+
```
|
|
37
|
+
<project-root>/pr-checkmate.json
|
|
38
|
+
```
|
|
39
|
+
<br>
|
|
40
|
+
|
|
41
|
+
### ⚙️ Example: pr-checkmate.json
|
|
42
|
+
```
|
|
43
|
+
{
|
|
44
|
+
"sourcePath": "src",
|
|
45
|
+
"commands": {
|
|
46
|
+
"npx pr-checkmate init": "Update pr-checkmate.json",
|
|
47
|
+
"npx pr-checkmate all": "Run all checks",
|
|
48
|
+
"npx pr-checkmate lint": "Lint code using ESLint",
|
|
49
|
+
"npx pr-checkmate prettier": "Format code using Prettier",
|
|
50
|
+
"npx pr-checkmate deps": "Check project dependencies",
|
|
51
|
+
"npx pr-checkmate npm-audit": "Run package vulnerabilities check",
|
|
52
|
+
"npx pr-checkmate security": "Security scan",
|
|
53
|
+
"npx pr-checkmate spellcheck": "Run spellcheck via cspell"
|
|
54
|
+
},
|
|
55
|
+
"eslint": {
|
|
56
|
+
"rules": {},
|
|
57
|
+
"ignorePatterns": []
|
|
58
|
+
},
|
|
59
|
+
"prettier": {
|
|
60
|
+
"rules": {}
|
|
61
|
+
},
|
|
62
|
+
"cspell": {
|
|
63
|
+
"words": [],
|
|
64
|
+
"ignorePaths": [],
|
|
65
|
+
"ignoreRegExpList": []
|
|
66
|
+
},
|
|
67
|
+
"documentation": {
|
|
68
|
+
"eslint": "https://eslint.org/docs/latest/rules/",
|
|
69
|
+
"typescriptEslint": "https://typescript-eslint.io/rules/",
|
|
70
|
+
"prettier": "https://prettier.io/docs/en/options.html",
|
|
71
|
+
"cspell": "https://cspell.org/configuration/"
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
<br>
|
|
18
77
|
|
|
19
78
|
## 🛠 How It Works
|
|
20
79
|
### 1. Install
|
|
@@ -27,7 +86,7 @@ npm install --save-dev pr-checkmate
|
|
|
27
86
|
```
|
|
28
87
|
npx pr-checkmate init
|
|
29
88
|
```
|
|
30
|
-
This creates a pr-checkmate.json config file, where you can specify the source code path.
|
|
89
|
+
> This creates a pr-checkmate.json config file, where you can specify the source code path.
|
|
31
90
|
|
|
32
91
|
### 3. Run Checks
|
|
33
92
|
```
|