@luxass/spectral-ruleset 0.0.1
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 +46 -0
- package/dist/ruleset.cjs +182603 -0
- package/dist/ruleset.js +182605 -0
- package/package.json +42 -0
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @luxass/spectral-ruleset
|
|
2
|
+
|
|
3
|
+
[![npm version][npm-version-src]][npm-version-href]
|
|
4
|
+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
5
|
+
|
|
6
|
+
Opinionated ruleset for Spectral with focus on best practices for OpenAPI and AsyncAPI specifications.
|
|
7
|
+
|
|
8
|
+
> [!IMPORTANT]
|
|
9
|
+
> This package provides a collection of rules that enforce API best practices and conventions. The rules are designed to help you create more consistent and maintainable API specifications.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @luxass/spectral-ruleset
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Create a `.spectral.yml` file:
|
|
20
|
+
|
|
21
|
+
```yaml
|
|
22
|
+
extends:
|
|
23
|
+
- "@luxass/spectral-ruleset"
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Or quickly create one using:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
echo 'extends: ["@luxass/spectral-ruleset"]' > .spectral.yml
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
You can also use it directly from unpkg:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
echo 'extends: ["https://unpkg.com/@luxass/spectral-ruleset"]' > .spectral.yml
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## 📄 License
|
|
39
|
+
|
|
40
|
+
Published under [MIT License](./LICENSE).
|
|
41
|
+
|
|
42
|
+
<!-- Badges -->
|
|
43
|
+
[npm-version-src]: https://img.shields.io/npm/v/@luxass/spectral-ruleset?style=flat&colorA=18181B&colorB=4169E1
|
|
44
|
+
[npm-version-href]: https://npmjs.com/package/@luxass/spectral-ruleset
|
|
45
|
+
[npm-downloads-src]: https://img.shields.io/npm/dm/@luxass/spectral-ruleset?style=flat&colorA=18181B&colorB=4169E1
|
|
46
|
+
[npm-downloads-href]: https://npmjs.com/package/@luxass/spectral-ruleset
|