@cbnventures/nova 0.17.0 → 0.18.0

package/build/src/types/rules/eslint/jsdoc/require-jsdoc-hierarchy.d.ts

@@ -1,302 +1,476 @@
 import type { TSESTree } from '@typescript-eslint/utils';
-import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+import type { RuleContext, RuleFix, RuleFixer } from '@typescript-eslint/utils/ts-eslint';
 
 import type {
-  SharedJsdocHierarchyCreateOptions,
-  SharedJsdocHierarchyFindSummaryInfoResult,
+  Shared_JsdocHierarchyCreateOptions as SharedJsdocHierarchyCreateOptions,
+  Shared_JsdocHierarchyFindSummaryInfoResult as SharedJsdocHierarchyFindSummaryInfoResult,
 } from '../../../shared.d.ts';
 
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Rule.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_RuleDefaultOptionsAnchorDirectories = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_RuleDefaultOptionsIgnoreFiles = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_RuleDefaultOptionsKnownNames = Record<string, string>;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_RuleDefaultOptionsStripDirectories = string[];
+
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Known Names.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_KnownNames = Map<string, string>;
+
 /**
  * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Build Fixed Comment.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentCommentValue = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_CommentValue = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_SummaryIndex = number;
 
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentSummaryIndex = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_OldSummary = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentOldSummary = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_NewSummary = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentNewSummary = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_Returns = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentReturns = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_Lines = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentLines = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_Line = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyBuildFixedCommentLine = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_BuildFixedComment_ReplacedLine = string;
 
 /**
  * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Check Class.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassContext = Readonly<RuleContext<string, unknown[]>>;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Context = Readonly<RuleContext<string, unknown[]>>;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Node = TSESTree.ClassDeclaration;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Options = SharedJsdocHierarchyCreateOptions;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassNode = TSESTree.ClassDeclaration;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassReturns = void;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Comments = TSESTree.Comment[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassComments = TSESTree.Comment[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_JsdocComment = TSESTree.Comment | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassJsdocComment = TSESTree.Comment | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Expected = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassExpected = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_SummaryInfo = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassSummaryInfo = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_FixedValue = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckClassFixedValue = string;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Check Class - Fix.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Fix_Fixer = RuleFixer;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckClass_Fix_Returns = RuleFix;
 
 /**
  * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Check Method.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodContext = Readonly<RuleContext<string, unknown[]>>;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Context = Readonly<RuleContext<string, unknown[]>>;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodNode = TSESTree.MethodDefinition;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Node = TSESTree.MethodDefinition;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodReturns = void;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Options = SharedJsdocHierarchyCreateOptions;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodComments = TSESTree.Comment[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodJsdocComment = TSESTree.Comment | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Comments = TSESTree.Comment[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodMethodName = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_JsdocComment = TSESTree.Comment | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodExpected = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_MethodName = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodSummaryInfo = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Expected = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_SummaryInfo = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_FixedValue = string;
+
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Check Method - Fix.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Fix_Fixer = RuleFixer;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckMethodFixedValue = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckMethod_Fix_Returns = RuleFix;
 
 /**
  * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Check Node.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeContext = Readonly<RuleContext<string, unknown[]>>;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Context = Readonly<RuleContext<string, unknown[]>>;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Node = TSESTree.Node;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Options = SharedJsdocHierarchyCreateOptions;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeNode = TSESTree.Node;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeReturns = void;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Comments = TSESTree.Comment[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeComments = TSESTree.Comment[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_JsdocComment = TSESTree.Comment | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeJsdocComment = TSESTree.Comment | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_ParentNames = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodePathParts = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Parent = TSESTree.Node | null | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeParent = TSESTree.Node | null | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Expected = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeExpected = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_SummaryInfo = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeSummaryInfo = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Suffix = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeSuffix = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_DescribeString = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeDescribeString = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_PathParts = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeDescribeSuffix = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_DescribeSuffix = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeName = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_NodeName = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeFixedValue = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_NamePathParts = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyCheckNodeVarName = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_NameSuffix = string | undefined;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_ExpectedWithSuffix = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_ExpectedPrefix = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_FixedValue = string;
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Dedup Against Path.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Check Node - Fix.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathWords = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Fix_Fixer = RuleFixer;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathPathParts = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_CheckNode_Fix_Returns = RuleFix;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathReturns = string | undefined;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Options = SharedJsdocHierarchyCreateOptions;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathPrefixLength = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic_Object_Segment = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathMatches = boolean;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic_Object_Prefix = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathSuffixStart = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic_Object = Readonly<{
+  segment: Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic_Object_Segment;
+  prefix: Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic_Object_Prefix;
+}>;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathWordAtIndex = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic = Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Diagnostic_Object | null;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathPartAtSuffix = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_UserKnownNames = Record<string, string>;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDedupAgainstPathRemaining = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_UserEntries = [string, string][];
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Derive Describe Suffix.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Class Declaration.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixDescribeString = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_ClassDeclaration_Node = TSESTree.ClassDeclaration;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixPathParts = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_ClassDeclaration_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixReturns = string | undefined;
-
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixWords = string[];
-
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixPrettyWords = string[];
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Export Named Declaration.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_ExportNamedDeclaration_Node = TSESTree.ExportNamedDeclaration;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixLoweredWord = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_ExportNamedDeclaration_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixKnownName = string | undefined;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Expression Statement.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_ExpressionStatement_Node = TSESTree.ExpressionStatement;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixDotIndex = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_ExpressionStatement_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixMethodPart = string;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Function Declaration.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_FunctionDeclaration_Node = TSESTree.FunctionDeclaration;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveDescribeSuffixPrettyName = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_FunctionDeclaration_Returns = void;
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Derive Hierarchy.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Method Definition.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyFilename = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_MethodDefinition_Node = TSESTree.MethodDefinition;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchySegments = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_MethodDefinition_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyOptions = SharedJsdocHierarchyCreateOptions;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Program.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Program_Node = TSESTree.Program;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyReturns = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_Program_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchySrcIndex = number;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Create - Variable Declaration.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_VariableDeclaration_Node = TSESTree.VariableDeclaration;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyAnchorIndex = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_Create_VariableDeclaration_Returns = void;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyAnchorToken = string;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Dedup Against Path.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_Words = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyLastSlashIndex = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_PathParts = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyFilenameStem = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_Returns = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyPrettySegments = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_PrefixLength = number;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyPrettyParts = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_Matches = boolean;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyAllParts = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_SuffixStart = number;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyRelativePath = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_WordAtIndex = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyStripped = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_PartAtSuffix = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyDeriveHierarchyParts = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DedupAgainstPath_Remaining = string[];
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Extract Describe String.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Derive Describe Suffix.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyExtractDescribeStringNode = TSESTree.ExpressionStatement;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_DescribeString = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyExtractDescribeStringReturns = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_PathParts = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyExtractDescribeStringIsDescribe = boolean;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_Returns = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyExtractDescribeStringFirstArg = TSESTree.CallExpressionArgument | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_Words = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_PrettyWords = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_LoweredWord = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_KnownName = string | undefined;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_HyphenatedWord = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_HyphenatedName = string | undefined;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_DotIndex = number;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_MethodPart = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_SnakeWords = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_SnakePrettyWords = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_SnakeLoweredWord = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_SnakeKnownName = string | undefined;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_PrettyName = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveDescribeSuffix_CamelWords = string[];
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Extract Node Name.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Derive Hierarchy.
  *
  * @since 0.15.0
  */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_Filename = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_Segments = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_Options = SharedJsdocHierarchyCreateOptions;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_Returns = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_Parts = ReadonlyArray<string>;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_LastSlashIndex = number;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_SafeExtensionPattern = RegExp;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_FilenameStem = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_NormalizedStem = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_StemPrettySegments = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_StemPrettyParts = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_StemAllParts = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_PrettySegments = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_PrettyParts = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveHierarchy_AllParts = string[];
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Find Summary Info.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Derive Invalid Prefix Diagnostic.
  *
- * @since 0.15.0
+ * @since 0.17.1
  */
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoCommentValue = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_Filename = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoReturns = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_Options = SharedJsdocHierarchyCreateOptions;
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoLines = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_ReturnsObject_Segment = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoLine = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_ReturnsObject_Prefix = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoTrimmed = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_ReturnsObject = {
+  segment: Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_ReturnsObject_Segment;
+  prefix: Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_ReturnsObject_Prefix;
+};
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoResultIndex = number;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_Returns = Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_ReturnsObject | null;
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoResultText = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_Parts = ReadonlyArray<string>;
 
-export type RulesEslintJsdocRequireJsdocHierarchyFindSummaryInfoResult = SharedJsdocHierarchyFindSummaryInfoResult;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_FirstSegment = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DeriveInvalidPrefixDiagnostic_Prefix = string;
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Known Names.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Derive Path Parts.
  *
- * @since 0.15.0
+ * @since 0.17.1
  */
-export type RulesEslintJsdocRequireJsdocHierarchyKnownNames = Map<string, string>;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_Filename = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_Options = SharedJsdocHierarchyCreateOptions;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_Returns = ReadonlyArray<string>;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_SrcIndex = number;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_AnchorIndex = number;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_AnchorToken = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_RelativePath = string;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_RawSegments = string[];
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_DerivePathParts_LastSegmentIndex = number;
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Merged Names.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Extract Describe String.
  *
  * @since 0.15.0
  */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_ExtractDescribeString_Node = TSESTree.ExpressionStatement;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_ExtractDescribeString_Returns = string | undefined;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_ExtractDescribeString_IsDescribe = boolean;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_ExtractDescribeString_FirstArg = TSESTree.CallExpressionArgument | undefined;
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Pretty Method Name.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Extract Node Name.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameName = string;
-
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameReturns = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_ExtractNodeName_Node = TSESTree.Node;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameWords = RegExpMatchArray | null;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_ExtractNodeName_Returns = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameResult = string[];
-
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameIndex = number;
-
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameLowered = string;
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Find Summary Info.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_FindSummaryInfo_CommentValue = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameNext = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_FindSummaryInfo_Returns = SharedJsdocHierarchyFindSummaryInfoResult | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNamePair = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_FindSummaryInfo_Lines = string[];
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameKnownPair = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_FindSummaryInfo_Line = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettyMethodNameKnownName = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_FindSummaryInfo_Trimmed = string;
 
 /**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Pretty Segment.
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Pretty Method Name.
  *
  * @since 0.15.0
  */
-export type RulesEslintJsdocRequireJsdocHierarchyPrettySegmentSegment = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Name = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettySegmentReturns = string;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Returns = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettySegmentKnownName = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Words = RegExpMatchArray | null;
 
-export type RulesEslintJsdocRequireJsdocHierarchyPrettySegmentWordName = string | undefined;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Result = string[];
 
-/**
- * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Rule.
- *
- * @since 0.15.0
- */
-export type RulesEslintJsdocRequireJsdocHierarchyRuleDefaultOptionsAnchorDirectories = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Index = number;
+
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Current = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleDefaultOptionsIgnoreFiles = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Next = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleDefaultOptionsKnownNames = Record<string, string>;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Pair = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleDefaultOptionsStripDirectories = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_KnownPair = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleOptions = SharedJsdocHierarchyCreateOptions;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_Lowered = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleOptionsKnownNames = Record<string, string>;
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettyMethodName_KnownName = string | undefined;
+
+/**
+ * Rules - ESLint - JSDoc - Require JSDoc Hierarchy - Pretty Segment.
+ *
+ * @since 0.15.0
+ */
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettySegment_Segment = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleUserEntries = [string, string][];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettySegment_Returns = string;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleOptionsAnchorDirectories = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettySegment_KnownName = string | undefined;
 
-export type RulesEslintJsdocRequireJsdocHierarchyRuleOptionsStripDirectories = string[];
+export type Rules_Eslint_Jsdoc_RequireJsdocHierarchy_Runner_PrettySegment_WordName = string | undefined;