Merge pull request #192 from AndreaPontrandolfo/AndreaPontrandolfo/is…

…sue182

feat(deps): Update  eslint-plugin-jsdoc to latest

.changeset/loud-dryers-boil.md

@@ -0,0 +1,6 @@
+---
+'eslint-config-sheriff': minor
+'sheriff-webservices': patch
+---
+
+feat(deps): Update eslint-plugin-jsdoc to latest. Closes #182

.changeset/violet-eyes-cover.md

@@ -0,0 +1,6 @@
+---
+'eslint-config-sheriff': patch
+'sheriff-webservices': patch
+---
+
+feat(deps): added @types/eslint-plugin-jsx-a11y

apps/config-validation-playground/src/samples/basic.ts

@@ -1,12 +1,18 @@
-// Function to add two numbers
+/**
+ * Function to add two numbers.
+ */
 export const addNumbers = function (a: number, b: number): number {
   return a + b;
 };
 
-// Function to check if a number is even
+/**
+ * Function to check if a number is even.
+ */
 export const isEven = (num: number): boolean => num % 2 === 0;
 
-// Function to calculate the factorial of a number
+/**
+ * Function to calculate the factorial of a number.
+ */
 export const factorial = (num: number): number => {
   if (num === 0 || num === 1) {
     return 1;
@@ -15,6 +21,8 @@ export const factorial = (num: number): number => {
   return num * factorial(num - 1);
 };
 
-// Function to calculate the sum of a list of numbers
+/**
+ * Function to calculate the sum of a list of numbers.
+ */
 export const sum = (numbers: number[]): number =>
   numbers.reduce((acc, curr) => acc + curr, 0);

apps/sheriff-webservices/package.json

@@ -16,6 +16,7 @@
   "devDependencies": {
     "@sherifforg/types": "workspace:*",
     "@tsconfig/node-lts": "^18.12.5",
+    "@types/eslint-plugin-jsx-a11y": "^6.9.0",
     "@types/lodash": "^4.17.6",
     "@types/node": "^20.14.10",
     "eslint-define-config": "^2.1.0",
@@ -37,7 +38,7 @@
     "eslint-plugin-fsecond": "^1.1.1",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^46.4.3",
+    "eslint-plugin-jsdoc": "^48.11.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-lodash-f": "^7.5.3",
     "eslint-plugin-playwright": "^0.12.0",

apps/sheriff-webservices/src/getAllRules.ts

@@ -3,7 +3,7 @@ import astro from 'eslint-plugin-astro';
 import fsecond from 'eslint-plugin-fsecond';
 import pluginImport from 'eslint-plugin-import';
 import jest from 'eslint-plugin-jest';
-import jsdoc from 'eslint-plugin-jsdoc'; // eslint-disable-line
+import jsdoc from 'eslint-plugin-jsdoc';
 import reactAccessibility from 'eslint-plugin-jsx-a11y';
 import lodashPlugin from 'eslint-plugin-lodash-f';
 import playwright from 'eslint-plugin-playwright';

package.json

@@ -34,11 +34,11 @@
     "knip": "^5.25.1",
     "prettier": "^3.3.2",
     "turbo": "^2.0.9",
-    "typesync": "^0.12.2"
+    "typesync": "^0.13.0"
   },
   "packageManager": "[email protected]",
   "engines": {
-    "node": ">=18.17.1"
+    "node": ">=20.10.0"
   },
   "pnpm": {
     "peerDependencyRules": {

packages/eslint-config-sheriff/package.json

@@ -68,7 +68,7 @@
     "eslint-plugin-fsecond": "^1.1.1",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^46.4.3",
+    "eslint-plugin-jsdoc": "^48.11.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-lodash-f": "^7.5.3",
     "eslint-plugin-playwright": "^0.12.0",
@@ -96,6 +96,7 @@
     "@arethetypeswrong/cli": "^0.9.0",
     "@sherifforg/constants": "workspace:*",
     "@sherifforg/types": "workspace:*",
+    "@types/eslint-plugin-jsx-a11y": "^6.9.0",
     "@types/lodash": "^4.17.6",
     "@types/node": "^20.14.10",
     "@typescript-eslint/utils": "^7.3.1",

packages/eslint-config-sheriff/src/handledModules.d.ts

@@ -2,13 +2,11 @@ declare module '@eslint/js';
 declare module '@next/eslint-plugin-next';
 declare module '@regru/eslint-plugin-prefer-early-return';
 declare module 'eslint-plugin-playwright';
-declare module 'eslint-plugin-jsdoc';
 declare module 'eslint-plugin-lodash-f';
 declare module 'eslint-plugin-import';
 declare module 'eslint-plugin-jest';
 declare module 'eslint-plugin-storybook';
 declare module 'eslint-plugin-react*';
-declare module 'eslint-plugin-jsx-a11y';
 declare module 'eslint-plugin-react-hooks';
 declare module 'eslint-plugin-react-refresh';
 declare module 'eslint-plugin-fsecond';

packages/eslint-config-sheriff/src/handpickedRules/jsdocHandPickedRules.ts

@@ -18,4 +18,5 @@ export const jsdocHandPickedRules = {
   ],
   'jsdoc/sort-tags': 2,
   'jsdoc/tag-lines': [2, 'any', { startLines: 1 }],
+  'jsdoc/convert-to-jsdoc-comments': 2,
 };