@checkdigit/spectral-config 0.0.1-PR.2-4d6f → 0.0.1-PR.2-046f

package/README.md

@@ -1,6 +1,6 @@
 # Check Digit Spectral Config
 
-The Check Digit Spectral Config is the standard package to install and configure [Spectral](https://stoplight.io/open-source/spectral/) for use in Check Digit projects.
+Check Digit Spectral Config is the standard package to install and configure [Spectral](https://stoplight.io/open-source/spectral/) for use in Check Digit projects.
 
 ### Installing
 
@@ -9,7 +9,7 @@ Spectral Config should be installed as a dev dependency:
 
 ### Additional Setup
 
-Once installed, add a file named `.spectral.json` to the root of your project. This file should extend the Check Digit Spectral Config:
+Once installed, add a file named `.spectral.json` to the root of your project. This file should extend Spectral Config:
 
 ```jsonc
 {
@@ -34,3 +34,9 @@ To include Spectral in your project's CI/CD pipeline, add the following to your
     "ci:lint": "npm run lint && npm run lint:spec",
   }
 ```
+
+### Rules for Certain Warnings and Errors
+
+`operation-operationId  Operation must have "operationId"`
+
+Add an operationId to the operation. Check Digit uses a `noun-noun-verb` naming convention. For example, the correct operationId for a `PUT` to path `/resource/{id}/item/{itemId}/key` is `resource-item-key-put`

package/dist/index.d.ts

@@ -1,5 +1 @@
-declare const _default: {
-    extends: string[];
-};
-export default _default;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,wBAEE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -1,7 +1,6 @@
 "use strict";
 // index.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    extends: ['spectral:oas'],
-};
+// This file is intentionally empty. As custom linting rules are needed, they will be added to this src directory.
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable unicorn/no-empty-file */
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,WAAW;;AAEX,kBAAe;IACb,OAAO,EAAE,CAAC,cAAc,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,WAAW;AAEX,kHAAkH;AAElH,+DAA+D;AAC/D,0CAA0C"}

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/spectral-config","version":"0.0.1-PR.2-4d6f","description":"Check Digit Spectral Config","typings":"./dist/index.d.ts","main":"./dist/index.js","prettier":"@checkdigit/prettier-config","engines":{"node":">=12.18","npm":">=6.14"},"files":["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/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 .ts src","test":"npm run ci:test","ci:test":"npm run ci:compile && npm run ci:lint && npm run ci:style","ci:compile":"tsc --noEmit","ci:lint":"npm run lint","ci:style":"npm run prettier"},"eslintConfig":{"extends":["@checkdigit/eslint-config"]},"jest":{"preset":"@checkdigit/jest-config","testTimeout":100000}}
+{"name":"@checkdigit/spectral-config","version":"0.0.1-PR.2-046f","description":"Check Digit Spectral Config","main":"ruleset.json","prettier":"@checkdigit/prettier-config","engines":{"node":">=12.18","npm":">=6.14"},"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/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","ci:lint":"npm run lint","ci:style":"npm run prettier"},"eslintConfig":{"extends":["@checkdigit/eslint-config"]},"jest":{"preset":"@checkdigit/jest-config","testTimeout":100000}}

package/ruleset.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["spectral:oas"]
+}

package/src/index.ts

@@ -1,5 +1,6 @@
 // index.ts
 
-export default {
-  extends: ['spectral:oas'],
-};
+// This file is intentionally empty. As custom linting rules are needed, they will be added to this src directory.
+
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable unicorn/no-empty-file */