@alextheman/eslint-plugin 4.5.1 → 4.7.0

package/dist/index.cjs

@@ -61,7 +61,7 @@ eslint_plugin_jsdoc = __toESM(eslint_plugin_jsdoc);
 
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "4.5.1";
+var version = "4.7.0";
 
 //#endregion
 //#region node_modules/.pnpm/globals@16.5.0/node_modules/globals/globals.json
@@ -3428,6 +3428,13 @@ var generalRestrictedImports_default = generalRestrictedImports;
 
 //#endregion
 //#region src/utility/public/checkCallExpression.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.
+* @returns A value of `true` if the given `objectName` and `propertyName` matches those of the node, and `false` otherwise.
+*/
 function checkCallExpression(node, objectName, propertyName) {
 	return node.callee.type === __typescript_eslint_utils.AST_NODE_TYPES.MemberExpression && node.callee.object.type === __typescript_eslint_utils.AST_NODE_TYPES.Identifier && node.callee.object.name === objectName && node.callee.property.type === __typescript_eslint_utils.AST_NODE_TYPES.Identifier && node.callee.property.name === propertyName;
 }
@@ -3435,6 +3442,11 @@ var checkCallExpression_default = checkCallExpression;
 
 //#endregion
 //#region src/utility/public/combineRestrictedImports.ts
+/**
+* Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
+* @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`.
+*/
 function combineRestrictedImports(...groups) {
 	const paths = [];
 	const patterns = [];
@@ -3454,6 +3466,11 @@ var combineRestrictedImports_default = combineRestrictedImports;
 
 //#endregion
 //#region src/utility/public/createRuleSchemaFromZodSchema.ts
+/**
+* Converts a Zod schema to a JSON schema for usage in an ESLint rule.
+* @param schema - The Zod schema to convert.
+* @returns An array containing the resulting JSON Schema, formatted for ESLint rule schema compatibility.
+*/
 function createRuleSchemaFromZodSchema(schema$1) {
 	return [(0, __alextheman_utility.omitProperties)(zod.default.toJSONSchema(schema$1), "$schema")];
 }
@@ -3461,6 +3478,14 @@ var createRuleSchemaFromZodSchema_default = createRuleSchemaFromZodSchema;
 
 //#endregion
 //#region src/utility/public/getImportSpecifiersAfterRemoving.ts
+/**
+* Returns a comma-separated string of import specifiers, excluding the specified import.
+* Useful for auto-fixable rules that remove a specific import from an import statement.
+* @param context - The current ESLint rule context.
+* @param specifiers - Array of import clause nodes.
+* @param importToRemove - The import name to remove from the list.
+* @returns A comma-separated string of import specifiers after removing the specified import.
+*/
 function getImportSpecifiersAfterRemoving(context, specifiers, importToRemove) {
 	return specifiers.filter((specifier) => {
 		return !(specifier.imported.name === importToRemove);
@@ -3907,6 +3932,28 @@ const personalAlexCLine = [{
 }];
 var alexCLine_default = personalAlexCLine;
 
+//#endregion
+//#region src/configs/helpers/requireJsdocOptions.ts
+const requireJsdocOptions = {
+	enableFixer: false,
+	publicOnly: true,
+	require: {
+		ClassDeclaration: true,
+		MethodDefinition: true
+	}
+};
+var requireJsdocOptions_default = requireJsdocOptions;
+
+//#endregion
+//#region src/configs/personal/typeScriptPackage.ts
+const personalTypeScriptPackage = [eslint_plugin_jsdoc.default.configs["flat/recommended-typescript-error"], { rules: { "jsdoc/require-jsdoc": ["warn", requireJsdocOptions_default] } }];
+var typeScriptPackage_default$1 = personalTypeScriptPackage;
+
+//#endregion
+//#region src/configs/personal/components.ts
+const personalComponents = [...typeScriptPackage_default$1, { rules: { "jsdoc/require-returns": "off" } }];
+var components_default = personalComponents;
+
 //#endregion
 //#region src/configs/helpers/restrictedImports/eslintPluginRestrictedImports.ts
 const eslintPluginRestrictedImports = combineRestrictedImports_default(generalRestrictedImports_default, { paths: [
@@ -3957,13 +4004,7 @@ function personalEslintPlugin(plugin) {
 		},
 		{
 			files: ["src/utility/public/**"],
-			rules: { "jsdoc/require-jsdoc": ["warn", {
-				enableFixer: false,
-				require: {
-					ClassDeclaration: true,
-					MethodDefinition: true
-				}
-			}] }
+			rules: { "jsdoc/require-jsdoc": ["error", requireJsdocOptions_default] }
 		}
 	];
 }
@@ -4064,17 +4105,6 @@ function personalTypeScript(plugin) {
 }
 var typeScript_default$2 = personalTypeScript;
 
-//#endregion
-//#region src/configs/personal/typeScriptPackage.ts
-const personalTypeScriptPackage = [eslint_plugin_jsdoc.default.configs["flat/recommended-typescript-error"], { rules: { "jsdoc/require-jsdoc": ["warn", {
-	enableFixer: false,
-	require: {
-		ClassDeclaration: true,
-		MethodDefinition: true
-	}
-}] } }];
-var typeScriptPackage_default$1 = personalTypeScriptPackage;
-
 //#endregion
 //#region src/configs/personal/utility.ts
 const personalUtility = [{
@@ -4164,6 +4194,7 @@ function createAlexPluginConfigs(plugin) {
 		},
 		personal: {
 			alexCLine: alexCLine_default,
+			components: components_default,
 			eslintPlugin: eslintPlugin_default(plugin),
 			javaScript: javaScriptBase_default(plugin),
 			neurosongsBackEnd: neurosongsBackEnd_default,

package/dist/index.d.cts

@@ -18,7 +18,7 @@ type CamelToKebab<S extends string> = S extends `${IgnoreCase<"J">}avaScript${in
 //#region src/configs/AlexPluginConfigGroup.d.ts
 type GeneralConfig = "javaScript" | "typeScript" | "react" | "packageJson";
 type PluginConfig = "base" | "tests";
-type PersonalConfig = "javaScript" | "typeScript" | "react" | "tests" | "eslintPlugin" | "neurosongsBackEnd" | "neurosongsFrontEnd" | "utility" | "alexCLine" | "typeScriptPackage";
+type PersonalConfig = "javaScript" | "typeScript" | "react" | "tests" | "eslintPlugin" | "neurosongsBackEnd" | "neurosongsFrontEnd" | "utility" | "alexCLine" | "typeScriptPackage" | "components";
 type CombinedConfig = "javaScript" | "typeScript" | "react" | "tests" | "typeScriptReact" | "javaScriptReact" | "typeScriptPackage";
 interface AlexPluginConfigGroup {
   general: Record<GeneralConfig, Linter.Config[]>;
@@ -232,15 +232,40 @@ declare function parseUseNormalizedImportsOptions(data: unknown): {
 };
 //#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.
+ * @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/utility/public/combineRestrictedImports.d.ts
+/**
+ * Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
+ * @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`.
+ */
 declare function combineRestrictedImports(...groups: NoRestrictedImportsOptions[]): NoRestrictedImportsOptions;
 //#endregion
 //#region src/utility/public/createRuleSchemaFromZodSchema.d.ts
+/**
+ * Converts a Zod schema to a JSON schema for usage in an ESLint rule.
+ * @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/getImportSpecifiersAfterRemoving.d.ts
-declare function getImportSpecifiersAfterRemoving(context: Readonly<RuleContext<"message", [ConsistentTestFunctionOptions]>>, specifiers: TSESTree.ImportClause[], importToRemove: string): string;
+/**
+ * Returns a comma-separated string of import specifiers, excluding the specified import.
+ * Useful for auto-fixable rules that remove a specific import from an import statement.
+ * @param context - The current ESLint rule context.
+ * @param specifiers - Array of import clause nodes.
+ * @param importToRemove - The import name to remove from the list.
+ * @returns A comma-separated string of import specifiers after removing the specified import.
+ */
+declare function getImportSpecifiersAfterRemoving<RuleOptions>(context: Readonly<RuleContext<"message", [RuleOptions]>>, specifiers: TSESTree.ImportClause[], importToRemove: string): string;
 //#endregion
 export { type AlexPlugin, AlexPluginConfigGroup, CombinedConfig, ConfigGroupName, ConfigKey, ConsistentTestFunctionOptions, GeneralConfig, NoNamespaceImportsOptions, NoRelativeImportsOptions, type NoRestrictedImportsOptions, PersonalConfig, PluginConfig, type RestrictedPathImport, type RestrictedPatternImport, RuleFixerFunction, StandardiseErrorMessagesOptions, TestFunction, UseNormalizedImportsOptions, checkCallExpression, combineRestrictedImports, createRuleSchemaFromZodSchema, alexPlugin as default, fixOnCondition, getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules, reactLanguageOptions, sortExports, sortImports, sortObjects, typeScriptLanguageOptions, unusedVarsIgnorePatterns, vitestConfig };

package/dist/index.d.ts

@@ -18,7 +18,7 @@ type CamelToKebab<S extends string> = S extends `${IgnoreCase<"J">}avaScript${in
 //#region src/configs/AlexPluginConfigGroup.d.ts
 type GeneralConfig = "javaScript" | "typeScript" | "react" | "packageJson";
 type PluginConfig = "base" | "tests";
-type PersonalConfig = "javaScript" | "typeScript" | "react" | "tests" | "eslintPlugin" | "neurosongsBackEnd" | "neurosongsFrontEnd" | "utility" | "alexCLine" | "typeScriptPackage";
+type PersonalConfig = "javaScript" | "typeScript" | "react" | "tests" | "eslintPlugin" | "neurosongsBackEnd" | "neurosongsFrontEnd" | "utility" | "alexCLine" | "typeScriptPackage" | "components";
 type CombinedConfig = "javaScript" | "typeScript" | "react" | "tests" | "typeScriptReact" | "javaScriptReact" | "typeScriptPackage";
 interface AlexPluginConfigGroup {
   general: Record<GeneralConfig, Linter.Config[]>;
@@ -232,15 +232,40 @@ declare function parseUseNormalizedImportsOptions(data: unknown): {
 };
 //#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.
+ * @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/utility/public/combineRestrictedImports.d.ts
+/**
+ * Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
+ * @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`.
+ */
 declare function combineRestrictedImports(...groups: NoRestrictedImportsOptions[]): NoRestrictedImportsOptions;
 //#endregion
 //#region src/utility/public/createRuleSchemaFromZodSchema.d.ts
+/**
+ * Converts a Zod schema to a JSON schema for usage in an ESLint rule.
+ * @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/getImportSpecifiersAfterRemoving.d.ts
-declare function getImportSpecifiersAfterRemoving(context: Readonly<RuleContext<"message", [ConsistentTestFunctionOptions]>>, specifiers: TSESTree.ImportClause[], importToRemove: string): string;
+/**
+ * Returns a comma-separated string of import specifiers, excluding the specified import.
+ * Useful for auto-fixable rules that remove a specific import from an import statement.
+ * @param context - The current ESLint rule context.
+ * @param specifiers - Array of import clause nodes.
+ * @param importToRemove - The import name to remove from the list.
+ * @returns A comma-separated string of import specifiers after removing the specified import.
+ */
+declare function getImportSpecifiersAfterRemoving<RuleOptions>(context: Readonly<RuleContext<"message", [RuleOptions]>>, specifiers: TSESTree.ImportClause[], importToRemove: string): string;
 //#endregion
 export { type AlexPlugin, AlexPluginConfigGroup, CombinedConfig, ConfigGroupName, ConfigKey, type ConsistentTestFunctionOptions, GeneralConfig, type NoNamespaceImportsOptions, type NoRelativeImportsOptions, type NoRestrictedImportsOptions, PersonalConfig, PluginConfig, type RestrictedPathImport, type RestrictedPatternImport, type RuleFixerFunction, type StandardiseErrorMessagesOptions, type TestFunction, type UseNormalizedImportsOptions, checkCallExpression, combineRestrictedImports, createRuleSchemaFromZodSchema, alexPlugin as default, fixOnCondition, getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules, reactLanguageOptions, sortExports, sortImports, sortObjects, typeScriptLanguageOptions, unusedVarsIgnorePatterns, vitestConfig };

package/dist/index.js

@@ -46,7 +46,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "4.5.1";
+var version = "4.7.0";
 
 //#endregion
 //#region node_modules/.pnpm/globals@16.5.0/node_modules/globals/globals.json
@@ -3413,6 +3413,13 @@ var generalRestrictedImports_default = generalRestrictedImports;
 
 //#endregion
 //#region src/utility/public/checkCallExpression.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.
+* @returns A value of `true` if the given `objectName` and `propertyName` matches those of the node, and `false` otherwise.
+*/
 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;
 }
@@ -3420,6 +3427,11 @@ var checkCallExpression_default = checkCallExpression;
 
 //#endregion
 //#region src/utility/public/combineRestrictedImports.ts
+/**
+* Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
+* @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`.
+*/
 function combineRestrictedImports(...groups) {
 	const paths = [];
 	const patterns = [];
@@ -3439,6 +3451,11 @@ var combineRestrictedImports_default = combineRestrictedImports;
 
 //#endregion
 //#region src/utility/public/createRuleSchemaFromZodSchema.ts
+/**
+* Converts a Zod schema to a JSON schema for usage in an ESLint rule.
+* @param schema - The Zod schema to convert.
+* @returns An array containing the resulting JSON Schema, formatted for ESLint rule schema compatibility.
+*/
 function createRuleSchemaFromZodSchema(schema$1) {
 	return [omitProperties(z.toJSONSchema(schema$1), "$schema")];
 }
@@ -3446,6 +3463,14 @@ var createRuleSchemaFromZodSchema_default = createRuleSchemaFromZodSchema;
 
 //#endregion
 //#region src/utility/public/getImportSpecifiersAfterRemoving.ts
+/**
+* Returns a comma-separated string of import specifiers, excluding the specified import.
+* Useful for auto-fixable rules that remove a specific import from an import statement.
+* @param context - The current ESLint rule context.
+* @param specifiers - Array of import clause nodes.
+* @param importToRemove - The import name to remove from the list.
+* @returns A comma-separated string of import specifiers after removing the specified import.
+*/
 function getImportSpecifiersAfterRemoving(context, specifiers, importToRemove) {
 	return specifiers.filter((specifier) => {
 		return !(specifier.imported.name === importToRemove);
@@ -3892,6 +3917,28 @@ const personalAlexCLine = [{
 }];
 var alexCLine_default = personalAlexCLine;
 
+//#endregion
+//#region src/configs/helpers/requireJsdocOptions.ts
+const requireJsdocOptions = {
+	enableFixer: false,
+	publicOnly: true,
+	require: {
+		ClassDeclaration: true,
+		MethodDefinition: true
+	}
+};
+var requireJsdocOptions_default = requireJsdocOptions;
+
+//#endregion
+//#region src/configs/personal/typeScriptPackage.ts
+const personalTypeScriptPackage = [jsdoc.configs["flat/recommended-typescript-error"], { rules: { "jsdoc/require-jsdoc": ["warn", requireJsdocOptions_default] } }];
+var typeScriptPackage_default$1 = personalTypeScriptPackage;
+
+//#endregion
+//#region src/configs/personal/components.ts
+const personalComponents = [...typeScriptPackage_default$1, { rules: { "jsdoc/require-returns": "off" } }];
+var components_default = personalComponents;
+
 //#endregion
 //#region src/configs/helpers/restrictedImports/eslintPluginRestrictedImports.ts
 const eslintPluginRestrictedImports = combineRestrictedImports_default(generalRestrictedImports_default, { paths: [
@@ -3942,13 +3989,7 @@ function personalEslintPlugin(plugin) {
 		},
 		{
 			files: ["src/utility/public/**"],
-			rules: { "jsdoc/require-jsdoc": ["warn", {
-				enableFixer: false,
-				require: {
-					ClassDeclaration: true,
-					MethodDefinition: true
-				}
-			}] }
+			rules: { "jsdoc/require-jsdoc": ["error", requireJsdocOptions_default] }
 		}
 	];
 }
@@ -4049,17 +4090,6 @@ function personalTypeScript(plugin) {
 }
 var typeScript_default$2 = personalTypeScript;
 
-//#endregion
-//#region src/configs/personal/typeScriptPackage.ts
-const personalTypeScriptPackage = [jsdoc.configs["flat/recommended-typescript-error"], { rules: { "jsdoc/require-jsdoc": ["warn", {
-	enableFixer: false,
-	require: {
-		ClassDeclaration: true,
-		MethodDefinition: true
-	}
-}] } }];
-var typeScriptPackage_default$1 = personalTypeScriptPackage;
-
 //#endregion
 //#region src/configs/personal/utility.ts
 const personalUtility = [{
@@ -4149,6 +4179,7 @@ function createAlexPluginConfigs(plugin) {
 		},
 		personal: {
 			alexCLine: alexCLine_default,
+			components: components_default,
 			eslintPlugin: eslintPlugin_default(plugin),
 			javaScript: javaScriptBase_default(plugin),
 			neurosongsBackEnd: neurosongsBackEnd_default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/eslint-plugin",
-  "version": "4.5.1",
+  "version": "4.7.0",
   "description": "A package to provide custom ESLint rules and configs",
   "repository": {
     "type": "git",
@@ -15,8 +15,8 @@
     "dist"
   ],
   "dependencies": {
-    "@alextheman/utility": "^3.4.2",
-    "@typescript-eslint/utils": "^8.48.1",
+    "@alextheman/utility": "^3.5.5",
+    "@typescript-eslint/utils": "^8.49.0",
     "common-tags": "^1.8.2",
     "zod": "^4.1.13"
   },
@@ -25,8 +25,8 @@
     "@types/common-tags": "^1.8.4",
     "@types/eslint": "^9.6.1",
     "@types/eslint-plugin-jsx-a11y": "^6.10.1",
-    "@types/node": "^24.10.1",
-    "@typescript-eslint/rule-tester": "^8.48.1",
+    "@types/node": "^25.0.1",
+    "@typescript-eslint/rule-tester": "^8.49.0",
     "dotenv-cli": "^11.0.0",
     "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
@@ -43,12 +43,12 @@
     "eslint-vitest-rule-tester": "^3.0.0",
     "globals": "^16.5.0",
     "husky": "^9.1.7",
-    "jsdom": "^27.2.0",
+    "jsdom": "^27.3.0",
     "prettier": "^3.7.4",
-    "tsdown": "^0.17.0",
+    "tsdown": "^0.17.3",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.48.1",
+    "typescript-eslint": "^8.49.0",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^4.0.15"
   },