From cd9a3a3275345281ef1178b3a2adf4ecd62e6c78 Mon Sep 17 00:00:00 2001
From: Mads Rasmussen <madsr@hey.com>
Date: Sun, 16 Apr 2023 20:27:07 +0200
Subject: [PATCH] add eslint to to ensure umb prefix on classes

---
 src/Umbraco.Web.UI.Client/.eslintrc.json      |  1 +
 .../eslint-local-rules.cjs                    | 27 +++++++++++++++++++
 2 files changed, 28 insertions(+)

diff --git a/src/Umbraco.Web.UI.Client/.eslintrc.json b/src/Umbraco.Web.UI.Client/.eslintrc.json
index 88caa66773..5d886c4d8f 100644
--- a/src/Umbraco.Web.UI.Client/.eslintrc.json
+++ b/src/Umbraco.Web.UI.Client/.eslintrc.json
@@ -44,6 +44,7 @@
 				"local-rules/enforce-element-suffix-on-element-class-name": "error",
 				"local-rules/prefer-umbraco-cms-imports": "error",
 				"local-rules/no-external-imports": "error",
+				"local-rules/umb-class-prefix": "error",
 				"@typescript-eslint/no-non-null-assertion": "off"
 			},
 			"settings": {
diff --git a/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs b/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs
index ed1c5036cd..5d121e8cfb 100644
--- a/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs
+++ b/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs
@@ -205,4 +205,31 @@ module.exports = {
 			};
 		},
 	},
+
+	/** @type {import('eslint').Rule.RuleModule} */
+	'umb-class-prefix': {
+		meta: {
+			type: 'problem',
+			docs: {
+				description: 'Ensure that all class declarations are prefixed with "Umb"',
+				category: 'Best Practices',
+				recommended: true,
+			},
+			schema: [],
+		},
+		create: function (context) {
+			function checkClassName(node) {
+				if (node.id && node.id.name && !node.id.name.startsWith('Umb')) {
+					context.report({
+						node: node.id,
+						message: 'Class declaration should be prefixed with "Umb"',
+					});
+				}
+			}
+
+			return {
+				ClassDeclaration: checkClassName,
+			};
+		},
+	},
 };