@luxass/spectral-ruleset 0.0.3 → 0.0.5

package/dist/ruleset.cjs

@@ -22,9 +22,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 
 //#endregion
-const __stoplight_spectral_formats = __toESM(require("@stoplight/spectral-formats"));
 const __stoplight_spectral_functions = __toESM(require("@stoplight/spectral-functions"));
 const __stoplight_spectral_rulesets = __toESM(require("@stoplight/spectral-rulesets"));
+const __stoplight_spectral_formats = __toESM(require("@stoplight/spectral-formats"));
 
 //#region node_modules/.pnpm/@stoplight+types@14.1.1/node_modules/@stoplight/types/dist/index.mjs
 var HttpOperationSecurityDeclarationTypes;
@@ -151,6 +151,68 @@ var NodeFormat;
 	NodeFormat$1["Webp"] = "webp";
 })(NodeFormat || (NodeFormat = {}));
 
+//#endregion
+//#region src/oas2.ts
+var oas2_default = {
+	"luxass/oas2/get-request-no-body": {
+		message: "A `GET` request MUST NOT accept a request body.",
+		description: "Defining a request body on a HTTP GET is technically possible in some implementations, but is increasingly frowned upon due to the confusion that comes from unspecified behavior in the HTTP specification.",
+		given: "$.paths..get.parameters..in",
+		then: {
+			function: __stoplight_spectral_functions.pattern,
+			functionOptions: { notMatch: "/^body$/" }
+		},
+		severity: DiagnosticSeverity.Error,
+		formats: [__stoplight_spectral_formats.oas2]
+	},
+	"luxass/oas2/protocol-https-only": {
+		description: "ALL requests MUST go through `https` protocol only.",
+		formats: [__stoplight_spectral_formats.oas2],
+		message: "Schemes MUST be https and no other value is allowed.",
+		severity: DiagnosticSeverity.Error,
+		recommended: true,
+		type: "style",
+		given: "$",
+		then: {
+			field: "schemes",
+			function: __stoplight_spectral_functions.schema,
+			functionOptions: { schema: {
+				type: "array",
+				items: {
+					type: "string",
+					enum: ["https"]
+				}
+			} }
+		}
+	}
+};
+
+//#endregion
+//#region src/oas3.ts
+var oas3_default = {
+	"luxass/oas3/protocol-https-only": {
+		description: "ALL requests MUST go through `https` protocol only.",
+		formats: [__stoplight_spectral_formats.oas3],
+		message: "Schemes MUST be https and no other value is allowed.",
+		severity: DiagnosticSeverity.Error,
+		recommended: true,
+		type: "style",
+		given: "$.servers..url",
+		then: {
+			function: __stoplight_spectral_functions.pattern,
+			functionOptions: { match: "/^https:/" }
+		}
+	},
+	"luxass/oas3/get-request-no-body": {
+		message: "A `GET` request MUST NOT accept a request body.",
+		description: "Defining a request body on a HTTP GET is in some implementations, but is increasingly frowned upon due to the confusion that comes from unspecified behavior in the HTTP specification.",
+		given: "$.paths..get.requestBody",
+		then: { function: __stoplight_spectral_functions.undefined },
+		formats: [__stoplight_spectral_formats.oas3],
+		severity: DiagnosticSeverity.Error
+	}
+};
+
 //#endregion
 //#region src/ruleset.ts
 var ruleset_default = {
@@ -189,39 +251,40 @@ var ruleset_default = {
 			},
 			severity: DiagnosticSeverity.Error
 		},
-		"luxass/oas2-protocol-https-only": {
-			description: "ALL requests MUST go through `https` protocol only.",
-			formats: [__stoplight_spectral_formats.oas2],
-			message: "Schemes MUST be https and no other value is allowed.",
-			severity: DiagnosticSeverity.Error,
+		"luxass/no-file-extensions-in-paths": {
+			message: "Paths must not include file extensions such as .json, .xml, .html and .txt.",
+			description: "Paths must not include file extensions such as `.json`, `.xml`, `.html` and `.txt`. Use the OpenAPI `content` keyword to tell consumers which Media Types are available.",
+			given: "$.paths[*]~",
+			then: {
+				function: __stoplight_spectral_functions.pattern,
+				functionOptions: { notMatch: ".(json|xml|html|txt)$" }
+			},
+			severity: DiagnosticSeverity.Error
+		},
+		"luxass/paths-kebab-case": {
+			description: "All YAML/JSON paths MUST follow kebab-case",
+			severity: DiagnosticSeverity.Warning,
 			recommended: true,
-			type: "style",
-			given: "$",
+			message: "{{property}} is not kebab-case: {{error}}",
+			given: "$.paths[*]~",
 			then: {
-				field: "schemes",
-				function: __stoplight_spectral_functions.schema,
-				functionOptions: { schema: {
-					type: "array",
-					items: {
-						type: "string",
-						enum: ["https"]
-					}
-				} }
+				function: __stoplight_spectral_functions.pattern,
+				functionOptions: { match: "^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$" }
 			}
 		},
-		"luxass/oas3-protocol-https-only": {
-			description: "ALL requests MUST go through `https` protocol only.",
-			formats: [__stoplight_spectral_formats.oas3],
-			message: "Schemes MUST be https and no other value is allowed.",
+		"luxass/headers-hyphenated-pascal-case": {
+			description: "All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation",
 			severity: DiagnosticSeverity.Error,
 			recommended: true,
-			type: "style",
-			given: "$.servers..url",
+			message: "{{property}} is not hyphenated-pascal-case: {{error}}",
+			given: "$..parameters[?(@.in == 'header')].name",
 			then: {
 				function: __stoplight_spectral_functions.pattern,
-				functionOptions: { match: "/^https:/" }
+				functionOptions: { match: "^[A-Z][a-z0-9]*(-[A-Z][a-z0-9]*)*$" }
 			}
-		}
+		},
+		...oas2_default,
+		...oas3_default
 	}
 };
 

package/dist/ruleset.js

@@ -1,6 +1,6 @@
-import { oas2, oas3 } from "@stoplight/spectral-formats";
-import { pattern, schema, truthy } from "@stoplight/spectral-functions";
+import { pattern, schema, truthy, undefined as undefined$1 } from "@stoplight/spectral-functions";
 import { asyncapi, oas } from "@stoplight/spectral-rulesets";
+import { oas2, oas3 } from "@stoplight/spectral-formats";
 
 //#region node_modules/.pnpm/@stoplight+types@14.1.1/node_modules/@stoplight/types/dist/index.mjs
 var HttpOperationSecurityDeclarationTypes;
@@ -127,6 +127,68 @@ var NodeFormat;
 	NodeFormat$1["Webp"] = "webp";
 })(NodeFormat || (NodeFormat = {}));
 
+//#endregion
+//#region src/oas2.ts
+var oas2_default = {
+	"luxass/oas2/get-request-no-body": {
+		message: "A `GET` request MUST NOT accept a request body.",
+		description: "Defining a request body on a HTTP GET is technically possible in some implementations, but is increasingly frowned upon due to the confusion that comes from unspecified behavior in the HTTP specification.",
+		given: "$.paths..get.parameters..in",
+		then: {
+			function: pattern,
+			functionOptions: { notMatch: "/^body$/" }
+		},
+		severity: DiagnosticSeverity.Error,
+		formats: [oas2]
+	},
+	"luxass/oas2/protocol-https-only": {
+		description: "ALL requests MUST go through `https` protocol only.",
+		formats: [oas2],
+		message: "Schemes MUST be https and no other value is allowed.",
+		severity: DiagnosticSeverity.Error,
+		recommended: true,
+		type: "style",
+		given: "$",
+		then: {
+			field: "schemes",
+			function: schema,
+			functionOptions: { schema: {
+				type: "array",
+				items: {
+					type: "string",
+					enum: ["https"]
+				}
+			} }
+		}
+	}
+};
+
+//#endregion
+//#region src/oas3.ts
+var oas3_default = {
+	"luxass/oas3/protocol-https-only": {
+		description: "ALL requests MUST go through `https` protocol only.",
+		formats: [oas3],
+		message: "Schemes MUST be https and no other value is allowed.",
+		severity: DiagnosticSeverity.Error,
+		recommended: true,
+		type: "style",
+		given: "$.servers..url",
+		then: {
+			function: pattern,
+			functionOptions: { match: "/^https:/" }
+		}
+	},
+	"luxass/oas3/get-request-no-body": {
+		message: "A `GET` request MUST NOT accept a request body.",
+		description: "Defining a request body on a HTTP GET is in some implementations, but is increasingly frowned upon due to the confusion that comes from unspecified behavior in the HTTP specification.",
+		given: "$.paths..get.requestBody",
+		then: { function: undefined$1 },
+		formats: [oas3],
+		severity: DiagnosticSeverity.Error
+	}
+};
+
 //#endregion
 //#region src/ruleset.ts
 var ruleset_default = {
@@ -165,39 +227,40 @@ var ruleset_default = {
 			},
 			severity: DiagnosticSeverity.Error
 		},
-		"luxass/oas2-protocol-https-only": {
-			description: "ALL requests MUST go through `https` protocol only.",
-			formats: [oas2],
-			message: "Schemes MUST be https and no other value is allowed.",
-			severity: DiagnosticSeverity.Error,
+		"luxass/no-file-extensions-in-paths": {
+			message: "Paths must not include file extensions such as .json, .xml, .html and .txt.",
+			description: "Paths must not include file extensions such as `.json`, `.xml`, `.html` and `.txt`. Use the OpenAPI `content` keyword to tell consumers which Media Types are available.",
+			given: "$.paths[*]~",
+			then: {
+				function: pattern,
+				functionOptions: { notMatch: ".(json|xml|html|txt)$" }
+			},
+			severity: DiagnosticSeverity.Error
+		},
+		"luxass/paths-kebab-case": {
+			description: "All YAML/JSON paths MUST follow kebab-case",
+			severity: DiagnosticSeverity.Warning,
 			recommended: true,
-			type: "style",
-			given: "$",
+			message: "{{property}} is not kebab-case: {{error}}",
+			given: "$.paths[*]~",
 			then: {
-				field: "schemes",
-				function: schema,
-				functionOptions: { schema: {
-					type: "array",
-					items: {
-						type: "string",
-						enum: ["https"]
-					}
-				} }
+				function: pattern,
+				functionOptions: { match: "^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$" }
 			}
 		},
-		"luxass/oas3-protocol-https-only": {
-			description: "ALL requests MUST go through `https` protocol only.",
-			formats: [oas3],
-			message: "Schemes MUST be https and no other value is allowed.",
+		"luxass/headers-hyphenated-pascal-case": {
+			description: "All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation",
 			severity: DiagnosticSeverity.Error,
 			recommended: true,
-			type: "style",
-			given: "$.servers..url",
+			message: "{{property}} is not hyphenated-pascal-case: {{error}}",
+			given: "$..parameters[?(@.in == 'header')].name",
 			then: {
 				function: pattern,
-				functionOptions: { match: "/^https:/" }
+				functionOptions: { match: "^[A-Z][a-z0-9]*(-[A-Z][a-z0-9]*)*$" }
 			}
-		}
+		},
+		...oas2_default,
+		...oas3_default
 	}
 };
 

package/package.json

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