@amrendrasharma/deployguard 1.0.0 → 1.0.2
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 +41 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,28 +1,33 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
|
+
<<<<<<< HEAD
|
|
3
|
+
|
|
4
|
+
=======
|
|
5
|
+
>>>>>>> 2ae13572a716d7f9cf8479dd0e645ffb35adaf93
|
|
6
|
+
# 🚢 deployguard
|
|
2
7
|
|
|
3
8
|
> A lightweight CLI tool that scans your project before deployment and detects common production issues.
|
|
4
9
|
|
|
5
|
-
[](https://www.npmjs.com/package/@amrendrasharma/deployguard)
|
|
6
11
|
[](https://opensource.org/licenses/MIT)
|
|
7
|
-
[](https://nodejs.org)
|
|
8
13
|
|
|
9
14
|
---
|
|
10
15
|
|
|
11
16
|
## ✨ What it does
|
|
12
17
|
|
|
13
|
-
Run `npx
|
|
18
|
+
Run `npx @amrendrasharma/deployguard` in any Node.js project before you deploy and get an instant health check:
|
|
14
19
|
|
|
15
20
|
```
|
|
16
21
|
──────────────────────────────────────────────────────────────────────────
|
|
17
|
-
🚢
|
|
22
|
+
🚢 deployguard v1.0.0 — Pre-deployment project scanner
|
|
18
23
|
──────────────────────────────────────────────────────────────────────────
|
|
19
24
|
|
|
20
25
|
Scanning: /Users/you/my-project
|
|
21
26
|
|
|
22
|
-
✔
|
|
23
|
-
✔
|
|
24
|
-
✔
|
|
25
|
-
✔
|
|
27
|
+
✔ Scanning for console.log statements...
|
|
28
|
+
✔ Checking environment variables...
|
|
29
|
+
✔ Checking for unused dependencies...
|
|
30
|
+
✔ Scanning for large files (> 5MB)...
|
|
26
31
|
|
|
27
32
|
──────────────────────────────────────────────────────────────────────────
|
|
28
33
|
Results
|
|
@@ -54,18 +59,18 @@ Run `npx shipcheck` in any Node.js project before you deploy and get an instant
|
|
|
54
59
|
|
|
55
60
|
Run without installing:
|
|
56
61
|
```bash
|
|
57
|
-
npx
|
|
62
|
+
npx @amrendrasharma/deployguard
|
|
58
63
|
```
|
|
59
64
|
|
|
60
65
|
Or install globally:
|
|
61
66
|
```bash
|
|
62
|
-
npm install -g
|
|
63
|
-
|
|
67
|
+
npm install -g @amrendrasharma/deployguard
|
|
68
|
+
deployguard
|
|
64
69
|
```
|
|
65
70
|
|
|
66
71
|
Scan a specific directory:
|
|
67
72
|
```bash
|
|
68
|
-
|
|
73
|
+
deployguard --dir ./my-app
|
|
69
74
|
```
|
|
70
75
|
|
|
71
76
|
---
|
|
@@ -74,10 +79,10 @@ shipcheck --dir ./my-app
|
|
|
74
79
|
|
|
75
80
|
```bash
|
|
76
81
|
# Install globally
|
|
77
|
-
npm install -g
|
|
82
|
+
npm install -g @amrendrasharma/deployguard
|
|
78
83
|
|
|
79
84
|
# Or use as a dev dependency
|
|
80
|
-
npm install --save-dev
|
|
85
|
+
npm install --save-dev @amrendrasharma/deployguard
|
|
81
86
|
```
|
|
82
87
|
|
|
83
88
|
---
|
|
@@ -118,7 +123,7 @@ Options:
|
|
|
118
123
|
## 📂 Project Structure
|
|
119
124
|
|
|
120
125
|
```
|
|
121
|
-
|
|
126
|
+
deployguard/
|
|
122
127
|
├── bin/
|
|
123
128
|
│ └── cli.js # CLI entry point (Commander.js setup, orchestration)
|
|
124
129
|
├── checks/
|
|
@@ -143,12 +148,11 @@ shipcheck/
|
|
|
143
148
|
|
|
144
149
|
Add to your `package.json`:
|
|
145
150
|
|
|
146
|
-
|
|
147
151
|
```json
|
|
148
152
|
{
|
|
149
153
|
"scripts": {
|
|
150
|
-
"precheck": "
|
|
151
|
-
"deploy": "
|
|
154
|
+
"precheck": "deployguard",
|
|
155
|
+
"deploy": "deployguard && your-deploy-command"
|
|
152
156
|
}
|
|
153
157
|
}
|
|
154
158
|
```
|
|
@@ -156,8 +160,8 @@ Add to your `package.json`:
|
|
|
156
160
|
### GitHub Actions
|
|
157
161
|
|
|
158
162
|
```yaml
|
|
159
|
-
# .github/workflows/
|
|
160
|
-
name: Pre-deploy
|
|
163
|
+
# .github/workflows/deployguard.yml
|
|
164
|
+
name: Pre-deploy Check
|
|
161
165
|
|
|
162
166
|
on:
|
|
163
167
|
push:
|
|
@@ -166,7 +170,7 @@ on:
|
|
|
166
170
|
branches: [main]
|
|
167
171
|
|
|
168
172
|
jobs:
|
|
169
|
-
|
|
173
|
+
deployguard:
|
|
170
174
|
runs-on: ubuntu-latest
|
|
171
175
|
steps:
|
|
172
176
|
- uses: actions/checkout@v4
|
|
@@ -174,20 +178,32 @@ jobs:
|
|
|
174
178
|
with:
|
|
175
179
|
node-version: '20'
|
|
176
180
|
- run: npm ci
|
|
177
|
-
- run: npx
|
|
181
|
+
- run: npx @amrendrasharma/deployguard --no-color
|
|
178
182
|
```
|
|
179
183
|
|
|
180
184
|
---
|
|
181
185
|
|
|
182
186
|
## 🤝 Contributing
|
|
183
187
|
|
|
184
|
-
1. Fork the repository
|
|
188
|
+
1. Fork the repository: [github.com/amrendrasharma1328-a11y/shipcheck](https://github.com/amrendrasharma1328-a11y/shipcheck)
|
|
185
189
|
2. Create your feature branch: `git checkout -b feat/new-check`
|
|
186
190
|
3. Commit your changes: `git commit -m 'feat: add secretsCheck'`
|
|
187
191
|
4. Push and open a Pull Request
|
|
188
192
|
|
|
189
193
|
---
|
|
190
194
|
|
|
195
|
+
## 👨💻 Author
|
|
196
|
+
|
|
197
|
+
**Amrendra Sharma**
|
|
198
|
+
- npm: [@amrendrasharma](https://www.npmjs.com/~amrendrasharma)
|
|
199
|
+
- GitHub: [amrendrasharma1328-a11y](https://github.com/amrendrasharma1328-a11y)
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
191
203
|
## 📄 License
|
|
192
204
|
|
|
193
|
-
|
|
205
|
+
<<<<<<< HEAD
|
|
206
|
+
MIT © [Amrendra Sharma](https://github.com/amrendrasharma1328-a11y)
|
|
207
|
+
=======
|
|
208
|
+
MIT © [Amrendra Sharma](https://github.com/amrendrasharma1328-a11y)
|
|
209
|
+
>>>>>>> 2ae13572a716d7f9cf8479dd0e645ffb35adaf93
|
package/package.json
CHANGED