eslint-plugin-jsdoc 61.2.0 → 61.2.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.
@@ -70,7 +70,7 @@ export type SetBlockDescription = (setter: (info: {
70
70
  delimiter: string;
71
71
  postDelimiter: string;
72
72
  start: string;
73
- }, seedTokens: (tokens?: Partial<import("comment-parser").Tokens>) => import("comment-parser").Tokens, descLines: string[]) => import("comment-parser").Line[]) => void;
73
+ }, seedTokens: (tokens?: Partial<import("comment-parser").Tokens>) => import("comment-parser").Tokens, descLines: string[], postDelims: string[]) => import("comment-parser").Line[]) => void;
74
74
  export type SetDescriptionLines = (matcher: RegExp, setter: (description: string) => string) => Integer;
75
75
  export type ChangeTag = (tag: import("comment-parser").Spec, ...tokens: Partial<import("comment-parser").Tokens>[]) => void;
76
76
  export type SetTag = (tag: import("comment-parser").Spec & {
@@ -90,7 +90,7 @@ export type EmptyTokens = (tokens: import("comment-parser").Tokens) => void;
90
90
  export type AddLine = (sourceIndex: Integer, tokens: Partial<import("comment-parser").Tokens>) => void;
91
91
  export type AddLines = (tagIndex: Integer, tagSourceOffset: Integer, numLines: Integer) => void;
92
92
  export type MakeMultiline = () => void;
93
- export type GetFunctionParameterNames = (useDefaultObjectProperties?: boolean | undefined) => import("./jsdocUtils.js").ParamNameInfo[];
93
+ export type GetFunctionParameterNames = (useDefaultObjectProperties?: boolean | undefined, ignoreInterfacedParameters?: boolean | undefined) => import("./jsdocUtils.js").ParamNameInfo[];
94
94
  export type HasParams = () => Integer;
95
95
  export type IsGenerator = () => boolean;
96
96
  export type IsConstructor = () => boolean;
@@ -176,10 +176,11 @@ export function getContextObject(contexts: import("./iterateJsdoc.js").Context[]
176
176
  /**
177
177
  * @param {ESTreeOrTypeScriptNode|null} functionNode
178
178
  * @param {boolean} [checkDefaultObjects]
179
+ * @param {boolean} [ignoreInterfacedParameters]
179
180
  * @throws {Error}
180
181
  * @returns {ParamNameInfo[]}
181
182
  */
182
- export function getFunctionParameterNames(functionNode: ESTreeOrTypeScriptNode | null, checkDefaultObjects?: boolean): ParamNameInfo[];
183
+ export function getFunctionParameterNames(functionNode: ESTreeOrTypeScriptNode | null, checkDefaultObjects?: boolean, ignoreInterfacedParameters?: boolean): ParamNameInfo[];
183
184
  /**
184
185
  * @param {import('eslint').SourceCode|{
185
186
  * text: string
@@ -177,7 +177,8 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
177
177
  * seedTokens: (
178
178
  * tokens?: Partial<import('comment-parser').Tokens>
179
179
  * ) => import('comment-parser').Tokens,
180
- * descLines: string[]
180
+ * descLines: string[],
181
+ * postDelims: string[]
181
182
  * ) => import('comment-parser').Line[]} setter
182
183
  * @returns {void}
183
184
  */
@@ -264,6 +265,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
264
265
  /**
265
266
  * @callback GetFunctionParameterNames
266
267
  * @param {boolean} [useDefaultObjectProperties]
268
+ * @param {boolean} [ignoreInterfacedParameters]
267
269
  * @returns {import('./jsdocUtils.js').ParamNameInfo[]}
268
270
  */
269
271
 
@@ -842,6 +844,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
842
844
  utils.setBlockDescription = setter => {
843
845
  /** @type {string[]} */
844
846
  const descLines = [];
847
+ /** @type {string[]} */
848
+ const postDelims = [];
845
849
  /**
846
850
  * @type {undefined|Integer}
847
851
  */
@@ -884,6 +888,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
884
888
  endIdx = idx;
885
889
  return true;
886
890
  }
891
+ postDelims.push(postDelimiter);
887
892
  descLines.push(description);
888
893
  return false;
889
894
  });
@@ -898,7 +903,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
898
903
  * start: string
899
904
  * }}
900
905
  */
901
- info, seedTokens, descLines));
906
+ info, seedTokens, descLines, postDelims));
902
907
  }
903
908
  };
904
909
 
@@ -1208,8 +1213,8 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
1208
1213
  utils.flattenRoots = jsdocUtils.flattenRoots;
1209
1214
 
1210
1215
  /** @type {GetFunctionParameterNames} */
1211
- utils.getFunctionParameterNames = useDefaultObjectProperties => {
1212
- return jsdocUtils.getFunctionParameterNames(node, useDefaultObjectProperties);
1216
+ utils.getFunctionParameterNames = (useDefaultObjectProperties, ignoreInterfacedParameters) => {
1217
+ return jsdocUtils.getFunctionParameterNames(node, useDefaultObjectProperties, ignoreInterfacedParameters);
1213
1218
  };
1214
1219
 
1215
1220
  /** @type {HasParams} */