eslint-plugin-jsdoc 46.4.6 → 46.5.1

package/dist/alignTransform.d.ts

@@ -1,32 +0,0 @@
-export default alignTransform;
-export type TypelessInfo = {
-    hasNoTypes: boolean;
-    maxNamedTagLength: import('./iterateJsdoc.js').Integer;
-    maxUnnamedTagLength: import('./iterateJsdoc.js').Integer;
-};
-export type Width = {
-    name: import('./iterateJsdoc.js').Integer;
-    start: import('./iterateJsdoc.js').Integer;
-    tag: import('./iterateJsdoc.js').Integer;
-    type: import('./iterateJsdoc.js').Integer;
-};
-/**
- * @param {{
- *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,
- *   tags: string[],
- *   indent: string,
- *   preserveMainDescriptionPostDelimiter: boolean,
- *   wrapIndent: string,
- * }} cfg
- * @returns {(
- *   block: import('comment-parser').Block
- * ) => import('comment-parser').Block}
- */
-declare function alignTransform({ customSpacings, tags, indent, preserveMainDescriptionPostDelimiter, wrapIndent, }: {
-    customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings;
-    tags: string[];
-    indent: string;
-    preserveMainDescriptionPostDelimiter: boolean;
-    wrapIndent: string;
-}): (block: import('comment-parser').Block) => import('comment-parser').Block;
-//# sourceMappingURL=alignTransform.d.ts.map

package/dist/alignTransform.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"alignTransform.d.ts","sourceRoot":"","sources":["../src/alignTransform.js"],"names":[],"mappings":";2BAYa;IACZ,UAAc,EAAE,OAAO,CAAC;IACxB,iBAAqB,EAAE,OAAO,mBAAmB,EAAE,OAAO,CAAC;IAC3D,mBAAuB,EAAE,OAAO,mBAAmB,EAAE,OAAO,CAAA;CACzD;oBAQS;IACZ,IAAQ,EAAE,OAAO,mBAAmB,EAAE,OAAO,CAAC;IAC9C,KAAS,EAAE,OAAO,mBAAmB,EAAE,OAAO,CAAC;IAC/C,GAAO,EAAE,OAAO,mBAAmB,EAAE,OAAO,CAAC;IAC7C,IAAQ,EAAE,OAAO,mBAAmB,EAAE,OAAO,CAAA;CAC1C;AAqHJ;;;;;;;;;;;GAWG;AACH,qHAXW;IACV,cAAkB,EAAE,OAAO,oCAAoC,EAAE,cAAc,CAAC;IAChF,IAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAU,EAAE,MAAM,CAAC;IACnB,oCAAwC,EAAE,OAAO,CAAC;IAClD,UAAc,EAAE,MAAM,CAAC;CACpB,WAEQ,OAAO,gBAAgB,EAAE,KAAK,KAClC,OAAO,gBAAgB,EAAE,KAAK,CAqMrC"}

package/dist/defaultTagOrder.d.ts

@@ -1,5 +0,0 @@
-export default defaultTagOrder;
-declare const defaultTagOrder: {
-    tags: string[];
-}[];
-//# sourceMappingURL=defaultTagOrder.d.ts.map

package/dist/defaultTagOrder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultTagOrder.d.ts","sourceRoot":"","sources":["../src/defaultTagOrder.js"],"names":[],"mappings":";AAAA;;IAqKE"}

package/dist/exportParser.d.ts

@@ -1,41 +0,0 @@
-declare namespace _default {
-    export { isUncommentedExport };
-    export { parse };
-}
-export default _default;
-export type ValueObject = {
-    value: string;
-};
-export type CreatedNode = {
-    type?: string | undefined;
-    value?: import("eslint").Rule.Node | ValueObject | undefined;
-    props: {
-        [key: string]: CreatedNode | null;
-    };
-    special?: true | undefined;
-    globalVars?: CreatedNode | undefined;
-    exported?: boolean | undefined;
-    ANONYMOUS_DEFAULT?: import("eslint").Rule.Node | undefined;
-};
-export type CreateSymbol = (node: import('eslint').Rule.Node | null, globals: CreatedNode, value: import('eslint').Rule.Node | null, scope?: CreatedNode | undefined, isGlobal?: boolean | SymbolOptions | undefined) => CreatedNode | null;
-export type SymbolOptions = {
-    simpleIdentifier?: boolean;
-};
-/**
- *
- * @param {import('eslint').Rule.Node} node
- * @param {import('eslint').SourceCode} sourceCode
- * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
- * @param {import('./iterateJsdoc.js').Settings} settings
- * @returns {boolean}
- */
-declare function isUncommentedExport(node: import('eslint').Rule.Node, sourceCode: import('eslint').SourceCode, opt: import('./rules/requireJsdoc.js').RequireJsdocOpts, settings: import('./iterateJsdoc.js').Settings): boolean;
-/**
- *
- * @param {import('eslint').Rule.Node} ast
- * @param {import('eslint').Rule.Node} node
- * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
- * @returns {CreatedNode}
- */
-declare function parse(ast: import('eslint').Rule.Node, node: import('eslint').Rule.Node, opt: import('./rules/requireJsdoc.js').RequireJsdocOpts): CreatedNode;
-//# sourceMappingURL=exportParser.d.ts.map

package/dist/exportParser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"exportParser.d.ts","sourceRoot":"","sources":["../src/exportParser.js"],"names":[],"mappings":";;;;;0BAQa;IACZ,KAAS,EAAE,MAAM,CAAA;CACd;;;;;;;;;;;;kCAoFO,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAC,IAAI,WAC/B,WAAW,SACX,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAC,IAAI,sFAG7B,WAAW,GAAC,IAAI;4BAShB;IACZ,gBAAoB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAgyBJ;;;;;;;GAOG;AACH,2CANW,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,cAC1B,OAAO,QAAQ,EAAE,UAAU,OAC3B,OAAO,yBAAyB,EAAE,gBAAgB,YAClD,OAAO,mBAAmB,EAAE,QAAQ,GAClC,OAAO,CAyCnB;AAvGD;;;;;;GAMG;AACH,4BALW,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,QAC1B,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,OAC1B,OAAO,yBAAyB,EAAE,gBAAgB,GAChD,WAAW,CAkCvB"}

package/dist/getDefaultTagStructureForMode.d.ts

@@ -1,11 +0,0 @@
-export default getDefaultTagStructureForMode;
-export type TagStructure = Map<string, Map<string, (string | boolean)>>;
-/**
- * @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
- */
-/**
- * @param {import('./jsdocUtils.js').ParserMode} mode
- * @returns {TagStructure}
- */
-declare function getDefaultTagStructureForMode(mode: import('./jsdocUtils.js').ParserMode): TagStructure;
-//# sourceMappingURL=getDefaultTagStructureForMode.d.ts.map

package/dist/getDefaultTagStructureForMode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDefaultTagStructureForMode.d.ts","sourceRoot":"","sources":["../src/getDefaultTagStructureForMode.js"],"names":[],"mappings":";2BACa,IAAI,MAAM,EAAE,IAAI,MAAM,EAAE,CAAC,MAAM,GAAC,OAAO,CAAC,CAAC,CAAC;AADvD;;GAEG;AACH;;;GAGG;AACH,qDAHW,OAAO,iBAAiB,EAAE,UAAU,gBAk8B9C"}

package/dist/index.d.ts

@@ -1,10 +0,0 @@
-export default index;
-/**
- * @type {import('eslint').ESLint.Plugin & {
- *   configs: Record<string, import('eslint').ESLint.ConfigData>
- * }}
- */
-declare const index: import('eslint').ESLint.Plugin & {
-    configs: Record<string, import('eslint').ESLint.ConfigData>;
-};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";AAsDA;;;;GAIG;AACH,qBAJU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,GAAG;IAC1C,OAAW,EAAE,OAAO,MAAM,EAAE,OAAO,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;CAC5D,CA2DF"}

package/dist/iterateJsdoc.d.ts

@@ -1,460 +0,0 @@
-/**
- * @param {JsdocVisitor} iterator
- * @param {RuleConfig} ruleConfig
- * @returns {import('eslint').Rule.RuleModule}
- */
-export default function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): import('eslint').Rule.RuleModule;
-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;
-};
-export type Context = string | ContextObject;
-export type CheckJsdoc = (info: {
-    lastIndex?: Integer;
-    isFunctionContext?: boolean;
-    selector?: string;
-    comment?: string;
-}, handler: ((jsdoc: import('@es-joy/jsdoccomment').JsdocBlockWithInline) => boolean | undefined) | null, 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;
-} | {
-    blocked: true;
-    tagName: string;
-};
-export type BasicUtils = {
-    forEachPreferredTag: ForEachPreferredTag;
-    reportSettings: ReportSettings;
-    parseClosureTemplateTag: ParseClosureTemplateTag;
-    getPreferredTagNameObject: GetPreferredTagNameObject;
-    pathDoesNotBeginWith: import('./jsdocUtils.js').PathDoesNotBeginWith;
-};
-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?: number | undefined;
-} | null | undefined, handler?: (() => void) | null | undefined, specRewire?: boolean | undefined, data?: {
-    [key: string]: string;
-} | undefined) => any;
-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;
-};
-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 | undefined;
-    tagSourceOffset?: number | undefined;
-} | undefined) => void;
-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.
- */
-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;
-}[];
-export type GetPreferredTagName = (cfg: {
-    tagName: string;
-    skipReportingBlockedTag?: boolean;
-    allowObjectReturn?: boolean;
-    defaultMessage?: string;
-}) => string | undefined | false | {
-    message: string;
-    replacement?: string | undefined;
-} | {
-    blocked: true;
-    tagName: string;
-};
-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;
-};
-export type TagMustHave = (tagName: string, otherModeMaps: import('./getDefaultTagStructureForMode.js').TagStructure[]) => boolean | {
-    otherMode: false;
-};
-export type TagMissingRequiredTypeOrNamepath = (tag: import('comment-parser').Spec, otherModeMaps: import('./getDefaultTagStructureForMode.js').TagStructure[]) => boolean | {
-    otherMode: false;
-};
-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[];
-};
-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;
-};
-export type Utils = BasicUtils & {
-    isIteratingFunction: 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.
- */
-export type EslintRuleMeta = import('eslint').Rule.RuleMetaData;
-/**
- * A plain object for tracking state as needed by rules across iterations.
- */
-export type StateObject = {
-    globalTags: {};
-    hasDuplicates: {
-        [key: string]: boolean;
-    };
-    selectorMap: {
-        [selector: string]: {
-            [comment: string]: number;
-        };
-    };
-    hasTag: {
-        [key: string]: boolean;
-    };
-    hasNonComment: number;
-    hasNonCommentBeforeTag: {
-        [key: string]: number | boolean;
-    };
-};
-/**
- * The Node AST as supplied by the parser.
- */
-export type Node = import('eslint').Rule.Node;
-export type Report = (message: string, fix?: import("eslint").Rule.ReportFixer | null | undefined, jsdocLoc?: {
-    line?: number | undefined;
-    column?: number | undefined;
-} | (import("comment-parser").Spec & {
-    line?: number | undefined;
-}) | null | undefined, data?: {
-    [key: string]: string;
-} | undefined) => void;
-export type PreferredTypes = {
-    [key: string]: string | false | {
-        message: string;
-        replacement?: string | false | undefined;
-        skipRootChecking?: boolean | undefined;
-    };
-};
-export type StructuredTags = {
-    [key: string]: {
-        name?: false | "namepath-defining" | "namepath-referencing" | "text" | undefined;
-        type?: boolean | string[] | undefined;
-        required?: ("name" | "type" | "typeOrNameRequired")[] | undefined;
-    };
-};
-/**
- * Settings from ESLint types.
- */
-export type Settings = {
-    [name: string]: any;
-    maxLines: Integer;
-    minLines: Integer;
-    tagNamePreference: import('./jsdocUtils.js').TagNamePreference;
-    mode: import('./jsdocUtils.js').ParserMode;
-    preferredTypes: PreferredTypes;
-    structuredTags: StructuredTags;
-    contexts?: Context[] | undefined;
-};
-/**
- * Create the report function
- */
-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;
-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: Utils;
-}) => any;
-export type NonCommentArgs = {
-    node: Node & {
-        range: [number, number];
-    };
-    state: StateObject;
-};
-export type RuleConfig = {
-    /**
-     * ESLint rule meta
-     */
-    meta: EslintRuleMeta;
-    /**
-     * Any default contexts
-     */
-    contextDefaults?: import("./jsdocUtils.js").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 {{
- *   [key: string]: false|string|{
- *     message: string,
- *     replacement?: false|string
- *     skipRootChecking?: boolean
- *   }
- * }} PreferredTypes
- */
-/**
- * @typedef {{
- *   [key: string]: {
- *     name?: "text"|"namepath-defining"|"namepath-referencing"|false,
- *     type?: boolean|string[],
- *     required?: ("name"|"type"|"typeOrNameRequired")[]
- *   }
- * }} StructuredTags
- */
-/**
- * Settings from ESLint types.
- * @typedef {{
- *   maxLines: Integer,
- *   minLines: Integer,
- *   tagNamePreference: import('./jsdocUtils.js').TagNamePreference,
- *   mode: import('./jsdocUtils.js').ParserMode,
- *   preferredTypes: PreferredTypes,
- *   structuredTags: StructuredTags,
- *   [name: string]: any,
- *   contexts?: Context[]
- * }} Settings
- */
-/**
- * @param {import('eslint').Rule.RuleContext} context
- * @returns {Settings|false}
- */
-export function getSettings(context: import('eslint').Rule.RuleContext): Settings | false;
-import { parseComment } from '@es-joy/jsdoccomment';
-declare const seedTokens: typeof import("comment-parser/lib/util.js").seedTokens;
-/**
- * Should use ESLint rule's typing.
- * @typedef {import('eslint').Rule.RuleMetaData} EslintRuleMeta
- */
-/**
- * A plain object for tracking state as needed by rules across iterations.
- * @typedef {{
- *   globalTags: {},
- *   hasDuplicates: {
- *     [key: string]: boolean
- *   },
- *   selectorMap: {
- *     [selector: string]: {
- *       [comment: string]: Integer
- *     }
- *   },
- *   hasTag: {
- *     [key: string]: boolean
- *   },
- *   hasNonComment: number,
- *   hasNonCommentBeforeTag: {
- *     [key: string]: boolean|number
- *   }
- * }} StateObject
- */
-/**
- * The Node AST as supplied by the parser.
- * @typedef {import('eslint').Rule.Node} Node
- */
-declare const globalState: Map<any, any>;
-/**
- * Create the report function
- * @callback MakeReport
- * @param {import('eslint').Rule.RuleContext} context
- * @param {import('estree').Node} commentNode
- * @returns {Report}
- */
-/** @type {MakeReport} */
-declare const makeReport: MakeReport;
-export { parseComment };
-//# sourceMappingURL=iterateJsdoc.d.ts.map

package/dist/iterateJsdoc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"iterateJsdoc.d.ts","sourceRoot":"","sources":["../src/iterateJsdoc.js"],"names":[],"mappings":"AAg0EA;;;;GAIG;AACH,+CAJW,YAAY,cACZ,UAAU,GACR,OAAO,QAAQ,EAAE,IAAI,CAAC,UAAU,CA8K5C;sBAp+EY,MAAM;mCAIN,OAAO,sBAAsB,EAAE,oBAAoB;4BAInD;IACZ,YAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,WAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAsB,CAAC,EAAE,OAAO,CAAA;CAC7B;sBAGS,MAAM,GAAC,aAAa;gCAKtB;IACV,SAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,QAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAW,CAAC,EAAE,MAAM,CAAA;CACjB,oBACqB,OAAO,sBAAsB,EAAE,oBAAoB,KAAK,OAAO,GAAC,SAAS,gBACvF,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,KACxB,IAAI;4CAKN,MAAM,mCAEM,OAAO,sBAAsB,EAAE,kBAAkB,iBACpD,MAAM,KAClB,IAAI,oDAEC,IAAI;uCAKN,MAAM,KACJ,IAAI;4CAKN,OAAO,gBAAgB,EAAE,IAAI,KAC3B,MAAM,EAAE;8CAKV;IACV,OAAW,EAAE,MAAM,CAAA;CAChB,KACS,MAAM,GAAC,KAAK,GAAC;IACzB,OAAW,EAAE,MAAM,CAAC;IACpB,WAAe,CAAC,EAAE,MAAM,GAAC,SAAS,CAAA;CAC/B,GAAC;IACJ,OAAW,EAAE,IAAI,CAAC;IAClB,OAAW,EAAE,MAAM,CAAA;CAChB;yBAIS;IACZ,mBAAuB,EAAE,mBAAmB,CAAC;IAC7C,cAAkB,EAAE,cAAc,CAAC;IACnC,uBAA2B,EAAE,uBAAuB,CAAC;IACrD,yBAA6B,EAAE,yBAAyB,CAAC;IACzD,oBAAwB,EAAE,OAAO,iBAAiB,EAAE,oBAAoB,CAAA;CACrE;wCAKS,OAAO;sCAKP,OAAO;mCAKT,OAAO,gBAAgB,EAAE,KAAK,uCAE5B,MAAM;gCAKR,MAAM;UACoC,OAAO;;uCAC1C,IAAI;;;uCAUX,MAAM,yCAEJ,MAAM;qCAKR,OAAO,gBAAgB,EAAE,IAAI,wCAE3B,MAAM,EAAE,GAAC,MAAM;qCAKjB,OAAO,gBAAgB,EAAE,IAAI,WAC7B,MAAM,wBACQ,MAAM,KAAK,MAAM,KAC7B,OAAO;mCAKP;IACZ,WAAe,EAAE,MAAM,CAAC;IACxB,YAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,mBAAuB,EAAE,OAAO,CAAA;CAC7B;kDAMO;IACV,SAAe,EAAE,MAAM,CAAC;IACxB,aAAmB,EAAE,MAAM,CAAC;IAC5B,KAAW,EAAE,MAAM,CAAA;CACd,wBAEU,QAAQ,OAAO,gBAAgB,EAAE,MAAM,CAAC,KAC9C,OAAO,gBAAgB,EAAE,MAAM,aACzB,MAAM,EAAE,KAChB,OAAO,gBAAgB,EAAE,IAAI,EAAE,KAC1B,IAAI;4CAMN,MAAM,wBACQ,MAAM,KAAK,MAAM,KAC7B,OAAO;8BAKT,OAAO,gBAAgB,EAAE,IAAI,aAC1B,QAAQ,OAAO,gBAAgB,EAAE,MAAM,CAAC,OACzC,IAAI;2BAMN,OAAO,gBAAgB,EAAE,IAAI,GAAG;IAC1C,IAAQ,EAAE,OAAO,CAAA;CACd,oEAES,IAAI;mCAMN,OAAO;;;kBAKL,IAAI;qCAKN,MAAM,6FAGJ,IAAI;iCAKJ,OAAO,GAAC,SAAS;mCAKhB,QAAQ,OAAO,gBAAgB,EAAE,MAAM,CAAC,GAAG,SAAS,KAC1D,OAAO,gBAAgB,EAAE,MAAM;;;;mCAO5B,OAAO,gBAAgB,EAAE,MAAM,KAC7B,IAAI;oCAKN,OAAO,UACP,QAAQ,OAAO,gBAAgB,EAAE,MAAM,CAAC,KACtC,IAAI;kCAMN,OAAO,mBACP,OAAO,YACP,OAAO,KACL,IAAI;kCAKJ,IAAI;8FAMJ,OAAO,iBAAiB,EAAE,aAAa,EAAE;8BAKzC,OAAO;gCAKP,OAAO;kCAKP,OAAO;yCAKT,MAAM,KACJ,KAAK,GAAC;IAClB,GAAO,EAAE,OAAO,CAAC;IACjB,IAAQ,EAAE,MAAM,CAAC;IACjB,IAAQ,EAAE,MAAM,CAAA;CACb,EAAE;wCAKK;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,uBAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,iBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,cAAkB,CAAC,EAAE,MAAM,CAAA;CACxB,KACS,MAAM,GAAC,SAAS,GAAC,KAAK,GAAC;IACnC,OAAW,EAAE,MAAM,CAAC;IACpB,WAAe,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;CAChC,GAAC;IACJ,OAAW,EAAE,IAAI,CAAC;IAClB,OAAW,EAAE,MAAM,CAAA;CAChB;gCAKO,MAAM,eACN,MAAM,EAAE,KACN,OAAO;8BAKT,MAAM,EAAE,KACN,OAAO;4BAKT,MAAM,KACJ,OAAO;kCAKT,MAAM,qBACY,MAAM,KAAK,OAAO;2CAKpC,MAAM,KACJ,MAAM;8BAKN,OAAO;6DAKT,MAAM,8FAGJ,OAAO,GAAC;IAAC,SAAS,EAAE,IAAI,CAAA;CAAC;oCAK3B,MAAM,iBACN,OAAO,oCAAoC,EACrD,YAAgB,EAAE,KACN,OAAO,GAAC;IACpB,SAAa,EAAE,KAAK,CAAA;CACjB;qDAKO,OAAO,gBAAgB,EAAE,IAAI,iBAC7B,OAAO,oCAAoC,EACrD,YAAgB,EAAE,KACN,OAAO,GAAC;IACpB,SAAa,EAAE,KAAK,CAAA;CACjB;oCAKO,MAAM,KACJ,OAAO;2CAKT,OAAO,iBAAiB,EAAE,UAAU,KAClC,OAAO,oCAAoC,EAAE,YAAY;0CAK3D,OAAO,gBAAgB,EAAE,IAAI,KAC3B,OAAO;6EAKT,OAAO,wCAEL,OAAO;kCAKP,OAAO;wCAKP,OAAO;kCAKP,OAAO;4BAKP,OAAO,GAAC,SAAS;gCAKnB,MAAM,KACJ,OAAO,gBAAgB,EAAE,IAAI,EAAE;uCAKjC,MAAM,EAAE,KACN,OAAO,sBAAsB,EAAE,kBAAkB,EAAE;wCAK/C,OAAO,sBAAsB,EAAE,kBAAkB,KAAK,OAAO,KACjE,OAAO,sBAAsB,EAAE,kBAAkB,EAAE;2CAK/C,CAAC,OAAO,gBAAgB,EAAE,IAAI,GAC9C,OAAW,sBAAsB,EAAE,oBAAoB,CAAC,KAAK,OAAO,KACxD,CAAC,OAAO,gBAAgB,EAAE,IAAI,GAC1C,OAAW,sBAAsB,EAAE,oBAAoB,CAAC,EAAE;mCAKhD,OAAO,gBAAgB,EAAE,IAAI,EAAE,KAC7B;IACZ,aAAiB,EAAE,OAAO,gBAAgB,EAAE,IAAI,EAAE,CAAC;IACnD,gBAAoB,EAAE,OAAO,gBAAgB,EAAE,IAAI,EAAE,CAAA;CAClD;qCAKO,MAAM,KACJ,OAAO;iCAKP,IAAI,GAAC,IAAI;kCAKT,IAAI,GAAC,oBAAoB;oCAK3B,MAAM,KACJ,OAAO;qCAKT,OAAO,EAAE,WACT,MAAM,GAAC,SAAS,KACd;IACZ,YAAgB,EAAE,OAAO,GAAC,SAAS,CAAC;IACpC,UAAc,EAAE,MAAM,CAAA;CACnB;oBAIS,UAAU,GAAG;IACzB,mBAAuB,EAAE,mBAAmB,CAAC;IAC7C,iBAAqB,EAAE,iBAAiB,CAAC;IACzC,SAAa,EAAE,SAAS,CAAC;IACzB,WAAe,EAAE,WAAW,CAAC;IAC7B,kBAAsB,EAAE,kBAAkB,CAAC;IAC3C,iBAAqB,EAAE,iBAAiB,CAAC;IACzC,iBAAqB,EAAE,iBAAiB,CAAC;IACzC,cAAkB,EAAE,cAAc,CAAC;IACnC,mBAAuB,EAAE,mBAAmB,CAAC;IAC7C,mBAAuB,EAAE,mBAAmB,CAAC;IAC7C,SAAa,EAAE,SAAS,CAAC;IACzB,MAAU,EAAE,MAAM,CAAC;IACnB,SAAa,EAAE,SAAS,CAAC;IACzB,MAAU,EAAE,MAAM,CAAC;IACnB,YAAgB,EAAE,YAAY,CAAC;IAC/B,YAAgB,UAAU,CAAC;IAC3B,WAAe,EAAE,WAAW,CAAC;IAC7B,OAAW,EAAE,OAAO,CAAC;IACrB,QAAY,EAAE,QAAQ,CAAC;IACvB,aAAiB,EAAE,aAAa,CAAC;IACjC,YAAgB,EAAE,OAAO,iBAAiB,EAAE,YAAY,CAAC;IACzD,yBAA6B,EAAE,yBAAyB,CAAC;IACzD,SAAa,EAAE,SAAS,CAAC;IACzB,WAAe,EAAE,WAAW,CAAC;IAC7B,aAAiB,EAAE,aAAa,CAAC;IACjC,gBAAoB,EAAE,gBAAgB,CAAC;IACvC,mBAAuB,EAAE,mBAAmB,CAAC;IAC7C,UAAc,EAAE,UAAU,CAAC;IAC3B,OAAW,EAAE,OAAO,CAAC;IACrB,MAAU,EAAE,MAAM,CAAC;IACnB,YAAgB,EAAE,YAAY,CAAC;IAC/B,qBAAyB,EAAE,qBAAqB,CAAC;IACjD,SAAa,EAAE,SAAS,CAAC;IACzB,wBAA4B,EAAE,oCAAoC,CAAC;IACnE,wBAA4B,EAAE,oCAAoC,CAAC;IACnE,uBAA2B,EAAE,WAAW,CAAC;IACzC,uBAA2B,EAAE,WAAW,CAAC;IACzC,gCAAoC,EAAE,gCAAgC,CAAC;IACvE,qBAAyB,EAAE,WAAW,CAAC;IACvC,wBAA4B,EAAE,WAAW,CAAC;IAC1C,6BAAiC,EAAE,WAAW,CAAC;IAC/C,oBAAwB,EAAE,WAAW,CAAC;IACtC,sBAA0B,EAAE,sBAAsB,CAAC;IACnD,qBAAyB,EAAE,qBAAqB,CAAC;IACjD,yCAA6C,EAAE,yCAAyC,CAAC;IACzF,aAAiB,EAAE,aAAa,CAAC;IACjC,mBAAuB,EAAE,mBAAmB,CAAC;IAC7C,aAAiB,EAAE,aAAa,CAAC;IACjC,OAAW,EAAE,OAAO,CAAC;IACrB,OAAW,EAAE,OAAO,CAAC;IACrB,cAAkB,EAAE,cAAc,CAAC;IACnC,UAAc,EAAE,UAAU,CAAC;IAC3B,aAAiB,EAAE,aAAa,CAAC;IACjC,aAAiB,EAAE,aAAa,CAAC;IACjC,YAAgB,EAAE,YAAY,CAAC;IAC/B,YAAgB,EAAE,YAAY,CAAC;IAC/B,aAAiB,EAAE,aAAa,CAAC;IACjC,WAAe,EAAE,WAAW,CAAC;IAC7B,WAAe,EAAE,WAAW,CAAA;CACzB;;;;6BAYS,OAAO,QAAQ,EAAE,IAAI,CAAC,YAAY;;;;;gBAM9B,EAAE;;;;;;;;;;;;mBAYC,MAAM;;;;;;;;mBAUb,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI;+BA6E5B,MAAM;;;;;;;kBASJ,IAAI;;;iBA0kCD,MAAM;;;;;;;;;;;;;;;;;cAkBP,OAAO;cACP,OAAO;uBACE,OAAO,iBAAiB,EAAE,iBAAiB;UACxD,OAAO,iBAAiB,EAAE,UAAU;oBAC1B,cAAc;oBACd,cAAc;;;;;;mCA0ExB,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,eACjC,OAAO,QAAQ,EAAE,IAAI,KACnB,MAAM;sCA2DT;IACT,SAAe,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;IACjD,UAAgB,EAAE,OAAO,QAAQ,EAAE,UAAU,CAAC;IAC9C,MAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAU,CAAC,EAAE;QACb,OAAe,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;QACnC,SAAiB,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;KAC9B,CAAC;IACR,KAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,WAAiB,CAAC,EAAE,IAAI,MAAM,EAAE,IAAI,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,KAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,SAAe,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAG;QAC/C,KAAa,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IACR,IAAU,CAAC,EAAE,IAAI,CAAC;IAClB,WAAiB,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,EAAE,CAAA;IAC3C,MAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAgB,CAAC,EAAE,UAAU,CAAC;IAC9B,QAAc,EAAE,QAAQ,CAAC;IACzB,KAAW,EAAE,UAAU,CAAC;CACnB,KACE,GAAG;iCAID;IACT,SAAe,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;IACjD,UAAgB,EAAE,OAAO,QAAQ,EAAE,UAAU,CAAC;IAC9C,MAAY,EAAE,MAAM,CAAC;IACrB,IAAU,EAAE;QACZ,OAAe,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;QACnC,SAAiB,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;KAC9B,CAAC;IACR,KAAW,EAAE,WAAW,CAAC;IACzB,aAAmB,IAAI,MAAM,EAAE,IAAI,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,KAAW,EAAE,oBAAoB,CAAC;IAClC,SAAe,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAG;QAC9C,KAAa,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IACR,IAAU,EAAE,IAAI,GAAC,IAAI,CAAC;IACtB,WAAiB,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,EAAE,CAAA;IAC3C,MAAY,EAAE,MAAM,CAAC;IACrB,UAAgB,CAAC,EAAE,UAAU,CAAC;IAC9B,QAAc,EAAE,QAAQ,CAAC;IACzB,KAAW,EAAE,KAAK,CAAC;CACd,KACE,GAAG;6BAyHE;IAAC,IAAI,EAAE,IAAI,GAAG;QAC1B,KAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAC;;;;;UAKX,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAYP;QACpB,SAAa,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;QAC/C,KAAS,EAAE,WAAW,CAAC;QACvB,QAAY,EAAE,QAAQ,CAAC;QACvB,KAAS,EAAE,UAAU,CAAA;KAClB,KAAK,IAAI;;;;;wBACO,cAAc,KAAK,IAAI;;AAjW3C;;;;;;;;GAQG;AACH;;;;;;;;GAQG;AACH;;;;;;;;;;;;GAYG;AAGH;;;GAGG;AACH,qCAHW,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,GAC/B,QAAQ,GAAC,KAAK,CA4D1B;6BA7zDM,sBAAsB;;AAmiB7B;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH;;;GAGG;AAUH,yCAA8B;AAmvC9B;;;;;;GAMG;AAEH,yBAAyB;AACzB,0BADW,UAAU,CAoDnB"}