@vijayhardaha/dev-config 1.1.3 → 2.0.0

package/README.md

@@ -6,6 +6,8 @@
 
 Reusable development configuration package for Next.js + TypeScript projects.
 
+> **v2.0.0** — Requires ESLint >=10. Native flat config only. No FlatCompat.
+
 ## Features
 
 - **ESLint** - Modular flat config with support for JavaScript, TypeScript, React, and Next.js
@@ -19,59 +21,66 @@ Reusable development configuration package for Next.js + TypeScript projects.
 ## Installation
 
 ```bash
-bun install @vijayhardaha/dev-config --save-dev
+bun install @vijayhardaha/dev-config --dev
 ```
 
 ### Install Required Packages
 
 ```bash
-bun add --save-dev eslint@9.39.4 @eslint/js@9.39.4 prettier @prettier/plugin-xml @eslint/compat @eslint/eslintrc eslint-config-prettier eslint-plugin-prettier globals  eslint-plugin-jsdoc eslint-plugin-import eslint-import-resolver-typescript typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser
+bun add --dev eslint prettier @prettier/plugin-xml eslint-plugin-prettier globals eslint-plugin-jsdoc eslint-plugin-import-x typescript typescript-eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser
 ```
 
 ### Install Optional Packages
 
-### Typescript
-
-```bash
-bun add --save-dev typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser
-```
-
-### Prettier
-
-```bash
-bun add --save-dev prettier @prettier/plugin-xml
-```
-
 #### Stylelint
 
 ```bash
-bun add --save-dev stylelint stylelint-config-property-sort-order-smacss stylelint-config-standard-scss stylelint-order
+bun add --dev stylelint stylelint-config-property-sort-order-smacss stylelint-config-standard-scss stylelint-order
 ```
 
 #### React
 
 ```bash
-bun add --save-dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
+bun add --dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
 ```
 
 #### Next.js
 
 ```bash
-bun add --save-dev @next/eslint-plugin-next@15.5.15 eslint-config-next@15.5.15
+bun add --dev @next/eslint-plugin-next eslint-config-next
 ```
 
 #### Commitlint
 
 ```bash
-bun add --save-dev husky @commitlint/cli @commitlint/config-conventional @commitlint/types
+bun add --dev husky @commitlint/cli @commitlint/config-conventional @commitlint/types
 ```
 
 #### Next Sitemap
 
 ```bash
-bun add --save-dev next-sitemap
+bun add --dev next-sitemap
 ```
 
+## Migrating from v1
+
+v2 drops FlatCompat and uses native ESLint 10 flat configs throughout.
+
+### What changed
+
+- **ESLint 10 required** — no longer compatible with ESLint 8/9
+- **No FlatCompat** — all configs import flat config arrays/objects directly
+- **`eslint-plugin-import` → `eslint-plugin-import-x`** — the ESLint 10-compatible fork
+- **`eslint-config-prettier` removed** — bundled in `eslint-plugin-prettier/recommended`
+- **`@eslint/js` removed** — no longer needed without FlatCompat
+- **`plugins` option now accepts flat config arrays/objects** — no string-based plugin names
+
+### Required updates
+
+1. Install ESLint 10+: `bun add --dev eslint@10`
+2. Replace `eslint-plugin-import` with `eslint-plugin-import-x`
+3. Remove unused deps: `@eslint/compat`, `@eslint/eslintrc`, `@eslint/js`, `eslint-config-prettier`, `eslint-import-resolver-typescript`
+
 ## Quick Start
 
 ### ESLint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vijayhardaha/dev-config",
-  "version": "1.1.3",
+  "version": "2.0.0",
   "description": "Reusable development configurations for Next.js + TypeScript projects",
   "scripts": {
     "lint": "eslint .",
@@ -58,12 +58,11 @@
     "typescript"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^21.0.1",
-    "@commitlint/config-conventional": "^21.0.1",
+    "@commitlint/cli": "^21.0.2",
+    "@commitlint/config-conventional": "^21.0.2",
     "@commitlint/types": "^21.0.1",
-    "@prettier/plugin-xml": "^3.4.2",
-    "@vijayhardaha/dev-config": "^1.1.2",
     "@vitest/coverage-v8": "^4.1.7",
+    "eslint-config-next": "^16.2.6",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
@@ -73,26 +72,24 @@
     "stylelint-config-property-sort-order-smacss": "^11.2.0",
     "stylelint-config-standard-scss": "^17.0.0",
     "stylelint-order": "^8.1.1",
-    "typescript": "^6.0.3",
     "vitest": "^4.1.7"
   },
+  "dependencies": {
+    "@eslint/compat": "^2.1.0"
+  },
   "peerDependencies": {
-    "@eslint/compat": ">=2",
-    "@eslint/eslintrc": ">=3",
-    "@eslint/js": ">=9",
     "@prettier/plugin-xml": ">=3",
     "@typescript-eslint/eslint-plugin": ">=8",
     "@typescript-eslint/parser": ">=8",
-    "eslint-config-prettier": ">=10",
-    "eslint-import-resolver-typescript": ">=4",
-    "eslint-plugin-import": ">=2",
+    "eslint": ">=10",
+    "eslint-plugin-import-x": ">=4",
     "eslint-plugin-jsdoc": ">=62",
     "eslint-plugin-prettier": ">=5",
-    "eslint": ">=9",
     "globals": ">=17",
     "husky": ">=9",
     "prettier": "^3.8.3",
-    "typescript": ">=6"
+    "typescript": ">=6",
+    "typescript-eslint": ">=8"
   },
   "peerDependenciesMeta": {
     "@commitlint/cli": {

package/src/eslint/index.js

@@ -9,9 +9,7 @@
  * =====================================================================
  */
 
-import { setup, buildConfig, files } from './lib/index.js';
-
-const { compat } = setup();
+import { buildConfig, files } from './lib/index.js';
 
 /**
  * Creates an ESLint configuration object with optional features.
@@ -35,7 +33,6 @@ export const createConfig = (options = {}) => {
   const { prettier = true, importOrder = true, jsdoc = true } = options;
 
   return buildConfig({
-    compat,
     files: [...files.withoutTs, ...(options.files || [])],
     options: { ...options, prettier, importOrder, jsdoc },
   });

package/src/eslint/lib/build-config.js

@@ -1,4 +1,9 @@
+import { fixupPluginRules } from '@eslint/compat';
 import { defineConfig } from 'eslint/config';
+import importX from 'eslint-plugin-import-x';
+import jsdocPlugin from 'eslint-plugin-jsdoc';
+import prettierRecommended from 'eslint-plugin-prettier/recommended';
+import tsEslint from 'typescript-eslint';
 
 import { globalIgnores } from './ignores.js';
 import { commonLanguageOptions } from './language-options.js';
@@ -9,10 +14,9 @@ import { commonParser } from './setup.js';
  * Builds a common ESLint configuration with support for various options.
  *
  * @param {object} config - Configuration options.
- * @param {object} config.compat - FlatCompat instance.
  * @param {string[]} config.files - File patterns to apply the config to.
- * @param {string[]} config.builtinPlugins - Plugin configs to always include (e.g., 'plugin:@typescript-eslint/recommended').
- * @param {object} config.conditionalPlugins - Conditional plugins based on options (e.g., { prettier: true, importOrder: true }).
+ * @param {(Array|object)[]} config.builtinPlugins - Flat config arrays or objects to always include.
+ * @param {object} config.conditionalPlugins - Conditional plugins based on options (e.g., { react: true, a11y: true }).
  * @param {object} [config.languageOptions] - Additional language options.
  * @param {object} [config.parserOptions] - Parser options.
  * @param {object} [config.settings] - Settings object.
@@ -23,7 +27,6 @@ import { commonParser } from './setup.js';
  * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
  */
 export const buildConfig = ({
-  compat,
   files: filePatterns,
   builtinPlugins = [],
   conditionalPlugins = {},
@@ -54,9 +57,9 @@ export const buildConfig = ({
 
   const builtPlugins = [
     ...builtinPlugins,
-    importOrder && 'plugin:import/recommended',
-    jsdoc && 'plugin:jsdoc/recommended',
-    prettier && 'plugin:prettier/recommended',
+    importOrder && importX.flatConfigs.recommended,
+    jsdoc && jsdocPlugin.configs['flat/recommended'],
+    prettier && prettierRecommended,
     ...conditionalPluginList,
   ].filter(Boolean);
 
@@ -66,6 +69,7 @@ export const buildConfig = ({
   const configObject = {
     files: [...filePatterns],
     ...(ignores && { ignores }),
+    ...(typescript && { plugins: { '@typescript-eslint': tsEslint.plugin } }),
     languageOptions: {
       ...commonLanguageOptions,
       ...(typescript && commonParser),
@@ -74,7 +78,7 @@ export const buildConfig = ({
       ...(typescript && { parserOptions: { tsconfigRootDir: process.cwd(), ...parserOptions } }),
     },
     settings: {
-      ...(importOrder && { 'import/resolver': { typescript: {} } }),
+      ...(importOrder && { 'import-x/resolver': { typescript: {} } }),
       ...(jsdoc && { jsdoc: { mode: 'typescript' } }),
       ...extraSettings,
       ...settings,
@@ -86,5 +90,27 @@ export const buildConfig = ({
   // Merge user global ignores with common global ignores
   const mergedGlobalIgnores = Array.isArray(userGlobalIgnores) ? globalIgnores(userGlobalIgnores) : globalIgnores();
 
-  return defineConfig([...mergedGlobalIgnores, ...compat.extends(...plugins), configObject]);
+  // Collect all flat configs (arrays spread, objects added directly)
+  const flatConfigs = [];
+
+  for (const plugin of plugins) {
+    if (Array.isArray(plugin)) {
+      flatConfigs.push(...plugin);
+    } else if (typeof plugin === 'object' && plugin !== null) {
+      flatConfigs.push(plugin);
+    }
+  }
+
+  // Wrap plugins with fixupPluginRules for ESLint 10 backward compatibility
+  // (addresses removed APIs like context.getFilename in eslint-plugin-react)
+  const fixedConfigs = flatConfigs.map((config) => {
+    if (!config.plugins) return config;
+    const fixed = { ...config, plugins: {} };
+    for (const [name, plugin] of Object.entries(config.plugins)) {
+      fixed.plugins[name] = fixupPluginRules(plugin);
+    }
+    return fixed;
+  });
+
+  return defineConfig([...mergedGlobalIgnores, ...fixedConfigs, configObject]);
 };

package/src/eslint/lib/build-config.test.js

@@ -17,14 +17,36 @@ describe('eslint/lib/build-config.js', () => {
     const module = await import('./build-config.js');
 
     // Import dependencies needed for the test.
-    const { setup } = await import('./setup.js');
     const { files } = await import('./files.js');
-    const { compat } = setup();
 
-    // Call buildConfig with test parameters (compat, JS-only files, empty options).
-    const result = module.buildConfig({ compat, files: files.withoutTs, options: {} });
+    // Call buildConfig with test parameters (JS-only files, empty options).
+    const result = module.buildConfig({ files: files.withoutTs, options: {} });
 
     // Verify that the result is an array (ESLint expects configs as an array).
     expect(Array.isArray(result)).toBe(true);
   });
+
+  // Test that buildConfig handles flat config arrays and objects.
+  it('should handle flat config arrays and objects', async () => {
+    const module = await import('./build-config.js');
+    const { files } = await import('./files.js');
+
+    // A flat config array (simulating eslint-config-next export)
+    const flatConfigArray = [{ name: 'test-flat-config', plugins: {}, rules: { 'no-console': 'warn' } }];
+
+    // A flat config object
+    const flatConfigObject = { name: 'test-flat-object', plugins: {}, rules: { 'no-debugger': 'warn' } };
+
+    const result = module.buildConfig({
+      files: files.withTs,
+      builtinPlugins: [flatConfigArray, flatConfigObject],
+      options: {},
+    });
+
+    expect(Array.isArray(result)).toBe(true);
+    // Should contain configs from the flat config array and object
+    const configNames = result.filter((c) => c.name).map((c) => c.name);
+    expect(configNames).toContain('test-flat-config');
+    expect(configNames).toContain('test-flat-object');
+  });
 });

package/src/eslint/lib/index.js

@@ -1,3 +1,2 @@
-export { setup } from './setup.js';
 export { files } from './files.js';
 export { buildConfig } from './build-config.js';

package/src/eslint/lib/index.test.js

@@ -2,15 +2,6 @@ import { describe, it, expect } from 'vitest';
 
 // Test suite for the ESLint lib module's main entry point.
 describe('eslint/lib/index.js', () => {
-  // Test that the module exports the setup function.
-  it('should export setup function', async () => {
-    // Dynamically import the index module to test its exports.
-    const module = await import('./index.js');
-
-    // Verify that setup is a function.
-    expect(typeof module.setup).toBe('function');
-  });
-
   // Test that the module exports a files object with TypeScript and non-TypeScript file arrays.
   it('should export files object', async () => {
     // Dynamically import the index module to test its exports.

package/src/eslint/lib/rules.js

@@ -116,7 +116,7 @@ const prettierRules = (prettier = true) => (prettier ? { 'prettier/prettier': 'w
 const importOrderRules = (importOrder = true) =>
   importOrder
     ? {
-        'import/order': [
+        'import-x/order': [
           'error',
           {
             groups: ['builtin', 'external', 'internal', ['parent', 'sibling'], 'index', 'object'],

package/src/eslint/lib/rules.test.js

@@ -43,8 +43,8 @@ describe('eslint/lib/rules.js', () => {
     // Call commonRules with importOrder option enabled.
     const result = module.commonRules({ importOrder: true });
 
-    // Verify that the import/order rule is present in the config.
-    expect(result['import/order']).toBeDefined();
+    // Verify that the import-x/order rule is present in the config.
+    expect(result['import-x/order']).toBeDefined();
   });
 
   // Test that Prettier rules are included when prettier option is true.

package/src/eslint/lib/setup.js

@@ -1,26 +1,5 @@
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { FlatCompat } from '@eslint/eslintrc';
-import js from '@eslint/js';
 import tsParser from '@typescript-eslint/parser';
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-/**
- * Creates a FlatCompat instance for using flat config format with older
- * ESLint configurations.
- */
-const compat = new FlatCompat({ baseDirectory: __dirname, recommendedConfig: js.configs.recommended });
-
-/**
- * Returns the setup object containing shared utilities for ESLint configs.
- *
- * @returns {{ compat: FlatCompat, tsParser: typeof tsParser, __dirname: string }} Reusable setup utilities for ESLint configurations.
- */
-export const setup = () => ({ compat, tsParser, __dirname });
-
 /**
  * Common parser configuration for TypeScript files.
  *

package/src/eslint/lib/setup.test.js

@@ -2,15 +2,6 @@ import { describe, it, expect } from 'vitest';
 
 // Test suite for the ESLint setup utilities module.
 describe('eslint/lib/setup.js', () => {
-  // Test that the module exports the setup function.
-  it('should export setup function', async () => {
-    // Dynamically import the setup module to test its exports.
-    const module = await import('./setup.js');
-
-    // Verify that setup is a function.
-    expect(typeof module.setup).toBe('function');
-  });
-
   // Test that the module exports the commonParser object with a parser property.
   it('should export commonParser object', async () => {
     // Dynamically import the setup module to test its exports.

package/src/eslint/next.js

@@ -9,9 +9,21 @@
  * =====================================================================
  */
 
-import { setup, buildConfig, files } from './lib/index.js';
+import nextCoreWebVitals from 'eslint-config-next/core-web-vitals';
 
-const { compat } = setup();
+import { buildConfig, files } from './lib/index.js';
+
+/**
+ * Removes the next/typescript item from the core-web-vitals config array.
+ * The \@typescript-eslint plugin is registered on the main config object
+ * instead (via build-config.js when typescript: true), which avoids plugin
+ * redefinition errors when TypeScript rules are applied in the shared config.
+ *
+ * @param {import('eslint').Linter.Config[]} configs - Config array to process.
+ *
+ * @returns {import('eslint').Linter.Config[]} Config array with next/typescript removed.
+ */
+const prepareNextConfig = (configs) => configs.filter((c) => c.name !== 'next/typescript');
 
 /**
  * Creates an ESLint configuration object for Next.js projects with TypeScript
@@ -38,13 +50,8 @@ export const createConfig = (options = {}) => {
   const { prettier = true, react = true, a11y = true, importOrder = true, jsdoc = true } = options;
 
   return buildConfig({
-    compat,
     files: files.withTs,
-    builtinPlugins: ['next/core-web-vitals', 'next/typescript', 'plugin:@typescript-eslint/recommended'],
-    conditionalPlugins: {
-      react: ['plugin:react/recommended', 'plugin:react-hooks/recommended'],
-      a11y: 'plugin:jsx-a11y/recommended',
-    },
+    builtinPlugins: [...prepareNextConfig(nextCoreWebVitals)],
     parserOptions: { ecmaFeatures: { jsx: true } },
     settings: { react: { version: 'detect' } },
     rules: {

package/src/eslint/react.js

@@ -9,9 +9,12 @@
  * =====================================================================
  */
 
-import { setup, buildConfig, files } from './lib/index.js';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import reactRecommended from 'eslint-plugin-react/configs/recommended.js';
+import reactHooks from 'eslint-plugin-react-hooks';
+import tsEslint from 'typescript-eslint';
 
-const { compat } = setup();
+import { buildConfig, files } from './lib/index.js';
 
 /**
  * Creates an ESLint configuration object for React projects with TypeScript
@@ -37,14 +40,13 @@ export const createConfig = (options = {}) => {
   const { prettier = true, a11y = true, importOrder = true, jsdoc = true } = options;
 
   return buildConfig({
-    compat,
     files: files.withTs,
     builtinPlugins: [
-      'plugin:react/recommended',
-      'plugin:react-hooks/recommended',
-      'plugin:@typescript-eslint/recommended',
+      { ...reactRecommended, files: ['**/*.{jsx,tsx}'] },
+      { ...reactHooks.configs.flat.recommended, files: ['**/*.{jsx,tsx}'] },
+      ...tsEslint.configs.recommended,
     ],
-    conditionalPlugins: { a11y: 'plugin:jsx-a11y/recommended' },
+    conditionalPlugins: { a11y: { ...jsxA11y.flatConfigs.recommended, files: ['**/*.{jsx,tsx}'] } },
     parserOptions: { ecmaFeatures: { jsx: true } },
     settings: { react: { version: 'detect' } },
     rules: { 'react/react-in-jsx-scope': 'off', 'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }] },

package/src/eslint/typescript.js

@@ -9,9 +9,9 @@
  * =====================================================================
  */
 
-import { setup, buildConfig, files } from './lib/index.js';
+import tsEslint from 'typescript-eslint';
 
-const { compat } = setup();
+import { buildConfig, files } from './lib/index.js';
 
 /**
  * Creates an ESLint configuration object for TypeScript projects.
@@ -35,9 +35,8 @@ export const createConfig = (options = {}) => {
   const { prettier = true, importOrder = true, jsdoc = true } = options;
 
   return buildConfig({
-    compat,
     files: files.withTs,
-    builtinPlugins: ['plugin:@typescript-eslint/recommended'],
+    builtinPlugins: [...tsEslint.configs.recommended],
     typescript: true,
     options: { ...options, prettier, importOrder, jsdoc },
   });