Merge pull request #528 from ixartz/update-from-max

fix: add jsdoc support in ESLint

Author: ixartz

.vscode/settings.json

@@ -9,7 +9,7 @@
   "typescript.tsdk": "node_modules/typescript/lib", // Use the workspace version of TypeScript
   "typescript.enablePromptUseWorkspaceTsdk": true, // For security reasons it's require that users opt into using the workspace version of typescript
   "typescript.preferences.autoImportSpecifierExcludeRegexes": [
-    // useRouter should be imported from `next/navigation` instead of `next/router`
+    // useRouter should be imported from `libs/I18nNavigation` instead of `next/router`
     "next/router",
     // give priority for Link to next/link instead of lucide-react
     "lucide-react",
@@ -18,7 +18,9 @@
     // Use Zod v4 instead of v3
     "zod/v3",
     // Sentry is imported with `import *`
-    "@sentry/nextjs"
+    "@sentry/nextjs",
+    // Use Input from Shadcn UI instead of Input from Postcss
+    "postcss"
   ],
 
   // Vitest

eslint.config.mjs

@@ -1,6 +1,7 @@
 import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import antfu from '@antfu/eslint-config';
+import jsdoc from 'eslint-plugin-jsdoc';
 import jsxA11y from 'eslint-plugin-jsx-a11y';
 import playwright from 'eslint-plugin-playwright';
 import storybook from 'eslint-plugin-storybook';
@@ -55,14 +56,22 @@ export default antfu(
   // --- Custom Rule Overrides ---
   {
     rules: {
+      // --- JSDoc Rules ---
+      // To avoid redefine errors with Antfu, JSDoc rules are added here
+      ...jsdoc.configs['flat/recommended-typescript'].rules,
+
       'antfu/no-top-level-await': 'off', // Allow top-level await
       'style/brace-style': ['error', '1tbs'], // Use the default brace style
       'ts/consistent-type-definitions': ['error', 'type'], // Use `type` instead of `interface`
       'react/prefer-destructuring-assignment': 'off', // Vscode doesn't support automatically destructuring, it's a pain to add a new variable
       'react-hooks/incompatible-library': 'off', // Disable warning for compilation skipped
+      'react-hooks/exhaustive-deps': 'off', // Disable exhaustive-deps in useEffect
       'node/prefer-global/process': 'off', // Allow using `process.env`
       'test/padding-around-all': 'error', // Add padding in test files
       'test/prefer-lowercase-title': 'off', // Allow using uppercase titles in test titles
+      'jsdoc/require-jsdoc': 'off', // JSDoc comments are optional
+      'jsdoc/require-returns': 'off', // Return types are optional
+      'jsdoc/require-hyphen-before-param-description': 'error', // Enforce hyphen before param description
     },
   },
 );

package-lock.json

@@ -83,6 +83,7 @@
     "drizzle-kit": "^0.31.8",
     "eslint": "^9.39.2",
     "eslint-plugin-format": "^1.3.1",
+    "eslint-plugin-jsdoc": "^62.5.4",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-playwright": "^2.5.1",
     "eslint-plugin-react-hooks": "^7.0.1",

package.json

@@ -15,24 +15,25 @@ export default defineConfig<ChromaticConfig>({
   // Look for files with the .spec.js or .e2e.js extension
   testMatch: '*.@(spec|e2e).?(c|m)[jt]s?(x)',
   // Timeout per test, test running locally are slower due to database connections with PGLite
-  timeout: 60 * 1000,
+  timeout: 30 * 1000,
   // Fail the build on CI if you accidentally left test.only in the source code.
   forbidOnly: !!process.env.CI,
   // Reporter to use. See https://playwright.dev/docs/test-reporters
   reporter: process.env.CI ? 'github' : 'list',
 
   expect: {
     // Set timeout for async expect matchers
-    timeout: 20 * 1000,
+    timeout: 15 * 1000,
   },
 
   // Run your local dev server before starting the tests:
   // https://playwright.dev/docs/test-advanced#launching-a-development-web-server-during-the-tests
   webServer: {
-    command: process.env.CI ? 'npx run-p db-server:memory start' : 'npx run-p db-server:memory dev:next',
+    command: process.env.CI ? 'npx run-p db-server:memory start --race' : 'npx run-p db-server:memory dev:next --race',
     url: baseURL,
-    timeout: 2 * 60 * 1000,
+    timeout: 60 * 1000,
     reuseExistingServer: !process.env.CI,
+    gracefulShutdown: { signal: 'SIGTERM', timeout: 2 * 1000 },
     env: {
       NEXT_PUBLIC_SENTRY_DISABLED: 'true',
     },

playwright.config.ts

@@ -1,7 +1,7 @@
 import { SignOutButton } from '@clerk/nextjs';
 import { getTranslations, setRequestLocale } from 'next-intl/server';
-import Link from 'next/link';
 import { LocaleSwitcher } from '@/components/LocaleSwitcher';
+import { Link } from '@/libs/I18nNavigation';
 import { BaseTemplate } from '@/templates/BaseTemplate';
 
 export default async function DashboardLayout(props: {

public/assets/images/posthog-logo.svg

@@ -1,7 +1,7 @@
 import { getTranslations, setRequestLocale } from 'next-intl/server';
-import Link from 'next/link';
 import { DemoBanner } from '@/components/DemoBanner';
 import { LocaleSwitcher } from '@/components/LocaleSwitcher';
+import { Link } from '@/libs/I18nNavigation';
 import { BaseTemplate } from '@/templates/BaseTemplate';
 
 export default async function Layout(props: {

src/app/[locale]/(auth)/dashboard/layout.tsx

@@ -1,7 +1,7 @@
 import type { Metadata } from 'next';
 import { getTranslations, setRequestLocale } from 'next-intl/server';
 import Image from 'next/image';
-import Link from 'next/link';
+import { Link } from '@/libs/I18nNavigation';
 
 type IPortfolioProps = {
   params: Promise<{ locale: string }>;

src/app/[locale]/(marketing)/layout.tsx

@@ -2,8 +2,8 @@
 
 import { zodResolver } from '@hookform/resolvers/zod';
 import { useTranslations } from 'next-intl';
-import { useRouter } from 'next/navigation';
 import { useForm } from 'react-hook-form';
+import { useRouter } from '@/libs/I18nNavigation';
 import { CounterValidation } from '@/validations/CounterValidation';
 
 export const CounterForm = () => {