You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-21Lines changed: 31 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,23 +20,25 @@ Say goodbye to unnoticed, years-old dependencies!
20
20
21
21
<br>
22
22
23
-
## Install
24
-
25
-
```bash
26
-
composer require rector/jack --dev
27
-
```
28
-
29
-
<br>
30
-
31
23
## Why Jack?
32
24
33
-
Manually upgrading dependencies can be daunting, especially when tackling multiple outdated packages at once. Large upgrades often lead to errors, compatibility issues, and costly delays. Jack automates and simplifies this process by:
25
+
Manually upgrading dependencies can be daunting, especially when tackling multiple outdated packages at once. Large upgrades often lead to errors, compatibility issues, and costly delays.
26
+
27
+
Jack automates and simplifies this process by:
34
28
35
29
- Monitoring outdated dependencies via CI.
36
30
- Gradually opening up package versions for safe updates.
37
31
- Prioritizing low-risk updates (e.g., dev dependencies).
38
32
39
-
With Jack, you upgrade **slowly and steadily**, avoiding the stress of massive, error-prone dependency overhauls.
33
+
<br>
34
+
35
+
## Install
36
+
37
+
Rector Jack is downgraded and scoped. It requires **PHP 7.2+** and can be installed on any legacy project.
38
+
39
+
```bash
40
+
composer require rector/jack --dev
41
+
```
40
42
41
43
<br>
42
44
@@ -48,29 +50,33 @@ Jack offers two powerful commands to keep your dependencies up to date:
48
50
49
51
### 1. Too many outdated dependencies? Let your CI tell you
50
52
51
-
Postponing upgrades often results in large, risky jumps (e.g., updating every few years). Jack integrates with your CI pipeline to catch outdated dependencies early.
53
+
Postponing upgrades often results in large, risky jumps (e.g., updating once a 3 years). Jack integrates with your CI pipeline to catch outdated dependencies early.
52
54
53
-
Run the `breakpoint` command to check for outdated major packages:
55
+
Run the `breakpoint` command to check for **outdated major packages**:
54
56
55
57
```bash
56
58
vendor/bin/jack breakpoint
57
59
```
58
60
59
61
<br>
60
62
61
-
By default, CI fails if there are more than **5 outdated packages**. Customize this limit to suit your project’s needs:
63
+
If there are more than 5 major outdated packages, the **CI will fail**.
64
+
65
+
<br>
66
+
67
+
Use `--limit` to raise or lower your bar:
62
68
63
69
```bash
64
70
vendor/bin/jack breakpoint --limit 3
65
71
```
66
72
67
-
This ensures upgrades stay on your radar without overwhelming you. No more "oops, our dependencies are three years old" moments!
73
+
This ensures upgrades stay on your radar without overwhelming you. No more "oops, our 30 dependencies are 5 years old" moments!
68
74
69
75
<br>
70
76
71
77
### 2. Open up Next Versions
72
78
73
-
We know we're behind the latest versions of our dependencies, but where to start? Which versions should be force to update first? We can get lot of errors if we try to bump wrong end of knot.
79
+
We know we're behind the latest versions of our dependencies, but where to start? Which versions should be force to update first? We can get lot of conflicts if we try to bump wrong end of knot.
74
80
75
81
Instead, let composer handle it. How? We open-up package versions to the next version:
76
82
@@ -89,29 +95,33 @@ Instead, let composer handle it. How? We open-up package versions to the next ve
89
95
}
90
96
```
91
97
92
-
This "opens up" versions without forcing updates. If no blockers exist, Composer will upgrade to the next version.
98
+
This "opens up" 5 versions without forcing updates. If no blockers exist, Composer will upgrade to the next version.
93
99
94
-
<br>
100
+
Then we run composer and let it do the work:
101
+
102
+
```bash
103
+
composer update
104
+
```
95
105
96
-
Command Options:
106
+
<br>
97
107
98
-
**Limit the number of packages** to process (default: 5):
108
+
To change the number of packages, use `--limit` option:
99
109
100
110
```bash
101
111
vendor/bin/jack open-versions --limit 3
102
112
```
103
113
104
114
<br>
105
115
106
-
**Dry run** to preview changes without modifying `composer.json`:
116
+
To preview changes without modifying `composer.json`, use:
107
117
108
118
```bash
109
119
vendor/bin/jack open-versions --dry-run
110
120
```
111
121
112
122
<br>
113
123
114
-
**Update dev dependencies first** for safer, low-risk updates:
124
+
Do you want to play it safe? Try low-risk dev packages first:
0 commit comments