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