eslint-plugin-jsdoc 51.4.1 → 52.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/alignTransform.cjs +1 -1
- package/dist/alignTransform.cjs.map +1 -1
- package/dist/generateRule.cjs +5 -5
- package/dist/generateRule.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.cjs +8 -8
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.d.ts +92 -0
- package/dist/getJsdocProcessorPlugin.d.ts.map +1 -0
- package/dist/iterateJsdoc.cjs +3 -3
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/iterateJsdoc.d.ts +462 -0
- package/dist/iterateJsdoc.d.ts.map +1 -0
- package/dist/jsdocUtils.cjs +9 -9
- package/dist/jsdocUtils.cjs.map +1 -1
- package/dist/rules/checkAlignment.cjs +1 -1
- package/dist/rules/checkAlignment.cjs.map +1 -1
- package/dist/rules/checkExamples.cjs +5 -5
- package/dist/rules/checkExamples.cjs.map +1 -1
- package/dist/rules/checkIndentation.cjs +6 -6
- package/dist/rules/checkIndentation.cjs.map +1 -1
- package/dist/rules/checkLineAlignment.cjs +3 -3
- package/dist/rules/checkLineAlignment.cjs.map +1 -1
- package/dist/rules/checkTagNames.cjs +1 -1
- package/dist/rules/checkTagNames.cjs.map +1 -1
- package/dist/rules/checkTemplateNames.cjs +1 -1
- package/dist/rules/checkTemplateNames.cjs.map +1 -1
- package/dist/rules/checkTypes.cjs +2 -2
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkValues.cjs +1 -1
- package/dist/rules/checkValues.cjs.map +1 -1
- package/dist/rules/emptyTags.cjs +1 -1
- package/dist/rules/emptyTags.cjs.map +1 -1
- package/dist/rules/importsAsDependencies.cjs +2 -2
- package/dist/rules/importsAsDependencies.cjs.map +1 -1
- package/dist/rules/linesBeforeBlock.cjs +1 -1
- package/dist/rules/linesBeforeBlock.cjs.map +1 -1
- package/dist/rules/matchDescription.cjs +4 -4
- package/dist/rules/matchDescription.cjs.map +1 -1
- package/dist/rules/matchName.cjs +1 -1
- package/dist/rules/matchName.cjs.map +1 -1
- package/dist/rules/noBadBlocks.cjs +2 -2
- package/dist/rules/noBadBlocks.cjs.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.cjs +2 -2
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
- package/dist/rules/noDefaults.cjs +2 -2
- package/dist/rules/noDefaults.cjs.map +1 -1
- package/dist/rules/noMultiAsterisks.cjs +6 -6
- package/dist/rules/noMultiAsterisks.cjs.map +1 -1
- package/dist/rules/noUndefinedTypes.cjs +4 -4
- package/dist/rules/noUndefinedTypes.cjs.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.cjs +21 -21
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +3 -3
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
- package/dist/rules/requireJsdoc.cjs +1 -1
- package/dist/rules/requireJsdoc.cjs.map +1 -1
- package/dist/rules/requireReturnsCheck.cjs +1 -1
- package/dist/rules/requireReturnsCheck.cjs.map +1 -1
- package/dist/rules/requireTemplate.cjs +2 -2
- package/dist/rules/requireTemplate.cjs.map +1 -1
- package/dist/rules/tagLines.cjs +2 -2
- package/dist/rules/tagLines.cjs.map +1 -1
- package/dist/rules/textEscaping.cjs +4 -4
- package/dist/rules/textEscaping.cjs.map +1 -1
- package/dist/rules/validTypes.cjs +1 -1
- package/dist/rules/validTypes.cjs.map +1 -1
- package/package.json +1 -1
- package/src/alignTransform.js +1 -1
- package/src/getJsdocProcessorPlugin.js +8 -8
- package/src/iterateJsdoc.js +3 -3
- package/src/jsdocUtils.js +9 -9
- package/src/rules/checkAlignment.js +1 -1
- package/src/rules/checkExamples.js +5 -5
- package/src/rules/checkIndentation.js +6 -6
- package/src/rules/checkLineAlignment.js +3 -3
- package/src/rules/checkTagNames.js +1 -1
- package/src/rules/checkTemplateNames.js +1 -1
- package/src/rules/checkTypes.js +2 -2
- package/src/rules/checkValues.js +1 -1
- package/src/rules/emptyTags.js +1 -1
- package/src/rules/importsAsDependencies.js +2 -2
- package/src/rules/linesBeforeBlock.js +1 -1
- package/src/rules/matchDescription.js +4 -4
- package/src/rules/matchName.js +1 -1
- package/src/rules/noBadBlocks.js +2 -2
- package/src/rules/noBlankBlockDescriptions.js +2 -2
- package/src/rules/noDefaults.js +2 -2
- package/src/rules/noMultiAsterisks.js +6 -6
- package/src/rules/noUndefinedTypes.js +4 -4
- package/src/rules/requireDescriptionCompleteSentence.js +21 -21
- package/src/rules/requireHyphenBeforeParamDescription.js +3 -3
- package/src/rules/requireJsdoc.js +1 -1
- package/src/rules/requireReturnsCheck.js +1 -1
- package/src/rules/requireTemplate.js +2 -2
- package/src/rules/tagLines.js +2 -2
- package/src/rules/textEscaping.js +4 -4
- package/src/rules/validTypes.js +1 -1
- package/eslint.config.js +0 -86
- package/pnpm-workspace.yaml +0 -3
|
@@ -0,0 +1,462 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @param {JsdocVisitor} iterator
|
|
3
|
+
* @param {RuleConfig} ruleConfig
|
|
4
|
+
* @returns {import('eslint').Rule.RuleModule}
|
|
5
|
+
*/
|
|
6
|
+
export default function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): import("eslint").Rule.RuleModule;
|
|
7
|
+
export { parseComment } from "@es-joy/jsdoccomment";
|
|
8
|
+
export type Integer = number;
|
|
9
|
+
export type JsdocBlockWithInline = import("@es-joy/jsdoccomment").JsdocBlockWithInline;
|
|
10
|
+
export type ContextObject = {
|
|
11
|
+
disallowName?: string;
|
|
12
|
+
allowName?: string;
|
|
13
|
+
context?: string;
|
|
14
|
+
comment?: string;
|
|
15
|
+
tags?: string[];
|
|
16
|
+
replacement?: string;
|
|
17
|
+
minimum?: Integer;
|
|
18
|
+
message?: string;
|
|
19
|
+
forceRequireReturn?: boolean;
|
|
20
|
+
};
|
|
21
|
+
export type Context = string | ContextObject;
|
|
22
|
+
export type CheckJsdoc = (info: {
|
|
23
|
+
lastIndex?: Integer;
|
|
24
|
+
isFunctionContext?: boolean;
|
|
25
|
+
selector?: string;
|
|
26
|
+
comment?: string;
|
|
27
|
+
}, handler: null | ((jsdoc: import("@es-joy/jsdoccomment").JsdocBlockWithInline) => boolean | undefined), node: import("eslint").Rule.Node) => void;
|
|
28
|
+
export type ForEachPreferredTag = (tagName: string, arrayHandler: (matchingJsdocTag: import("@es-joy/jsdoccomment").JsdocTagWithInline, targetTagName: string) => void, skipReportingBlockedTag?: boolean | undefined) => void;
|
|
29
|
+
export type ReportSettings = (message: string) => void;
|
|
30
|
+
export type ParseClosureTemplateTag = (tag: import("comment-parser").Spec) => string[];
|
|
31
|
+
export type GetPreferredTagNameObject = (cfg: {
|
|
32
|
+
tagName: string;
|
|
33
|
+
}) => string | false | {
|
|
34
|
+
message: string;
|
|
35
|
+
replacement?: string | undefined;
|
|
36
|
+
} | {
|
|
37
|
+
blocked: true;
|
|
38
|
+
tagName: string;
|
|
39
|
+
};
|
|
40
|
+
export type BasicUtils = {
|
|
41
|
+
forEachPreferredTag: ForEachPreferredTag;
|
|
42
|
+
reportSettings: ReportSettings;
|
|
43
|
+
parseClosureTemplateTag: ParseClosureTemplateTag;
|
|
44
|
+
getPreferredTagNameObject: GetPreferredTagNameObject;
|
|
45
|
+
pathDoesNotBeginWith: import("./jsdocUtils.js").PathDoesNotBeginWith;
|
|
46
|
+
};
|
|
47
|
+
export type IsIteratingFunction = () => boolean;
|
|
48
|
+
export type IsVirtualFunction = () => boolean;
|
|
49
|
+
export type Stringify = (tagBlock: import("comment-parser").Block, specRewire?: boolean | undefined) => string;
|
|
50
|
+
export type ReportJSDoc = (msg: string, tag?: import("comment-parser").Spec | {
|
|
51
|
+
line: Integer;
|
|
52
|
+
column?: Integer;
|
|
53
|
+
} | null | undefined, handler?: (() => void) | null | undefined, specRewire?: boolean | undefined, data?: undefined | {
|
|
54
|
+
[key: string]: string;
|
|
55
|
+
}) => any;
|
|
56
|
+
export type GetRegexFromString = (str: string, requiredFlags?: string | undefined) => RegExp;
|
|
57
|
+
export type GetTagDescription = (tg: import("comment-parser").Spec, returnArray?: boolean | undefined) => string[] | string;
|
|
58
|
+
export type SetTagDescription = (tg: import("comment-parser").Spec, matcher: RegExp, setter: (description: string) => string) => Integer;
|
|
59
|
+
export type GetDescription = () => {
|
|
60
|
+
description: string;
|
|
61
|
+
descriptions: string[];
|
|
62
|
+
lastDescriptionLine: Integer;
|
|
63
|
+
};
|
|
64
|
+
export type SetBlockDescription = (setter: (info: {
|
|
65
|
+
delimiter: string;
|
|
66
|
+
postDelimiter: string;
|
|
67
|
+
start: string;
|
|
68
|
+
}, seedTokens: (tokens?: Partial<import("comment-parser").Tokens>) => import("comment-parser").Tokens, descLines: string[]) => import("comment-parser").Line[]) => void;
|
|
69
|
+
export type SetDescriptionLines = (matcher: RegExp, setter: (description: string) => string) => Integer;
|
|
70
|
+
export type ChangeTag = (tag: import("comment-parser").Spec, ...tokens: Partial<import("comment-parser").Tokens>[]) => void;
|
|
71
|
+
export type SetTag = (tag: import("comment-parser").Spec & {
|
|
72
|
+
line: Integer;
|
|
73
|
+
}, tokens?: Partial<import("comment-parser").Tokens> | undefined) => void;
|
|
74
|
+
export type RemoveTag = (tagIndex: Integer, cfg?: {
|
|
75
|
+
removeEmptyBlock?: boolean;
|
|
76
|
+
tagSourceOffset?: Integer;
|
|
77
|
+
} | undefined) => void;
|
|
78
|
+
export type AddTag = (targetTagName: string, number?: number | undefined, tokens?: {} | import("comment-parser").Tokens | undefined) => void;
|
|
79
|
+
export type GetFirstLine = () => Integer | undefined;
|
|
80
|
+
export type SeedTokens = (tokens?: Partial<import("comment-parser").Tokens> | undefined) => import("comment-parser").Tokens;
|
|
81
|
+
/**
|
|
82
|
+
* Sets tokens to empty string.
|
|
83
|
+
*/
|
|
84
|
+
export type EmptyTokens = (tokens: import("comment-parser").Tokens) => void;
|
|
85
|
+
export type AddLine = (sourceIndex: Integer, tokens: Partial<import("comment-parser").Tokens>) => void;
|
|
86
|
+
export type AddLines = (tagIndex: Integer, tagSourceOffset: Integer, numLines: Integer) => void;
|
|
87
|
+
export type MakeMultiline = () => void;
|
|
88
|
+
export type GetFunctionParameterNames = (useDefaultObjectProperties?: boolean | undefined) => import("./jsdocUtils.js").ParamNameInfo[];
|
|
89
|
+
export type HasParams = () => Integer;
|
|
90
|
+
export type IsGenerator = () => boolean;
|
|
91
|
+
export type IsConstructor = () => boolean;
|
|
92
|
+
export type GetJsdocTagsDeep = (tagName: string) => false | {
|
|
93
|
+
idx: Integer;
|
|
94
|
+
name: string;
|
|
95
|
+
type: string;
|
|
96
|
+
}[];
|
|
97
|
+
export type GetPreferredTagName = (cfg: {
|
|
98
|
+
tagName: string;
|
|
99
|
+
skipReportingBlockedTag?: boolean;
|
|
100
|
+
allowObjectReturn?: boolean;
|
|
101
|
+
defaultMessage?: string;
|
|
102
|
+
}) => string | undefined | false | {
|
|
103
|
+
message: string;
|
|
104
|
+
replacement?: string | undefined;
|
|
105
|
+
} | {
|
|
106
|
+
blocked: true;
|
|
107
|
+
tagName: string;
|
|
108
|
+
};
|
|
109
|
+
export type IsValidTag = (name: string, definedTags: string[]) => boolean;
|
|
110
|
+
export type HasATag = (names: string[]) => boolean;
|
|
111
|
+
export type HasTag = (name: string) => boolean;
|
|
112
|
+
export type ComparePaths = (name: string) => (otherPathName: string) => boolean;
|
|
113
|
+
export type DropPathSegmentQuotes = (name: string) => string;
|
|
114
|
+
export type AvoidDocs = () => boolean;
|
|
115
|
+
export type TagMightHaveNamePositionTypePosition = (tagName: string, otherModeMaps?: import("./getDefaultTagStructureForMode.js").TagStructure[] | undefined) => boolean | {
|
|
116
|
+
otherMode: true;
|
|
117
|
+
};
|
|
118
|
+
export type TagMustHave = (tagName: string, otherModeMaps: import("./getDefaultTagStructureForMode.js").TagStructure[]) => boolean | {
|
|
119
|
+
otherMode: false;
|
|
120
|
+
};
|
|
121
|
+
export type TagMissingRequiredTypeOrNamepath = (tag: import("comment-parser").Spec, otherModeMaps: import("./getDefaultTagStructureForMode.js").TagStructure[]) => boolean | {
|
|
122
|
+
otherMode: false;
|
|
123
|
+
};
|
|
124
|
+
export type IsNamepathX = (tagName: string) => boolean;
|
|
125
|
+
export type GetTagStructureForMode = (mde: import("./jsdocUtils.js").ParserMode) => import("./getDefaultTagStructureForMode.js").TagStructure;
|
|
126
|
+
export type MayBeUndefinedTypeTag = (tag: import("comment-parser").Spec) => boolean;
|
|
127
|
+
export type HasValueOrExecutorHasNonEmptyResolveValue = (anyPromiseAsReturn: boolean, allBranches?: boolean | undefined) => boolean;
|
|
128
|
+
export type HasYieldValue = () => boolean;
|
|
129
|
+
export type HasYieldReturnValue = () => boolean;
|
|
130
|
+
export type HasThrowValue = () => boolean;
|
|
131
|
+
export type IsAsync = () => boolean | undefined;
|
|
132
|
+
export type GetTags = (tagName: string) => import("comment-parser").Spec[];
|
|
133
|
+
export type GetPresentTags = (tagList: string[]) => import("@es-joy/jsdoccomment").JsdocTagWithInline[];
|
|
134
|
+
export type FilterTags = (filter: (tag: import("@es-joy/jsdoccomment").JsdocTagWithInline) => boolean) => import("@es-joy/jsdoccomment").JsdocTagWithInline[];
|
|
135
|
+
export type FilterAllTags = (filter: (tag: (import("comment-parser").Spec | import("@es-joy/jsdoccomment").JsdocInlineTagNoType)) => boolean) => (import("comment-parser").Spec | import("@es-joy/jsdoccomment").JsdocInlineTagNoType)[];
|
|
136
|
+
export type GetTagsByType = (tags: import("comment-parser").Spec[]) => {
|
|
137
|
+
tagsWithNames: import("comment-parser").Spec[];
|
|
138
|
+
tagsWithoutNames: import("comment-parser").Spec[];
|
|
139
|
+
};
|
|
140
|
+
export type HasOptionTag = (tagName: string) => boolean;
|
|
141
|
+
export type GetClassNode = () => Node | null;
|
|
142
|
+
export type GetClassJsdoc = () => null | JsdocBlockWithInline;
|
|
143
|
+
export type ClassHasTag = (tagName: string) => boolean;
|
|
144
|
+
export type FindContext = (contexts: Context[], comment: string | undefined) => {
|
|
145
|
+
foundContext: Context | undefined;
|
|
146
|
+
contextStr: string;
|
|
147
|
+
};
|
|
148
|
+
export type Utils = BasicUtils & {
|
|
149
|
+
isIteratingFunction: IsIteratingFunction;
|
|
150
|
+
isVirtualFunction: IsVirtualFunction;
|
|
151
|
+
stringify: Stringify;
|
|
152
|
+
reportJSDoc: ReportJSDoc;
|
|
153
|
+
getRegexFromString: GetRegexFromString;
|
|
154
|
+
getTagDescription: GetTagDescription;
|
|
155
|
+
setTagDescription: SetTagDescription;
|
|
156
|
+
getDescription: GetDescription;
|
|
157
|
+
setBlockDescription: SetBlockDescription;
|
|
158
|
+
setDescriptionLines: SetDescriptionLines;
|
|
159
|
+
changeTag: ChangeTag;
|
|
160
|
+
setTag: SetTag;
|
|
161
|
+
removeTag: RemoveTag;
|
|
162
|
+
addTag: AddTag;
|
|
163
|
+
getFirstLine: GetFirstLine;
|
|
164
|
+
seedTokens: SeedTokens;
|
|
165
|
+
emptyTokens: EmptyTokens;
|
|
166
|
+
addLine: AddLine;
|
|
167
|
+
addLines: AddLines;
|
|
168
|
+
makeMultiline: MakeMultiline;
|
|
169
|
+
flattenRoots: import("./jsdocUtils.js").FlattenRoots;
|
|
170
|
+
getFunctionParameterNames: GetFunctionParameterNames;
|
|
171
|
+
hasParams: HasParams;
|
|
172
|
+
isGenerator: IsGenerator;
|
|
173
|
+
isConstructor: IsConstructor;
|
|
174
|
+
getJsdocTagsDeep: GetJsdocTagsDeep;
|
|
175
|
+
getPreferredTagName: GetPreferredTagName;
|
|
176
|
+
isValidTag: IsValidTag;
|
|
177
|
+
hasATag: HasATag;
|
|
178
|
+
hasTag: HasTag;
|
|
179
|
+
comparePaths: ComparePaths;
|
|
180
|
+
dropPathSegmentQuotes: DropPathSegmentQuotes;
|
|
181
|
+
avoidDocs: AvoidDocs;
|
|
182
|
+
tagMightHaveNamePosition: TagMightHaveNamePositionTypePosition;
|
|
183
|
+
tagMightHaveTypePosition: TagMightHaveNamePositionTypePosition;
|
|
184
|
+
tagMustHaveNamePosition: TagMustHave;
|
|
185
|
+
tagMustHaveTypePosition: TagMustHave;
|
|
186
|
+
tagMissingRequiredTypeOrNamepath: TagMissingRequiredTypeOrNamepath;
|
|
187
|
+
isNamepathDefiningTag: IsNamepathX;
|
|
188
|
+
isNamepathReferencingTag: IsNamepathX;
|
|
189
|
+
isNamepathOrUrlReferencingTag: IsNamepathX;
|
|
190
|
+
tagMightHaveNamepath: IsNamepathX;
|
|
191
|
+
getTagStructureForMode: GetTagStructureForMode;
|
|
192
|
+
mayBeUndefinedTypeTag: MayBeUndefinedTypeTag;
|
|
193
|
+
hasValueOrExecutorHasNonEmptyResolveValue: HasValueOrExecutorHasNonEmptyResolveValue;
|
|
194
|
+
hasYieldValue: HasYieldValue;
|
|
195
|
+
hasYieldReturnValue: HasYieldReturnValue;
|
|
196
|
+
hasThrowValue: HasThrowValue;
|
|
197
|
+
isAsync: IsAsync;
|
|
198
|
+
getTags: GetTags;
|
|
199
|
+
getPresentTags: GetPresentTags;
|
|
200
|
+
filterTags: FilterTags;
|
|
201
|
+
filterAllTags: FilterAllTags;
|
|
202
|
+
getTagsByType: GetTagsByType;
|
|
203
|
+
hasOptionTag: HasOptionTag;
|
|
204
|
+
getClassNode: GetClassNode;
|
|
205
|
+
getClassJsdoc: GetClassJsdoc;
|
|
206
|
+
classHasTag: ClassHasTag;
|
|
207
|
+
findContext: FindContext;
|
|
208
|
+
};
|
|
209
|
+
/**
|
|
210
|
+
* Should use ESLint rule's typing.
|
|
211
|
+
*/
|
|
212
|
+
export type EslintRuleMeta = import("eslint").Rule.RuleMetaData;
|
|
213
|
+
/**
|
|
214
|
+
* A plain object for tracking state as needed by rules across iterations.
|
|
215
|
+
*/
|
|
216
|
+
export type StateObject = {
|
|
217
|
+
globalTags: {};
|
|
218
|
+
hasDuplicates: {
|
|
219
|
+
[key: string]: boolean;
|
|
220
|
+
};
|
|
221
|
+
selectorMap: {
|
|
222
|
+
[selector: string]: {
|
|
223
|
+
[comment: string]: Integer;
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
hasTag: {
|
|
227
|
+
[key: string]: boolean;
|
|
228
|
+
};
|
|
229
|
+
hasNonComment: number;
|
|
230
|
+
hasNonCommentBeforeTag: {
|
|
231
|
+
[key: string]: boolean | number;
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
/**
|
|
235
|
+
* The Node AST as supplied by the parser.
|
|
236
|
+
*/
|
|
237
|
+
export type Node = import("eslint").Rule.Node;
|
|
238
|
+
export type Report = (message: string, fix?: import("eslint").Rule.ReportFixer | null | undefined, jsdocLoc?: {
|
|
239
|
+
line?: Integer;
|
|
240
|
+
column?: Integer;
|
|
241
|
+
} | (import("comment-parser").Spec & {
|
|
242
|
+
line?: Integer;
|
|
243
|
+
}) | null | undefined, data?: undefined | {
|
|
244
|
+
[key: string]: string;
|
|
245
|
+
}) => void;
|
|
246
|
+
export type PreferredTypes = {
|
|
247
|
+
[key: string]: false | string | {
|
|
248
|
+
message: string;
|
|
249
|
+
replacement?: false | string;
|
|
250
|
+
skipRootChecking?: boolean;
|
|
251
|
+
};
|
|
252
|
+
};
|
|
253
|
+
export type StructuredTags = {
|
|
254
|
+
[key: string]: {
|
|
255
|
+
name?: "text" | "namepath-defining" | "namepath-referencing" | false;
|
|
256
|
+
type?: boolean | string[];
|
|
257
|
+
required?: ("name" | "type" | "typeOrNameRequired")[];
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
/**
|
|
261
|
+
* Settings from ESLint types.
|
|
262
|
+
*/
|
|
263
|
+
export type Settings = {
|
|
264
|
+
maxLines: Integer;
|
|
265
|
+
minLines: Integer;
|
|
266
|
+
tagNamePreference: import("./jsdocUtils.js").TagNamePreference;
|
|
267
|
+
mode: import("./jsdocUtils.js").ParserMode;
|
|
268
|
+
preferredTypes: PreferredTypes;
|
|
269
|
+
structuredTags: StructuredTags;
|
|
270
|
+
[name: string]: any;
|
|
271
|
+
contexts?: Context[];
|
|
272
|
+
};
|
|
273
|
+
export type JSDocSettings = {
|
|
274
|
+
settings?: {
|
|
275
|
+
jsdoc?: {
|
|
276
|
+
ignorePrivate: boolean;
|
|
277
|
+
ignoreInternal: boolean;
|
|
278
|
+
maxLines: Integer;
|
|
279
|
+
minLines: Integer;
|
|
280
|
+
tagNamePreference: import("./jsdocUtils.js").TagNamePreference;
|
|
281
|
+
preferredTypes: PreferredTypes;
|
|
282
|
+
structuredTags: StructuredTags;
|
|
283
|
+
overrideReplacesDocs: boolean;
|
|
284
|
+
ignoreReplacesDocs: boolean;
|
|
285
|
+
implementsReplacesDocs: boolean;
|
|
286
|
+
augmentsExtendsReplacesDocs: boolean;
|
|
287
|
+
exemptDestructuredRootsFromChecks: boolean;
|
|
288
|
+
mode: import("./jsdocUtils.js").ParserMode;
|
|
289
|
+
contexts: Context[];
|
|
290
|
+
};
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
/**
|
|
294
|
+
* Create the report function
|
|
295
|
+
*/
|
|
296
|
+
export type MakeReport = (context: import("eslint").Rule.RuleContext, commentNode: import("estree").Node) => Report;
|
|
297
|
+
export type JsdocVisitorBasic = (arg: {
|
|
298
|
+
context: import("eslint").Rule.RuleContext;
|
|
299
|
+
sourceCode: import("eslint").SourceCode;
|
|
300
|
+
indent?: string;
|
|
301
|
+
info?: {
|
|
302
|
+
comment?: string | undefined;
|
|
303
|
+
lastIndex?: Integer | undefined;
|
|
304
|
+
};
|
|
305
|
+
state?: StateObject;
|
|
306
|
+
globalState?: Map<string, Map<string, string>>;
|
|
307
|
+
jsdoc?: JsdocBlockWithInline;
|
|
308
|
+
jsdocNode?: import("eslint").Rule.Node & {
|
|
309
|
+
range: [number, number];
|
|
310
|
+
};
|
|
311
|
+
node?: Node;
|
|
312
|
+
allComments?: import("estree").Node[];
|
|
313
|
+
report?: Report;
|
|
314
|
+
makeReport?: MakeReport;
|
|
315
|
+
settings: Settings;
|
|
316
|
+
utils: BasicUtils;
|
|
317
|
+
}) => any;
|
|
318
|
+
export type JsdocVisitor = (arg: {
|
|
319
|
+
context: import("eslint").Rule.RuleContext;
|
|
320
|
+
sourceCode: import("eslint").SourceCode;
|
|
321
|
+
indent: string;
|
|
322
|
+
info: {
|
|
323
|
+
comment?: string | undefined;
|
|
324
|
+
lastIndex?: Integer | undefined;
|
|
325
|
+
};
|
|
326
|
+
state: StateObject;
|
|
327
|
+
globalState: Map<string, Map<string, string>>;
|
|
328
|
+
jsdoc: JsdocBlockWithInline;
|
|
329
|
+
jsdocNode: import("eslint").Rule.Node & {
|
|
330
|
+
range: [number, number];
|
|
331
|
+
};
|
|
332
|
+
node: Node | null;
|
|
333
|
+
allComments?: import("estree").Node[];
|
|
334
|
+
report: Report;
|
|
335
|
+
makeReport?: MakeReport;
|
|
336
|
+
settings: Settings;
|
|
337
|
+
utils: Utils;
|
|
338
|
+
}) => any;
|
|
339
|
+
export type NonCommentArgs = {
|
|
340
|
+
node: Node & {
|
|
341
|
+
range: [number, number];
|
|
342
|
+
};
|
|
343
|
+
state: StateObject;
|
|
344
|
+
};
|
|
345
|
+
export type RuleConfig = {
|
|
346
|
+
/**
|
|
347
|
+
* ESLint rule meta
|
|
348
|
+
*/
|
|
349
|
+
meta: EslintRuleMeta;
|
|
350
|
+
/**
|
|
351
|
+
* Any default contexts
|
|
352
|
+
*/
|
|
353
|
+
contextDefaults?: jsdocUtils.DefaultContexts | undefined;
|
|
354
|
+
/**
|
|
355
|
+
* Whether to force a `contexts` check
|
|
356
|
+
*/
|
|
357
|
+
contextSelected?: true | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* Whether to iterate all JSDoc blocks by default
|
|
360
|
+
* regardless of context
|
|
361
|
+
*/
|
|
362
|
+
iterateAllJsdocs?: true | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* Whether to check `@private` blocks (normally exempted)
|
|
365
|
+
*/
|
|
366
|
+
checkPrivate?: true | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* Whether to check `@internal` blocks (normally exempted)
|
|
369
|
+
*/
|
|
370
|
+
checkInternal?: true | undefined;
|
|
371
|
+
/**
|
|
372
|
+
* Whether to iterates over all JSDoc blocks regardless of attachment
|
|
373
|
+
*/
|
|
374
|
+
checkFile?: true | undefined;
|
|
375
|
+
/**
|
|
376
|
+
* Whether to avoid relying on settings for global contexts
|
|
377
|
+
*/
|
|
378
|
+
nonGlobalSettings?: true | undefined;
|
|
379
|
+
/**
|
|
380
|
+
* Whether to disable the tracking of visited comment nodes (as
|
|
381
|
+
* non-tracked may conduct further actions)
|
|
382
|
+
*/
|
|
383
|
+
noTracking?: true | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* Whether the rule expects contexts to be based on a match option
|
|
386
|
+
*/
|
|
387
|
+
matchContext?: true | undefined;
|
|
388
|
+
/**
|
|
389
|
+
* Handler to be executed upon exiting iteration of program AST
|
|
390
|
+
*/
|
|
391
|
+
exit?: ((args: {
|
|
392
|
+
context: import("eslint").Rule.RuleContext;
|
|
393
|
+
state: StateObject;
|
|
394
|
+
settings: Settings;
|
|
395
|
+
utils: BasicUtils;
|
|
396
|
+
}) => void) | undefined;
|
|
397
|
+
/**
|
|
398
|
+
* Handler to be executed if rule wishes
|
|
399
|
+
* to be supplied nodes without comments
|
|
400
|
+
*/
|
|
401
|
+
nonComment?: ((nca: NonCommentArgs) => void) | undefined;
|
|
402
|
+
};
|
|
403
|
+
/**
|
|
404
|
+
* @typedef {{
|
|
405
|
+
* [key: string]: false|string|{
|
|
406
|
+
* message: string,
|
|
407
|
+
* replacement?: false|string
|
|
408
|
+
* skipRootChecking?: boolean
|
|
409
|
+
* }
|
|
410
|
+
* }} PreferredTypes
|
|
411
|
+
*/
|
|
412
|
+
/**
|
|
413
|
+
* @typedef {{
|
|
414
|
+
* [key: string]: {
|
|
415
|
+
* name?: "text"|"namepath-defining"|"namepath-referencing"|false,
|
|
416
|
+
* type?: boolean|string[],
|
|
417
|
+
* required?: ("name"|"type"|"typeOrNameRequired")[]
|
|
418
|
+
* }
|
|
419
|
+
* }} StructuredTags
|
|
420
|
+
*/
|
|
421
|
+
/**
|
|
422
|
+
* Settings from ESLint types.
|
|
423
|
+
* @typedef {{
|
|
424
|
+
* maxLines: Integer,
|
|
425
|
+
* minLines: Integer,
|
|
426
|
+
* tagNamePreference: import('./jsdocUtils.js').TagNamePreference,
|
|
427
|
+
* mode: import('./jsdocUtils.js').ParserMode,
|
|
428
|
+
* preferredTypes: PreferredTypes,
|
|
429
|
+
* structuredTags: StructuredTags,
|
|
430
|
+
* [name: string]: any,
|
|
431
|
+
* contexts?: Context[]
|
|
432
|
+
* }} Settings
|
|
433
|
+
*/
|
|
434
|
+
/**
|
|
435
|
+
* @typedef {{
|
|
436
|
+
* settings?: {
|
|
437
|
+
* jsdoc?: {
|
|
438
|
+
* ignorePrivate: boolean,
|
|
439
|
+
* ignoreInternal: boolean,
|
|
440
|
+
* maxLines: Integer,
|
|
441
|
+
* minLines: Integer,
|
|
442
|
+
* tagNamePreference: import('./jsdocUtils.js').TagNamePreference,
|
|
443
|
+
* preferredTypes: PreferredTypes,
|
|
444
|
+
* structuredTags: StructuredTags,
|
|
445
|
+
* overrideReplacesDocs: boolean,
|
|
446
|
+
* ignoreReplacesDocs: boolean,
|
|
447
|
+
* implementsReplacesDocs: boolean,
|
|
448
|
+
* augmentsExtendsReplacesDocs: boolean,
|
|
449
|
+
* exemptDestructuredRootsFromChecks: boolean,
|
|
450
|
+
* mode: import('./jsdocUtils.js').ParserMode,
|
|
451
|
+
* contexts: Context[],
|
|
452
|
+
* }
|
|
453
|
+
* }
|
|
454
|
+
* }} JSDocSettings
|
|
455
|
+
*/
|
|
456
|
+
/**
|
|
457
|
+
* @param {import('eslint').Rule.RuleContext & JSDocSettings} context
|
|
458
|
+
* @returns {Settings|false}
|
|
459
|
+
*/
|
|
460
|
+
export function getSettings(context: import("eslint").Rule.RuleContext & JSDocSettings): Settings | false;
|
|
461
|
+
import * as jsdocUtils from './jsdocUtils.js';
|
|
462
|
+
//# sourceMappingURL=iterateJsdoc.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"iterateJsdoc.d.ts","sourceRoot":"","sources":["../src/iterateJsdoc.js"],"names":[],"mappings":"AAgyEA;;;;GAIG;AACH,+CAJW,YAAY,cACZ,UAAU,GACR,OAAO,QAAQ,EAAE,IAAI,CAAC,UAAU,CA8K5C;;sBAp8EY,MAAM;mCAIN,OAAO,sBAAsB,EAAE,oBAAoB;4BAInD;IACR,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;sBAGS,MAAM,GAAC,aAAa;gCAKtB;IACN,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,WACO,IAAI,GAAC,CAAC,CAAC,KAAK,EAAE,OAAO,sBAAsB,EAAE,oBAAoB,KAAK,OAAO,GAAC,SAAS,CAAC,QACxF,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,KACxB,IAAI;4CAKN,MAAM,gBACN,CACN,gBAAgB,EAAE,OAAO,sBAAsB,EAAE,kBAAkB,EACnE,aAAa,EAAE,MAAM,KAClB,IAAI,oDAEC,IAAI;uCAKN,MAAM,KACJ,IAAI;4CAKN,OAAO,gBAAgB,EAAE,IAAI,KAC3B,MAAM,EAAE;8CAKV;IACN,OAAO,EAAE,MAAM,CAAA;CAChB,KACS,MAAM,GAAC,KAAK,GAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,GAAC,SAAS,CAAA;CAC/B,GAAC;IACA,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;yBAIS;IACR,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,cAAc,EAAE,cAAc,CAAC;IAC/B,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,OAAO,iBAAiB,EAAE,oBAAoB,CAAA;CACrE;wCAKS,OAAO;sCAKP,OAAO;mCAKT,OAAO,gBAAgB,EAAE,KAAK,uCAE5B,MAAM;gCAKR,MAAM;UACoC,OAAO;aAAW,OAAO;uCAC5D,IAAI,+DAEX,SAAS,GAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB;uCAKO,MAAM,yCAEJ,MAAM;qCAKR,OAAO,gBAAgB,EAAE,IAAI,wCAE3B,MAAM,EAAE,GAAC,MAAM;qCAKjB,OAAO,gBAAgB,EAAE,IAAI,WAC7B,MAAM,UACN,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,KAC7B,OAAO;mCAKP;IACR,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAA;CAC7B;2CAKO,CACN,IAAI,EAAE;IACJ,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAA;CACd,EACD,UAAU,EAAE,CACV,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,KAC9C,OAAO,gBAAgB,EAAE,MAAM,EACpC,SAAS,EAAE,MAAM,EAAE,KAChB,OAAO,gBAAgB,EAAE,IAAI,EAAE,KAC1B,IAAI;4CAKN,MAAM,UACN,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,KAC7B,OAAO;8BAKT,OAAO,gBAAgB,EAAE,IAAI,aAC1B,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,EAAA,KACzC,IAAI;2BAKN,OAAO,gBAAgB,EAAE,IAAI,GAAG;IACtC,IAAI,EAAE,OAAO,CAAA;CACd,oEAES,IAAI;mCAKN,OAAO;uBAEM,OAAO;sBACR,OAAO;kBAEjB,IAAI;qCAKN,MAAM,6FAGJ,IAAI;iCAKJ,OAAO,GAAC,SAAS;yBAIjB,CACR,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,GAAG,SAAS,KAC1D,OAAO,gBAAgB,EAAE,MAAM;;;;mCAM5B,OAAO,gBAAgB,EAAE,MAAM,KAC7B,IAAI;oCAKN,OAAO,UACP,OAAO,CAAC,OAAO,gBAAgB,EAAE,MAAM,CAAC,KACtC,IAAI;kCAKN,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;IACd,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAA;CACb,EAAE;wCAKK;IACN,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,KACS,MAAM,GAAC,SAAS,GAAC,KAAK,GAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;CAChC,GAAC;IACA,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;gCAKO,MAAM,eACN,MAAM,EAAE,KACN,OAAO;8BAKT,MAAM,EAAE,KACN,OAAO;4BAKT,MAAM,KACJ,OAAO;kCAKT,MAAM,KACJ,CAAC,aAAa,EAAE,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,EACjD,YAAY,EAAE,KACN,OAAO,GAAC;IAChB,SAAS,EAAE,KAAK,CAAA;CACjB;qDAKO,OAAO,gBAAgB,EAAE,IAAI,iBAC7B,OAAO,oCAAoC,EACjD,YAAY,EAAE,KACN,OAAO,GAAC;IAChB,SAAS,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;kCAKrD,CAAC,GAAG,EAAE,OAAO,sBAAsB,EAAE,kBAAkB,KAAK,OAAO,KACjE,OAAO,sBAAsB,EAAE,kBAAkB,EAAE;qCAKrD,CAAC,GAAG,EAAE,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;IACR,aAAa,EAAE,OAAO,gBAAgB,EAAE,IAAI,EAAE,CAAC;IAC/C,gBAAgB,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;IACR,YAAY,EAAE,OAAO,GAAC,SAAS,CAAC;IAChC,UAAU,EAAE,MAAM,CAAA;CACnB;oBAIS,UAAU,GAAG;IACrB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,cAAc,EAAE,cAAc,CAAC;IAC/B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,YAAY,EAAE,OAAO,iBAAiB,EAAE,YAAY,CAAC;IACrD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;IAC3B,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,SAAS,EAAE,SAAS,CAAC;IACrB,wBAAwB,EAAE,oCAAoC,CAAC;IAC/D,wBAAwB,EAAE,oCAAoC,CAAC;IAC/D,uBAAuB,EAAE,WAAW,CAAC;IACrC,uBAAuB,EAAE,WAAW,CAAC;IACrC,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,qBAAqB,EAAE,WAAW,CAAC;IACnC,wBAAwB,EAAE,WAAW,CAAC;IACtC,6BAA6B,EAAE,WAAW,CAAC;IAC3C,oBAAoB,EAAE,WAAW,CAAC;IAClC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,yCAAyC,EAAE,yCAAyC,CAAC;IACrF,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,aAAa,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,WAAW,CAAA;CACzB;;;;6BAYS,OAAO,QAAQ,EAAE,IAAI,CAAC,YAAY;;;;0BAKlC;IACR,UAAU,EAAE,EAAE,CAAC;IACf,aAAa,EAAE;QACnB,CAAO,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACvB,CAAC;IACF,WAAW,EAAE;QACjB,CAAO,QAAQ,EAAE,MAAM,GAAG;YAC1B,CAAS,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;SAC3B,CAAA;KACF,CAAC;IACF,MAAM,EAAE;QACZ,CAAO,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACvB,CAAC;IACF,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB,EAAE;QAC5B,CAAO,GAAG,EAAE,MAAM,GAAG,OAAO,GAAC,MAAM,CAAA;KAC9B,CAAA;CACF;;;;mBAKS,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI;+BA6E5B,MAAM;WAGJ,OAAO;aAAW,OAAO;;WACO,OAAO;8BAEzC,SAAS,GAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,KACS,IAAI;6BA+gCJ;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG,KAAK,GAAC,MAAM,GAAC;QAC1B,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,KAAK,GAAC,MAAM,CAAA;QAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAC3B,CAAA;CACF;6BAGS;IACZ,CAAK,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,CAAC,EAAE,MAAM,GAAC,mBAAmB,GAAC,sBAAsB,GAAC,KAAK,CAAC;QAC/D,IAAI,CAAC,EAAE,OAAO,GAAC,MAAM,EAAE,CAAC;QACxB,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAC,MAAM,GAAC,oBAAoB,CAAC,EAAE,CAAA;KAClD,CAAA;CACF;;;;uBAIS;IACR,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,iBAAiB,EAAE,OAAO,iBAAiB,EAAE,iBAAiB,CAAC;IAC/D,IAAI,EAAE,OAAO,iBAAiB,EAAE,UAAU,CAAC;IAC3C,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IACnC,CAAK,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB;4BAIS;IACR,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE;YACN,aAAa,EAAE,OAAO,CAAC;YACvB,cAAc,EAAE,OAAO,CAAC;YACxB,QAAQ,EAAE,OAAO,CAAC;YAClB,QAAQ,EAAE,OAAO,CAAC;YAClB,iBAAiB,EAAE,OAAO,iBAAiB,EAAE,iBAAiB,CAAC;YAC/D,cAAc,EAAE,cAAc,CAAC;YAC/B,cAAc,EAAE,cAAc,CAAC;YAC/B,oBAAoB,EAAE,OAAO,CAAC;YAC9B,kBAAkB,EAAE,OAAO,CAAC;YAC5B,sBAAsB,EAAE,OAAO,CAAC;YAChC,2BAA2B,EAAE,OAAO,CAAC;YACrC,iCAAiC,EAAE,OAAO,CAAC;YAC3C,IAAI,EAAE,OAAO,iBAAiB,EAAE,UAAU,CAAC;YAC3C,QAAQ,EAAE,OAAO,EAAE,CAAC;SACrB,CAAA;KACF,CAAA;CACF;;;;mCAsEO,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,eACjC,OAAO,QAAQ,EAAE,IAAI,KACnB,MAAM;gCAuDN,CACR,GAAG,EAAE;IACH,OAAO,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;IAC3C,UAAU,EAAE,OAAO,QAAQ,EAAE,UAAU,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;QAC3B,SAAS,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;KAC9B,CAAC;IACF,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/C,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAG;QACvC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,WAAW,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,EAAE,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,UAAU,CAAC;CACnB,KACE,GAAG;2BAGE,CACR,GAAG,EAAE;IACH,OAAO,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;IAC3C,UAAU,EAAE,OAAO,QAAQ,EAAE,UAAU,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,GAAC,SAAS,CAAC;QAC3B,SAAS,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;KAC9B,CAAC;IACF,KAAK,EAAE,WAAW,CAAC;IACnB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9C,KAAK,EAAE,oBAAoB,CAAC;IAC5B,SAAS,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAG;QACtC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IACF,IAAI,EAAE,IAAI,GAAC,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,QAAQ,EAAE,IAAI,EAAE,CAAA;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,KACE,GAAG;6BA8HE;IAAC,IAAI,EAAE,IAAI,GAAG;QACtB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACxB,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAC;;;;;UAKX,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAYP;QAChB,OAAO,EAAE,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;QAC3C,KAAK,EAAE,WAAW,CAAC;QACnB,QAAQ,EAAE,QAAQ,CAAC;QACnB,KAAK,EAAE,UAAU,CAAA;KAClB,KAAK,IAAI;;;;;wBACO,cAAc,KAAK,IAAI;;AAzX3C;;;;;;;;GAQG;AACH;;;;;;;;GAQG;AACH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;GAGG;AACH,qCAHW,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW,GAAG,aAAa,GAC/C,QAAQ,GAAC,KAAK,CA4D1B;4BAxxD2B,iBAAiB"}
|
package/dist/jsdocUtils.cjs
CHANGED
|
@@ -498,9 +498,9 @@ context = {
|
|
|
498
498
|
// https://github.com/eslint/eslint/issues/13289
|
|
499
499
|
// https://github.com/gajus/eslint-plugin-jsdoc/issues/537
|
|
500
500
|
const tagPreferenceFixed = Object.fromEntries(Object.entries(tagPreference).map(([key, value]) => {
|
|
501
|
-
return [key.replace(/^tag /
|
|
501
|
+
return [key.replace(/^tag /v, ''), value];
|
|
502
502
|
}));
|
|
503
|
-
if (Object.
|
|
503
|
+
if (Object.hasOwn(tagPreferenceFixed, name)) {
|
|
504
504
|
return tagPreferenceFixed[name];
|
|
505
505
|
}
|
|
506
506
|
const tagNames = getTagNamesForMode(mode, context);
|
|
@@ -1222,7 +1222,7 @@ const hasThrowValue = (node, innerFunction) => {
|
|
|
1222
1222
|
*/
|
|
1223
1223
|
/*
|
|
1224
1224
|
const isInlineTag = (tag) => {
|
|
1225
|
-
return /^(@link|@linkcode|@linkplain|@tutorial) /
|
|
1225
|
+
return /^(@link|@linkcode|@linkplain|@tutorial) /v.test(tag);
|
|
1226
1226
|
};
|
|
1227
1227
|
*/
|
|
1228
1228
|
|
|
@@ -1236,7 +1236,7 @@ const isInlineTag = (tag) => {
|
|
|
1236
1236
|
exports.hasThrowValue = hasThrowValue;
|
|
1237
1237
|
const parseClosureTemplateTag = tag => {
|
|
1238
1238
|
return tag.name.split(',').map(type => {
|
|
1239
|
-
return type.trim().replace(/^\[?(?<name>.*?)=.*$/
|
|
1239
|
+
return type.trim().replace(/^\[?(?<name>.*?)=.*$/v, '$<name>');
|
|
1240
1240
|
});
|
|
1241
1241
|
};
|
|
1242
1242
|
|
|
@@ -1371,7 +1371,7 @@ const getTagsByType = (context, mode, tags) => {
|
|
|
1371
1371
|
*/
|
|
1372
1372
|
exports.getTagsByType = getTagsByType;
|
|
1373
1373
|
const getIndent = sourceCode => {
|
|
1374
|
-
return (sourceCode.text.match(/^\n*([ \t]+)/
|
|
1374
|
+
return (sourceCode.text.match(/^\n*([ \t]+)/v)?.[1] ?? '') + ' ';
|
|
1375
1375
|
};
|
|
1376
1376
|
|
|
1377
1377
|
/**
|
|
@@ -1476,7 +1476,7 @@ const exemptSpeciaMethods = (jsdoc, node, context, schema) => {
|
|
|
1476
1476
|
*/
|
|
1477
1477
|
exports.exemptSpeciaMethods = exemptSpeciaMethods;
|
|
1478
1478
|
const dropPathSegmentQuotes = str => {
|
|
1479
|
-
return str.replaceAll(/\.(['"])(.*)\1/
|
|
1479
|
+
return str.replaceAll(/\.(['"])(.*)\1/gv, '.$2');
|
|
1480
1480
|
};
|
|
1481
1481
|
|
|
1482
1482
|
/**
|
|
@@ -1510,13 +1510,13 @@ const pathDoesNotBeginWith = (name, otherPathName) => {
|
|
|
1510
1510
|
*/
|
|
1511
1511
|
exports.pathDoesNotBeginWith = pathDoesNotBeginWith;
|
|
1512
1512
|
const getRegexFromString = (regexString, requiredFlags) => {
|
|
1513
|
-
const match = regexString.match(/^\/(.*)\/([
|
|
1514
|
-
let flags = '
|
|
1513
|
+
const match = regexString.match(/^\/(.*)\/([gimyvus]*)$/vs);
|
|
1514
|
+
let flags = 'v';
|
|
1515
1515
|
let regex = regexString;
|
|
1516
1516
|
if (match) {
|
|
1517
1517
|
[, regex, flags] = match;
|
|
1518
1518
|
if (!flags) {
|
|
1519
|
-
flags = '
|
|
1519
|
+
flags = 'v';
|
|
1520
1520
|
}
|
|
1521
1521
|
}
|
|
1522
1522
|
const uniqueFlags = [...new Set(flags + (requiredFlags || ''))];
|