Fix(eslint-config-base): Require empty line after description in JSDoc

* @see: gajus/eslint-plugin-jsdoc#847 * @see: gajus/eslint-plugin-jsdoc#1031 * @see: https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v42.0.0 refs #158
lmc-eu · Dec 13, 2023 · b501d6f · b501d6f
1 parent d6b37cb
commit b501d6f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/eslint-config-base/optional.js b/packages/eslint-config-base/optional.js
@@ -173,6 +173,11 @@ module.exports = {
     // @see: https://github.com/lmc-eu/cookie-consent-manager/pull/120
     // https://github.com/gajus/eslint-plugin-jsdoc#require-returns-description
     'jsdoc/require-returns-description': ['off'],
+
+    // Require an empty line after description to ensure better readability
+    // @see: https://github.com/lmc-eu/code-quality-tools/issues/158
+    // https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md
+    'jsdoc/tag-lines': ['warn', 'any', { startLines: 1 }],
   },
 
   overrides: [