Refactor ESLint config and update changelog

Author: fabian-hiller

library/.eslintrc.cjs

@@ -41,23 +41,38 @@ module.exports = {
     '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/consistent-type-imports': 'warn',
     '@typescript-eslint/no-non-null-assertion': 'off',
+
+    // Imports
     'no-duplicate-imports': 'off',
     'import/extensions': ['error', 'always'],
-    'jsdoc/tag-lines': ['error', 'any', {
-      'startLines': 1,
-    }],
-    'jsdoc/sort-tags': ['error', { 'linesBetween': 1, "tagSequence": [{ "tags": ["deprecated"] }, { "tags": ["param"] }, { "tags": ["returns"] }] }],
+
+    // JSDoc
+    'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
+    'jsdoc/sort-tags': [
+      'error',
+      {
+        linesBetween: 1,
+        tagSequence: [
+          { tags: ['deprecated'] },
+          { tags: ['param'] },
+          { tags: ['returns'] },
+        ],
+      },
+    ],
     // NOTE: For overloads functions, we only require a JSDoc at the top
     // SEE: https://github.com/gajus/eslint-plugin-jsdoc/issues/666
-    "jsdoc/require-jsdoc": ["error", {
-      "contexts": [
-        'ExportNamedDeclaration[declaration.type="TSDeclareFunction"]:not(ExportNamedDeclaration[declaration.type="TSDeclareFunction"] + ExportNamedDeclaration[declaration.type="TSDeclareFunction"])',
-        'ExportNamedDeclaration[declaration.type="FunctionDeclaration"]:not(ExportNamedDeclaration[declaration.type="TSDeclareFunction"] + ExportNamedDeclaration[declaration.type="FunctionDeclaration"])',
-      ],
-      "require": {
-        "FunctionDeclaration": false
-      }
-    }],
+    'jsdoc/require-jsdoc': [
+      'error',
+      {
+        contexts: [
+          'ExportNamedDeclaration[declaration.type="TSDeclareFunction"]:not(ExportNamedDeclaration[declaration.type="TSDeclareFunction"] + ExportNamedDeclaration[declaration.type="TSDeclareFunction"])',
+          'ExportNamedDeclaration[declaration.type="FunctionDeclaration"]:not(ExportNamedDeclaration[declaration.type="TSDeclareFunction"] + ExportNamedDeclaration[declaration.type="FunctionDeclaration"])',
+        ],
+        require: {
+          FunctionDeclaration: false,
+        },
+      },
+    ],
 
     // Security
     'security/detect-object-injection': 'off', // Too many false positives

library/CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to the library will be documented in this file.
 ## vX.X.X (Month DD, YYYY)
 
 - Change structure of schemas, validations and transformations to make properties accessible (pull request #211)
+- Fix errors in JSDoc comments and add JSDoc ESLint plugin (pull request #205)
 
 ## v0.20.1 (November 2, 2023)