add exit visitor creator helpers for all rule types and improve JSDoc comments

- Added createExitVisitorsForAnyNetworkRule helper for network rule exit visitors
- Added createExitVisitorsForAnyCosmeticRule helper for cosmetic rule exit visitors
- Added createExitVisitorsForAnyCommentRule helper for comment rule exit visitors
- Added createExitVisitorsForAnyValidRule helper for valid rule exit visitors
- Added createExitVisitorsForAnyRule helper for all rule exit visitors including invalid and empty

Author: scripthunter7

src/linter/index.ts

@@ -46,6 +46,11 @@ export {
     createVisitorsForAnyNetworkRule,
     createVisitorsForAnyRule,
     createVisitorsForAnyValidRule,
+    createExitVisitorsForAnyCommentRule,
+    createExitVisitorsForAnyCosmeticRule,
+    createExitVisitorsForAnyNetworkRule,
+    createExitVisitorsForAnyRule,
+    createExitVisitorsForAnyValidRule,
 } from './visitor-creator';
 export { type LinterRuleLoader } from './rule-registry/rule-loader';
 export { type LinterFileProps } from './file-props';

src/linter/visitor-creator.ts

@@ -8,13 +8,27 @@ import { type Visitor } from './source-code/visitor-collection';
  *
  * @returns Visitors for any network rule.
  */
-export const createVisitorsForAnyNetworkRule = (visitor: Visitor) => {
+export const createVisitorsForAnyNetworkRule = (visitor: Visitor): LinterRuleVisitors => {
     return {
         NetworkRule: visitor,
         HostRule: visitor,
     };
 };
 
+/**
+ * Helper to create exit visitors for any network rule.
+ *
+ * @param visitor The visitor to use.
+ *
+ * @returns Exit visitors for any network rule.
+ */
+export const createExitVisitorsForAnyNetworkRule = (visitor: Visitor): LinterRuleVisitors => {
+    return {
+        'NetworkRule:exit': visitor,
+        'HostRule:exit': visitor,
+    };
+};
+
 /**
  * Helper to create visitors for any cosmetic rule.
  *
@@ -34,6 +48,25 @@ export const createVisitorsForAnyCosmeticRule = (
     };
 };
 
+/**
+ * Helper to create exit visitors for any cosmetic rule.
+ *
+ * @param visitor The visitor to use.
+ *
+ * @returns Exit visitors for any cosmetic rule.
+ */
+export const createExitVisitorsForAnyCosmeticRule = (
+    visitor: Visitor,
+): LinterRuleVisitors => {
+    return {
+        'CssInjectionRule:exit': visitor,
+        'ElementHidingRule:exit': visitor,
+        'ScriptletInjectionRule:exit': visitor,
+        'HtmlFilteringRule:exit': visitor,
+        'JsInjectionRule:exit': visitor,
+    };
+};
+
 /**
  * Helper to create visitors for any comment rule.
  *
@@ -55,11 +88,31 @@ export const createVisitorsForAnyCommentRule = (
 };
 
 /**
- * Helper to create visitors for any rule.
+ * Helper to create exit visitors for any comment rule.
  *
  * @param visitor The visitor to use.
  *
- * @returns Visitors for any rule.
+ * @returns Exit visitors for any comment rule.
+ */
+export const createExitVisitorsForAnyCommentRule = (
+    visitor: Visitor,
+): LinterRuleVisitors => {
+    return {
+        'AgentCommentRule:exit': visitor,
+        'CommentRule:exit': visitor,
+        'ConfigCommentRule:exit': visitor,
+        'HintCommentRule:exit': visitor,
+        'MetadataCommentRule:exit': visitor,
+        'PreProcessorCommentRule:exit': visitor,
+    };
+};
+
+/**
+ * Helper to create visitors for any valid rule.
+ *
+ * @param visitor The visitor to use.
+ *
+ * @returns Visitors for any valid rule.
  */
 export const createVisitorsForAnyValidRule = (
     visitor: Visitor,
@@ -72,7 +125,24 @@ export const createVisitorsForAnyValidRule = (
 };
 
 /**
- * Helper to create visitors for any rule.
+ * Helper to create exit visitors for any valid rule.
+ *
+ * @param visitor The visitor to use.
+ *
+ * @returns Exit visitors for any valid rule.
+ */
+export const createExitVisitorsForAnyValidRule = (
+    visitor: Visitor,
+): LinterRuleVisitors => {
+    return {
+        ...createExitVisitorsForAnyNetworkRule(visitor),
+        ...createExitVisitorsForAnyCosmeticRule(visitor),
+        ...createExitVisitorsForAnyCommentRule(visitor),
+    };
+};
+
+/**
+ * Helper to create visitors for any rule (including invalid and empty rules).
  *
  * @param visitor The visitor to use.
  *
@@ -89,3 +159,22 @@ export const createVisitorsForAnyRule = (
         EmptyRule: visitor,
     };
 };
+
+/**
+ * Helper to create exit visitors for any rule (including invalid and empty rules).
+ *
+ * @param visitor The visitor to use.
+ *
+ * @returns Exit visitors for any rule.
+ */
+export const createExitVisitorsForAnyRule = (
+    visitor: Visitor,
+): LinterRuleVisitors => {
+    return {
+        ...createExitVisitorsForAnyNetworkRule(visitor),
+        ...createExitVisitorsForAnyCosmeticRule(visitor),
+        ...createExitVisitorsForAnyCommentRule(visitor),
+        'InvalidRule:exit': visitor,
+        'EmptyRule:exit': visitor,
+    };
+};