@zityhub/check-updates 0.0.6 → 1.0.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/README.md +72 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# check-updates
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@zityhub/check-updates)
|
|
4
|
+
[](https://github.com/zityhub/check-updates/actions/workflows/ci.yml)
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
Install it as a development dependency:
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npm install -D @zityhub/check-updates
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Or run it directly using [npx](https://docs.npmjs.com/cli/v7/commands/npx):
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
npx @zityhub/check-updates
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
Check if any of your project's dependencies have a major version update:
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
check-updates
|
|
26
|
+
|
|
27
|
+
2024-10-08T18:32:05.485Z ERROR Job check-updates finished failed
|
|
28
|
+
{
|
|
29
|
+
"type": {
|
|
30
|
+
"name": "job",
|
|
31
|
+
"data": {
|
|
32
|
+
"jobName": "check-updates",
|
|
33
|
+
"message": "Major update available for: awilix,jsonpath-plus,stripe"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The command will return an error if there are any packages that need a major version update.
|
|
40
|
+
|
|
41
|
+
## Exclude Packages
|
|
42
|
+
|
|
43
|
+
You can ignore specific dependencies to ensure the check returns an exit code 0:
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
check-updates --exclude=awilix --exclude=jsonpath-plus --exclude=stripe
|
|
47
|
+
|
|
48
|
+
2024-10-08T18:34:51.341Z INFO Job check-updates finished success
|
|
49
|
+
{
|
|
50
|
+
"type": {
|
|
51
|
+
"name": "job",
|
|
52
|
+
"data": {
|
|
53
|
+
"jobName": "check-updates",
|
|
54
|
+
"message": "Major update available for: awilix,jsonpath-plus,stripe"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Add it as a Script in your Package
|
|
61
|
+
|
|
62
|
+
It is recommended to add it as a script in your package.json for easier usage:
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"scripts": {
|
|
67
|
+
"check-updates": "check-updates"
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
|
package/package.json
CHANGED