eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/iterateJsdoc.d.ts

@@ -1,413 +1,405 @@
-import * as _es_joy_jsdoccomment0 from "@es-joy/jsdoccomment";
-import { parseComment } from "@es-joy/jsdoccomment";
-import * as comment_parser0 from "comment-parser";
-import * as eslint0 from "eslint";
-import * as __jsdocUtils_js0 from "./jsdocUtils.js";
-import * as __getDefaultTagStructureForMode_js0 from "./getDefaultTagStructureForMode.js";
-import * as estree0 from "estree";
-
-//#region src/iterateJsdoc.d.ts
 /**
  * @param {JsdocVisitor} iterator
  * @param {RuleConfig} ruleConfig
  * @returns {import('eslint').Rule.RuleModule}
  */
-declare function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): eslint0.Rule.RuleModule;
-type Integer = number;
-type JsdocBlockWithInline = _es_joy_jsdoccomment0.JsdocBlockWithInline;
-type ContextObject = {
-  disallowName?: string;
-  allowName?: string;
-  context?: string;
-  comment?: string;
-  tags?: string[];
-  replacement?: string;
-  minimum?: Integer;
-  message?: string;
-  forceRequireReturn?: boolean;
+export default function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): import("eslint").Rule.RuleModule;
+export { parseComment } from "@es-joy/jsdoccomment";
+export type Integer = number;
+export type JsdocBlockWithInline = import("@es-joy/jsdoccomment").JsdocBlockWithInline;
+export type ContextObject = {
+    disallowName?: string;
+    allowName?: string;
+    context?: string;
+    comment?: string;
+    tags?: string[];
+    replacement?: string;
+    minimum?: Integer;
+    message?: string;
+    forceRequireReturn?: boolean;
 };
-type Context = string | ContextObject;
-type CheckJsdoc = (info: {
-  lastIndex?: Integer;
-  isFunctionContext?: boolean;
-  selector?: string;
-  comment?: string;
-}, handler: null | ((jsdoc: _es_joy_jsdoccomment0.JsdocBlockWithInline) => boolean | undefined), node: eslint0.Rule.Node) => void;
-type ForEachPreferredTag = (tagName: string, arrayHandler: (matchingJsdocTag: _es_joy_jsdoccomment0.JsdocTagWithInline, targetTagName: string) => void, skipReportingBlockedTag?: boolean | undefined) => void;
-type ReportSettings = (message: string) => void;
-type ParseClosureTemplateTag = (tag: comment_parser0.Spec) => string[];
-type GetPreferredTagNameObject = (cfg: {
-  tagName: string;
+export type Context = string | ContextObject;
+export type CheckJsdoc = (info: {
+    lastIndex?: Integer;
+    isFunctionContext?: boolean;
+    selector?: string;
+    comment?: string;
+}, handler: null | ((jsdoc: import("@es-joy/jsdoccomment").JsdocBlockWithInline) => boolean | undefined), node: import("eslint").Rule.Node) => void;
+export type ForEachPreferredTag = (tagName: string, arrayHandler: (matchingJsdocTag: import("@es-joy/jsdoccomment").JsdocTagWithInline, targetTagName: string) => void, skipReportingBlockedTag?: boolean | undefined) => void;
+export type ReportSettings = (message: string) => void;
+export type ParseClosureTemplateTag = (tag: import("comment-parser").Spec) => string[];
+export type GetPreferredTagNameObject = (cfg: {
+    tagName: string;
 }) => string | false | {
-  message: string;
-  replacement?: string | undefined;
+    message: string;
+    replacement?: string | undefined;
 } | {
-  blocked: true;
-  tagName: string;
+    blocked: true;
+    tagName: string;
 };
-type BasicUtils = {
-  forEachPreferredTag: ForEachPreferredTag;
-  reportSettings: ReportSettings;
-  parseClosureTemplateTag: ParseClosureTemplateTag;
-  getPreferredTagNameObject: GetPreferredTagNameObject;
-  pathDoesNotBeginWith: __jsdocUtils_js0.PathDoesNotBeginWith;
+export type BasicUtils = {
+    forEachPreferredTag: ForEachPreferredTag;
+    reportSettings: ReportSettings;
+    parseClosureTemplateTag: ParseClosureTemplateTag;
+    getPreferredTagNameObject: GetPreferredTagNameObject;
+    pathDoesNotBeginWith: import("./jsdocUtils.js").PathDoesNotBeginWith;
 };
-type IsIteratingFunction = () => boolean;
-type IsVirtualFunction = () => boolean;
-type Stringify = (tagBlock: comment_parser0.Block, specRewire?: boolean | undefined) => string;
-type ReportJSDoc = (msg: string, tag?: comment_parser0.Spec | {
-  line: Integer;
-  column?: Integer;
+export type IsIteratingFunction = () => boolean;
+export type IsVirtualFunction = () => boolean;
+export type Stringify = (tagBlock: import("comment-parser").Block, specRewire?: boolean | undefined) => string;
+export type ReportJSDoc = (msg: string, tag?: import("comment-parser").Spec | {
+    line: Integer;
+    column?: Integer;
 } | null | undefined, handler?: (() => void) | null | undefined, specRewire?: boolean | undefined, data?: undefined | {
-  [key: string]: string;
+    [key: string]: string;
 }) => any;
-type GetRegexFromString = (str: string, requiredFlags?: string | undefined) => RegExp;
-type GetTagDescription = (tg: comment_parser0.Spec, returnArray?: boolean | undefined) => string[] | string;
-type SetTagDescription = (tg: comment_parser0.Spec, matcher: RegExp, setter: (description: string) => string) => Integer;
-type GetDescription = () => {
-  description: string;
-  descriptions: string[];
-  lastDescriptionLine: Integer;
+export type GetRegexFromString = (str: string, requiredFlags?: string | undefined) => RegExp;
+export type GetTagDescription = (tg: import("comment-parser").Spec, returnArray?: boolean | undefined) => string[] | string;
+export type SetTagDescription = (tg: import("comment-parser").Spec, matcher: RegExp, setter: (description: string) => string) => Integer;
+export type GetDescription = () => {
+    description: string;
+    descriptions: string[];
+    lastDescriptionLine: Integer;
 };
-type SetBlockDescription = (setter: (info: {
-  delimiter: string;
-  postDelimiter: string;
-  start: string;
-}, seedTokens: (tokens?: Partial<comment_parser0.Tokens>) => comment_parser0.Tokens, descLines: string[]) => comment_parser0.Line[]) => void;
-type SetDescriptionLines = (matcher: RegExp, setter: (description: string) => string) => Integer;
-type ChangeTag = (tag: comment_parser0.Spec, ...tokens: Partial<comment_parser0.Tokens>[]) => void;
-type SetTag = (tag: comment_parser0.Spec & {
-  line: Integer;
-}, tokens?: Partial<comment_parser0.Tokens> | undefined) => void;
-type RemoveTag = (tagIndex: Integer, cfg?: {
-  removeEmptyBlock?: boolean;
-  tagSourceOffset?: Integer;
+export type SetBlockDescription = (setter: (info: {
+    delimiter: string;
+    postDelimiter: string;
+    start: string;
+}, seedTokens: (tokens?: Partial<import("comment-parser").Tokens>) => import("comment-parser").Tokens, descLines: string[]) => import("comment-parser").Line[]) => void;
+export type SetDescriptionLines = (matcher: RegExp, setter: (description: string) => string) => Integer;
+export type ChangeTag = (tag: import("comment-parser").Spec, ...tokens: Partial<import("comment-parser").Tokens>[]) => void;
+export type SetTag = (tag: import("comment-parser").Spec & {
+    line: Integer;
+}, tokens?: Partial<import("comment-parser").Tokens> | undefined) => void;
+export type RemoveTag = (tagIndex: Integer, cfg?: {
+    removeEmptyBlock?: boolean;
+    tagSourceOffset?: Integer;
 } | undefined) => void;
-type AddTag = (targetTagName: string, number?: number | undefined, tokens?: {} | comment_parser0.Tokens | undefined) => void;
-type GetFirstLine = () => Integer | undefined;
-type SeedTokens = (tokens?: Partial<comment_parser0.Tokens> | undefined) => comment_parser0.Tokens;
+export type AddTag = (targetTagName: string, number?: number | undefined, tokens?: {} | import("comment-parser").Tokens | undefined) => void;
+export type GetFirstLine = () => Integer | undefined;
+export type SeedTokens = (tokens?: Partial<import("comment-parser").Tokens> | undefined) => import("comment-parser").Tokens;
 /**
  * Sets tokens to empty string.
  */
-type EmptyTokens = (tokens: comment_parser0.Tokens) => void;
-type AddLine = (sourceIndex: Integer, tokens: Partial<comment_parser0.Tokens>) => void;
-type AddLines = (tagIndex: Integer, tagSourceOffset: Integer, numLines: Integer) => void;
-type MakeMultiline = () => void;
-type GetFunctionParameterNames = (useDefaultObjectProperties?: boolean | undefined) => __jsdocUtils_js0.ParamNameInfo[];
-type HasParams = () => Integer;
-type IsGenerator = () => boolean;
-type IsConstructor = () => boolean;
-type GetJsdocTagsDeep = (tagName: string) => false | {
-  idx: Integer;
-  name: string;
-  type: string;
+export type EmptyTokens = (tokens: import("comment-parser").Tokens) => void;
+export type AddLine = (sourceIndex: Integer, tokens: Partial<import("comment-parser").Tokens>) => void;
+export type AddLines = (tagIndex: Integer, tagSourceOffset: Integer, numLines: Integer) => void;
+export type MakeMultiline = () => void;
+export type GetFunctionParameterNames = (useDefaultObjectProperties?: boolean | undefined) => import("./jsdocUtils.js").ParamNameInfo[];
+export type HasParams = () => Integer;
+export type IsGenerator = () => boolean;
+export type IsConstructor = () => boolean;
+export type GetJsdocTagsDeep = (tagName: string) => false | {
+    idx: Integer;
+    name: string;
+    type: string;
 }[];
-type GetPreferredTagName = (cfg: {
-  tagName: string;
-  skipReportingBlockedTag?: boolean;
-  allowObjectReturn?: boolean;
-  defaultMessage?: string;
+export type GetPreferredTagName = (cfg: {
+    tagName: string;
+    skipReportingBlockedTag?: boolean;
+    allowObjectReturn?: boolean;
+    defaultMessage?: string;
 }) => string | undefined | false | {
-  message: string;
-  replacement?: string | undefined;
+    message: string;
+    replacement?: string | undefined;
 } | {
-  blocked: true;
-  tagName: string;
+    blocked: true;
+    tagName: string;
 };
-type IsValidTag = (name: string, definedTags: string[]) => boolean;
-type HasATag = (names: string[]) => boolean;
-type HasTag = (name: string) => boolean;
-type ComparePaths = (name: string) => (otherPathName: string) => boolean;
-type DropPathSegmentQuotes = (name: string) => string;
-type AvoidDocs = () => boolean;
-type TagMightHaveNamePositionTypePosition = (tagName: string, otherModeMaps?: __getDefaultTagStructureForMode_js0.TagStructure[] | undefined) => boolean | {
-  otherMode: true;
+export type IsValidTag = (name: string, definedTags: string[]) => boolean;
+export type HasATag = (names: string[]) => boolean;
+export type HasTag = (name: string) => boolean;
+export type ComparePaths = (name: string) => (otherPathName: string) => boolean;
+export type DropPathSegmentQuotes = (name: string) => string;
+export type AvoidDocs = () => boolean;
+export type TagMightHaveNamePositionTypePosition = (tagName: string, otherModeMaps?: import("./getDefaultTagStructureForMode.js").TagStructure[] | undefined) => boolean | {
+    otherMode: true;
 };
-type TagMustHave = (tagName: string, otherModeMaps: __getDefaultTagStructureForMode_js0.TagStructure[]) => boolean | {
-  otherMode: false;
+export type TagMustHave = (tagName: string, otherModeMaps: import("./getDefaultTagStructureForMode.js").TagStructure[]) => boolean | {
+    otherMode: false;
 };
-type TagMissingRequiredTypeOrNamepath = (tag: comment_parser0.Spec, otherModeMaps: __getDefaultTagStructureForMode_js0.TagStructure[]) => boolean | {
-  otherMode: false;
+export type TagMissingRequiredTypeOrNamepath = (tag: import("comment-parser").Spec, otherModeMaps: import("./getDefaultTagStructureForMode.js").TagStructure[]) => boolean | {
+    otherMode: false;
 };
-type IsNamepathX = (tagName: string) => boolean;
-type GetTagStructureForMode = (mde: __jsdocUtils_js0.ParserMode) => __getDefaultTagStructureForMode_js0.TagStructure;
-type MayBeUndefinedTypeTag = (tag: comment_parser0.Spec) => boolean;
-type HasValueOrExecutorHasNonEmptyResolveValue = (anyPromiseAsReturn: boolean, allBranches?: boolean | undefined) => boolean;
-type HasYieldValue = () => boolean;
-type HasYieldReturnValue = () => boolean;
-type HasThrowValue = () => boolean;
-type IsAsync = () => boolean | undefined;
-type GetTags = (tagName: string) => comment_parser0.Spec[];
-type GetPresentTags = (tagList: string[]) => _es_joy_jsdoccomment0.JsdocTagWithInline[];
-type FilterTags = (filter: (tag: _es_joy_jsdoccomment0.JsdocTagWithInline) => boolean) => _es_joy_jsdoccomment0.JsdocTagWithInline[];
-type FilterAllTags = (filter: (tag: (comment_parser0.Spec | _es_joy_jsdoccomment0.JsdocInlineTagNoType)) => boolean) => (comment_parser0.Spec | _es_joy_jsdoccomment0.JsdocInlineTagNoType)[];
-type GetTagsByType = (tags: comment_parser0.Spec[]) => {
-  tagsWithNames: comment_parser0.Spec[];
-  tagsWithoutNames: comment_parser0.Spec[];
+export type IsNamepathX = (tagName: string) => boolean;
+export type GetTagStructureForMode = (mde: import("./jsdocUtils.js").ParserMode) => import("./getDefaultTagStructureForMode.js").TagStructure;
+export type MayBeUndefinedTypeTag = (tag: import("comment-parser").Spec) => boolean;
+export type HasValueOrExecutorHasNonEmptyResolveValue = (anyPromiseAsReturn: boolean, allBranches?: boolean | undefined) => boolean;
+export type HasYieldValue = () => boolean;
+export type HasYieldReturnValue = () => boolean;
+export type HasThrowValue = () => boolean;
+export type IsAsync = () => boolean | undefined;
+export type GetTags = (tagName: string) => import("comment-parser").Spec[];
+export type GetPresentTags = (tagList: string[]) => import("@es-joy/jsdoccomment").JsdocTagWithInline[];
+export type FilterTags = (filter: (tag: import("@es-joy/jsdoccomment").JsdocTagWithInline) => boolean) => import("@es-joy/jsdoccomment").JsdocTagWithInline[];
+export type FilterAllTags = (filter: (tag: (import("comment-parser").Spec | import("@es-joy/jsdoccomment").JsdocInlineTagNoType)) => boolean) => (import("comment-parser").Spec | import("@es-joy/jsdoccomment").JsdocInlineTagNoType)[];
+export type GetTagsByType = (tags: import("comment-parser").Spec[]) => {
+    tagsWithNames: import("comment-parser").Spec[];
+    tagsWithoutNames: import("comment-parser").Spec[];
 };
-type HasOptionTag = (tagName: string) => boolean;
-type GetClassNode = () => Node | null;
-type GetClassJsdoc = () => null | JsdocBlockWithInline;
-type ClassHasTag = (tagName: string) => boolean;
-type FindContext = (contexts: Context[], comment: string | undefined) => {
-  foundContext: Context | undefined;
-  contextStr: string;
+export type HasOptionTag = (tagName: string) => boolean;
+export type GetClassNode = () => Node | null;
+export type GetClassJsdoc = () => null | JsdocBlockWithInline;
+export type ClassHasTag = (tagName: string) => boolean;
+export type FindContext = (contexts: Context[], comment: string | undefined) => {
+    foundContext: Context | undefined;
+    contextStr: string;
 };
-type Utils = BasicUtils & {
-  isIteratingFunction: IsIteratingFunction;
-  isIteratingFunctionOrVariable: IsIteratingFunction;
-  isVirtualFunction: IsVirtualFunction;
-  stringify: Stringify;
-  reportJSDoc: ReportJSDoc;
-  getRegexFromString: GetRegexFromString;
-  getTagDescription: GetTagDescription;
-  setTagDescription: SetTagDescription;
-  getDescription: GetDescription;
-  setBlockDescription: SetBlockDescription;
-  setDescriptionLines: SetDescriptionLines;
-  changeTag: ChangeTag;
-  setTag: SetTag;
-  removeTag: RemoveTag;
-  addTag: AddTag;
-  getFirstLine: GetFirstLine;
-  seedTokens: SeedTokens;
-  emptyTokens: EmptyTokens;
-  addLine: AddLine;
-  addLines: AddLines;
-  makeMultiline: MakeMultiline;
-  flattenRoots: __jsdocUtils_js0.FlattenRoots;
-  getFunctionParameterNames: GetFunctionParameterNames;
-  hasParams: HasParams;
-  isGenerator: IsGenerator;
-  isConstructor: IsConstructor;
-  getJsdocTagsDeep: GetJsdocTagsDeep;
-  getPreferredTagName: GetPreferredTagName;
-  isValidTag: IsValidTag;
-  hasATag: HasATag;
-  hasTag: HasTag;
-  comparePaths: ComparePaths;
-  dropPathSegmentQuotes: DropPathSegmentQuotes;
-  avoidDocs: AvoidDocs;
-  tagMightHaveNamePosition: TagMightHaveNamePositionTypePosition;
-  tagMightHaveTypePosition: TagMightHaveNamePositionTypePosition;
-  tagMustHaveNamePosition: TagMustHave;
-  tagMustHaveTypePosition: TagMustHave;
-  tagMissingRequiredTypeOrNamepath: TagMissingRequiredTypeOrNamepath;
-  isNamepathDefiningTag: IsNamepathX;
-  isNamepathReferencingTag: IsNamepathX;
-  isNamepathOrUrlReferencingTag: IsNamepathX;
-  tagMightHaveNamepath: IsNamepathX;
-  getTagStructureForMode: GetTagStructureForMode;
-  mayBeUndefinedTypeTag: MayBeUndefinedTypeTag;
-  hasValueOrExecutorHasNonEmptyResolveValue: HasValueOrExecutorHasNonEmptyResolveValue;
-  hasYieldValue: HasYieldValue;
-  hasYieldReturnValue: HasYieldReturnValue;
-  hasThrowValue: HasThrowValue;
-  isAsync: IsAsync;
-  getTags: GetTags;
-  getPresentTags: GetPresentTags;
-  filterTags: FilterTags;
-  filterAllTags: FilterAllTags;
-  getTagsByType: GetTagsByType;
-  hasOptionTag: HasOptionTag;
-  getClassNode: GetClassNode;
-  getClassJsdoc: GetClassJsdoc;
-  classHasTag: ClassHasTag;
-  findContext: FindContext;
+export type Utils = BasicUtils & {
+    isIteratingFunction: IsIteratingFunction;
+    isIteratingFunctionOrVariable: IsIteratingFunction;
+    isVirtualFunction: IsVirtualFunction;
+    stringify: Stringify;
+    reportJSDoc: ReportJSDoc;
+    getRegexFromString: GetRegexFromString;
+    getTagDescription: GetTagDescription;
+    setTagDescription: SetTagDescription;
+    getDescription: GetDescription;
+    setBlockDescription: SetBlockDescription;
+    setDescriptionLines: SetDescriptionLines;
+    changeTag: ChangeTag;
+    setTag: SetTag;
+    removeTag: RemoveTag;
+    addTag: AddTag;
+    getFirstLine: GetFirstLine;
+    seedTokens: SeedTokens;
+    emptyTokens: EmptyTokens;
+    addLine: AddLine;
+    addLines: AddLines;
+    makeMultiline: MakeMultiline;
+    flattenRoots: import("./jsdocUtils.js").FlattenRoots;
+    getFunctionParameterNames: GetFunctionParameterNames;
+    hasParams: HasParams;
+    isGenerator: IsGenerator;
+    isConstructor: IsConstructor;
+    getJsdocTagsDeep: GetJsdocTagsDeep;
+    getPreferredTagName: GetPreferredTagName;
+    isValidTag: IsValidTag;
+    hasATag: HasATag;
+    hasTag: HasTag;
+    comparePaths: ComparePaths;
+    dropPathSegmentQuotes: DropPathSegmentQuotes;
+    avoidDocs: AvoidDocs;
+    tagMightHaveNamePosition: TagMightHaveNamePositionTypePosition;
+    tagMightHaveTypePosition: TagMightHaveNamePositionTypePosition;
+    tagMustHaveNamePosition: TagMustHave;
+    tagMustHaveTypePosition: TagMustHave;
+    tagMissingRequiredTypeOrNamepath: TagMissingRequiredTypeOrNamepath;
+    isNamepathDefiningTag: IsNamepathX;
+    isNamepathReferencingTag: IsNamepathX;
+    isNamepathOrUrlReferencingTag: IsNamepathX;
+    tagMightHaveNamepath: IsNamepathX;
+    getTagStructureForMode: GetTagStructureForMode;
+    mayBeUndefinedTypeTag: MayBeUndefinedTypeTag;
+    hasValueOrExecutorHasNonEmptyResolveValue: HasValueOrExecutorHasNonEmptyResolveValue;
+    hasYieldValue: HasYieldValue;
+    hasYieldReturnValue: HasYieldReturnValue;
+    hasThrowValue: HasThrowValue;
+    isAsync: IsAsync;
+    getTags: GetTags;
+    getPresentTags: GetPresentTags;
+    filterTags: FilterTags;
+    filterAllTags: FilterAllTags;
+    getTagsByType: GetTagsByType;
+    hasOptionTag: HasOptionTag;
+    getClassNode: GetClassNode;
+    getClassJsdoc: GetClassJsdoc;
+    classHasTag: ClassHasTag;
+    findContext: FindContext;
 };
 /**
  * Should use ESLint rule's typing.
  */
-type EslintRuleMeta = eslint0.Rule.RuleMetaData;
+export type EslintRuleMeta = import("eslint").Rule.RuleMetaData;
 /**
  * A plain object for tracking state as needed by rules across iterations.
  */
-type StateObject = {
-  globalTags: {};
-  hasDuplicates: {
-    [key: string]: boolean;
-  };
-  selectorMap: {
-    [selector: string]: {
-      [comment: string]: Integer;
+export type StateObject = {
+    globalTags: {};
+    hasDuplicates: {
+        [key: string]: boolean;
+    };
+    selectorMap: {
+        [selector: string]: {
+            [comment: string]: Integer;
+        };
+    };
+    hasTag: {
+        [key: string]: boolean;
+    };
+    hasNonComment: number;
+    hasNonCommentBeforeTag: {
+        [key: string]: boolean | number;
     };
-  };
-  hasTag: {
-    [key: string]: boolean;
-  };
-  hasNonComment: number;
-  hasNonCommentBeforeTag: {
-    [key: string]: boolean | number;
-  };
 };
 /**
  * The Node AST as supplied by the parser.
  */
-type Node = eslint0.Rule.Node;
-type Report = (message: string, fix?: eslint0.Rule.ReportFixer | null | undefined, jsdocLoc?: {
-  line?: Integer;
-  column?: Integer;
-} | (comment_parser0.Spec & {
-  line?: Integer;
+export type Node = import("eslint").Rule.Node;
+export type Report = (message: string, fix?: import("eslint").Rule.ReportFixer | null | undefined, jsdocLoc?: {
+    line?: Integer;
+    column?: Integer;
+} | (import("comment-parser").Spec & {
+    line?: Integer;
 }) | null | undefined, data?: undefined | {
-  [key: string]: string;
+    [key: string]: string;
 }) => void;
-type PreferredTypes = {
-  [key: string]: false | string | {
-    message: string;
-    replacement?: false | string;
-    skipRootChecking?: boolean;
-  };
+export type PreferredTypes = {
+    [key: string]: false | string | {
+        message: string;
+        replacement?: false | string;
+        skipRootChecking?: boolean;
+    };
 };
-type StructuredTags = {
-  [key: string]: {
-    name?: "text" | "namepath-defining" | "namepath-referencing" | false;
-    type?: boolean | string[];
-    required?: ("name" | "type" | "typeOrNameRequired")[];
-  };
+export type StructuredTags = {
+    [key: string]: {
+        name?: "text" | "namepath-defining" | "namepath-referencing" | false;
+        type?: boolean | string[];
+        required?: ("name" | "type" | "typeOrNameRequired")[];
+    };
 };
 /**
  * Settings from ESLint types.
  */
-type Settings = {
-  maxLines: Integer;
-  minLines: Integer;
-  tagNamePreference: __jsdocUtils_js0.TagNamePreference;
-  mode: __jsdocUtils_js0.ParserMode;
-  preferredTypes: PreferredTypes;
-  structuredTags: StructuredTags;
-  [name: string]: any;
-  contexts?: Context[];
+export type Settings = {
+    maxLines: Integer;
+    minLines: Integer;
+    tagNamePreference: import("./jsdocUtils.js").TagNamePreference;
+    mode: import("./jsdocUtils.js").ParserMode;
+    preferredTypes: PreferredTypes;
+    structuredTags: StructuredTags;
+    [name: string]: any;
+    contexts?: Context[];
 };
-type JSDocSettings = {
-  settings?: {
-    jsdoc?: {
-      ignorePrivate: boolean;
-      ignoreInternal: boolean;
-      maxLines: Integer;
-      minLines: Integer;
-      tagNamePreference: __jsdocUtils_js0.TagNamePreference;
-      preferredTypes: PreferredTypes;
-      structuredTags: StructuredTags;
-      overrideReplacesDocs: boolean;
-      ignoreReplacesDocs: boolean;
-      implementsReplacesDocs: boolean;
-      augmentsExtendsReplacesDocs: boolean;
-      exemptDestructuredRootsFromChecks: boolean;
-      mode: __jsdocUtils_js0.ParserMode;
-      contexts: Context[];
+export type JSDocSettings = {
+    settings?: {
+        jsdoc?: {
+            ignorePrivate: boolean;
+            ignoreInternal: boolean;
+            maxLines: Integer;
+            minLines: Integer;
+            tagNamePreference: import("./jsdocUtils.js").TagNamePreference;
+            preferredTypes: PreferredTypes;
+            structuredTags: StructuredTags;
+            overrideReplacesDocs: boolean;
+            ignoreReplacesDocs: boolean;
+            implementsReplacesDocs: boolean;
+            augmentsExtendsReplacesDocs: boolean;
+            exemptDestructuredRootsFromChecks: boolean;
+            mode: import("./jsdocUtils.js").ParserMode;
+            contexts: Context[];
+        };
     };
-  };
 };
 /**
  * Create the report function
  */
-type MakeReport = (context: eslint0.Rule.RuleContext, commentNode: estree0.Node) => Report;
-type JsdocVisitorBasic = (arg: {
-  context: eslint0.Rule.RuleContext;
-  sourceCode: eslint0.SourceCode;
-  indent?: string;
-  info?: {
-    comment?: string | undefined;
-    lastIndex?: Integer | undefined;
-  };
-  state?: StateObject;
-  globalState?: Map<string, Map<string, string>>;
-  jsdoc?: JsdocBlockWithInline;
-  jsdocNode?: eslint0.Rule.Node & {
-    range: [number, number];
-  };
-  node?: Node;
-  allComments?: estree0.Node[];
-  report?: Report;
-  makeReport?: MakeReport;
-  settings: Settings;
-  utils: BasicUtils;
-}) => any;
-type JsdocVisitor = (arg: {
-  context: eslint0.Rule.RuleContext;
-  sourceCode: eslint0.SourceCode;
-  indent: string;
-  info: {
-    comment?: string | undefined;
-    lastIndex?: Integer | undefined;
-  };
-  state: StateObject;
-  globalState: Map<string, Map<string, string>>;
-  jsdoc: JsdocBlockWithInline;
-  jsdocNode: eslint0.Rule.Node & {
-    range: [number, number];
-  };
-  node: Node | null;
-  allComments?: estree0.Node[];
-  report: Report;
-  makeReport?: MakeReport;
-  settings: Settings;
-  utils: Utils;
+export type MakeReport = (context: import("eslint").Rule.RuleContext, commentNode: import("estree").Node) => Report;
+export type JsdocVisitorBasic = (arg: {
+    context: import("eslint").Rule.RuleContext;
+    sourceCode: import("eslint").SourceCode;
+    indent?: string;
+    info?: {
+        comment?: string | undefined;
+        lastIndex?: Integer | undefined;
+    };
+    state?: StateObject;
+    globalState?: Map<string, Map<string, string>>;
+    jsdoc?: JsdocBlockWithInline;
+    jsdocNode?: import("eslint").Rule.Node & {
+        range: [number, number];
+    };
+    node?: Node;
+    allComments?: import("estree").Node[];
+    report?: Report;
+    makeReport?: MakeReport;
+    settings: Settings;
+    utils: BasicUtils;
 }) => any;
-type NonCommentArgs = {
-  node: Node & {
-    range: [number, number];
-  };
-  state: StateObject;
-};
-type RuleConfig = {
-  /**
-   * ESLint rule meta
-   */
-  meta: EslintRuleMeta;
-  /**
-   * Any default contexts
-   */
-  contextDefaults?: __jsdocUtils_js0.DefaultContexts | undefined;
-  /**
-   * Whether to force a `contexts` check
-   */
-  contextSelected?: true | undefined;
-  /**
-   * Whether to iterate all JSDoc blocks by default
-   * regardless of context
-   */
-  iterateAllJsdocs?: true | undefined;
-  /**
-   * Whether to check `@private` blocks (normally exempted)
-   */
-  checkPrivate?: true | undefined;
-  /**
-   * Whether to check `@internal` blocks (normally exempted)
-   */
-  checkInternal?: true | undefined;
-  /**
-   * Whether to iterates over all JSDoc blocks regardless of attachment
-   */
-  checkFile?: true | undefined;
-  /**
-   * Whether to avoid relying on settings for global contexts
-   */
-  nonGlobalSettings?: true | undefined;
-  /**
-   * Whether to disable the tracking of visited comment nodes (as
-   * non-tracked may conduct further actions)
-   */
-  noTracking?: true | undefined;
-  /**
-   * Whether the rule expects contexts to be based on a match option
-   */
-  matchContext?: true | undefined;
-  /**
-   * Handler to be executed upon exiting iteration of program AST
-   */
-  exit?: ((args: {
-    context: eslint0.Rule.RuleContext;
+export type JsdocVisitor = (arg: {
+    context: import("eslint").Rule.RuleContext;
+    sourceCode: import("eslint").SourceCode;
+    indent: string;
+    info: {
+        comment?: string | undefined;
+        lastIndex?: Integer | undefined;
+    };
     state: StateObject;
+    globalState: Map<string, Map<string, string>>;
+    jsdoc: JsdocBlockWithInline;
+    jsdocNode: import("eslint").Rule.Node & {
+        range: [number, number];
+    };
+    node: Node | null;
+    allComments?: import("estree").Node[];
+    report: Report;
+    makeReport?: MakeReport;
     settings: Settings;
-    utils: BasicUtils;
-  }) => void) | undefined;
-  /**
-   * Handler to be executed if rule wishes
-   * to be supplied nodes without comments
-   */
-  nonComment?: ((nca: NonCommentArgs) => void) | undefined;
+    utils: Utils;
+}) => any;
+export type NonCommentArgs = {
+    node: Node & {
+        range: [number, number];
+    };
+    state: StateObject;
+};
+export type RuleConfig = {
+    /**
+     * ESLint rule meta
+     */
+    meta: EslintRuleMeta;
+    /**
+     * Any default contexts
+     */
+    contextDefaults?: jsdocUtils.DefaultContexts | undefined;
+    /**
+     * Whether to force a `contexts` check
+     */
+    contextSelected?: true | undefined;
+    /**
+     * Whether to iterate all JSDoc blocks by default
+     * regardless of context
+     */
+    iterateAllJsdocs?: true | undefined;
+    /**
+     * Whether to check `@private` blocks (normally exempted)
+     */
+    checkPrivate?: true | undefined;
+    /**
+     * Whether to check `@internal` blocks (normally exempted)
+     */
+    checkInternal?: true | undefined;
+    /**
+     * Whether to iterates over all JSDoc blocks regardless of attachment
+     */
+    checkFile?: true | undefined;
+    /**
+     * Whether to avoid relying on settings for global contexts
+     */
+    nonGlobalSettings?: true | undefined;
+    /**
+     * Whether to disable the tracking of visited comment nodes (as
+     * non-tracked may conduct further actions)
+     */
+    noTracking?: true | undefined;
+    /**
+     * Whether the rule expects contexts to be based on a match option
+     */
+    matchContext?: true | undefined;
+    /**
+     * Handler to be executed upon exiting iteration of program AST
+     */
+    exit?: ((args: {
+        context: import("eslint").Rule.RuleContext;
+        state: StateObject;
+        settings: Settings;
+        utils: BasicUtils;
+    }) => void) | undefined;
+    /**
+     * Handler to be executed if rule wishes
+     * to be supplied nodes without comments
+     */
+    nonComment?: ((nca: NonCommentArgs) => void) | undefined;
 };
 /**
  * @typedef {{
@@ -466,7 +458,6 @@ type RuleConfig = {
  * @param {import('eslint').Rule.RuleContext & JSDocSettings} context
  * @returns {Settings|false}
  */
-declare function getSettings(context: eslint0.Rule.RuleContext & JSDocSettings): Settings | false;
-//#endregion
-export { AddLine, AddLines, AddTag, AvoidDocs, BasicUtils, ChangeTag, CheckJsdoc, ClassHasTag, ComparePaths, Context, ContextObject, DropPathSegmentQuotes, EmptyTokens, EslintRuleMeta, FilterAllTags, FilterTags, FindContext, ForEachPreferredTag, GetClassJsdoc, GetClassNode, GetDescription, GetFirstLine, GetFunctionParameterNames, GetJsdocTagsDeep, GetPreferredTagName, GetPreferredTagNameObject, GetPresentTags, GetRegexFromString, GetTagDescription, GetTagStructureForMode, GetTags, GetTagsByType, HasATag, HasOptionTag, HasParams, HasTag, HasThrowValue, HasValueOrExecutorHasNonEmptyResolveValue, HasYieldReturnValue, HasYieldValue, Integer, IsAsync, IsConstructor, IsGenerator, IsIteratingFunction, IsNamepathX, IsValidTag, IsVirtualFunction, JSDocSettings, JsdocBlockWithInline, JsdocVisitor, JsdocVisitorBasic, MakeMultiline, MakeReport, MayBeUndefinedTypeTag, Node, NonCommentArgs, ParseClosureTemplateTag, PreferredTypes, RemoveTag, Report, ReportJSDoc, ReportSettings, RuleConfig, SeedTokens, SetBlockDescription, SetDescriptionLines, SetTag, SetTagDescription, Settings, StateObject, Stringify, StructuredTags, TagMightHaveNamePositionTypePosition, TagMissingRequiredTypeOrNamepath, TagMustHave, Utils, iterateJsdoc as default, getSettings, parseComment };
+export function getSettings(context: import("eslint").Rule.RuleContext & JSDocSettings): Settings | false;
+import * as jsdocUtils from './jsdocUtils.js';
 //# sourceMappingURL=iterateJsdoc.d.ts.map