eslint-plugin-jsdoc 61.1.4 → 61.1.5

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.
@@ -10,7 +10,7 @@ const WarnSettings = function () {
10
10
  return {
11
11
  /**
12
12
  * Warn only once for each context and setting
13
- * @param {{}} context
13
+ * @param {import('eslint').Rule.RuleContext} context
14
14
  * @param {string} setting
15
15
  * @returns {boolean}
16
16
  */
@@ -18,7 +18,7 @@ const WarnSettings = function () {
18
18
  return warnedSettings.has(context) && /** @type {Set<string>} */warnedSettings.get(context).has(setting);
19
19
  },
20
20
  /**
21
- * @param {{}} context
21
+ * @param {import('eslint').Rule.RuleContext} context
22
22
  * @param {string} setting
23
23
  * @returns {void}
24
24
  */
@@ -1 +1 @@
1
- {"version":3,"file":"WarnSettings.cjs","names":["WarnSettings","warnedSettings","WeakMap","hasBeenWarned","context","setting","has","get","markSettingAsWarned","set","Set","add","_default","exports","default","module"],"sources":["../src/WarnSettings.js"],"sourcesContent":["const WarnSettings = function () {\n /** @type {WeakMap<object, Set<string>>} */\n const warnedSettings = new WeakMap();\n\n return {\n /**\n * Warn only once for each context and setting\n * @param {{}} context\n * @param {string} setting\n * @returns {boolean}\n */\n hasBeenWarned (context, setting) {\n return warnedSettings.has(context) && /** @type {Set<string>} */ (\n warnedSettings.get(context)\n ).has(setting);\n },\n\n /**\n * @param {{}} context\n * @param {string} setting\n * @returns {void}\n */\n markSettingAsWarned (context, setting) {\n // c8 ignore else\n if (!warnedSettings.has(context)) {\n warnedSettings.set(context, new Set());\n }\n\n /** @type {Set<string>} */ (warnedSettings.get(context)).add(setting);\n },\n };\n};\n\nexport default WarnSettings;\n"],"mappings":";;;;;;AAAA,MAAMA,YAAY,GAAG,SAAAA,CAAA,EAAY;EAC/B;EACA,MAAMC,cAAc,GAAG,IAAIC,OAAO,CAAC,CAAC;EAEpC,OAAO;IACL;AACJ;AACA;AACA;AACA;AACA;IACIC,aAAaA,CAAEC,OAAO,EAAEC,OAAO,EAAE;MAC/B,OAAOJ,cAAc,CAACK,GAAG,CAACF,OAAO,CAAC,IAAI,0BACpCH,cAAc,CAACM,GAAG,CAACH,OAAO,CAAC,CAC3BE,GAAG,CAACD,OAAO,CAAC;IAChB,CAAC;IAED;AACJ;AACA;AACA;AACA;IACIG,mBAAmBA,CAAEJ,OAAO,EAAEC,OAAO,EAAE;MACrC;MACA,IAAI,CAACJ,cAAc,CAACK,GAAG,CAACF,OAAO,CAAC,EAAE;QAChCH,cAAc,CAACQ,GAAG,CAACL,OAAO,EAAE,IAAIM,GAAG,CAAC,CAAC,CAAC;MACxC;;MAEA;MAA4BT,cAAc,CAACM,GAAG,CAACH,OAAO,CAAC,CAAEO,GAAG,CAACN,OAAO,CAAC;IACvE;EACF,CAAC;AACH,CAAC;AAAC,IAAAO,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEad,YAAY;AAAAe,MAAA,CAAAF,OAAA,GAAAA,OAAA,CAAAC,OAAA","ignoreList":[]}
1
+ {"version":3,"file":"WarnSettings.cjs","names":["WarnSettings","warnedSettings","WeakMap","hasBeenWarned","context","setting","has","get","markSettingAsWarned","set","Set","add","_default","exports","default","module"],"sources":["../src/WarnSettings.js"],"sourcesContent":["const WarnSettings = function () {\n /** @type {WeakMap<object, Set<string>>} */\n const warnedSettings = new WeakMap();\n\n return {\n /**\n * Warn only once for each context and setting\n * @param {import('eslint').Rule.RuleContext} context\n * @param {string} setting\n * @returns {boolean}\n */\n hasBeenWarned (context, setting) {\n return warnedSettings.has(context) && /** @type {Set<string>} */ (\n warnedSettings.get(context)\n ).has(setting);\n },\n\n /**\n * @param {import('eslint').Rule.RuleContext} context\n * @param {string} setting\n * @returns {void}\n */\n markSettingAsWarned (context, setting) {\n // c8 ignore else\n if (!warnedSettings.has(context)) {\n warnedSettings.set(context, new Set());\n }\n\n /** @type {Set<string>} */ (warnedSettings.get(context)).add(setting);\n },\n };\n};\n\nexport default WarnSettings;\n"],"mappings":";;;;;;AAAA,MAAMA,YAAY,GAAG,SAAAA,CAAA,EAAY;EAC/B;EACA,MAAMC,cAAc,GAAG,IAAIC,OAAO,CAAC,CAAC;EAEpC,OAAO;IACL;AACJ;AACA;AACA;AACA;AACA;IACIC,aAAaA,CAAEC,OAAO,EAAEC,OAAO,EAAE;MAC/B,OAAOJ,cAAc,CAACK,GAAG,CAACF,OAAO,CAAC,IAAI,0BACpCH,cAAc,CAACM,GAAG,CAACH,OAAO,CAAC,CAC3BE,GAAG,CAACD,OAAO,CAAC;IAChB,CAAC;IAED;AACJ;AACA;AACA;AACA;IACIG,mBAAmBA,CAAEJ,OAAO,EAAEC,OAAO,EAAE;MACrC;MACA,IAAI,CAACJ,cAAc,CAACK,GAAG,CAACF,OAAO,CAAC,EAAE;QAChCH,cAAc,CAACQ,GAAG,CAACL,OAAO,EAAE,IAAIM,GAAG,CAAC,CAAC,CAAC;MACxC;;MAEA;MAA4BT,cAAc,CAACM,GAAG,CAACH,OAAO,CAAC,CAAEO,GAAG,CAACN,OAAO,CAAC;IACvE;EACF,CAAC;AACH,CAAC;AAAC,IAAAO,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEad,YAAY;AAAAe,MAAA,CAAAF,OAAA,GAAAA,OAAA,CAAAC,OAAA","ignoreList":[]}
@@ -2,16 +2,16 @@ export default WarnSettings;
2
2
  declare function WarnSettings(): {
3
3
  /**
4
4
  * Warn only once for each context and setting
5
- * @param {{}} context
5
+ * @param {import('eslint').Rule.RuleContext} context
6
6
  * @param {string} setting
7
7
  * @returns {boolean}
8
8
  */
9
- hasBeenWarned(context: {}, setting: string): boolean;
9
+ hasBeenWarned(context: import("eslint").Rule.RuleContext, setting: string): boolean;
10
10
  /**
11
- * @param {{}} context
11
+ * @param {import('eslint').Rule.RuleContext} context
12
12
  * @param {string} setting
13
13
  * @returns {void}
14
14
  */
15
- markSettingAsWarned(context: {}, setting: string): void;
15
+ markSettingAsWarned(context: import("eslint").Rule.RuleContext, setting: string): void;
16
16
  };
17
17
  //# sourceMappingURL=WarnSettings.d.ts.map
@@ -2,15 +2,15 @@ export default WarnSettings;
2
2
  declare function WarnSettings(): {
3
3
  /**
4
4
  * Warn only once for each context and setting
5
- * @param {{}} context
5
+ * @param {import('eslint').Rule.RuleContext} context
6
6
  * @param {string} setting
7
7
  * @returns {boolean}
8
8
  */
9
- hasBeenWarned(context: {}, setting: string): boolean;
9
+ hasBeenWarned(context: import("eslint").Rule.RuleContext, setting: string): boolean;
10
10
  /**
11
- * @param {{}} context
11
+ * @param {import('eslint').Rule.RuleContext} context
12
12
  * @param {string} setting
13
13
  * @returns {void}
14
14
  */
15
- markSettingAsWarned(context: {}, setting: string): void;
15
+ markSettingAsWarned(context: import("eslint").Rule.RuleContext, setting: string): void;
16
16
  };
@@ -80,7 +80,7 @@ export type RemoveTag = (tagIndex: Integer, cfg?: {
80
80
  removeEmptyBlock?: boolean;
81
81
  tagSourceOffset?: Integer;
82
82
  } | undefined) => void;
83
- export type AddTag = (targetTagName: string, number?: number | undefined, tokens?: {} | import("comment-parser").Tokens | undefined) => void;
83
+ export type AddTag = (targetTagName: string, number?: number | undefined, tokens?: Partial<import("comment-parser").Tokens> | undefined) => void;
84
84
  export type GetFirstLine = () => Integer | undefined;
85
85
  export type SeedTokens = (tokens?: Partial<import("comment-parser").Tokens> | undefined) => import("comment-parser").Tokens;
86
86
  /**
@@ -227,7 +227,7 @@ export type EslintRuleMeta = import("eslint").Rule.RuleMetaData;
227
227
  * A plain object for tracking state as needed by rules across iterations.
228
228
  */
229
229
  export type StateObject = {
230
- globalTags: {};
230
+ globalTags: boolean;
231
231
  hasDuplicates: {
232
232
  [key: string]: boolean;
233
233
  };
@@ -262,13 +262,13 @@ export function getPreferredTagName(jsdoc: import("./iterateJsdoc.js").JsdocBloc
262
262
  * @param {string} name
263
263
  * @param {ParserMode|undefined} mode
264
264
  * @param {TagNamePreference} tagPreference
265
- * @param {Reporter} context
265
+ * @param {import('eslint').Rule.RuleContext} context
266
266
  * @returns {string|false|{
267
267
  * message: string;
268
268
  * replacement?: string|undefined;
269
269
  * }}
270
270
  */
271
- export function getPreferredTagNameSimple(name: string, mode: ParserMode | undefined, tagPreference?: TagNamePreference, context?: Reporter): string | false | {
271
+ export function getPreferredTagNameSimple(name: string, mode: ParserMode | undefined, tagPreference?: TagNamePreference, context?: import("eslint").Rule.RuleContext): string | false | {
272
272
  message: string;
273
273
  replacement?: string | undefined;
274
274
  };
@@ -219,7 +219,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
219
219
  * @callback AddTag
220
220
  * @param {string} targetTagName
221
221
  * @param {Integer} [number]
222
- * @param {import('comment-parser').Tokens|{}} [tokens]
222
+ * @param {Partial<import('comment-parser').Tokens>} [tokens]
223
223
  * @returns {void}
224
224
  */
225
225
 
@@ -574,7 +574,7 @@ const {
574
574
  /**
575
575
  * A plain object for tracking state as needed by rules across iterations.
576
576
  * @typedef {{
577
- * globalTags: {},
577
+ * globalTags: boolean,
578
578
  * hasDuplicates: {
579
579
  * [key: string]: boolean
580
580
  * },