pr-checkmate 1.0.7 → 1.0.8
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 +13 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,22 +1,17 @@
|
|
|
1
1
|
# 🔍 PR CheckMate
|
|
2
|
-
|
|
3
2
|
> **PR CheckMate** is an npm package for automating Pull Request checks.
|
|
4
3
|
> It helps teams maintain code quality by automatically validating linting, formatting, dependencies, and spelling before merging to `main`.
|
|
5
4
|
|
|
6
|
-
---
|
|
7
5
|
|
|
8
6
|
## ⚡ Why PR CheckMate?
|
|
9
|
-
|
|
10
7
|
* ✅ Automatic checks on every PR without extra setup.
|
|
11
8
|
* ✅ No need to install ESLint, Prettier, or cspell in your project — all included.
|
|
12
9
|
* ✅ Enforces a unified code style across repositories.
|
|
13
10
|
* ✅ Checks `package.json` / `package-lock.json` for dependency changes.
|
|
14
11
|
* ✅ Spellcheck for code, documentation, and JSON files.
|
|
15
12
|
|
|
16
|
-
---
|
|
17
13
|
|
|
18
14
|
## 🛠 How It Works
|
|
19
|
-
|
|
20
15
|
### 1. Install
|
|
21
16
|
|
|
22
17
|
```bash
|
|
@@ -35,7 +30,6 @@ npx pr-checkmate <job>
|
|
|
35
30
|
```
|
|
36
31
|
|
|
37
32
|
#### ⚡ Jobs
|
|
38
|
-
|
|
39
33
|
| Job | Description |
|
|
40
34
|
|------------|-------------|
|
|
41
35
|
| `all` | Run all checks: ESLint, dependency check, Prettier, spellcheck |
|
|
@@ -43,9 +37,13 @@ npx pr-checkmate <job>
|
|
|
43
37
|
| `prettier` | Format code using Prettier |
|
|
44
38
|
| `deps` | Check project dependencies |
|
|
45
39
|
| `spellcheck` | Run spellcheck via cspell |
|
|
40
|
+
<br>
|
|
46
41
|
|
|
47
42
|
## 📦 Example GitHub Actions Workflow
|
|
48
43
|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
49
47
|
```yaml
|
|
50
48
|
name: PR CheckMate Quality Checks
|
|
51
49
|
|
|
@@ -75,7 +73,14 @@ jobs:
|
|
|
75
73
|
> Fully automated process: no need to install ESLint, Prettier, or cspell in your repository.
|
|
76
74
|
|
|
77
75
|
|
|
78
|
-
|
|
76
|
+
## 📌 Benefits
|
|
77
|
+
|
|
78
|
+
* ✅ Self-contained — the package handles all checks internally
|
|
79
|
+
* ✅ Works locally and in CI/CD (GitHub Actions, GitLab CI, etc.)
|
|
80
|
+
* ✅ Enforces a unified code style across repositories
|
|
81
|
+
* ✅ Automatic formatting and commits when needed
|
|
82
|
+
* ✅ Minimal setup — just `init` and `npx pr-checkmate all`
|
|
83
|
+
|
|
79
84
|
|
|
80
85
|
## 🧰 Tech Stack
|
|
81
86
|
|
|
@@ -84,17 +89,7 @@ jobs:
|
|
|
84
89
|
* **ESLint + @typescript-eslint** — code linting
|
|
85
90
|
* **Prettier** — auto-formatting
|
|
86
91
|
* **cspell** — spellchecking
|
|
87
|
-
* **execa** — running CLI commands from Node.js
|
|
88
|
-
|
|
89
|
-
---
|
|
90
|
-
|
|
91
|
-
## 📌 Benefits
|
|
92
|
-
|
|
93
|
-
* ✅ Self-contained — the package handles all checks internally
|
|
94
|
-
* ✅ Works locally and in CI/CD (GitHub Actions, GitLab CI, etc.)
|
|
95
|
-
* ✅ Enforces a unified code style across repositories
|
|
96
|
-
* ✅ Automatic formatting and commits when needed
|
|
97
|
-
* ✅ Minimal setup — just `init` and `npx pr-checkmate all`
|
|
92
|
+
* **execa** — running CLI commands from Node.js
|
|
98
93
|
|
|
99
94
|
|
|
100
95
|
## 📜 License
|