|
| 1 | +# Script Simplification Quick Start |
| 2 | + |
| 3 | +**For:** socket-sdk-js, socket-packageurl-js, socket-lib, socket-registry |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 🎯 Quick Wins |
| 8 | + |
| 9 | +### 1. Remove Redundant `-ci` Scripts |
| 10 | + |
| 11 | +```bash |
| 12 | +# Find all -ci scripts |
| 13 | +grep -r '".*-ci"' package.json packages/*/package.json |
| 14 | + |
| 15 | +# Remove them - they're just duplicates! |
| 16 | +# Use base commands in CI with flags instead |
| 17 | +``` |
| 18 | + |
| 19 | +**Example:** |
| 20 | +```diff |
| 21 | + { |
| 22 | + "scripts": { |
| 23 | + "lint": "eslint .", |
| 24 | +- "lint-ci": "eslint .", |
| 25 | + "test": "vitest run", |
| 26 | +- "test-ci": "vitest run" |
| 27 | + } |
| 28 | + } |
| 29 | +``` |
| 30 | + |
| 31 | +### 2. Standardize Test Commands |
| 32 | + |
| 33 | +**Use this pattern everywhere:** |
| 34 | +```json |
| 35 | +{ |
| 36 | + "scripts": { |
| 37 | + "test": "vitest run", |
| 38 | + "test:watch": "vitest", |
| 39 | + "test:coverage": "vitest run --coverage" |
| 40 | + } |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +### 3. Remove Duplicate `:all` Scripts |
| 45 | + |
| 46 | +If base command already does everything, remove the `:all` variant: |
| 47 | + |
| 48 | +```diff |
| 49 | + { |
| 50 | + "scripts": { |
| 51 | + "type": "tsc --noEmit", |
| 52 | +- "type:all": "tsc --noEmit" |
| 53 | + } |
| 54 | + } |
| 55 | +``` |
| 56 | + |
| 57 | +--- |
| 58 | + |
| 59 | +## 📊 Impact |
| 60 | + |
| 61 | +**socket-cli results:** |
| 62 | +- **Removed:** 4 redundant `-ci` scripts |
| 63 | +- **Saved:** ~15% script count |
| 64 | +- **Benefit:** Clearer, more maintainable |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## 📖 Full Guide |
| 69 | + |
| 70 | +See complete consolidation guide: |
| 71 | +- **socket-cli:** `docs/development/script-consolidation-guide.md` |
| 72 | +- **GitHub:** https://github.com/SocketDev/socket-cli/blob/main/docs/development/script-consolidation-guide.md |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## ✅ Quick Audit Checklist |
| 77 | + |
| 78 | +Run these commands in your repo: |
| 79 | + |
| 80 | +```bash |
| 81 | +# 1. Show all scripts |
| 82 | +cat package.json | jq '.scripts' |
| 83 | + |
| 84 | +# 2. Find -ci aliases (should remove these) |
| 85 | +grep -E '"[^"]*-ci"' package.json |
| 86 | + |
| 87 | +# 3. Find duplicate patterns |
| 88 | +find packages -name package.json -exec \ |
| 89 | + jq -r '.name + ": " + (.scripts.test // "none")' {} \; |
| 90 | +``` |
| 91 | + |
| 92 | +**Look for:** |
| 93 | +- [ ] Any script ending in `-ci` |
| 94 | +- [ ] Duplicate scripts in root and packages |
| 95 | +- [ ] Inconsistent test command patterns |
| 96 | +- [ ] Scripts that do the exact same thing |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +## 🚀 Quick Implementation |
| 101 | + |
| 102 | +```bash |
| 103 | +# 1. Backup |
| 104 | +cp package.json package.json.backup |
| 105 | + |
| 106 | +# 2. Remove -ci scripts |
| 107 | +# Edit package.json, remove all *-ci entries |
| 108 | + |
| 109 | +# 3. Update CI workflows |
| 110 | +# Change references from 'lint-ci' to 'lint' |
| 111 | + |
| 112 | +# 4. Test |
| 113 | +pnpm run lint |
| 114 | +pnpm run test |
| 115 | +pnpm run type |
| 116 | + |
| 117 | +# 5. Commit |
| 118 | +git add package.json |
| 119 | +git commit -m "chore: remove redundant -ci script aliases" |
| 120 | +``` |
| 121 | + |
| 122 | +--- |
| 123 | + |
| 124 | +## 🤝 Share This! |
| 125 | + |
| 126 | +Copy this file to other Socket repos: |
| 127 | +```bash |
| 128 | +# In each repo: |
| 129 | +mkdir -p docs/development |
| 130 | +cp /path/to/socket-cli/docs/development/SCRIPT-SIMPLIFICATION-QUICK-START.md \ |
| 131 | + docs/development/ |
| 132 | +``` |
| 133 | + |
| 134 | +--- |
| 135 | + |
| 136 | +**Questions?** See full guide or reach out to Socket dev team. |
0 commit comments