@alextheman/eslint-plugin 5.2.3 → 5.4.0

package/dist/index.cjs

@@ -43,11 +43,11 @@ let eslint_plugin_perfectionist = require("eslint-plugin-perfectionist");
 eslint_plugin_perfectionist = __toESM(eslint_plugin_perfectionist);
 let eslint_plugin_prettier = require("eslint-plugin-prettier");
 eslint_plugin_prettier = __toESM(eslint_plugin_prettier);
-let typescript_eslint = require("typescript-eslint");
-typescript_eslint = __toESM(typescript_eslint);
 let vite_tsconfig_paths = require("vite-tsconfig-paths");
 vite_tsconfig_paths = __toESM(vite_tsconfig_paths);
 let vitest_config = require("vitest/config");
+let typescript_eslint = require("typescript-eslint");
+typescript_eslint = __toESM(typescript_eslint);
 let eslint_plugin_jsx_a11y = require("eslint-plugin-jsx-a11y");
 eslint_plugin_jsx_a11y = __toESM(eslint_plugin_jsx_a11y);
 let eslint_plugin_react = require("eslint-plugin-react");
@@ -3428,6 +3428,8 @@ var generalRestrictedImports_default = generalRestrictedImports;
 /**
 * Checks if a given node matches the expected object and property names.
 *
+* @category Utility
+*
 * @param node - The node to check.
 * @param objectName - The object name to compare against the node.
 * @param propertyName - The property name to compare against the node.
@@ -3444,6 +3446,8 @@ var checkCallExpression_default = checkCallExpression;
 /**
 * Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
 *
+* @category Utility
+*
 * @param groups - Option groups to combine, applied in the order provided.
 *
 * @returns A new object combining all paths and patterns from the given groups, suitable as an option to pass to `no-restricted-imports`.
@@ -3470,6 +3474,8 @@ var combineRestrictedImports_default = combineRestrictedImports;
 /**
 * Converts a Zod schema to a JSON schema for usage in an ESLint rule.
 *
+* @category Utility
+*
 * @param schema - The Zod schema to convert.
 *
 * @returns An array containing the resulting JSON Schema, formatted for ESLint rule schema compatibility.
@@ -3479,6 +3485,26 @@ function createRuleSchemaFromZodSchema(schema$1) {
 }
 var createRuleSchemaFromZodSchema_default = createRuleSchemaFromZodSchema;
 
+//#endregion
+//#region src/utility/public/fixOnCondition.ts
+/**
+* Returns a rule fixer function to run based on a given condition
+*
+* @category Utility
+*
+* @param fixable - Whether the rule should be treated as fixable or not, and therefore whether the fixer should run.
+* @param fix - The rule fixer function to run.
+*
+* @returns The rule fixer function invoked with the fixer, provided the fixable condition is met.
+*/
+function fixOnCondition(fixable, fix) {
+	return (fixer) => {
+		if (!fixable) return null;
+		return fix(fixer);
+	};
+}
+var fixOnCondition_default = fixOnCondition;
+
 //#endregion
 //#region src/utility/private/camelToKebab.ts
 function camelToKebab(string) {
@@ -3501,6 +3527,8 @@ var createConfigGroup_default = createConfigGroup;
 /**
 * Takes in a nested group of configs, and returns them flattened according to ESLint config naming conventions.
 *
+* @category Utility
+*
 * @template ConfigObject - The type of the input config object.
 *
 * @param config - A doubly-nested config object to pass in, where the key of the top-level object is the config group name, and the key of the nested object is the name of the config within the group (e.g. `groupName.configName`).
@@ -3547,6 +3575,8 @@ var flattenConfigs_default = flattenConfigs;
 *
 * Useful for auto-fixable rules that remove a specific import from an import statement.
 *
+* @category Utility
+*
 * @template RuleOptions - The type of the RuleOptions from the given context.
 *
 * @param context - The current ESLint rule context.
@@ -3723,9 +3753,49 @@ const generalJavaScript = [
 var javaScript_default$1 = generalJavaScript;
 
 //#endregion
-//#region src/configs/helpers/prettierRules.ts
-const prettierRules = { printWidth: 100 };
-var prettierRules_default = prettierRules;
+//#region src/configs/external/prettierConfig.ts
+const prettierConfig = { printWidth: 100 };
+var prettierConfig_default = prettierConfig;
+
+//#endregion
+//#region src/configs/external/typeDocConfig.ts
+function typeDocConfig(entryPoints = ["./src/index.ts"]) {
+	return {
+		disableSources: true,
+		entryPoints,
+		excludeNotDocumented: true,
+		includeVersion: true,
+		outputs: [{
+			name: "html",
+			options: { navigation: {
+				excludeReferences: false,
+				includeCategories: true,
+				includeFolders: true,
+				includeGroups: true
+			} },
+			path: "docs/features/html"
+		}, {
+			name: "markdown",
+			path: "docs/features/markdown"
+		}],
+		plugin: ["typedoc-plugin-markdown", "typedoc-rhineai-theme"]
+	};
+}
+var typeDocConfig_default = typeDocConfig;
+
+//#endregion
+//#region src/configs/external/vitestConfig.ts
+function vitestConfig(environment = "jsdom") {
+	return (0, vitest_config.defineConfig)({
+		plugins: [(0, vite_tsconfig_paths.default)()],
+		test: {
+			environment,
+			globals: true,
+			include: ["**/tests/**/*.test.ts"]
+		}
+	});
+}
+var vitestConfig_default = vitestConfig;
 
 //#endregion
 //#region src/configs/helpers/reactLanguageOptions.ts
@@ -3736,30 +3806,6 @@ const reactLanguageOptions = {
 };
 var reactLanguageOptions_default = reactLanguageOptions;
 
-//#endregion
-//#region src/configs/helpers/typeDocConfig.ts
-const typeDocConfig = {
-	disableSources: true,
-	entryPoints: ["./src/index.ts"],
-	excludeNotDocumented: true,
-	includeVersion: true,
-	outputs: [{
-		name: "html",
-		options: { navigation: {
-			excludeReferences: false,
-			includeCategories: true,
-			includeFolders: true,
-			includeGroups: true
-		} },
-		path: "docs/features/html"
-	}, {
-		name: "markdown",
-		path: "docs/features/markdown"
-	}],
-	plugin: ["typedoc-plugin-markdown", "typedoc-rhineai-theme"]
-};
-var typeDocConfig_default = typeDocConfig;
-
 //#endregion
 //#region src/configs/helpers/typeScriptLanguageOptions.ts
 const typeScriptLanguageOptions = {
@@ -3773,20 +3819,6 @@ const typeScriptLanguageOptions = {
 };
 var typeScriptLanguageOptions_default = typeScriptLanguageOptions;
 
-//#endregion
-//#region src/configs/helpers/vitestConfig.ts
-function vitestConfig(environment = "jsdom") {
-	return (0, vitest_config.defineConfig)({
-		plugins: [(0, vite_tsconfig_paths.default)()],
-		test: {
-			environment,
-			globals: true,
-			include: ["**/tests/**/*.test.ts"]
-		}
-	});
-}
-var vitestConfig_default = vitestConfig;
-
 //#endregion
 //#region src/configs/helpers/sorting/sortClasses.ts
 const sortClasses = {
@@ -3929,7 +3961,7 @@ function personalJavaScript(plugin) {
 			"prefer-arrow-callback": ["error", { allowNamedFunctions: false }],
 			"prefer-destructuring": "error",
 			"prefer-template": "error",
-			"prettier/prettier": ["warn", prettierRules_default],
+			"prettier/prettier": ["warn", prettierConfig_default],
 			"sort-vars": "error"
 		}
 	}, {
@@ -4391,22 +4423,9 @@ const createRule = _typescript_eslint_utils.ESLintUtils.RuleCreator((ruleName) =
 });
 var createRule_default = createRule;
 
-//#endregion
-//#region src/rules/helpers/fixOnCondition.ts
-function fixOnCondition(fixable, fix) {
-	return (fixer) => {
-		if (!fixable) return null;
-		return fix(fixer);
-	};
-}
-var fixOnCondition_default = fixOnCondition;
-
 //#endregion
 //#region src/rules/consistent-test-function.ts
 const validTestFunctionsSchema = zod.default.enum(["test", "it"]);
-function parseTestFunction(data) {
-	return validTestFunctionsSchema.parse(data);
-}
 const consistentTestFunctionOptionsSchema = zod.default.object({
 	preference: validTestFunctionsSchema,
 	fixable: zod.default.boolean()
@@ -4802,7 +4821,7 @@ var rules_default = {
 //#endregion
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "5.2.3";
+var version = "5.4.0";
 
 //#endregion
 //#region src/alexPlugin.ts
@@ -4830,19 +4849,6 @@ exports.default = src_default;
 exports.fixOnCondition = fixOnCondition_default;
 exports.flattenConfigs = flattenConfigs_default;
 exports.getImportSpecifiersAfterRemoving = getImportSpecifiersAfterRemoving_default;
-exports.parseConsistentTestFunctionOptions = parseConsistentTestFunctionOptions;
-exports.parseNoNamespaceImportsOptions = parseNoNamespaceImportsOptions;
-exports.parseNoRelativeImportsOptions = parseNoRelativeImportsOptions;
-exports.parseStandardiseErrorMessagesOptions = parseStandardiseErrorMessagesOptions;
-exports.parseTestFunction = parseTestFunction;
-exports.parseUseNormalizedImportsOptions = parseUseNormalizedImportsOptions;
-exports.prettierRules = prettierRules_default;
-exports.reactLanguageOptions = reactLanguageOptions_default;
-exports.sortClasses = sortClasses_default;
-exports.sortExports = sortExports_default;
-exports.sortImports = sortImports_default;
-exports.sortObjects = sortObjects_default;
+exports.prettierConfig = prettierConfig_default;
 exports.typeDocConfig = typeDocConfig_default;
-exports.typeScriptLanguageOptions = typeScriptLanguageOptions_default;
-exports.unusedVarsIgnorePatterns = unusedVarsIgnorePatterns_default;
 exports.vitestConfig = vitestConfig_default;

package/dist/index.d.cts

@@ -4,15 +4,25 @@ import { TypeDocOptions } from "typedoc";
 import { PluginOptions } from "typedoc-plugin-markdown";
 import * as vite0 from "vite";
 import { VitestEnvironment } from "vitest/node";
-import { RuleContext, RuleFix, RuleFixer } from "@typescript-eslint/utils/ts-eslint";
-import z from "zod";
 import { TSESTree } from "@typescript-eslint/utils";
 import { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
+import z from "zod";
+import { RuleContext, RuleFix, RuleFixer } from "@typescript-eslint/utils/ts-eslint";
 
 //#region src/utility/private/camelToKebab.d.ts
 type CamelToKebab<S extends string> = S extends `${infer Head}${infer Tail}` ? Head extends Lowercase<Head> ? `${Head}${CamelToKebab<Tail>}` : `-${Lowercase<Head>}${CamelToKebab<Tail>}` : S;
 //#endregion
 //#region src/utility/public/GetFlattenedConfigNames.d.ts
+/**
+ * A helper type to turn the keys of a doubly-nested object into a flattened ESLint config key.
+ *
+ * @category Utility
+ *
+ * @example
+ * ```typescript
+ * type ConfigNames = GetFlattenedConfigNames<{ general: { typescriptReact }}> // "general/typescript-react"
+ * ```
+ */
 type GetFlattenedConfigNames<ConfigObject extends { [K in keyof ConfigObject]: Record<string, Linter.Config[]> }> = { [Group in keyof ConfigObject & string]: `${CamelToKebab<Group>}/${CamelToKebab<keyof ConfigObject[Group] & string>}` }[keyof ConfigObject & string];
 //#endregion
 //#region src/configs/AlexPluginConfigGroup.d.ts
@@ -49,101 +59,30 @@ interface AlexPlugin {
 }
 declare const alexPlugin: AlexPlugin;
 //#endregion
-//#region src/configs/helpers/prettierRules.d.ts
-declare const prettierRules: Config;
-//#endregion
-//#region src/configs/helpers/reactLanguageOptions.d.ts
-declare const reactLanguageOptions: Linter.LanguageOptions;
-//#endregion
-//#region src/configs/helpers/typeDocConfig.d.ts
-declare const typeDocConfig: TypeDocOptions & PluginOptions;
-//#endregion
-//#region src/configs/helpers/typeScriptLanguageOptions.d.ts
-declare const typeScriptLanguageOptions: Linter.LanguageOptions;
+//#region src/configs/external/prettierConfig.d.ts
+declare const prettierConfig: Config;
 //#endregion
-//#region src/configs/helpers/unusedVarsIgnorePatterns.d.ts
-declare const unusedVarsIgnorePatterns: {
-  argsIgnorePattern: string;
-  caughtErrorsIgnorePattern: string;
-  varsIgnorePattern: string;
-};
+//#region src/configs/external/typeDocConfig.d.ts
+declare function typeDocConfig(entryPoints?: string[]): TypeDocOptions & PluginOptions;
 //#endregion
-//#region src/configs/helpers/vitestConfig.d.ts
+//#region src/configs/external/vitestConfig.d.ts
 declare function vitestConfig(environment?: VitestEnvironment): vite0.UserConfig;
 //#endregion
-//#region src/configs/helpers/sorting/sortClasses.d.ts
-declare const sortClasses: {
-  customGroups: never[];
-  fallbackSort: {
-    type: string;
-  };
-  groups: (string | string[])[];
-  ignoreCase: boolean;
-  newlinesBetween: number;
-  order: string;
-  partitionByComment: boolean;
-  partitionByNewLine: boolean;
-  specialCharacters: string;
-  type: string;
-};
-//#endregion
-//#region src/configs/helpers/sorting/sortExports.d.ts
-declare const sortExports: {
-  customGroups: never[];
-  fallbackSort: {
-    type: string;
-  };
-  groups: string[];
-  ignoreCase: boolean;
-  newlinesBetween: number;
-  order: string;
-  partitionByComment: boolean;
-  partitionByNewLine: boolean;
-  specialCharacters: string;
-  type: string;
-};
-//#endregion
-//#region src/configs/helpers/sorting/sortImports.d.ts
-declare const sortImports: {
-  customGroups: ({
-    elementNamePattern: string[];
-    groupName: string;
-    selector?: undefined;
-  } | {
-    elementNamePattern: string[];
-    groupName: string;
-    selector: string;
-  })[];
-  groups: string[];
-  ignoreCase: boolean;
-  internalPattern: string[];
-  newlinesBetween: number;
-  order: string;
-  partitionByComment: boolean;
-  partitionByNewLine: boolean;
-  specialCharacters: string;
-  type: string;
-};
-//#endregion
-//#region src/configs/helpers/sorting/sortObjects.d.ts
-declare const sortObjects: {
-  customGroups: never[];
-  fallbackSort: {
-    type: string;
-  };
-  groups: never[];
-  ignoreCase: boolean;
-  newlinesBetween: string;
-  order: string;
-  partitionByComment: boolean;
-  partitionByNewLine: boolean;
-  specialCharacters: string;
-  styledComponents: boolean;
-  type: string;
-  useConfigurationIf: {};
-};
+//#region src/utility/public/checkCallExpression.d.ts
+/**
+ * Checks if a given node matches the expected object and property names.
+ *
+ * @category Utility
+ *
+ * @param node - The node to check.
+ * @param objectName - The object name to compare against the node.
+ * @param propertyName - The property name to compare against the node.
+ *
+ * @returns A value of `true` if the given `objectName` and `propertyName` matches those of the node, and `false` otherwise.
+ */
+declare function checkCallExpression(node: TSESTree.CallExpression, objectName: string, propertyName: string): boolean;
 //#endregion
-//#region src/configs/helpers/restrictedImports/NoRestrictedImportsOptions.d.ts
+//#region src/utility/public/NoRestrictedImportsOptions.d.ts
 interface RestrictedPathImportBase {
   message: string;
   name: string;
@@ -208,75 +147,19 @@ interface NoRestrictedImportsOptionsPathsAndPatterns {
   paths: RestrictedPathImport[];
   patterns: RestrictedPatternImport[];
 }
-type NoRestrictedImportsOptions = NoRestrictedImportsOptionsPathsOnly | NoRestrictedImportsOptionsPatternsOnly | NoRestrictedImportsOptionsPathsAndPatterns;
-//#endregion
-//#region src/rules/consistent-test-function.d.ts
-declare const validTestFunctionsSchema: z.ZodEnum<{
-  test: "test";
-  it: "it";
-}>;
-type TestFunction = z.infer<typeof validTestFunctionsSchema>;
-declare function parseTestFunction(data: unknown): TestFunction;
-declare const consistentTestFunctionOptionsSchema: z.ZodObject<{
-  preference: z.ZodOptional<z.ZodEnum<{
-    test: "test";
-    it: "it";
-  }>>;
-  fixable: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-type ConsistentTestFunctionOptions = z.infer<typeof consistentTestFunctionOptionsSchema>;
-declare function parseConsistentTestFunctionOptions(data: unknown): ConsistentTestFunctionOptions;
-//#endregion
-//#region src/rules/helpers/fixOnCondition.d.ts
-type RuleFixerFunction = (fixer: RuleFixer) => RuleFix | null;
-declare function fixOnCondition(fixable: boolean, fix: RuleFixerFunction): RuleFixerFunction;
-//#endregion
-//#region src/rules/no-namespace-imports.d.ts
-declare const noNamespaceImportsOptionsSchema: z.ZodObject<{
-  allow: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.core.$strip>;
-type NoNamespaceImportsOptions = z.infer<typeof noNamespaceImportsOptionsSchema>;
-declare function parseNoNamespaceImportsOptions(data: unknown): NoNamespaceImportsOptions;
-//#endregion
-//#region src/rules/no-relative-imports.d.ts
-declare const noRelativeImportsOptionsSchema: z.ZodObject<{
-  depth: z.ZodOptional<z.ZodInt>;
-}, z.core.$strip>;
-type NoRelativeImportsOptions = z.infer<typeof noRelativeImportsOptionsSchema>;
-declare function parseNoRelativeImportsOptions(data: unknown): NoRelativeImportsOptions;
-//#endregion
-//#region src/rules/standardise-error-messages.d.ts
-declare const standardiseErrorMessagesOptionsSchema: z.ZodObject<{
-  regex: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type StandardiseErrorMessagesOptions = z.infer<typeof standardiseErrorMessagesOptionsSchema>;
-declare function parseStandardiseErrorMessagesOptions(data: unknown): StandardiseErrorMessagesOptions;
-//#endregion
-//#region src/rules/use-normalized-imports.d.ts
-declare const useNormalizedImportsOptionsSchema: z.ZodObject<{
-  fixable: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-type UseNormalizedImportsOptions = z.infer<typeof useNormalizedImportsOptionsSchema>;
-declare function parseUseNormalizedImportsOptions(data: unknown): {
-  fixable?: boolean | undefined;
-};
-//#endregion
-//#region src/utility/public/checkCallExpression.d.ts
 /**
- * Checks if a given node matches the expected object and property names.
- *
- * @param node - The node to check.
- * @param objectName - The object name to compare against the node.
- * @param propertyName - The property name to compare against the node.
+ * Options for the built-in ESLint `no-restricted-imports` rule.
  *
- * @returns A value of `true` if the given `objectName` and `propertyName` matches those of the node, and `false` otherwise.
+ *  @category Rule Options
  */
-declare function checkCallExpression(node: TSESTree.CallExpression, objectName: string, propertyName: string): boolean;
+type NoRestrictedImportsOptions = NoRestrictedImportsOptionsPathsOnly | NoRestrictedImportsOptionsPatternsOnly | NoRestrictedImportsOptionsPathsAndPatterns;
 //#endregion
 //#region src/utility/public/combineRestrictedImports.d.ts
 /**
  * Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
  *
+ * @category Utility
+ *
  * @param groups - Option groups to combine, applied in the order provided.
  *
  * @returns A new object combining all paths and patterns from the given groups, suitable as an option to pass to `no-restricted-imports`.
@@ -287,16 +170,34 @@ declare function combineRestrictedImports(...groups: NoRestrictedImportsOptions[
 /**
  * Converts a Zod schema to a JSON schema for usage in an ESLint rule.
  *
+ * @category Utility
+ *
  * @param schema - The Zod schema to convert.
  *
  * @returns An array containing the resulting JSON Schema, formatted for ESLint rule schema compatibility.
  */
 declare function createRuleSchemaFromZodSchema(schema: z.ZodType): JSONSchema4[];
 //#endregion
+//#region src/utility/public/fixOnCondition.d.ts
+type RuleFixerFunction = (fixer: RuleFixer) => RuleFix | null;
+/**
+ * Returns a rule fixer function to run based on a given condition
+ *
+ * @category Utility
+ *
+ * @param fixable - Whether the rule should be treated as fixable or not, and therefore whether the fixer should run.
+ * @param fix - The rule fixer function to run.
+ *
+ * @returns The rule fixer function invoked with the fixer, provided the fixable condition is met.
+ */
+declare function fixOnCondition(fixable: boolean, fix: RuleFixerFunction): RuleFixerFunction;
+//#endregion
 //#region src/utility/public/flattenConfigs.d.ts
 /**
  * Takes in a nested group of configs, and returns them flattened according to ESLint config naming conventions.
  *
+ * @category Utility
+ *
  * @template ConfigObject - The type of the input config object.
  *
  * @param config - A doubly-nested config object to pass in, where the key of the top-level object is the config group name, and the key of the nested object is the name of the config within the group (e.g. `groupName.configName`).
@@ -337,6 +238,8 @@ declare function flattenConfigs<ConfigObject extends { [K in keyof ConfigObject]
  *
  * Useful for auto-fixable rules that remove a specific import from an import statement.
  *
+ * @category Utility
+ *
  * @template RuleOptions - The type of the RuleOptions from the given context.
  *
  * @param context - The current ESLint rule context.
@@ -347,4 +250,4 @@ declare function flattenConfigs<ConfigObject extends { [K in keyof ConfigObject]
  */
 declare function getImportSpecifiersAfterRemoving<RuleOptions>(context: Readonly<RuleContext<"message", [RuleOptions]>>, specifiers: TSESTree.ImportClause[], importToRemove: string): string;
 //#endregion
-export { AlexConfigGroupName, AlexFlattenedConfigName, type AlexPlugin, AlexPluginConfigFlattened, AlexPluginConfigObject, CombinedConfig, type GetFlattenedConfigNames as ConfigKey, ConsistentTestFunctionOptions, GeneralConfig, NoNamespaceImportsOptions, NoRelativeImportsOptions, type NoRestrictedImportsOptions, PersonalConfig, PluginConfig, type RestrictedPathImport, type RestrictedPatternImport, RuleFixerFunction, StandardiseErrorMessagesOptions, TestFunction, UseNormalizedImportsOptions, checkCallExpression, combineRestrictedImports, createRuleSchemaFromZodSchema, alexPlugin as default, fixOnCondition, flattenConfigs, getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules, reactLanguageOptions, sortClasses, sortExports, sortImports, sortObjects, typeDocConfig, typeScriptLanguageOptions, unusedVarsIgnorePatterns, vitestConfig };
+export { AlexConfigGroupName, AlexFlattenedConfigName, type AlexPlugin, AlexPluginConfigFlattened, AlexPluginConfigObject, CombinedConfig, GeneralConfig, type GetFlattenedConfigNames, type NoRestrictedImportsOptions, PersonalConfig, PluginConfig, checkCallExpression, combineRestrictedImports, createRuleSchemaFromZodSchema, alexPlugin as default, fixOnCondition, flattenConfigs, getImportSpecifiersAfterRemoving, prettierConfig, typeDocConfig, vitestConfig };