test: add require-jsdoc test

Author: brettz9

docs/rules/require-jsdoc.md

@@ -2018,6 +2018,29 @@ export function arrayMap<Target, Source extends AnyArrayType>(data: Source, call
 }
 // "jsdoc/require-jsdoc": ["error"|"warn", {"skipInterveningOverloadedDeclarations":true}]
 
+/**
+ * Array map function with overload for NonEmptyArray
+ * @example
+ * const data = [{value: 'value'}] as const;
+ * const result1: NonEmptyReadonlyArray<'value'> = arrayMap(data, (value) => value.value); // pick type from data
+ * const result2: NonEmptyReadonlyArray<'value'> = arrayMap<'value', typeof data>(data, (value) => value.value); // enforce output type
+ * @template Target - The type of the array to map to
+ * @template Source - The type of the array to map from
+ * @param {Source} data - The array to map
+ * @param {MapCallback<Target, Source>} callback - Callback function to map data from the array
+ * @returns {AnyArrayType<Target>} Mapped array
+ * @since v0.2.0
+ */
+export function arrayMap<Target, Source extends NonEmptyArray<unknown> | NonEmptyReadonlyArray<unknown>>(
+  data: Source,
+  callback: MapCallback<Target, Source>,
+): NonEmptyArray<Target>;
+export function arrayMap<Target, Source extends Array<unknown>>(data: Source, callback: MapCallback<Target, Source>): Array<Target>;
+export function arrayMap<Target, Source extends AnyArrayType>(data: Source, callback: MapCallback<Target, Source>): AnyArrayType<Target> {
+  return data.map(callback);
+}
+// "jsdoc/require-jsdoc": ["error"|"warn", {"contexts":["TSDeclareFunction"],"exemptOverloadedImplementations":false,"skipInterveningOverloadedDeclarations":true}]
+
 export interface A {
   a: string;
   /**

test/rules/assertions/requireJsdoc.js

@@ -6624,6 +6624,43 @@ function quux (foo) {
         },
       ],
     },
+    {
+      code: `
+        /**
+         * Array map function with overload for NonEmptyArray
+         * @example
+         * const data = [{value: 'value'}] as const;
+         * const result1: NonEmptyReadonlyArray<'value'> = arrayMap(data, (value) => value.value); // pick type from data
+         * const result2: NonEmptyReadonlyArray<'value'> = arrayMap<'value', typeof data>(data, (value) => value.value); // enforce output type
+         * @template Target - The type of the array to map to
+         * @template Source - The type of the array to map from
+         * @param {Source} data - The array to map
+         * @param {MapCallback<Target, Source>} callback - Callback function to map data from the array
+         * @returns {AnyArrayType<Target>} Mapped array
+         * @since v0.2.0
+         */
+        export function arrayMap<Target, Source extends NonEmptyArray<unknown> | NonEmptyReadonlyArray<unknown>>(
+          data: Source,
+          callback: MapCallback<Target, Source>,
+        ): NonEmptyArray<Target>;
+        export function arrayMap<Target, Source extends Array<unknown>>(data: Source, callback: MapCallback<Target, Source>): Array<Target>;
+        export function arrayMap<Target, Source extends AnyArrayType>(data: Source, callback: MapCallback<Target, Source>): AnyArrayType<Target> {
+          return data.map(callback);
+        }
+      `,
+      languageOptions: {
+        parser: typescriptEslintParser,
+      },
+      options: [
+        {
+          contexts: [
+            'TSDeclareFunction',
+          ],
+          exemptOverloadedImplementations: false,
+          skipInterveningOverloadedDeclarations: true,
+        },
+      ],
+    },
     {
       code: `
         export interface A {