@mkaradeniz/eslint-config 5.1.0 → 5.3.0

package/base.mjs

@@ -1,5 +1,6 @@
 import { fileURLToPath } from 'node:url';
 import eslintPluginImportX from 'eslint-plugin-import-x';
+import eslintPluginJsdoc from 'eslint-plugin-jsdoc';
 import eslintPluginOnlyWarn from 'eslint-plugin-only-warn';
 import eslintPluginPerfectionist from 'eslint-plugin-perfectionist';
 import eslintPluginPreferArrowFunctions from 'eslint-plugin-prefer-arrow-functions';
@@ -83,6 +84,10 @@ export const baseConfig = [
        * https://github.com/un-ts/eslint-plugin-import-x
        */
       'import-x': eslintPluginImportX,
+      /**
+       * https://github.com/gajus/eslint-plugin-jsdoc
+       */
+      jsdoc: eslintPluginJsdoc,
       /**
        * https://github.com/bfanger/eslint-plugin-only-warn
        */
@@ -117,18 +122,6 @@ export const baseConfig = [
       '*.setup.ts',
       '**/*.stories.ts',
       '**/*.stories.tsx',
-      '*/app/**/error.tsx',
-      '*/app/**/global-error.tsx',
-      '*/app/**/layout.tsx',
-      '*/app/**/loading.tsx',
-      '*/app/**/not-found.tsx',
-      '*/app/**/opengraph-image.tsx',
-      '*/app/**/page.tsx',
-      '*/app/**/robots.ts',
-      '*/app/**/route.tsx',
-      '*/app/**/sitemap.ts',
-      '*/app/**/template.tsx',
-      '*/app/**/twitter-image.tsx',
       '*Config.mjs',
       '*Config.ts',
       '*config.js',
@@ -140,6 +133,15 @@ export const baseConfig = [
       'import-x/no-default-export': 'off',
     },
   },
+  {
+    files: ['**/env.ts', '**/env.client.ts', '**/env.server.ts', '**/seed.ts', '**/prisma.config.ts'],
+    rules: {
+      'no-restricted-syntax': [
+        'warn',
+        ...baseRules.rules['no-restricted-syntax'].slice(1).filter(selector => !selector.selector.includes('process')),
+      ],
+    },
+  },
   // Ignore patterns
   ...gitignoreConfig,
   { ignores: ['.next/**/*', 'dist/**/*', 'node_modules/**/*', 'out/**/*'] },

package/next.mjs

@@ -11,4 +11,49 @@ export const nextConfig = [
     },
   },
   { ...nextRules },
+  {
+    files: [
+      '*/app/**/default.tsx',
+      '*/app/**/error.tsx',
+      '*/app/**/apple-icon.tsx',
+      '*/app/**/forbidden.tsx',
+      '*/app/**/global-error.tsx',
+      '*/app/**/icon.tsx',
+      '*/app/**/layout.tsx',
+      '*/app/**/loading.tsx',
+      '*/app/**/manifest.ts',
+      '*/app/**/not-found.tsx',
+      '*/app/**/opengraph-image.tsx',
+      '*/app/**/page.tsx',
+      '*/app/**/robots.ts',
+      '*/app/**/route.tsx',
+      '*/app/**/sitemap.ts',
+      '*/app/**/template.tsx',
+      '*/app/**/twitter-image.tsx',
+      '*/app/**/unauthorized.tsx',
+      '**/instrumentation.ts',
+      '**/instrumentation-client.ts',
+      '**/mdx-components.tsx',
+      '**/middleware.ts',
+      '**/proxy.ts',
+    ],
+    rules: {
+      'import-x/no-default-export': ['off'],
+    },
+  },
+  {
+    files: [
+      '*/app/**/apple-icon.tsx',
+      '*/app/**/global-error.tsx',
+      '*/app/**/manifest.ts',
+      '*/app/**/not-found.tsx',
+      '*/app/**/opengraph-image.tsx',
+      '*/app/**/twitter-image.tsx',
+      '**/instrumentation-client.ts',
+      '**/mdx-components.tsx',
+    ],
+    rules: {
+      'unicorn/filename-case': ['off'],
+    },
+  },
 ];

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@mkaradeniz/eslint-config",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "private": false,
   "files": [
     "base.mjs",
     "web.mjs",
     "next.mjs",
     "react.mjs",
+    "shadcn.mjs",
     "turbo.mjs",
     "eslint.config.mjs",
     "rules/"
@@ -28,6 +29,7 @@
     "@next/eslint-plugin-next": "^16.1.6",
     "@stylistic/eslint-plugin": "^5.8.0",
     "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-jsdoc": "^62.5.5",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-only-warn": "^1.1.0",
     "eslint-plugin-perfectionist": "^5.5.0",

package/rules/baseRules.mjs

@@ -98,6 +98,22 @@ export const baseRules = {
         message: 'Use !isNotNullOrUndefined() instead of === undefined.',
         selector: 'BinaryExpression[operator="==="][right.type="Identifier"][right.name="undefined"]',
       },
+      {
+        message: 'Exported functions with >1 parameter must use a single object parameter.',
+        selector: 'ExportNamedDeclaration > VariableDeclaration > VariableDeclarator > ArrowFunctionExpression[params.length>1]',
+      },
+      {
+        message: 'No IIFEs — create a utils file instead.',
+        selector: 'CallExpression[callee.type="ArrowFunctionExpression"]',
+      },
+      {
+        message: 'No IIFEs — create a utils file instead.',
+        selector: 'CallExpression[callee.type="FunctionExpression"]',
+      },
+      {
+        message: 'Use envConfigClient or envConfigServer instead of process.env.',
+        selector: 'MemberExpression[object.name="process"][property.name="env"]',
+      },
     ],
     'no-return-assign': ['warn'],
     'no-script-url': ['warn'],
@@ -161,6 +177,26 @@ export const baseRules = {
     'import-x/no-relative-packages': ['warn'],
     'import-x/no-self-import': ['warn'],
     'import-x/no-useless-path-segments': ['warn'],
+    // jsdoc
+    'jsdoc/require-description': ['warn'],
+    'jsdoc/require-jsdoc': [
+      'warn',
+      {
+        contexts: [
+          'ExportNamedDeclaration > VariableDeclaration > VariableDeclarator > ArrowFunctionExpression',
+          'ExportNamedDeclaration > TSTypeAliasDeclaration > TSTypeLiteral > TSPropertySignature',
+          'ExportNamedDeclaration > TSInterfaceDeclaration > TSInterfaceBody > TSPropertySignature',
+        ],
+        require: {
+          ArrowFunctionExpression: false,
+          ClassDeclaration: false,
+          ClassExpression: false,
+          FunctionDeclaration: false,
+          FunctionExpression: false,
+          MethodDefinition: false,
+        },
+      },
+    ],
     // perfectionist
     'perfectionist/sort-enums': ['warn', { ignoreCase: false, order: 'asc', partitionByNewLine: true, type: 'alphabetical' }],
     'perfectionist/sort-interfaces': ['warn', { ignoreCase: false, order: 'asc', partitionByNewLine: true, type: 'alphabetical' }],

package/rules/reactRules.mjs

@@ -36,6 +36,13 @@ export const reactRules = {
             name: 'react',
           },
         ],
+        patterns: [
+          {
+            allowImportNamePattern: 'Icon$',
+            group: ['lucide-react'],
+            message: 'Always use the Icon postfix when importing from lucide-react (e.g. CrownIcon, not Crown).',
+          },
+        ],
       },
     ],
     'no-restricted-syntax': [
@@ -55,6 +62,7 @@ export const reactRules = {
     'react/iframe-missing-sandbox': ['warn'],
     'react/jsx-boolean-value': ['warn', 'always'],
     'react/jsx-curly-brace-presence': ['warn', { children: 'ignore', props: 'never' }],
+    'react/jsx-filename-extension': ['warn', { extensions: ['.tsx'] }],
     'react/jsx-fragments': ['warn'],
     'react/jsx-handler-names': ['warn', { checkLocalVariables: false, eventHandlerPrefix: 'handle', eventHandlerPropPrefix: 'on' }],
     'react/jsx-key': ['warn'],

package/rules/typescriptRules.mjs

@@ -105,6 +105,18 @@ export const typescriptRules = {
     '@typescript-eslint/prefer-optional-chain': ['warn'],
     '@typescript-eslint/prefer-readonly': ['warn'],
     '@typescript-eslint/require-await': ['warn'],
+    '@typescript-eslint/strict-boolean-expressions': [
+      'warn',
+      {
+        allowNullableBoolean: false,
+        allowNullableEnum: false,
+        allowNullableNumber: false,
+        allowNullableObject: false,
+        allowNullableString: false,
+        allowNumber: false,
+        allowString: false,
+      },
+    ],
     '@typescript-eslint/switch-exhaustiveness-check': ['warn'],
     '@typescript-eslint/triple-slash-reference': ['warn'],
     '@typescript-eslint/unified-signatures': ['warn'],

package/shadcn.mjs

@@ -0,0 +1,25 @@
+/**
+ * Relaxes rules for shadcn/ui generated components.
+ *
+ * Factory function because the path to shadcn components varies per project.
+ * Only rules that conflict with how shadcn structurally organizes code are disabled —
+ * style rules (arrow functions, prop sorting, imports, etc.) stay enforced.
+ *
+ * @example
+ * import { createShadcnConfig } from '@mkaradeniz/eslint-config/shadcn.mjs';
+ * export default [...reactConfig, ...createShadcnConfig('src/components/ui')];
+ */
+export const createShadcnConfig = (componentPath = '**/components/ui') => [
+  {
+    files: [`${componentPath}/**`],
+    rules: {
+      // shadcn prop types are wrappers around library types (Radix, Recharts) — self-documenting, JSDoc adds noise.
+      'jsdoc/require-description': ['off'],
+      'jsdoc/require-jsdoc': ['off'],
+      // shadcn ships multiple related components per file (e.g. Dialog, DialogTrigger, DialogContent).
+      'react/no-multi-comp': ['off'],
+      // shadcn CLI expects exact filenames like `dialog.tsx`, `dropdown-menu.tsx`. Renaming breaks `npx shadcn add`.
+      'unicorn/filename-case': ['off'],
+    },
+  },
+];