specchain-pro 0.1.0
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/CHANGELOG.md +68 -0
- package/CONTRIBUTING.md +397 -0
- package/DEPLOYMENT_OPTIONS.md +358 -0
- package/DEPLOY_WITHOUT_NPM.md +443 -0
- package/ENABLE_2FA.md +133 -0
- package/LICENSE +21 -0
- package/NPM_PUBLISH_STEPS.md +432 -0
- package/PUBLISH_COMMANDS.txt +61 -0
- package/QUICK_DEPLOY.md +206 -0
- package/README.md +264 -0
- package/YOUR_DEPLOYMENT_CHECKLIST.md +268 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +182 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/core/config.d.ts +14 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/config.js +143 -0
- package/dist/core/config.js.map +1 -0
- package/dist/types/index.d.ts +142 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +46 -0
- package/dist/types/index.js.map +1 -0
- package/dist/utils/logger.d.ts +9 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +79 -0
- package/dist/utils/logger.js.map +1 -0
- package/package.json +69 -0
- package/scripts/deploy-github.ps1 +108 -0
- package/scripts/deploy-github.sh +96 -0
- package/scripts/deploy.ps1 +183 -0
- package/scripts/deploy.sh +159 -0
- package/setup-git.ps1 +30 -0
- package/setup-git.sh +32 -0
|
@@ -0,0 +1,432 @@
|
|
|
1
|
+
# Publish SpecChain Pro to npm - Step by Step
|
|
2
|
+
|
|
3
|
+
The package name **"specchain-pro"** is available! ✅
|
|
4
|
+
|
|
5
|
+
Follow these exact steps to publish to npm.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📋 Prerequisites
|
|
10
|
+
|
|
11
|
+
- [ ] Node.js 18+ installed
|
|
12
|
+
- [ ] Project built successfully
|
|
13
|
+
- [ ] All tests passing (or skipped for MVP)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Step 1: Create npm Account (5 minutes)
|
|
18
|
+
|
|
19
|
+
### Option A: Via Website
|
|
20
|
+
1. Go to https://www.npmjs.com/signup
|
|
21
|
+
2. Fill in:
|
|
22
|
+
- Username (e.g., `yourusername`)
|
|
23
|
+
- Email address
|
|
24
|
+
- Password
|
|
25
|
+
3. Verify your email
|
|
26
|
+
|
|
27
|
+
### Option B: Via CLI
|
|
28
|
+
```bash
|
|
29
|
+
npm adduser
|
|
30
|
+
# Enter username, password, and email when prompted
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Step 2: Login to npm (1 minute)
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Login
|
|
39
|
+
npm login
|
|
40
|
+
|
|
41
|
+
# You'll be prompted for:
|
|
42
|
+
# - Username
|
|
43
|
+
# - Password
|
|
44
|
+
# - Email
|
|
45
|
+
# - One-time password (if 2FA enabled)
|
|
46
|
+
|
|
47
|
+
# Verify you're logged in
|
|
48
|
+
npm whoami
|
|
49
|
+
# Should show your username
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Step 3: Update Package Metadata (2 minutes)
|
|
55
|
+
|
|
56
|
+
Update `package.json` with your information:
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"name": "specchain-pro",
|
|
61
|
+
"version": "0.1.0",
|
|
62
|
+
"description": "AI-powered specification generation with blockchain proof-of-authorship",
|
|
63
|
+
"author": "Your Name <your.email@example.com>",
|
|
64
|
+
"repository": {
|
|
65
|
+
"type": "git",
|
|
66
|
+
"url": "https://github.com/yourusername/specchain-pro.git"
|
|
67
|
+
},
|
|
68
|
+
"bugs": {
|
|
69
|
+
"url": "https://github.com/yourusername/specchain-pro/issues"
|
|
70
|
+
},
|
|
71
|
+
"homepage": "https://github.com/yourusername/specchain-pro#readme"
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Replace:
|
|
76
|
+
- `Your Name` with your actual name
|
|
77
|
+
- `your.email@example.com` with your email
|
|
78
|
+
- `yourusername` with your GitHub username
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Step 4: Build the Project (1 minute)
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
# Clean build
|
|
86
|
+
npm run build
|
|
87
|
+
|
|
88
|
+
# Verify dist folder exists
|
|
89
|
+
dir dist # Windows
|
|
90
|
+
ls dist # Linux/Mac
|
|
91
|
+
|
|
92
|
+
# Check the CLI entry point
|
|
93
|
+
type dist\cli\index.js # Windows (first line should be #!/usr/bin/env node)
|
|
94
|
+
cat dist/cli/index.js # Linux/Mac
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Step 5: Test Locally (2 minutes)
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
# Link globally
|
|
103
|
+
npm link
|
|
104
|
+
|
|
105
|
+
# Test commands
|
|
106
|
+
spec --version
|
|
107
|
+
spec --help
|
|
108
|
+
spec new "Test idea"
|
|
109
|
+
|
|
110
|
+
# Unlink
|
|
111
|
+
npm unlink -g specchain-pro
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Step 6: Dry Run (1 minute)
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# See what will be published
|
|
120
|
+
npm publish --dry-run
|
|
121
|
+
|
|
122
|
+
# Review the output - should show:
|
|
123
|
+
# - dist/ folder
|
|
124
|
+
# - package.json
|
|
125
|
+
# - README.md
|
|
126
|
+
# - LICENSE
|
|
127
|
+
# - CHANGELOG.md
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Expected output:
|
|
131
|
+
```
|
|
132
|
+
npm notice 📦 specchain-pro@0.1.0
|
|
133
|
+
npm notice === Tarball Contents ===
|
|
134
|
+
npm notice 1.1kB LICENSE
|
|
135
|
+
npm notice 2.3kB README.md
|
|
136
|
+
npm notice 1.5kB CHANGELOG.md
|
|
137
|
+
npm notice 1.2kB package.json
|
|
138
|
+
npm notice 15.2kB dist/...
|
|
139
|
+
npm notice === Tarball Details ===
|
|
140
|
+
npm notice name: specchain-pro
|
|
141
|
+
npm notice version: 0.1.0
|
|
142
|
+
npm notice filename: specchain-pro-0.1.0.tgz
|
|
143
|
+
npm notice package size: XX.X kB
|
|
144
|
+
npm notice unpacked size: XX.X kB
|
|
145
|
+
npm notice total files: XX
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## Step 7: Publish to npm! (1 minute)
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
# Publish
|
|
154
|
+
npm publish
|
|
155
|
+
|
|
156
|
+
# You should see:
|
|
157
|
+
# + specchain-pro@0.1.0
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
If successful, you'll see:
|
|
161
|
+
```
|
|
162
|
+
npm notice
|
|
163
|
+
npm notice 📦 specchain-pro@0.1.0
|
|
164
|
+
npm notice === Tarball Details ===
|
|
165
|
+
npm notice name: specchain-pro
|
|
166
|
+
npm notice version: 0.1.0
|
|
167
|
+
npm notice shasum: [hash]
|
|
168
|
+
npm notice integrity: [hash]
|
|
169
|
+
npm notice total files: XX
|
|
170
|
+
npm notice
|
|
171
|
+
npm notice Publishing to https://registry.npmjs.org/
|
|
172
|
+
+ specchain-pro@0.1.0
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Step 8: Verify Publication (2 minutes)
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
# Check on npm
|
|
181
|
+
npm view specchain-pro
|
|
182
|
+
|
|
183
|
+
# Should show your package info
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
Visit: https://www.npmjs.com/package/specchain-pro
|
|
187
|
+
|
|
188
|
+
You should see your package page! 🎉
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## Step 9: Test Installation (2 minutes)
|
|
193
|
+
|
|
194
|
+
```bash
|
|
195
|
+
# Install globally from npm
|
|
196
|
+
npm install -g specchain-pro
|
|
197
|
+
|
|
198
|
+
# Test it works
|
|
199
|
+
spec --version
|
|
200
|
+
spec --help
|
|
201
|
+
|
|
202
|
+
# Uninstall
|
|
203
|
+
npm uninstall -g specchain-pro
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## Step 10: Push to GitHub (2 minutes)
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
# Initialize git (if not done)
|
|
212
|
+
git init
|
|
213
|
+
git add .
|
|
214
|
+
git commit -m "Release v0.1.0 to npm"
|
|
215
|
+
|
|
216
|
+
# Create GitHub repo, then:
|
|
217
|
+
git remote add origin https://github.com/yourusername/specchain-pro.git
|
|
218
|
+
git branch -M main
|
|
219
|
+
git push -u origin main
|
|
220
|
+
|
|
221
|
+
# Create release tag
|
|
222
|
+
git tag -a v0.1.0 -m "Release v0.1.0: Published to npm"
|
|
223
|
+
git push origin v0.1.0
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
## Step 11: Create GitHub Release (3 minutes)
|
|
229
|
+
|
|
230
|
+
1. Go to: https://github.com/yourusername/specchain-pro/releases/new
|
|
231
|
+
2. Click "Choose a tag" → Select `v0.1.0`
|
|
232
|
+
3. Release title: `v0.1.0 - MVP Base Foundation`
|
|
233
|
+
4. Description:
|
|
234
|
+
|
|
235
|
+
```markdown
|
|
236
|
+
## 🎉 SpecChain Pro v0.1.0 - MVP Base Foundation
|
|
237
|
+
|
|
238
|
+
First release of SpecChain Pro! Now available on npm.
|
|
239
|
+
|
|
240
|
+
### 📦 Installation
|
|
241
|
+
|
|
242
|
+
```bash
|
|
243
|
+
npm install -g specchain-pro
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### ✅ What's Included
|
|
247
|
+
- Complete project infrastructure
|
|
248
|
+
- CLI interface with 6 commands
|
|
249
|
+
- Configuration management
|
|
250
|
+
- Error handling and logging
|
|
251
|
+
- Type definitions
|
|
252
|
+
- Comprehensive documentation
|
|
253
|
+
|
|
254
|
+
### 🚧 Coming Soon
|
|
255
|
+
- Local storage layer
|
|
256
|
+
- Blockchain proof layer
|
|
257
|
+
- AI spec engine
|
|
258
|
+
- Export system
|
|
259
|
+
|
|
260
|
+
### 📚 Documentation
|
|
261
|
+
- [README](https://github.com/yourusername/specchain-pro#readme)
|
|
262
|
+
- [Getting Started](GETTING_STARTED.md)
|
|
263
|
+
- [Full Roadmap](.kiro/specs/specchain-pro/roadmap.md)
|
|
264
|
+
|
|
265
|
+
### 🔗 Links
|
|
266
|
+
- npm: https://www.npmjs.com/package/specchain-pro
|
|
267
|
+
- GitHub: https://github.com/yourusername/specchain-pro
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
5. Click "Publish release"
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
## ✅ Success Checklist
|
|
275
|
+
|
|
276
|
+
- [ ] npm account created
|
|
277
|
+
- [ ] Logged in to npm (`npm whoami` works)
|
|
278
|
+
- [ ] package.json updated with your info
|
|
279
|
+
- [ ] Project built (`npm run build`)
|
|
280
|
+
- [ ] Dry run successful (`npm publish --dry-run`)
|
|
281
|
+
- [ ] Published to npm (`npm publish`)
|
|
282
|
+
- [ ] Package visible on npmjs.com
|
|
283
|
+
- [ ] Installation works (`npm install -g specchain-pro`)
|
|
284
|
+
- [ ] Pushed to GitHub
|
|
285
|
+
- [ ] GitHub release created
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
|
|
289
|
+
## 🎉 You're Live!
|
|
290
|
+
|
|
291
|
+
Your package is now published! Users can install it with:
|
|
292
|
+
|
|
293
|
+
```bash
|
|
294
|
+
npm install -g specchain-pro
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
---
|
|
298
|
+
|
|
299
|
+
## 📊 Monitor Your Package
|
|
300
|
+
|
|
301
|
+
### npm Stats
|
|
302
|
+
- Package page: https://www.npmjs.com/package/specchain-pro
|
|
303
|
+
- Download stats: https://npm-stat.com/charts.html?package=specchain-pro
|
|
304
|
+
|
|
305
|
+
### GitHub
|
|
306
|
+
- Repository: https://github.com/yourusername/specchain-pro
|
|
307
|
+
- Issues: https://github.com/yourusername/specchain-pro/issues
|
|
308
|
+
- Stars: Watch your GitHub stars grow!
|
|
309
|
+
|
|
310
|
+
---
|
|
311
|
+
|
|
312
|
+
## 🔄 Future Updates
|
|
313
|
+
|
|
314
|
+
When you add new features:
|
|
315
|
+
|
|
316
|
+
```bash
|
|
317
|
+
# 1. Make changes and build
|
|
318
|
+
npm run build
|
|
319
|
+
|
|
320
|
+
# 2. Update version
|
|
321
|
+
npm version patch # 0.1.0 → 0.1.1 (bug fixes)
|
|
322
|
+
npm version minor # 0.1.0 → 0.2.0 (new features)
|
|
323
|
+
npm version major # 0.1.0 → 1.0.0 (breaking changes)
|
|
324
|
+
|
|
325
|
+
# 3. Publish
|
|
326
|
+
npm publish
|
|
327
|
+
|
|
328
|
+
# 4. Push to GitHub
|
|
329
|
+
git push && git push --tags
|
|
330
|
+
|
|
331
|
+
# 5. Create new GitHub release
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
Or use the automated script:
|
|
335
|
+
|
|
336
|
+
```bash
|
|
337
|
+
# Windows
|
|
338
|
+
.\scripts\deploy.ps1
|
|
339
|
+
|
|
340
|
+
# Linux/Mac
|
|
341
|
+
./scripts/deploy.sh
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
---
|
|
345
|
+
|
|
346
|
+
## 🐛 Troubleshooting
|
|
347
|
+
|
|
348
|
+
### Error: "You must be logged in to publish packages"
|
|
349
|
+
```bash
|
|
350
|
+
npm login
|
|
351
|
+
npm whoami # Verify
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
### Error: "Package name too similar to existing package"
|
|
355
|
+
```bash
|
|
356
|
+
# Use a scoped package instead
|
|
357
|
+
# Update package.json: "@yourusername/specchain-pro"
|
|
358
|
+
npm publish --access public
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
### Error: "You do not have permission to publish"
|
|
362
|
+
```bash
|
|
363
|
+
# Make sure you're logged in as the right user
|
|
364
|
+
npm whoami
|
|
365
|
+
|
|
366
|
+
# If wrong user, logout and login again
|
|
367
|
+
npm logout
|
|
368
|
+
npm login
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
### Error: "402 Payment Required"
|
|
372
|
+
```bash
|
|
373
|
+
# For scoped packages, make them public
|
|
374
|
+
npm publish --access public
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Build errors
|
|
378
|
+
```bash
|
|
379
|
+
# Clean and rebuild
|
|
380
|
+
rmdir /s /q dist node_modules # Windows
|
|
381
|
+
rm -rf dist node_modules # Linux/Mac
|
|
382
|
+
|
|
383
|
+
npm install
|
|
384
|
+
npm run build
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
## 📢 Announce Your Package
|
|
390
|
+
|
|
391
|
+
Share on:
|
|
392
|
+
- **Twitter/X**: "Just published SpecChain Pro to npm! 🚀"
|
|
393
|
+
- **Reddit**: r/node, r/programming, r/javascript
|
|
394
|
+
- **Dev.to**: Write a launch post
|
|
395
|
+
- **Hacker News**: Show HN post
|
|
396
|
+
- **LinkedIn**: Professional announcement
|
|
397
|
+
|
|
398
|
+
Example tweet:
|
|
399
|
+
```
|
|
400
|
+
🚀 Just published SpecChain Pro v0.1.0 to npm!
|
|
401
|
+
|
|
402
|
+
AI-powered specification generation with blockchain proof-of-authorship.
|
|
403
|
+
|
|
404
|
+
Install: npm install -g specchain-pro
|
|
405
|
+
|
|
406
|
+
Features:
|
|
407
|
+
✨ Transform ideas into structured specs
|
|
408
|
+
🔐 Blockchain-based proof of ownership
|
|
409
|
+
⚡ CLI-first developer experience
|
|
410
|
+
|
|
411
|
+
#opensource #nodejs #blockchain #ai
|
|
412
|
+
|
|
413
|
+
https://www.npmjs.com/package/specchain-pro
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
---
|
|
417
|
+
|
|
418
|
+
## 🎯 Next Steps
|
|
419
|
+
|
|
420
|
+
1. ✅ Package published to npm
|
|
421
|
+
2. ✅ GitHub repository created
|
|
422
|
+
3. ✅ Release notes published
|
|
423
|
+
4. 📢 Announce on social media
|
|
424
|
+
5. 👀 Monitor downloads and issues
|
|
425
|
+
6. 🔨 Continue building features from tasks.md
|
|
426
|
+
7. 🚀 Publish updates regularly
|
|
427
|
+
|
|
428
|
+
---
|
|
429
|
+
|
|
430
|
+
**Congratulations! You're now an npm package author! 🎉**
|
|
431
|
+
|
|
432
|
+
Your package: https://www.npmjs.com/package/specchain-pro
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Quick Command Reference for Publishing to npm
|
|
2
|
+
|
|
3
|
+
## Step-by-Step Commands (Copy & Paste)
|
|
4
|
+
|
|
5
|
+
# 1. Create npm account (if needed)
|
|
6
|
+
npm adduser
|
|
7
|
+
|
|
8
|
+
# 2. Login to npm
|
|
9
|
+
npm login
|
|
10
|
+
npm whoami
|
|
11
|
+
|
|
12
|
+
# 3. Build project
|
|
13
|
+
npm run build
|
|
14
|
+
|
|
15
|
+
# 4. Test locally
|
|
16
|
+
npm link
|
|
17
|
+
spec --version
|
|
18
|
+
spec --help
|
|
19
|
+
npm unlink -g specchain-pro
|
|
20
|
+
|
|
21
|
+
# 5. Dry run
|
|
22
|
+
npm publish --dry-run
|
|
23
|
+
|
|
24
|
+
# 6. Publish to npm
|
|
25
|
+
npm publish
|
|
26
|
+
|
|
27
|
+
# 7. Verify
|
|
28
|
+
npm view specchain-pro
|
|
29
|
+
|
|
30
|
+
# 8. Test installation
|
|
31
|
+
npm install -g specchain-pro
|
|
32
|
+
spec --version
|
|
33
|
+
npm uninstall -g specchain-pro
|
|
34
|
+
|
|
35
|
+
# 9. Push to GitHub
|
|
36
|
+
git init
|
|
37
|
+
git add .
|
|
38
|
+
git commit -m "Release v0.1.0 to npm"
|
|
39
|
+
git remote add origin https://github.com/yourusername/specchain-pro.git
|
|
40
|
+
git push -u origin main
|
|
41
|
+
git tag -a v0.1.0 -m "Release v0.1.0"
|
|
42
|
+
git push origin v0.1.0
|
|
43
|
+
|
|
44
|
+
# Done! Your package is live at:
|
|
45
|
+
# https://www.npmjs.com/package/specchain-pro
|
|
46
|
+
|
|
47
|
+
## Future Updates
|
|
48
|
+
|
|
49
|
+
# Update version and publish
|
|
50
|
+
npm version patch # or minor, or major
|
|
51
|
+
npm publish
|
|
52
|
+
git push && git push --tags
|
|
53
|
+
|
|
54
|
+
## Or use automated script
|
|
55
|
+
|
|
56
|
+
# Windows
|
|
57
|
+
.\scripts\deploy.ps1
|
|
58
|
+
|
|
59
|
+
# Linux/Mac
|
|
60
|
+
chmod +x scripts/deploy.sh
|
|
61
|
+
./scripts/deploy.sh
|
package/QUICK_DEPLOY.md
ADDED
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# Quick Deployment Guide
|
|
2
|
+
|
|
3
|
+
## 🚀 Deploy in 5 Minutes
|
|
4
|
+
|
|
5
|
+
### Prerequisites
|
|
6
|
+
- Node.js 18+ installed
|
|
7
|
+
- npm account created
|
|
8
|
+
- Git repository initialized
|
|
9
|
+
|
|
10
|
+
### Step 1: Prepare Package (1 min)
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Update package.json with your details
|
|
14
|
+
# - name: "specchain-pro" or "@yourusername/specchain-pro"
|
|
15
|
+
# - author: "Your Name <email@example.com>"
|
|
16
|
+
# - repository: Your GitHub URL
|
|
17
|
+
|
|
18
|
+
# Build the project
|
|
19
|
+
npm run build
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Step 2: Test Locally (1 min)
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Test the CLI
|
|
26
|
+
npm link
|
|
27
|
+
spec --help
|
|
28
|
+
spec --version
|
|
29
|
+
npm unlink
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Step 3: Login to npm (30 sec)
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm login
|
|
36
|
+
# Enter username, password, email
|
|
37
|
+
npm whoami # Verify login
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Step 4: Publish to npm (1 min)
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# Dry run first
|
|
44
|
+
npm publish --dry-run
|
|
45
|
+
|
|
46
|
+
# Publish for real
|
|
47
|
+
npm publish
|
|
48
|
+
|
|
49
|
+
# For scoped packages (@username/package)
|
|
50
|
+
npm publish --access public
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Step 5: Push to GitHub (1 min)
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# Initialize git (if not done)
|
|
57
|
+
git init
|
|
58
|
+
git add .
|
|
59
|
+
git commit -m "Initial release v0.1.0"
|
|
60
|
+
|
|
61
|
+
# Create GitHub repo, then:
|
|
62
|
+
git remote add origin https://github.com/yourusername/specchain-pro.git
|
|
63
|
+
git branch -M main
|
|
64
|
+
git push -u origin main
|
|
65
|
+
|
|
66
|
+
# Create tag
|
|
67
|
+
git tag -a v0.1.0 -m "Release v0.1.0"
|
|
68
|
+
git push origin v0.1.0
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Step 6: Verify (30 sec)
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# Check on npm
|
|
75
|
+
npm view specchain-pro
|
|
76
|
+
|
|
77
|
+
# Install globally and test
|
|
78
|
+
npm install -g specchain-pro
|
|
79
|
+
spec --version
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## ✅ Done!
|
|
83
|
+
|
|
84
|
+
Your package is now live on npm! 🎉
|
|
85
|
+
|
|
86
|
+
### Next Steps
|
|
87
|
+
|
|
88
|
+
1. **Create GitHub Release**
|
|
89
|
+
- Go to: https://github.com/yourusername/specchain-pro/releases/new
|
|
90
|
+
- Select tag: v0.1.0
|
|
91
|
+
- Add release notes from CHANGELOG.md
|
|
92
|
+
|
|
93
|
+
2. **Share Your Project**
|
|
94
|
+
- Twitter/X
|
|
95
|
+
- Reddit (r/node, r/programming)
|
|
96
|
+
- Dev.to
|
|
97
|
+
- Hacker News
|
|
98
|
+
|
|
99
|
+
3. **Monitor**
|
|
100
|
+
- npm downloads: https://npm-stat.com/charts.html?package=specchain-pro
|
|
101
|
+
- GitHub stars and issues
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 🔧 Automated Deployment (Recommended)
|
|
106
|
+
|
|
107
|
+
### Using Deployment Script
|
|
108
|
+
|
|
109
|
+
**Linux/Mac:**
|
|
110
|
+
```bash
|
|
111
|
+
chmod +x scripts/deploy.sh
|
|
112
|
+
./scripts/deploy.sh
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
**Windows:**
|
|
116
|
+
```powershell
|
|
117
|
+
.\scripts\deploy.ps1
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
The script will:
|
|
121
|
+
- ✓ Run all checks
|
|
122
|
+
- ✓ Build the project
|
|
123
|
+
- ✓ Bump version
|
|
124
|
+
- ✓ Publish to npm
|
|
125
|
+
- ✓ Push to git with tags
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## 🐛 Common Issues
|
|
130
|
+
|
|
131
|
+
### "Package name already taken"
|
|
132
|
+
```bash
|
|
133
|
+
# Use scoped package
|
|
134
|
+
# Update package.json: "@yourusername/specchain-pro"
|
|
135
|
+
npm publish --access public
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### "Not logged in"
|
|
139
|
+
```bash
|
|
140
|
+
npm login
|
|
141
|
+
npm whoami
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### "Build fails"
|
|
145
|
+
```bash
|
|
146
|
+
rm -rf node_modules dist
|
|
147
|
+
npm install
|
|
148
|
+
npm run build
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### "CLI not working"
|
|
152
|
+
```bash
|
|
153
|
+
# Check dist/cli/index.js has shebang
|
|
154
|
+
head -n 1 dist/cli/index.js
|
|
155
|
+
# Should show: #!/usr/bin/env node
|
|
156
|
+
|
|
157
|
+
# Make executable (Linux/Mac)
|
|
158
|
+
chmod +x dist/cli/index.js
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 📊 Deployment Checklist
|
|
164
|
+
|
|
165
|
+
- [ ] package.json updated with your details
|
|
166
|
+
- [ ] Build successful (`npm run build`)
|
|
167
|
+
- [ ] Tests passing (`npm test`)
|
|
168
|
+
- [ ] Logged in to npm (`npm whoami`)
|
|
169
|
+
- [ ] Published to npm (`npm publish`)
|
|
170
|
+
- [ ] Pushed to GitHub with tags
|
|
171
|
+
- [ ] GitHub release created
|
|
172
|
+
- [ ] Package installable (`npm install -g specchain-pro`)
|
|
173
|
+
- [ ] CLI working (`spec --help`)
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 🎯 Version Updates
|
|
178
|
+
|
|
179
|
+
For future releases:
|
|
180
|
+
|
|
181
|
+
```bash
|
|
182
|
+
# Bug fix (0.1.0 → 0.1.1)
|
|
183
|
+
npm version patch
|
|
184
|
+
npm publish
|
|
185
|
+
git push && git push --tags
|
|
186
|
+
|
|
187
|
+
# New feature (0.1.0 → 0.2.0)
|
|
188
|
+
npm version minor
|
|
189
|
+
npm publish
|
|
190
|
+
git push && git push --tags
|
|
191
|
+
|
|
192
|
+
# Breaking change (0.1.0 → 1.0.0)
|
|
193
|
+
npm version major
|
|
194
|
+
npm publish
|
|
195
|
+
git push && git push --tags
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## 📚 Full Documentation
|
|
201
|
+
|
|
202
|
+
For detailed deployment instructions, see [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md)
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
**Ready to deploy? Let's go! 🚀**
|