eslint-config-dolmios 2.0.4 → 2.0.5

package/README.md

@@ -13,7 +13,7 @@ This ESLint configuration is designed for use with ESLint v9, which uses a flat
 ### Setting Up ESLint
 1.  **Create an ESLint Configuration File**: In the root of your project, create a file named  `eslint.config.js`.
 
-2.  **Import and Extend the Configuration**: Add the following content to  `eslint.config.mjs`  to use the  `eslint-config-dolmios`  configuration:
+2.  **Import and Extend the Configuration**: Add the following content to  `eslint.config.js`  to use the  `eslint-config-dolmios`  configuration:
 
 
 ```js
@@ -25,6 +25,30 @@ export default [
 ];
 ```
 
+### Features
+
+- **TypeScript Support**: Comprehensive TypeScript linting with strict type checking
+- **React Best Practices**: Rules for React and React Hooks
+- **Accessibility**: A11y rules to ensure your app is accessible
+- **Next.js Optimization**: Includes Next.js Core Web Vitals rules for performance optimization
+- **Code Organization**: Perfectionist plugin for consistent code organization
+- **Modern JavaScript**: Enforces modern JavaScript practices
+
+### Next.js Compatibility
+
+This configuration automatically detects your Next.js project structure and adjusts accordingly:
+
+- **App Router Support**: Works with Next.js App Router projects
+- **Pages Router Support**: Works with Next.js Pages Router projects
+- **Non-Next.js Projects**: Works with regular React projects without Next.js
+
+The configuration automatically detects:
+- If you're using Next.js (by checking for `next.config.js`)
+- If you're using App Router (by checking for an `app` directory)
+- If you're using Pages Router (by checking for `pages` or `src/pages` directories)
+
+Rules like `no-html-link-for-pages` are only enabled when a Pages Router is detected.
+
 ---
 
 ### Usage with Prettier

package/eslint.config.js

@@ -28,8 +28,7 @@ export default [
       '**/eslint.config.js',
       '**/eslint.config.mjs',
       '**/eslint.config.cjs',
-      '**/next.config.js',
-      '**/next-sitemap.config.js'
+      '**/next.config.js'
     ],
   },
   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-dolmios",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "A simple ESLint config with Prettier and a couple TSConfig setups",
   "author": "Jackson Dolman <mail@dolmios.com>",
   "bugs": {

package/rules.js

@@ -2,15 +2,15 @@
 
 // TypeScript specific rules
 const typescriptRules = {
+    '@typescript-eslint/ban-ts-comment': ['warn', { 'ts-ignore': 'allow-with-description' }],
     '@typescript-eslint/explicit-function-return-type': 'warn',
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/no-inferrable-types': 'warn',
     '@typescript-eslint/no-non-null-assertion': 'warn',
     '@typescript-eslint/no-unused-vars': [
         'warn',
-        { args: 'none', ignoreRestSiblings: true, argsIgnorePattern: '^_' },
+        { args: 'none', argsIgnorePattern: '^_', ignoreRestSiblings: true },
     ],
-    '@typescript-eslint/no-explicit-any': 'warn',
-    '@typescript-eslint/ban-ts-comment': ['warn', { 'ts-ignore': 'allow-with-description' }],
-    '@typescript-eslint/no-inferrable-types': 'warn',
     '@typescript-eslint/prefer-as-const': 'warn',
     'no-unused-vars': 'off',
 };
@@ -39,6 +39,8 @@ const a11yRules = {
 
 // React specific rules
 const reactRules = {
+    'react-hooks/exhaustive-deps': 'warn',
+    'react-hooks/rules-of-hooks': 'error',
     'react/button-has-type': 'warn',
     'react/destructuring-assignment': 'warn',
     'react/display-name': 'off',
@@ -73,27 +75,25 @@ const reactRules = {
     'react/sort-comp': 'warn',
     'react/style-prop-object': 'warn',
     'react/void-dom-elements-no-children': 'warn',
-    'react-hooks/exhaustive-deps': 'warn',
-    'react-hooks/rules-of-hooks': 'error',
 };
 
 // Next.js rules
 const nextRules = {
-    '@next/next/no-html-link-for-pages': 'warn',
-    '@next/next/no-img-element': 'warn',
-    '@next/next/no-unwanted-polyfillio': 'warn',
-    '@next/next/no-css-tags': 'warn',
-    '@next/next/no-sync-scripts': 'warn',
     '@next/next/google-font-display': 'warn',
     '@next/next/google-font-preconnect': 'warn',
     '@next/next/next-script-for-ga': 'warn',
+    '@next/next/no-css-tags': 'warn',
+    '@next/next/no-html-link-for-pages': 'off',
+    '@next/next/no-img-element': 'warn',
     '@next/next/no-page-custom-font': 'warn',
+    '@next/next/no-sync-scripts': 'warn',
+    '@next/next/no-unwanted-polyfillio': 'warn',
 };
 
 // Perfectionist rules
 const perfectionistRules = {
-    'perfectionist/sort-objects': ['warn', { order: 'asc', type: 'natural' }],
     'perfectionist/sort-imports': ['warn', { order: 'asc', type: 'natural' }],
+    'perfectionist/sort-objects': ['warn', { order: 'asc', type: 'natural' }],
 };
 
 // General JavaScript rules
@@ -113,7 +113,7 @@ const generalRules = {
     'no-label-var': 'warn',
     'no-labels': 'warn',
     'no-lone-blocks': 'warn',
-    'no-mixed-requires': ['warn', { grouping: true, allowCall: false }],
+    'no-mixed-requires': ['warn', { allowCall: false, grouping: true }],
     'no-multi-spaces': 'warn',
     'no-multi-str': 'warn',
     'no-multiple-empty-lines': [