@alextheman/eslint-plugin 5.1.1 → 5.2.1

package/dist/index.cjs

@@ -3735,6 +3735,30 @@ 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 = {
@@ -4085,9 +4109,16 @@ var requireJsdocOptions_default = requireJsdocOptions;
 //#endregion
 //#region src/configs/personal/typeScriptPackage.ts
 const personalTypeScriptPackage = [eslint_plugin_jsdoc.default.configs["flat/recommended-typescript-error"], { rules: {
-	"jsdoc/check-tag-names": ["error", { definedTags: ["note"] }],
+	"jsdoc/check-tag-names": ["error", { definedTags: ["category", "note"] }],
 	"jsdoc/require-jsdoc": ["warn", requireJsdocOptions_default],
+	"jsdoc/require-tags": ["error", { tags: ["ExportNamedDeclaration", "ExportDefaultDeclaration"].map((context) => {
+		return {
+			context,
+			tag: "category"
+		};
+	}) }],
 	"jsdoc/sort-tags": ["error", { tagSequence: [
+		{ tags: ["category"] },
 		{ tags: ["deprecated"] },
 		{ tags: ["template"] },
 		{ tags: ["param"] },
@@ -4770,7 +4801,7 @@ var rules_default = {
 //#endregion
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "5.1.1";
+var version = "5.2.1";
 
 //#endregion
 //#region src/alexPlugin.ts
@@ -4810,6 +4841,7 @@ exports.sortClasses = sortClasses_default;
 exports.sortExports = sortExports_default;
 exports.sortImports = sortImports_default;
 exports.sortObjects = sortObjects_default;
+exports.typeDocConfig = typeDocConfig_default;
 exports.typeScriptLanguageOptions = typeScriptLanguageOptions_default;
 exports.unusedVarsIgnorePatterns = unusedVarsIgnorePatterns_default;
 exports.vitestConfig = vitestConfig_default;

package/dist/index.d.cts

@@ -1,5 +1,7 @@
 import { Linter } from "eslint";
 import { Config } from "prettier";
+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";
@@ -53,6 +55,9 @@ declare const prettierRules: Config;
 //#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;
 //#endregion
@@ -342,4 +347,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, typeScriptLanguageOptions, unusedVarsIgnorePatterns, vitestConfig };
+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 };

package/dist/index.d.ts

@@ -2,6 +2,8 @@ import { TSESTree } from "@typescript-eslint/utils";
 import z from "zod";
 import { Linter } from "eslint";
 import { Config } from "prettier";
+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";
@@ -53,6 +55,9 @@ declare const prettierRules: Config;
 //#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;
 //#endregion
@@ -342,4 +347,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, 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, flattenConfigs, getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules, reactLanguageOptions, sortClasses, sortExports, sortImports, sortObjects, typeScriptLanguageOptions, unusedVarsIgnorePatterns, vitestConfig };
+export { AlexConfigGroupName, AlexFlattenedConfigName, type AlexPlugin, AlexPluginConfigFlattened, AlexPluginConfigObject, CombinedConfig, type GetFlattenedConfigNames as 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, flattenConfigs, getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules, reactLanguageOptions, sortClasses, sortExports, sortImports, sortObjects, typeDocConfig, typeScriptLanguageOptions, unusedVarsIgnorePatterns, vitestConfig };

package/dist/index.js

@@ -3719,6 +3719,30 @@ 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 = {
@@ -4069,9 +4093,16 @@ var requireJsdocOptions_default = requireJsdocOptions;
 //#endregion
 //#region src/configs/personal/typeScriptPackage.ts
 const personalTypeScriptPackage = [jsdoc.configs["flat/recommended-typescript-error"], { rules: {
-	"jsdoc/check-tag-names": ["error", { definedTags: ["note"] }],
+	"jsdoc/check-tag-names": ["error", { definedTags: ["category", "note"] }],
 	"jsdoc/require-jsdoc": ["warn", requireJsdocOptions_default],
+	"jsdoc/require-tags": ["error", { tags: ["ExportNamedDeclaration", "ExportDefaultDeclaration"].map((context) => {
+		return {
+			context,
+			tag: "category"
+		};
+	}) }],
 	"jsdoc/sort-tags": ["error", { tagSequence: [
+		{ tags: ["category"] },
 		{ tags: ["deprecated"] },
 		{ tags: ["template"] },
 		{ tags: ["param"] },
@@ -4754,7 +4785,7 @@ var rules_default = {
 //#endregion
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "5.1.1";
+var version = "5.2.1";
 
 //#endregion
 //#region src/alexPlugin.ts
@@ -4775,4 +4806,4 @@ var alexPlugin_default = alexPlugin;
 var src_default = alexPlugin_default;
 
 //#endregion
-export { checkCallExpression_default as checkCallExpression, combineRestrictedImports_default as combineRestrictedImports, createRuleSchemaFromZodSchema_default as createRuleSchemaFromZodSchema, src_default as default, fixOnCondition_default as fixOnCondition, flattenConfigs_default as flattenConfigs, getImportSpecifiersAfterRemoving_default as getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules_default as prettierRules, reactLanguageOptions_default as reactLanguageOptions, sortClasses_default as sortClasses, sortExports_default as sortExports, sortImports_default as sortImports, sortObjects_default as sortObjects, typeScriptLanguageOptions_default as typeScriptLanguageOptions, unusedVarsIgnorePatterns_default as unusedVarsIgnorePatterns, vitestConfig_default as vitestConfig };
+export { checkCallExpression_default as checkCallExpression, combineRestrictedImports_default as combineRestrictedImports, createRuleSchemaFromZodSchema_default as createRuleSchemaFromZodSchema, src_default as default, fixOnCondition_default as fixOnCondition, flattenConfigs_default as flattenConfigs, getImportSpecifiersAfterRemoving_default as getImportSpecifiersAfterRemoving, parseConsistentTestFunctionOptions, parseNoNamespaceImportsOptions, parseNoRelativeImportsOptions, parseStandardiseErrorMessagesOptions, parseTestFunction, parseUseNormalizedImportsOptions, prettierRules_default as prettierRules, reactLanguageOptions_default as reactLanguageOptions, sortClasses_default as sortClasses, sortExports_default as sortExports, sortImports_default as sortImports, sortObjects_default as sortObjects, typeDocConfig_default as typeDocConfig, typeScriptLanguageOptions_default as typeScriptLanguageOptions, unusedVarsIgnorePatterns_default as unusedVarsIgnorePatterns, vitestConfig_default as vitestConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/eslint-plugin",
-  "version": "5.1.1",
+  "version": "5.2.1",
   "description": "A package to provide custom ESLint rules and configs",
   "repository": {
     "type": "git",
@@ -50,6 +50,9 @@
     "prettier": "^3.7.4",
     "tsdown": "^0.18.1",
     "tsx": "^4.21.0",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-rhineai-theme": "^1.2.0",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0",
     "vite-tsconfig-paths": "^6.0.3",
@@ -70,6 +73,9 @@
     "eslint-plugin-react": ">=7.0.0",
     "eslint-plugin-react-hooks": ">=7.0.0",
     "eslint-plugin-react-refresh": ">=0.4.0",
+    "typedoc": ">=0.28.15",
+    "typedoc-plugin-markdown": ">=4.9.0",
+    "typedoc-rhineai-theme": "^1.2.0",
     "typescript-eslint": ">=8.0.0",
     "vite-tsconfig-paths": ">=5.1.4",
     "vitest": ">=4.0.13"