@alextheman/eslint-plugin 1.11.1 → 1.12.1

package/dist/index.cjs

@@ -3706,7 +3706,7 @@ module.exports = __toCommonJS(index_exports);
 
 // package.json
 var name = "@alextheman/eslint-plugin";
-var version = "1.11.1";
+var version = "1.12.1";
 
 // src/configs/alexPluginBase.ts
 function createAlexPluginBaseConfig(plugin2) {
@@ -3725,7 +3725,8 @@ function createAlexPluginBaseConfig(plugin2) {
       files: ["**/*.test.ts"],
       rules: {
         "@alextheman/no-isolated-tests": "error",
-        "@alextheman/no-skipped-tests": "warn"
+        "@alextheman/no-skipped-tests": "warn",
+        "@alextheman/consistent-test-function": ["error", { preference: "test" }]
       }
     }
   ];
@@ -3899,6 +3900,10 @@ function createAlexTypeScriptReactBaseConfig(plugin2) {
 }
 var alexTypeScriptReactBase_default = createAlexTypeScriptReactBaseConfig;
 
+// src/rules/consistent-test-function.ts
+var import_utils2 = require("@typescript-eslint/utils");
+var import_zod = __toESM(require("zod"), 1);
+
 // src/create-rule.ts
 var import_utils = require("@typescript-eslint/utils");
 var createRule = import_utils.ESLintUtils.RuleCreator((ruleName) => {
@@ -3906,10 +3911,154 @@ var createRule = import_utils.ESLintUtils.RuleCreator((ruleName) => {
 });
 var create_rule_default = createRule;
 
+// src/utility/getImportSpecifiersAfterRemoving.ts
+function getImportSpecifiersAfterRemoving(context, specifiers, importToRemove) {
+  return specifiers.filter((specifier) => {
+    return !(specifier.imported.name === importToRemove);
+  }).map((specifier) => {
+    return context.sourceCode.getText(specifier);
+  }).join(", ");
+}
+var getImportSpecifiersAfterRemoving_default = getImportSpecifiersAfterRemoving;
+
+// src/rules/consistent-test-function.ts
+var validTestFunctionsSchema = import_zod.default.enum(["test", "it"]);
+var consistentTestFunction = create_rule_default({
+  name: "consistent-test-function",
+  meta: {
+    docs: {
+      description: "Enforce a consistent function (either `test` or `it`)"
+    },
+    messages: {
+      message: "Unexpected {{source}}. Please use {{preference}} instead."
+    },
+    type: "suggestion",
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          preference: {
+            type: "string"
+          }
+        },
+        additionalProperties: false
+      }
+    ]
+  },
+  defaultOptions: [{ preference: "test" }],
+  create(context) {
+    var _a;
+    const preference = (_a = context.options[0]) == null ? void 0 : _a.preference;
+    const validatedPreference = validTestFunctionsSchema.parse(preference != null ? preference : "test");
+    return {
+      CallExpression(node) {
+        if (node.callee.type === import_utils2.AST_NODE_TYPES.Identifier && node.callee.name === "it" && validatedPreference === "test") {
+          return context.report({
+            node,
+            messageId: "message",
+            data: {
+              source: node.callee.name,
+              preference: validatedPreference
+            },
+            fix(fixer) {
+              return fixer.replaceText(node.callee, "test");
+            }
+          });
+        }
+        if (node.callee.type === import_utils2.AST_NODE_TYPES.Identifier && node.callee.name === "test" && validatedPreference === "it") {
+          return context.report({
+            node,
+            messageId: "message",
+            data: {
+              source: node.callee.name,
+              preference: validatedPreference
+            },
+            fix(fixer) {
+              return fixer.replaceText(node.callee, "it");
+            }
+          });
+        }
+      },
+      ImportDeclaration(node) {
+        for (const specifier of node.specifiers) {
+          if (specifier.type === import_utils2.AST_NODE_TYPES.ImportSpecifier && specifier.imported.type === import_utils2.AST_NODE_TYPES.Identifier && specifier.imported.name === "it" && validatedPreference === "test") {
+            return context.report({
+              node,
+              messageId: "message",
+              data: {
+                source: specifier.imported.name,
+                preference: validatedPreference
+              },
+              fix(fixer) {
+                const importedNames = node.specifiers.map((specifier2) => {
+                  return specifier2.type === import_utils2.AST_NODE_TYPES.ImportSpecifier && specifier2.imported.type === import_utils2.AST_NODE_TYPES.Identifier ? specifier2.imported.name : "";
+                });
+                if (importedNames.includes("it") && importedNames.includes("test")) {
+                  const newSpecifiers = getImportSpecifiersAfterRemoving_default(
+                    context,
+                    node.specifiers,
+                    "it"
+                  );
+                  return fixer.replaceTextRange(
+                    [
+                      node.specifiers[0].range[0],
+                      node.specifiers[node.specifiers.length - 1].range[1]
+                    ],
+                    newSpecifiers
+                  );
+                }
+                return fixer.replaceTextRange(
+                  [specifier.imported.range[0], specifier.imported.range[1]],
+                  validatedPreference
+                );
+              }
+            });
+          }
+          if (specifier.type === import_utils2.AST_NODE_TYPES.ImportSpecifier && specifier.imported.type === import_utils2.AST_NODE_TYPES.Identifier && specifier.imported.name === "test" && validatedPreference === "it") {
+            return context.report({
+              node,
+              messageId: "message",
+              data: {
+                source: specifier.imported.name,
+                preference: validatedPreference
+              },
+              fix(fixer) {
+                const importedNames = node.specifiers.map((specifier2) => {
+                  return specifier2.type === import_utils2.AST_NODE_TYPES.ImportSpecifier && specifier2.imported.type === import_utils2.AST_NODE_TYPES.Identifier ? specifier2.imported.name : "";
+                });
+                if (importedNames.includes("it") && importedNames.includes("test")) {
+                  const newSpecifiers = getImportSpecifiersAfterRemoving_default(
+                    context,
+                    node.specifiers,
+                    "test"
+                  );
+                  return fixer.replaceTextRange(
+                    [
+                      node.specifiers[0].range[0],
+                      node.specifiers[node.specifiers.length - 1].range[1]
+                    ],
+                    newSpecifiers
+                  );
+                }
+                return fixer.replaceTextRange(
+                  [specifier.imported.range[0], specifier.imported.range[1]],
+                  validatedPreference
+                );
+              }
+            });
+          }
+        }
+      }
+    };
+  }
+});
+var consistent_test_function_default = consistentTestFunction;
+
 // src/utility/checkCallExpression.ts
-var import_utils2 = require("@typescript-eslint/utils");
+var import_utils3 = require("@typescript-eslint/utils");
 function checkCallExpression(node, objectName, propertyName) {
-  return node.callee.type === import_utils2.AST_NODE_TYPES.MemberExpression && node.callee.object.type === import_utils2.AST_NODE_TYPES.Identifier && node.callee.object.name === objectName && node.callee.property.type === import_utils2.AST_NODE_TYPES.Identifier && node.callee.property.name === propertyName;
+  return node.callee.type === import_utils3.AST_NODE_TYPES.MemberExpression && node.callee.object.type === import_utils3.AST_NODE_TYPES.Identifier && node.callee.object.name === objectName && node.callee.property.type === import_utils3.AST_NODE_TYPES.Identifier && node.callee.property.name === propertyName;
 }
 var checkCallExpression_default = checkCallExpression;
 
@@ -3930,7 +4079,7 @@ var noIsolatedTests = create_rule_default({
   create(context) {
     return {
       CallExpression(node) {
-        if (checkCallExpression_default(node, "describe", "only") || checkCallExpression_default(node, "test", "only")) {
+        if (checkCallExpression_default(node, "describe", "only") || checkCallExpression_default(node, "test", "only") || checkCallExpression_default(node, "it", "only")) {
           return context.report({
             node,
             messageId: "message",
@@ -4141,7 +4290,7 @@ var noSkippedTests = create_rule_default({
   create(context) {
     return {
       CallExpression(node) {
-        if (checkCallExpression_default(node, "describe", "skip") || checkCallExpression_default(node, "test", "skip")) {
+        if (checkCallExpression_default(node, "describe", "skip") || checkCallExpression_default(node, "test", "skip") || checkCallExpression_default(node, "it", "skip")) {
           return context.report({
             node,
             messageId: "message",
@@ -4157,7 +4306,7 @@ var noSkippedTests = create_rule_default({
 var no_skipped_tests_default = noSkippedTests;
 
 // src/rules/use-object-shorthand.ts
-var import_utils3 = require("@typescript-eslint/utils");
+var import_utils4 = require("@typescript-eslint/utils");
 var useObjectShorthand = create_rule_default({
   name: "use-object-shorthand",
   meta: {
@@ -4175,7 +4324,7 @@ var useObjectShorthand = create_rule_default({
   create(context) {
     return {
       Property(node) {
-        if (node.key.type === import_utils3.AST_NODE_TYPES.Identifier && node.value.type === import_utils3.AST_NODE_TYPES.Identifier && node.key.name === node.value.name && !node.shorthand) {
+        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) {
           context.report({
             node,
             messageId: "useShorthand",
@@ -4196,6 +4345,7 @@ var use_object_shorthand_default = useObjectShorthand;
 
 // src/rules/index.ts
 var rules_default = {
+  "consistent-test-function": consistent_test_function_default,
   "no-isolated-tests": no_isolated_tests_default,
   "no-namespace-imports": no_namespace_imports_default,
   "no-plugin-configs-access-from-src-configs": no_plugin_configs_access_from_src_configs_default,

package/dist/index.d.cts

@@ -1,11 +1,18 @@
 import { Linter } from 'eslint';
 import { Config } from 'prettier';
+import z from 'zod';
 
 var name = "@alextheman/eslint-plugin";
-var version = "1.11.1";
+var version = "1.12.1";
 
 declare const prettierRules: Config;
 
+declare const validTestFunctionsSchema: z.ZodEnum<{
+    test: "test";
+    it: "it";
+}>;
+type ValidTestFunctions = z.infer<typeof validTestFunctionsSchema>;
+
 interface AlexPlugin {
     meta: {
         name: typeof name;
@@ -24,4 +31,4 @@ interface AlexPlugin {
 
 declare const plugin: AlexPlugin;
 
-export { type AlexPlugin, plugin as default, prettierRules };
+export { type AlexPlugin, type ValidTestFunctions, plugin as default, prettierRules };

package/dist/index.d.ts

@@ -1,11 +1,18 @@
 import { Linter } from 'eslint';
 import { Config } from 'prettier';
+import z from 'zod';
 
 var name = "@alextheman/eslint-plugin";
-var version = "1.11.1";
+var version = "1.12.1";
 
 declare const prettierRules: Config;
 
+declare const validTestFunctionsSchema: z.ZodEnum<{
+    test: "test";
+    it: "it";
+}>;
+type ValidTestFunctions = z.infer<typeof validTestFunctionsSchema>;
+
 interface AlexPlugin {
     meta: {
         name: typeof name;
@@ -24,4 +31,4 @@ interface AlexPlugin {
 
 declare const plugin: AlexPlugin;
 
-export { type AlexPlugin, plugin as default, prettierRules };
+export { type AlexPlugin, type ValidTestFunctions, plugin as default, prettierRules };

package/dist/index.js

@@ -3692,7 +3692,7 @@ var require_globals2 = __commonJS({
 
 // package.json
 var name = "@alextheman/eslint-plugin";
-var version = "1.11.1";
+var version = "1.12.1";
 
 // src/configs/alexPluginBase.ts
 function createAlexPluginBaseConfig(plugin2) {
@@ -3711,7 +3711,8 @@ function createAlexPluginBaseConfig(plugin2) {
       files: ["**/*.test.ts"],
       rules: {
         "@alextheman/no-isolated-tests": "error",
-        "@alextheman/no-skipped-tests": "warn"
+        "@alextheman/no-skipped-tests": "warn",
+        "@alextheman/consistent-test-function": ["error", { preference: "test" }]
       }
     }
   ];
@@ -3885,6 +3886,10 @@ function createAlexTypeScriptReactBaseConfig(plugin2) {
 }
 var alexTypeScriptReactBase_default = createAlexTypeScriptReactBaseConfig;
 
+// src/rules/consistent-test-function.ts
+import { AST_NODE_TYPES } from "@typescript-eslint/utils";
+import z from "zod";
+
 // src/create-rule.ts
 import { ESLintUtils } from "@typescript-eslint/utils";
 var createRule = ESLintUtils.RuleCreator((ruleName) => {
@@ -3892,10 +3897,154 @@ var createRule = ESLintUtils.RuleCreator((ruleName) => {
 });
 var create_rule_default = createRule;
 
+// src/utility/getImportSpecifiersAfterRemoving.ts
+function getImportSpecifiersAfterRemoving(context, specifiers, importToRemove) {
+  return specifiers.filter((specifier) => {
+    return !(specifier.imported.name === importToRemove);
+  }).map((specifier) => {
+    return context.sourceCode.getText(specifier);
+  }).join(", ");
+}
+var getImportSpecifiersAfterRemoving_default = getImportSpecifiersAfterRemoving;
+
+// src/rules/consistent-test-function.ts
+var validTestFunctionsSchema = z.enum(["test", "it"]);
+var consistentTestFunction = create_rule_default({
+  name: "consistent-test-function",
+  meta: {
+    docs: {
+      description: "Enforce a consistent function (either `test` or `it`)"
+    },
+    messages: {
+      message: "Unexpected {{source}}. Please use {{preference}} instead."
+    },
+    type: "suggestion",
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          preference: {
+            type: "string"
+          }
+        },
+        additionalProperties: false
+      }
+    ]
+  },
+  defaultOptions: [{ preference: "test" }],
+  create(context) {
+    var _a;
+    const preference = (_a = context.options[0]) == null ? void 0 : _a.preference;
+    const validatedPreference = validTestFunctionsSchema.parse(preference != null ? preference : "test");
+    return {
+      CallExpression(node) {
+        if (node.callee.type === AST_NODE_TYPES.Identifier && node.callee.name === "it" && validatedPreference === "test") {
+          return context.report({
+            node,
+            messageId: "message",
+            data: {
+              source: node.callee.name,
+              preference: validatedPreference
+            },
+            fix(fixer) {
+              return fixer.replaceText(node.callee, "test");
+            }
+          });
+        }
+        if (node.callee.type === AST_NODE_TYPES.Identifier && node.callee.name === "test" && validatedPreference === "it") {
+          return context.report({
+            node,
+            messageId: "message",
+            data: {
+              source: node.callee.name,
+              preference: validatedPreference
+            },
+            fix(fixer) {
+              return fixer.replaceText(node.callee, "it");
+            }
+          });
+        }
+      },
+      ImportDeclaration(node) {
+        for (const specifier of node.specifiers) {
+          if (specifier.type === AST_NODE_TYPES.ImportSpecifier && specifier.imported.type === AST_NODE_TYPES.Identifier && specifier.imported.name === "it" && validatedPreference === "test") {
+            return context.report({
+              node,
+              messageId: "message",
+              data: {
+                source: specifier.imported.name,
+                preference: validatedPreference
+              },
+              fix(fixer) {
+                const importedNames = node.specifiers.map((specifier2) => {
+                  return specifier2.type === AST_NODE_TYPES.ImportSpecifier && specifier2.imported.type === AST_NODE_TYPES.Identifier ? specifier2.imported.name : "";
+                });
+                if (importedNames.includes("it") && importedNames.includes("test")) {
+                  const newSpecifiers = getImportSpecifiersAfterRemoving_default(
+                    context,
+                    node.specifiers,
+                    "it"
+                  );
+                  return fixer.replaceTextRange(
+                    [
+                      node.specifiers[0].range[0],
+                      node.specifiers[node.specifiers.length - 1].range[1]
+                    ],
+                    newSpecifiers
+                  );
+                }
+                return fixer.replaceTextRange(
+                  [specifier.imported.range[0], specifier.imported.range[1]],
+                  validatedPreference
+                );
+              }
+            });
+          }
+          if (specifier.type === AST_NODE_TYPES.ImportSpecifier && specifier.imported.type === AST_NODE_TYPES.Identifier && specifier.imported.name === "test" && validatedPreference === "it") {
+            return context.report({
+              node,
+              messageId: "message",
+              data: {
+                source: specifier.imported.name,
+                preference: validatedPreference
+              },
+              fix(fixer) {
+                const importedNames = node.specifiers.map((specifier2) => {
+                  return specifier2.type === AST_NODE_TYPES.ImportSpecifier && specifier2.imported.type === AST_NODE_TYPES.Identifier ? specifier2.imported.name : "";
+                });
+                if (importedNames.includes("it") && importedNames.includes("test")) {
+                  const newSpecifiers = getImportSpecifiersAfterRemoving_default(
+                    context,
+                    node.specifiers,
+                    "test"
+                  );
+                  return fixer.replaceTextRange(
+                    [
+                      node.specifiers[0].range[0],
+                      node.specifiers[node.specifiers.length - 1].range[1]
+                    ],
+                    newSpecifiers
+                  );
+                }
+                return fixer.replaceTextRange(
+                  [specifier.imported.range[0], specifier.imported.range[1]],
+                  validatedPreference
+                );
+              }
+            });
+          }
+        }
+      }
+    };
+  }
+});
+var consistent_test_function_default = consistentTestFunction;
+
 // src/utility/checkCallExpression.ts
-import { AST_NODE_TYPES } from "@typescript-eslint/utils";
+import { AST_NODE_TYPES as AST_NODE_TYPES2 } from "@typescript-eslint/utils";
 function checkCallExpression(node, objectName, propertyName) {
-  return node.callee.type === AST_NODE_TYPES.MemberExpression && node.callee.object.type === AST_NODE_TYPES.Identifier && node.callee.object.name === objectName && node.callee.property.type === AST_NODE_TYPES.Identifier && node.callee.property.name === propertyName;
+  return node.callee.type === AST_NODE_TYPES2.MemberExpression && node.callee.object.type === AST_NODE_TYPES2.Identifier && node.callee.object.name === objectName && node.callee.property.type === AST_NODE_TYPES2.Identifier && node.callee.property.name === propertyName;
 }
 var checkCallExpression_default = checkCallExpression;
 
@@ -3916,7 +4065,7 @@ var noIsolatedTests = create_rule_default({
   create(context) {
     return {
       CallExpression(node) {
-        if (checkCallExpression_default(node, "describe", "only") || checkCallExpression_default(node, "test", "only")) {
+        if (checkCallExpression_default(node, "describe", "only") || checkCallExpression_default(node, "test", "only") || checkCallExpression_default(node, "it", "only")) {
           return context.report({
             node,
             messageId: "message",
@@ -4127,7 +4276,7 @@ var noSkippedTests = create_rule_default({
   create(context) {
     return {
       CallExpression(node) {
-        if (checkCallExpression_default(node, "describe", "skip") || checkCallExpression_default(node, "test", "skip")) {
+        if (checkCallExpression_default(node, "describe", "skip") || checkCallExpression_default(node, "test", "skip") || checkCallExpression_default(node, "it", "skip")) {
           return context.report({
             node,
             messageId: "message",
@@ -4143,7 +4292,7 @@ var noSkippedTests = create_rule_default({
 var no_skipped_tests_default = noSkippedTests;
 
 // src/rules/use-object-shorthand.ts
-import { AST_NODE_TYPES as AST_NODE_TYPES2 } from "@typescript-eslint/utils";
+import { AST_NODE_TYPES as AST_NODE_TYPES3 } from "@typescript-eslint/utils";
 var useObjectShorthand = create_rule_default({
   name: "use-object-shorthand",
   meta: {
@@ -4161,7 +4310,7 @@ var useObjectShorthand = create_rule_default({
   create(context) {
     return {
       Property(node) {
-        if (node.key.type === AST_NODE_TYPES2.Identifier && node.value.type === AST_NODE_TYPES2.Identifier && node.key.name === node.value.name && !node.shorthand) {
+        if (node.key.type === AST_NODE_TYPES3.Identifier && node.value.type === AST_NODE_TYPES3.Identifier && node.key.name === node.value.name && !node.shorthand) {
           context.report({
             node,
             messageId: "useShorthand",
@@ -4182,6 +4331,7 @@ var use_object_shorthand_default = useObjectShorthand;
 
 // src/rules/index.ts
 var rules_default = {
+  "consistent-test-function": consistent_test_function_default,
   "no-isolated-tests": no_isolated_tests_default,
   "no-namespace-imports": no_namespace_imports_default,
   "no-plugin-configs-access-from-src-configs": no_plugin_configs_access_from_src_configs_default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/eslint-plugin",
-  "version": "1.11.1",
+  "version": "1.12.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -53,6 +53,7 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "common-tags": "^1.8.2"
+    "common-tags": "^1.8.2",
+    "zod": "^4.1.5"
   }
 }