@alextheman/eslint-plugin 2.2.3 → 2.3.0

package/dist/index.cjs

@@ -3715,7 +3715,7 @@ module.exports = __toCommonJS(index_exports);
 
 // package.json
 var name = "@alextheman/eslint-plugin";
-var version = "2.2.3";
+var version = "2.3.0";
 
 // src/configs/general/javaScriptBase.ts
 var import_js = __toESM(require_src(), 1);
@@ -4040,13 +4040,21 @@ var typeScriptBase_default = typeScriptBase;
 
 // src/configs/combined/typeScriptBase.ts
 function createCombinedTypeScriptBaseConfig(plugin) {
-  return [...pluginBase_default(plugin), ...typeScriptBase_default];
+  return [
+    ...pluginBase_default(plugin),
+    ...typeScriptBase_default,
+    {
+      rules: {
+        "@alextheman/standardise-error-messages": "error"
+      }
+    }
+  ];
 }
 var typeScriptBase_default2 = createCombinedTypeScriptBaseConfig;
 
 // src/configs/combined/typeScriptReactBase.ts
 function createCombinedTypeScriptReactBaseConfig(plugin) {
-  return [...pluginBase_default(plugin), ...typeScriptBase_default, ...reactBase_default];
+  return [...typeScriptBase_default2(plugin), ...reactBase_default];
 }
 var typeScriptReactBase_default = createCombinedTypeScriptReactBaseConfig;
 
@@ -4476,6 +4484,61 @@ var noSkippedTests = createRule_default({
 });
 var no_skipped_tests_default = noSkippedTests;
 
+// src/rules/standardise-error-messages.ts
+var import_utils4 = require("@typescript-eslint/utils");
+function checkCurrentNode(context, node) {
+  var _a, _b;
+  const errorRegex = (_b = (_a = context.options[0]) == null ? void 0 : _a.regex) != null ? _b : "^[A-Z]+(?:_[A-Z]+)*$";
+  if (node.callee.type === import_utils4.AST_NODE_TYPES.Identifier && node.callee.name === "Error") {
+    const [errorArgument] = node.arguments;
+    const errorMessage = errorArgument.type === import_utils4.AST_NODE_TYPES.Literal ? errorArgument.value : "";
+    if (!RegExp(errorRegex).test(typeof errorMessage === "string" ? errorMessage : "")) {
+      return context.report({
+        node,
+        messageId: "message",
+        data: {
+          error: errorMessage,
+          regex: errorRegex
+        }
+      });
+    }
+  }
+}
+var standardiseErrorMessages = createRule_default({
+  name: "standardise-error-messages",
+  meta: {
+    docs: {
+      description: "Enforce a consistent standard for error messages."
+    },
+    messages: {
+      message: "Expected error message {{error}} to match {{regex}}."
+    },
+    type: "suggestion",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          regex: {
+            type: "string"
+          }
+        }
+      }
+    ]
+  },
+  defaultOptions: [{ regex: "^[A-Z]+(?:_[A-Z]+)*$" }],
+  create(context) {
+    return {
+      CallExpression(node) {
+        return checkCurrentNode(context, node);
+      },
+      NewExpression(node) {
+        return checkCurrentNode(context, node);
+      }
+    };
+  }
+});
+var standardise_error_messages_default = standardiseErrorMessages;
+
 // src/rules/use-normalized-imports.ts
 var import_path = __toESM(require("path"), 1);
 var useNormalizedImports = createRule_default({
@@ -4528,7 +4591,7 @@ var useNormalizedImports = createRule_default({
 var use_normalized_imports_default = useNormalizedImports;
 
 // src/rules/use-object-shorthand.ts
-var import_utils4 = require("@typescript-eslint/utils");
+var import_utils5 = require("@typescript-eslint/utils");
 var useObjectShorthand = createRule_default({
   name: "use-object-shorthand",
   meta: {
@@ -4546,7 +4609,7 @@ var useObjectShorthand = createRule_default({
   create(context) {
     return {
       Property(node) {
-        if (node.key.type === import_utils4.AST_NODE_TYPES.Identifier && node.value.type === import_utils4.AST_NODE_TYPES.Identifier && node.key.name === node.value.name && !node.shorthand) {
+        if (node.key.type === import_utils5.AST_NODE_TYPES.Identifier && node.value.type === import_utils5.AST_NODE_TYPES.Identifier && node.key.name === node.value.name && !node.shorthand) {
           context.report({
             node,
             messageId: "useShorthand",
@@ -4573,6 +4636,7 @@ var rules_default = {
   "no-plugin-configs-access-from-src-configs": no_plugin_configs_access_from_src_configs_default,
   "no-relative-imports": no_relative_imports_default,
   "no-skipped-tests": no_skipped_tests_default,
+  "standardise-error-messages": standardise_error_messages_default,
   "use-normalized-imports": use_normalized_imports_default,
   "use-object-shorthand": use_object_shorthand_default
 };

package/dist/index.d.cts

@@ -3,7 +3,7 @@ import z from 'zod';
 import { Config } from 'prettier';
 
 var name = "@alextheman/eslint-plugin";
-var version = "2.2.3";
+var version = "2.3.0";
 
 interface AlexPluginConfigs {
     general: {

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import z from 'zod';
 import { Config } from 'prettier';
 
 var name = "@alextheman/eslint-plugin";
-var version = "2.2.3";
+var version = "2.3.0";
 
 interface AlexPluginConfigs {
     general: {

package/dist/index.js

@@ -3700,7 +3700,7 @@ var require_globals2 = __commonJS({
 
 // package.json
 var name = "@alextheman/eslint-plugin";
-var version = "2.2.3";
+var version = "2.3.0";
 
 // src/configs/general/javaScriptBase.ts
 var import_js = __toESM(require_src(), 1);
@@ -4025,13 +4025,21 @@ var typeScriptBase_default = typeScriptBase;
 
 // src/configs/combined/typeScriptBase.ts
 function createCombinedTypeScriptBaseConfig(plugin) {
-  return [...pluginBase_default(plugin), ...typeScriptBase_default];
+  return [
+    ...pluginBase_default(plugin),
+    ...typeScriptBase_default,
+    {
+      rules: {
+        "@alextheman/standardise-error-messages": "error"
+      }
+    }
+  ];
 }
 var typeScriptBase_default2 = createCombinedTypeScriptBaseConfig;
 
 // src/configs/combined/typeScriptReactBase.ts
 function createCombinedTypeScriptReactBaseConfig(plugin) {
-  return [...pluginBase_default(plugin), ...typeScriptBase_default, ...reactBase_default];
+  return [...typeScriptBase_default2(plugin), ...reactBase_default];
 }
 var typeScriptReactBase_default = createCombinedTypeScriptReactBaseConfig;
 
@@ -4461,6 +4469,61 @@ var noSkippedTests = createRule_default({
 });
 var no_skipped_tests_default = noSkippedTests;
 
+// src/rules/standardise-error-messages.ts
+import { AST_NODE_TYPES as AST_NODE_TYPES3 } from "@typescript-eslint/utils";
+function checkCurrentNode(context, node) {
+  var _a, _b;
+  const errorRegex = (_b = (_a = context.options[0]) == null ? void 0 : _a.regex) != null ? _b : "^[A-Z]+(?:_[A-Z]+)*$";
+  if (node.callee.type === AST_NODE_TYPES3.Identifier && node.callee.name === "Error") {
+    const [errorArgument] = node.arguments;
+    const errorMessage = errorArgument.type === AST_NODE_TYPES3.Literal ? errorArgument.value : "";
+    if (!RegExp(errorRegex).test(typeof errorMessage === "string" ? errorMessage : "")) {
+      return context.report({
+        node,
+        messageId: "message",
+        data: {
+          error: errorMessage,
+          regex: errorRegex
+        }
+      });
+    }
+  }
+}
+var standardiseErrorMessages = createRule_default({
+  name: "standardise-error-messages",
+  meta: {
+    docs: {
+      description: "Enforce a consistent standard for error messages."
+    },
+    messages: {
+      message: "Expected error message {{error}} to match {{regex}}."
+    },
+    type: "suggestion",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          regex: {
+            type: "string"
+          }
+        }
+      }
+    ]
+  },
+  defaultOptions: [{ regex: "^[A-Z]+(?:_[A-Z]+)*$" }],
+  create(context) {
+    return {
+      CallExpression(node) {
+        return checkCurrentNode(context, node);
+      },
+      NewExpression(node) {
+        return checkCurrentNode(context, node);
+      }
+    };
+  }
+});
+var standardise_error_messages_default = standardiseErrorMessages;
+
 // src/rules/use-normalized-imports.ts
 import path from "path";
 var useNormalizedImports = createRule_default({
@@ -4513,7 +4576,7 @@ var useNormalizedImports = createRule_default({
 var use_normalized_imports_default = useNormalizedImports;
 
 // src/rules/use-object-shorthand.ts
-import { AST_NODE_TYPES as AST_NODE_TYPES3 } from "@typescript-eslint/utils";
+import { AST_NODE_TYPES as AST_NODE_TYPES4 } from "@typescript-eslint/utils";
 var useObjectShorthand = createRule_default({
   name: "use-object-shorthand",
   meta: {
@@ -4531,7 +4594,7 @@ var useObjectShorthand = createRule_default({
   create(context) {
     return {
       Property(node) {
-        if (node.key.type === AST_NODE_TYPES3.Identifier && node.value.type === AST_NODE_TYPES3.Identifier && node.key.name === node.value.name && !node.shorthand) {
+        if (node.key.type === AST_NODE_TYPES4.Identifier && node.value.type === AST_NODE_TYPES4.Identifier && node.key.name === node.value.name && !node.shorthand) {
           context.report({
             node,
             messageId: "useShorthand",
@@ -4558,6 +4621,7 @@ var rules_default = {
   "no-plugin-configs-access-from-src-configs": no_plugin_configs_access_from_src_configs_default,
   "no-relative-imports": no_relative_imports_default,
   "no-skipped-tests": no_skipped_tests_default,
+  "standardise-error-messages": standardise_error_messages_default,
   "use-normalized-imports": use_normalized_imports_default,
   "use-object-shorthand": use_object_shorthand_default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/eslint-plugin",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "A package to provide custom ESLint rules and configs",
   "license": "ISC",
   "author": "alextheman",