lint jsdoc

Author: severo

eslint.config.js

@@ -4,6 +4,7 @@ import { includeIgnoreFile } from '@eslint/compat'
 import js from '@eslint/js'
 import stylistic from '@stylistic/eslint-plugin'
 import { defineConfig } from 'eslint/config'
+import jsdoc from 'eslint-plugin-jsdoc'
 import simpleImportSort from 'eslint-plugin-simple-import-sort'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
@@ -13,15 +14,30 @@ const gitignorePath = fileURLToPath(new URL('.gitignore', import.meta.url))
 export default defineConfig([
   includeIgnoreFile(gitignorePath, 'Imported .gitignore patterns'),
   {
-    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
-    plugins: { js, '@stylistic': stylistic, 'simple-import-sort': simpleImportSort },
+    files: ['**/*.{ts,js}'],
+    plugins: { js, '@stylistic': stylistic },
     extends: ['js/recommended'],
     languageOptions: { globals: { ...globals.browser, ...globals.node } },
+  },
+  tseslint.configs.recommended,
+  stylistic.configs.recommended,
+  jsdoc.configs['flat/recommended-error'],
+  {
+    files: ['**/*.{js,ts}'],
+    plugins: { 'simple-import-sort': simpleImportSort, jsdoc },
     rules: {
       'simple-import-sort/imports': 'error',
       'simple-import-sort/exports': 'error',
+      'jsdoc/require-yields-type': 'off',
+      'jsdoc/require-param-type': 'off',
+      'jsdoc/require-returns-type': 'off',
     },
   },
-  tseslint.configs.recommended,
-  stylistic.configs.recommended,
+  {
+    files: ['tests/*.ts'],
+    rules: {
+      'jsdoc/require-jsdoc': 'off',
+    },
+  },
+
 ])

package-lock.json

@@ -43,6 +43,7 @@
     "@vitest/coverage-v8": "4.0.7",
     "bumpp": "10.3.1",
     "eslint": "9.39.1",
+    "eslint-plugin-jsdoc": "^61.1.12",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "globals": "16.5.0",
     "tsdown": "0.16.0",

package.json

@@ -1,12 +1,8 @@
 /**
  * Throws if the provided value is not a strictly positive integer. Undefined is allowed.
- *
  * @param value The desired value.
  * @returns The validated value: a strictly positive integer.
  */
-export function checkStrictlyPositiveInteger(value?: undefined): undefined
-export function checkStrictlyPositiveInteger(value: number): number
-export function checkStrictlyPositiveInteger(value?: number): number | undefined
 export function checkStrictlyPositiveInteger(value?: number): number | undefined {
   if (
     value === undefined
@@ -22,13 +18,9 @@ export function checkStrictlyPositiveInteger(value?: number): number | undefined
 
 /**
  * Throws if the provided value is not a non-negative integer. Undefined is allowed.
- *
  * @param value The desired value.
  * @returns The validated value: a non-negative integer.
  */
-export function checkNonNegativeInteger(value?: undefined): undefined
-export function checkNonNegativeInteger(value: number): number
-export function checkNonNegativeInteger(value?: number): number | undefined
 export function checkNonNegativeInteger(value?: number): number | undefined {
   if (
     value === undefined