@luxass/spectral-ruleset 0.0.4 → 1.0.0

package/README.md

@@ -35,6 +35,76 @@ You can also use it directly from unpkg:
 echo 'extends: ["https://unpkg.com/@luxass/spectral-ruleset"]' > .spectral.yml
 ```
 
+## Rules
+
+This ruleset extends the official OpenAPI and AsyncAPI rulesets from `@stoplight/spectral-rulesets`, with some built-in rules modified (`operation-tags` and `operation-operationId` are disabled, `operation-success-response` is set to error level).
+
+### Custom Rules
+
+<details>
+<summary><strong>General Rules</strong></summary>
+
+##### `luxass/api-homepage` ⚠️
+Ensures that APIs have a root path (`/`) defined. This helps with API discoverability and provides a clear entry point for consumers.
+
+##### `luxass/api-homepage-get` ⚠️
+Ensures that the API root path (`/`) has a GET operation defined. This allows consumers to discover what the API offers.
+
+##### `luxass/version-in-info` ⚠️
+Enforces semantic versioning format for the `info.version` field (e.g., `1.0.0`).
+
+</details>
+
+<details>
+<summary><strong>Path Rules</strong></summary>
+
+##### `luxass/paths-kebab-case` ⚠️
+Enforces kebab-case naming convention for all API paths (e.g., `/user-profiles` instead of `/userProfiles`).
+
+##### `luxass/no-file-extensions-in-paths` ❌
+Prevents file extensions (`.json`, `.xml`, `.html`, `.txt`) in API paths. Use the `content` field to specify media types instead.
+
+##### `luxass/no-trailing-slash` ⚠️
+Prevents trailing slashes in paths (except for the root path `/`), avoiding confusion about resource identity.
+
+##### `luxass/plural-resource-names` ⚠️
+Encourages using plural nouns for resource collections (e.g., `/users` instead of `/user`).
+
+</details>
+
+<details>
+<summary><strong>Header Rules</strong></summary>
+
+##### `luxass/no-x-headers` ❌
+Prevents usage of headers starting with `X-` prefix. Encourages using standardized headers instead of the deprecated X- convention.
+
+##### `luxass/headers-hyphenated-pascal-case` ❌
+Enforces `Hyphenated-Pascal-Case` notation for HTTP headers (e.g., `Content-Type`, `Accept-Language`).
+
+</details>
+
+<details>
+<summary><strong>OpenAPI 2.0 Specific Rules</strong></summary>
+
+##### `luxass/oas2/protocol-https-only` ❌
+Ensures that only HTTPS protocol is used in the `schemes` array.
+
+##### `luxass/oas2/get-request-no-body` ❌
+Prevents GET requests from having request bodies, following HTTP best practices.
+
+</details>
+
+<details>
+<summary><strong>OpenAPI 3.x Specific Rules</strong></summary>
+
+##### `luxass/oas3/protocol-https-only` ❌
+Ensures that all server URLs use HTTPS protocol only.
+
+##### `luxass/oas3/get-request-no-body` ❌
+Prevents GET requests from having `requestBody` defined, following HTTP best practices.
+
+</details>
+
 ## 📄 License
 
 Published under [MIT License](./LICENSE).

package/dist/ruleset.cjs

@@ -261,6 +261,38 @@ var ruleset_default = {
 			},
 			severity: DiagnosticSeverity.Error
 		},
+		"luxass/paths-kebab-case": {
+			description: "All YAML/JSON paths MUST follow kebab-case",
+			severity: DiagnosticSeverity.Warning,
+			recommended: true,
+			message: "{{property}} is not kebab-case: {{error}}",
+			given: "$.paths[*]~",
+			then: {
+				function: __stoplight_spectral_functions.pattern,
+				functionOptions: { match: "^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$" }
+			}
+		},
+		"luxass/headers-hyphenated-pascal-case": {
+			description: "All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation",
+			severity: DiagnosticSeverity.Error,
+			recommended: true,
+			message: "{{property}} is not hyphenated-pascal-case: {{error}}",
+			given: "$..parameters[?(@.in == 'header')].name",
+			then: {
+				function: __stoplight_spectral_functions.pattern,
+				functionOptions: { match: "^[A-Z][a-z0-9]*(-[A-Z][a-z0-9]*)*$" }
+			}
+		},
+		"luxass/version-in-info": {
+			message: "API version should follow semantic versioning.",
+			description: "The info.version field should follow semantic versioning (e.g., 1.0.0).",
+			given: "$.info.version",
+			then: {
+				function: __stoplight_spectral_functions.pattern,
+				functionOptions: { match: "^\\d+\\.\\d+\\.\\d+" }
+			},
+			severity: DiagnosticSeverity.Warning
+		},
 		...oas2_default,
 		...oas3_default
 	}

package/dist/ruleset.js

@@ -237,6 +237,38 @@ var ruleset_default = {
 			},
 			severity: DiagnosticSeverity.Error
 		},
+		"luxass/paths-kebab-case": {
+			description: "All YAML/JSON paths MUST follow kebab-case",
+			severity: DiagnosticSeverity.Warning,
+			recommended: true,
+			message: "{{property}} is not kebab-case: {{error}}",
+			given: "$.paths[*]~",
+			then: {
+				function: pattern,
+				functionOptions: { match: "^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$" }
+			}
+		},
+		"luxass/headers-hyphenated-pascal-case": {
+			description: "All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation",
+			severity: DiagnosticSeverity.Error,
+			recommended: true,
+			message: "{{property}} is not hyphenated-pascal-case: {{error}}",
+			given: "$..parameters[?(@.in == 'header')].name",
+			then: {
+				function: pattern,
+				functionOptions: { match: "^[A-Z][a-z0-9]*(-[A-Z][a-z0-9]*)*$" }
+			}
+		},
+		"luxass/version-in-info": {
+			message: "API version should follow semantic versioning.",
+			description: "The info.version field should follow semantic versioning (e.g., 1.0.0).",
+			given: "$.info.version",
+			then: {
+				function: pattern,
+				functionOptions: { match: "^\\d+\\.\\d+\\.\\d+" }
+			},
+			severity: DiagnosticSeverity.Warning
+		},
 		...oas2_default,
 		...oas3_default
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luxass/spectral-ruleset",
-  "version": "0.0.4",
+  "version": "1.0.0",
   "description": "Opinonated ruleset for Spectral",
   "type": "module",
   "repository": {