@checkdigit/spectral-config 2.0.1 → 2.1.0-PR.17-6936
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/LICENSE +1 -1
- package/README.md +11 -9
- package/package.json +1 -47
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ Spectral Config should be installed as a dev dependency:
|
|
|
11
11
|
|
|
12
12
|
Once installed, add a file named `.spectral.json` to the root of your project. This file should extend Spectral Config:
|
|
13
13
|
|
|
14
|
-
```
|
|
14
|
+
```json
|
|
15
15
|
{
|
|
16
16
|
"extends": ["@checkdigit/spectral-config"]
|
|
17
17
|
}
|
|
@@ -19,20 +19,22 @@ Once installed, add a file named `.spectral.json` to the root of your project. T
|
|
|
19
19
|
|
|
20
20
|
Also add the following to your `package.json` to run Spectral:
|
|
21
21
|
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
22
|
+
```json
|
|
23
|
+
{
|
|
24
|
+
"scripts": {
|
|
25
|
+
"lint:openapi": "spectral lint src/**/swagger.yml"
|
|
26
|
+
}
|
|
26
27
|
}
|
|
27
28
|
```
|
|
28
29
|
|
|
29
30
|
To include Spectral in your project's CI/CD pipeline, add the following to your `package.json`:
|
|
30
31
|
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
"ci:lint": "... && npm run lint:openapi"
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"scripts": {
|
|
35
|
+
"ci:lint": "... && npm run lint:openapi"
|
|
35
36
|
}
|
|
37
|
+
}
|
|
36
38
|
```
|
|
37
39
|
|
|
38
40
|
### Plugins
|
package/package.json
CHANGED
|
@@ -1,47 +1 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@checkdigit/spectral-config",
|
|
3
|
-
"version": "2.0.1",
|
|
4
|
-
"description": "Check Digit Spectral Config",
|
|
5
|
-
"main": "ruleset.json",
|
|
6
|
-
"private": false,
|
|
7
|
-
"prettier": "@checkdigit/prettier-config",
|
|
8
|
-
"engines": {
|
|
9
|
-
"node": ">=18"
|
|
10
|
-
},
|
|
11
|
-
"files": [
|
|
12
|
-
"ruleset.json"
|
|
13
|
-
],
|
|
14
|
-
"repository": {
|
|
15
|
-
"type": "git",
|
|
16
|
-
"url": "git+https://github.com/checkdigit/spectral-config.git"
|
|
17
|
-
},
|
|
18
|
-
"author": "Check Digit, LLC",
|
|
19
|
-
"license": "UNLICENSED",
|
|
20
|
-
"bugs": {
|
|
21
|
-
"url": "https://github.com/checkdigit/spectral-config/issues"
|
|
22
|
-
},
|
|
23
|
-
"homepage": "https://github.com/checkdigit/spectral-config#readme",
|
|
24
|
-
"devDependencies": {
|
|
25
|
-
"@checkdigit/prettier-config": "^4.0.0"
|
|
26
|
-
},
|
|
27
|
-
"peerDependencies": {
|
|
28
|
-
"@stoplight/spectral-cli": "6.8.0"
|
|
29
|
-
},
|
|
30
|
-
"scripts": {
|
|
31
|
-
"prettier": "prettier --ignore-path .gitignore --list-different .",
|
|
32
|
-
"prettier:fix": "prettier --ignore-path .gitignore --write .",
|
|
33
|
-
"lint": "",
|
|
34
|
-
"lint:fix": "",
|
|
35
|
-
"test": "npm run ci:compile && npm run ci:test && npm run ci:style && npm run ci:lint",
|
|
36
|
-
"ci:compile": "",
|
|
37
|
-
"ci:test": "spectral lint test/openapi.yml --ruleset test/.spectral.json",
|
|
38
|
-
"ci:coverage": "",
|
|
39
|
-
"ci:lint": "npm run lint",
|
|
40
|
-
"ci:style": "npm run prettier"
|
|
41
|
-
},
|
|
42
|
-
"eslintConfig": {
|
|
43
|
-
"extends": [
|
|
44
|
-
"@checkdigit/eslint-config"
|
|
45
|
-
]
|
|
46
|
-
}
|
|
47
|
-
}
|
|
1
|
+
{"name":"@checkdigit/spectral-config","version":"2.1.0-PR.17-6936","description":"Check Digit Spectral Config","main":"ruleset.json","private":false,"prettier":"@checkdigit/prettier-config","engines":{"node":">=20.11"},"files":["ruleset.json"],"repository":{"type":"git","url":"git+https://github.com/checkdigit/spectral-config.git"},"author":"Check Digit, LLC","license":"UNLICENSED","bugs":{"url":"https://github.com/checkdigit/spectral-config/issues"},"homepage":"https://github.com/checkdigit/spectral-config#readme","devDependencies":{"@checkdigit/prettier-config":"^5.3.0"},"peerDependencies":{"@stoplight/spectral-cli":"6.11.0"},"scripts":{"prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","lint":"","lint:fix":"","test":"npm run ci:compile && npm run ci:test && npm run ci:style && npm run ci:lint","ci:compile":"","ci:test":"spectral lint test/openapi.yml --ruleset test/.spectral.json","ci:coverage":"","ci:lint":"npm run lint","ci:style":"npm run prettier"},"eslintConfig":{"extends":["@checkdigit/eslint-config"]}}
|