@checkdigit/spectral-config 0.0.1-PR.2-7bdd

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2021-2023 Check Digit, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# 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.
+
+### Installing
+
+Spectral Config should be installed as a dev dependency:
+`npm install @checkdigit/spectral-config --save-dev`
+
+### 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:
+
+```jsonc
+{
+  "extends": ["@checkdigit/spectral-config"]
+}
+```
+
+Also add the following to your `package.json` to run Spectral:
+
+```jsonc
+"scripts": {
+  // ...
+  "lint:spec": "spectral lint src/**/swagger.yml",
+}
+```
+
+To include Spectral in your project's CI/CD pipeline, add the following to your `package.json`:
+
+```jsonc
+"scripts": {
+  // ...
+    "ci:lint": "npm run lint && npm run lint:spec",
+  }
+```

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+// index.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    extends: ['spectral:oas'],
+    rules: [],
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,WAAW;;AAEX,kBAAe;IACb,OAAO,EAAE,CAAC,cAAc,CAAC;IACzB,KAAK,EAAE,EAAE;CACV,CAAC"}

package/package.json

@@ -0,0 +1 @@
+{"name":"@checkdigit/spectral-config","version":"0.0.1-PR.2-7bdd","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}}

package/src/index.ts

@@ -0,0 +1,6 @@
+// index.ts
+
+export default {
+  extends: ['spectral:oas'],
+  rules: [],
+};