Skip to content

Commit f20671f

Browse files
authored
chore: bump @socketsecurity/lib to 5.11.3 (#75)
1 parent 6aa4807 commit f20671f

4 files changed

Lines changed: 90 additions & 10 deletions

File tree

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# updating Reference Documentation
2+
3+
## Table of Contents
4+
5+
1. [How the Update Script Works](#how-the-update-script-works)
6+
2. [Files Changed After Update](#files-changed-after-update)
7+
3. [Validation Commands](#validation-commands)
8+
4. [Troubleshooting](#troubleshooting)
9+
10+
---
11+
12+
## How the Update Script Works
13+
14+
`pnpm run update` runs `scripts/update.mjs` which performs:
15+
16+
```bash
17+
# 1. Run taze recursively with write mode
18+
pnpm exec taze -r -w
19+
20+
# 2. Force-update Socket scoped packages (bypasses taze maturity period)
21+
pnpm update @socketsecurity/* @socketregistry/* @socketbin/* --latest -r
22+
23+
# 3. pnpm install runs automatically to reconcile lockfile
24+
```
25+
26+
### Repo Structure
27+
28+
- **Monorepo** with pnpm workspaces: `packages/npm/*`, `perf/*`, `registry`, `scripts`
29+
- Uses `pnpm-workspace.yaml` catalog for centralized version management
30+
- Dependencies use `catalog:` references in package.json files
31+
- Has `pnpm.overrides` mapping many packages to `@socketregistry/*` replacements
32+
- Has `pnpm.patchedDependencies` for brace-expansion, iconv-lite, minimatch
33+
34+
---
35+
36+
## Files Changed After Update
37+
38+
- `package.json` - Root dependency version pins
39+
- `pnpm-workspace.yaml` - Catalog version entries
40+
- `packages/npm/*/package.json` - Workspace package dependencies
41+
- `pnpm-lock.yaml` - Lock file
42+
43+
---
44+
45+
## Validation Commands
46+
47+
```bash
48+
# Fix lint issues
49+
pnpm run fix --all
50+
51+
# Run all checks (lint + type check)
52+
pnpm run check --all
53+
54+
# Run tests
55+
pnpm test
56+
```
57+
58+
---
59+
60+
## Troubleshooting
61+
62+
### taze Fails to Detect Updates
63+
64+
**Cause:** taze has a maturity period for new releases.
65+
**Solution:** Socket packages are force-updated separately via `pnpm update --latest`.
66+
67+
### Catalog Version Mismatches
68+
69+
**Symptom:** Workspace packages reference `catalog:` but version differs from
70+
what taze wrote to root `package.json`.
71+
**Solution:** Ensure `pnpm-workspace.yaml` catalog entries match. taze updates
72+
catalog entries directly when using `-r -w`.
73+
74+
### Lock File Conflicts
75+
76+
**Solution:**
77+
```bash
78+
rm pnpm-lock.yaml
79+
pnpm install
80+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"@socketregistry/is-unicode-supported": "workspace:*",
6464
"@socketregistry/packageurl-js": "catalog:",
6565
"@socketregistry/scripts": "file:scripts",
66-
"@socketsecurity/lib": "5.11.2",
66+
"@socketsecurity/lib": "5.11.3",
6767
"@types/fs-extra": "catalog:",
6868
"@types/node": "catalog:",
6969
"@types/normalize-package-data": "catalog:",

pnpm-lock.yaml

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pnpm-workspace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ catalog:
2222
'@npmcli/package-json': 7.0.0
2323
'@npmcli/promise-spawn': 8.0.3
2424
'@socketregistry/packageurl-js': 1.3.5
25-
'@socketsecurity/lib': 5.11.2
25+
'@socketsecurity/lib': 5.11.3
2626
'@types/fs-extra': 11.0.4
2727
'@types/node': 24.9.2
2828
'@types/normalize-package-data': 2.4.4

0 commit comments

Comments
 (0)