pnpm-catalog-updates 0.6.5 → 0.6.6
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 +130 -0
- package/package.json +2 -4
package/README.md
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# pcu
|
|
2
|
+
|
|
3
|
+
A powerful CLI tool for managing pnpm workspace catalog dependencies with ease.
|
|
4
|
+
|
|
5
|
+
## 🚀 Quick Start
|
|
6
|
+
|
|
7
|
+
### Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Install globally
|
|
11
|
+
npm install -g pcu
|
|
12
|
+
|
|
13
|
+
# Or use with pnpm
|
|
14
|
+
pnpm add -g pcu
|
|
15
|
+
|
|
16
|
+
# Or use legacy package name
|
|
17
|
+
npm install -g pnpm-catalog-updates
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Usage
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Check for outdated catalog dependencies
|
|
24
|
+
pcu check
|
|
25
|
+
# or
|
|
26
|
+
pcu -c
|
|
27
|
+
|
|
28
|
+
# Update catalog dependencies interactively
|
|
29
|
+
pcu update --interactive
|
|
30
|
+
# or
|
|
31
|
+
pcu -i
|
|
32
|
+
|
|
33
|
+
# Update to latest versions
|
|
34
|
+
pcu update
|
|
35
|
+
# or
|
|
36
|
+
pcu -u
|
|
37
|
+
|
|
38
|
+
# Analyze impact of updates
|
|
39
|
+
pcu analyze
|
|
40
|
+
# or
|
|
41
|
+
pcu -a
|
|
42
|
+
|
|
43
|
+
# Show workspace information
|
|
44
|
+
pcu workspace
|
|
45
|
+
# or
|
|
46
|
+
pcu -s
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## 📋 Commands
|
|
50
|
+
|
|
51
|
+
| Command | Shorthand | Description |
|
|
52
|
+
| --------------- | --------- | ----------------------------------------------- |
|
|
53
|
+
| `pcu check` | `pcu -c` | Check for outdated catalog dependencies |
|
|
54
|
+
| `pcu update` | `pcu -u` | Update catalog dependencies |
|
|
55
|
+
| `pcu analyze` | `pcu -a` | Analyze impact of dependency updates |
|
|
56
|
+
| `pcu workspace` | `pcu -s` | Show workspace information and validation |
|
|
57
|
+
| `pcu init` | | Initialize workspace with catalog configuration |
|
|
58
|
+
| `pcu help` | `pcu -h` | Display help information |
|
|
59
|
+
|
|
60
|
+
## 🎯 Common Examples
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# Interactive update with backup
|
|
64
|
+
pcu update --interactive --backup
|
|
65
|
+
|
|
66
|
+
# Update only minor versions
|
|
67
|
+
pcu update --target minor
|
|
68
|
+
|
|
69
|
+
# Check specific catalog
|
|
70
|
+
pcu check --catalog node18
|
|
71
|
+
|
|
72
|
+
# Analyze before updating
|
|
73
|
+
pcu analyze default react
|
|
74
|
+
|
|
75
|
+
# Validate workspace
|
|
76
|
+
pcu workspace --validate
|
|
77
|
+
|
|
78
|
+
# Dry run update
|
|
79
|
+
pcu update --dry-run
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## ⚙️ Options
|
|
83
|
+
|
|
84
|
+
### Global Options
|
|
85
|
+
|
|
86
|
+
- `--help, -h`: Show help
|
|
87
|
+
- `--version, -v`: Show version
|
|
88
|
+
- `--verbose`: Enable verbose logging
|
|
89
|
+
- `--quiet`: Suppress non-error output
|
|
90
|
+
|
|
91
|
+
### Update Options
|
|
92
|
+
|
|
93
|
+
- `--interactive, -i`: Interactive mode
|
|
94
|
+
- `--dry-run, -d`: Show what would be updated without making changes
|
|
95
|
+
- `--backup, -b`: Create backup before updating
|
|
96
|
+
- `--target <level>`: Update target (patch|minor|major|latest)
|
|
97
|
+
- `--catalog <name>`: Target specific catalog
|
|
98
|
+
|
|
99
|
+
## 📁 Configuration
|
|
100
|
+
|
|
101
|
+
Create a `.pcurc.json` file in your project root:
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"catalogs": ["default", "node18", "dev"],
|
|
106
|
+
"updateTarget": "minor",
|
|
107
|
+
"backup": true,
|
|
108
|
+
"interactive": false
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## 🔧 Requirements
|
|
113
|
+
|
|
114
|
+
- Node.js >= 22.0.0
|
|
115
|
+
- pnpm workspace with catalog configuration
|
|
116
|
+
- pnpm-workspace.yaml with catalog entries
|
|
117
|
+
|
|
118
|
+
## 📚 Documentation
|
|
119
|
+
|
|
120
|
+
For complete documentation, visit:
|
|
121
|
+
[pnpm-catalog-updates](https://github.com/houko/pnpm-catalog-updates#readme)
|
|
122
|
+
|
|
123
|
+
## 🤝 Contributing
|
|
124
|
+
|
|
125
|
+
Found a bug or want to contribute? Visit our
|
|
126
|
+
[GitHub repository](https://github.com/houko/pnpm-catalog-updates).
|
|
127
|
+
|
|
128
|
+
## 📄 License
|
|
129
|
+
|
|
130
|
+
MIT © [Evan Hu](https://github.com/houko)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pnpm-catalog-updates",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.6",
|
|
4
4
|
"description": "CLI application for pnpm-catalog-updates",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -14,9 +14,7 @@
|
|
|
14
14
|
"dist",
|
|
15
15
|
"bin",
|
|
16
16
|
"src",
|
|
17
|
-
"
|
|
18
|
-
"../../README.ja.md",
|
|
19
|
-
"../../README.zh-CN.md"
|
|
17
|
+
"README.md"
|
|
20
18
|
],
|
|
21
19
|
"scripts": {
|
|
22
20
|
"build": "tsup && pnpm run build:bin",
|