coderifts 1.2.0 → 1.5.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 +6 -20
- package/package.json +5 -9
package/README.md
CHANGED
|
@@ -1,17 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @coderifts/cli
|
|
2
2
|
|
|
3
3
|
Detect breaking API changes between OpenAPI specs from the command line. Works locally or with the CodeRifts cloud API.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install -g coderifts
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
Or run without installing:
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
npx coderifts diff old-api.yaml new-api.yaml
|
|
8
|
+
npm install -g @coderifts/cli
|
|
15
9
|
```
|
|
16
10
|
|
|
17
11
|
## Quick Start
|
|
@@ -70,7 +64,8 @@ Save your CodeRifts API key for cloud features. Get a free key at [app.coderifts
|
|
|
70
64
|
|
|
71
65
|
```yaml
|
|
72
66
|
- name: Check API breaking changes
|
|
73
|
-
run:
|
|
67
|
+
run: |
|
|
68
|
+
npx @coderifts/cli diff old-api.yaml new-api.yaml --ci --format json
|
|
74
69
|
```
|
|
75
70
|
|
|
76
71
|
### GitLab CI
|
|
@@ -78,13 +73,13 @@ Save your CodeRifts API key for cloud features. Get a free key at [app.coderifts
|
|
|
78
73
|
```yaml
|
|
79
74
|
api-check:
|
|
80
75
|
script:
|
|
81
|
-
- npx coderifts diff old-api.yaml new-api.yaml --ci --threshold 40
|
|
76
|
+
- npx @coderifts/cli diff old-api.yaml new-api.yaml --ci --threshold 40
|
|
82
77
|
```
|
|
83
78
|
|
|
84
79
|
### Jenkins
|
|
85
80
|
|
|
86
81
|
```groovy
|
|
87
|
-
sh 'npx coderifts diff old-api.yaml new-api.yaml --ci'
|
|
82
|
+
sh 'npx @coderifts/cli diff old-api.yaml new-api.yaml --ci'
|
|
88
83
|
```
|
|
89
84
|
|
|
90
85
|
## Environment Variables
|
|
@@ -94,18 +89,9 @@ sh 'npx coderifts diff old-api.yaml new-api.yaml --ci'
|
|
|
94
89
|
| `CODERIFTS_API_KEY` | API key (alternative to `coderifts login`) |
|
|
95
90
|
| `NO_COLOR` | Disable colored output |
|
|
96
91
|
|
|
97
|
-
## Exit Codes
|
|
98
|
-
|
|
99
|
-
| Code | Meaning |
|
|
100
|
-
|------|---------|
|
|
101
|
-
| `0` | No breaking changes (or below threshold) |
|
|
102
|
-
| `1` | Breaking changes found (in CI mode) or analysis failed |
|
|
103
|
-
|
|
104
92
|
## Links
|
|
105
93
|
|
|
106
94
|
- [Website](https://coderifts.com)
|
|
107
|
-
- [CLI Integration Page](https://coderifts.com/integrations/cli/)
|
|
108
95
|
- [API Docs](https://app.coderifts.com/api/docs)
|
|
109
96
|
- [Get API Key](https://app.coderifts.com/api/signup)
|
|
110
97
|
- [GitHub](https://github.com/coderifts/app)
|
|
111
|
-
- [npm](https://www.npmjs.com/package/coderifts)
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "coderifts",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
4
|
"description": "Detect breaking API changes from the command line. Works locally or with the CodeRifts cloud API.",
|
|
5
5
|
"author": "CodeRifts <hello@coderifts.com>",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"bin": {
|
|
8
|
-
"coderifts": "./bin/coderifts.js"
|
|
8
|
+
"coderifts-cli": "./bin/coderifts.js"
|
|
9
9
|
},
|
|
10
10
|
"main": "src/commands/diff.js",
|
|
11
11
|
"files": [
|
|
@@ -21,8 +21,7 @@
|
|
|
21
21
|
"governance",
|
|
22
22
|
"cli",
|
|
23
23
|
"ci-cd",
|
|
24
|
-
"swagger"
|
|
25
|
-
"devtools"
|
|
24
|
+
"swagger"
|
|
26
25
|
],
|
|
27
26
|
"repository": {
|
|
28
27
|
"type": "git",
|
|
@@ -32,10 +31,7 @@
|
|
|
32
31
|
"homepage": "https://coderifts.com",
|
|
33
32
|
"bugs": "https://github.com/coderifts/app/issues",
|
|
34
33
|
"engines": {
|
|
35
|
-
"node": ">=
|
|
36
|
-
},
|
|
37
|
-
"scripts": {
|
|
38
|
-
"test": "node --test test/*.test.js"
|
|
34
|
+
"node": ">=16.0.0"
|
|
39
35
|
},
|
|
40
36
|
"dependencies": {
|
|
41
37
|
"chalk": "^4.1.2",
|
|
@@ -43,7 +39,7 @@
|
|
|
43
39
|
"commander": "^12.0.0",
|
|
44
40
|
"inquirer": "^8.2.6",
|
|
45
41
|
"js-yaml": "^4.1.0",
|
|
46
|
-
"openapi-diff": "^0.
|
|
42
|
+
"openapi-diff": "^0.23.5",
|
|
47
43
|
"ora": "^5.4.1"
|
|
48
44
|
}
|
|
49
45
|
}
|