@checkdigit/spectral-config 0.0.1-PR.2-7841 → 0.0.1-PR.2-66b3
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 +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,6 +35,22 @@ To include Spectral in your project's CI/CD pipeline, add the following to your
|
|
|
35
35
|
}
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
+
### Plugins
|
|
39
|
+
|
|
40
|
+
#### Webstorm
|
|
41
|
+
|
|
42
|
+
Install Spectral, by Schwartz IT https://plugins.jetbrains.com/plugin/18520-spectral
|
|
43
|
+
|
|
44
|
+
Configure at `WebStorm > Settings > Tools > Spectral`.
|
|
45
|
+
|
|
46
|
+
Set Ruleset to the absolute path to project's `.spectral.json` (`/Users/.../payment-card/.spectral.json`). This plugin doesn't seem to respect path variables, so this will be global. Hopefully this will be fixed in a future plugin update.
|
|
47
|
+
|
|
48
|
+
Set Included files to the following glob pattern `**/*swagger.yml`.
|
|
49
|
+
|
|
50
|
+
#### VS Code
|
|
51
|
+
|
|
52
|
+
Install Spectral, by Spotlight https://marketplace.visualstudio.com/items?itemName=stoplight.spectral
|
|
53
|
+
|
|
38
54
|
### Rules for Certain Warnings and Errors
|
|
39
55
|
|
|
40
56
|
`operation-operationId Operation must have "operationId"`
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@checkdigit/spectral-config","version":"0.0.1-PR.2-
|
|
1
|
+
{"name":"@checkdigit/spectral-config","version":"0.0.1-PR.2-66b3","description":"Check Digit Spectral Config","main":"ruleset.json","prettier":"@checkdigit/prettier-config","engines":{"node":">=16"},"files":["ruleset.json","dist","/src/"],"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/eslint-config":"7.5.0","@checkdigit/jest-config":"^2.1.0","@checkdigit/prettier-config":"^3.2.0","@checkdigit/typescript-config":"^3.2.0"},"peerDependencies":{"@stoplight/spectral-cli":"6.6.0"},"scripts":{"postversion":"git push && git push --tags","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","lint":"eslint -f unix --ext .js,.ts 'src/**/*.ts'","lint:fix":"eslint -f unix --ext .js,.ts 'src/**/*.ts' --fix","cover:browser":"jest --coverage=true && open coverage/lcov-report/index.html","clean":"npm cache verify && rimraf coverage node_modules","test":"npm run ci:compile && npm run ci:test && npm run ci:style && npm run ci:lint","ci:compile":"tsc --noEmit","ci:test":"spectral lint test/openapi.yml --ruleset test/.spectral.json","ci:coverage":"jest --coverage=true --passWithNoTests","ci:lint":"npm run lint","ci:style":"npm run prettier"},"eslintConfig":{"extends":["@checkdigit/eslint-config"]},"jest":{"preset":"@checkdigit/jest-config"}}
|