@vijayhardaha/dev-config 2.0.3 → 2.1.0

package/README.md

@@ -6,7 +6,7 @@
 
 Reusable development configuration package for Next.js + TypeScript projects.
 
-> **v2.0.0** — Requires ESLint >=10. Native flat config only. No FlatCompat.
+> **v2.0.4** — Requires ESLint >=10. Native flat config only. No FlatCompat.
 
 ## Features
 
@@ -21,17 +21,25 @@ Reusable development configuration package for Next.js + TypeScript projects.
 ## Installation
 
 ```bash
-bun install @vijayhardaha/dev-config --dev
+bun add --dev @vijayhardaha/dev-config
 ```
 
 ### Install Required Packages
 
 ```bash
-bun add --dev eslint @eslint/compat 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
+bun add --dev eslint @eslint/compat eslint-config-prettier prettier @prettier/plugin-xml eslint-plugin-prettier globals eslint-plugin-jsdoc eslint-plugin-import-x @typescript-eslint/eslint-plugin @typescript-eslint/parser typescript typescript-eslint husky
 ```
 
 ### Install Optional Packages
 
+Only install what you need based on your project setup.
+
+#### TypeScript Import Resolution
+
+```bash
+bun add --dev eslint-import-resolver-typescript
+```
+
 #### Stylelint
 
 ```bash
@@ -53,7 +61,7 @@ bun add --dev @next/eslint-plugin-next eslint-config-next
 #### Commitlint
 
 ```bash
-bun add --dev husky @commitlint/cli @commitlint/config-conventional @commitlint/types
+bun add --dev @commitlint/cli @commitlint/config-conventional @commitlint/types
 ```
 
 #### Next Sitemap
@@ -79,7 +87,14 @@ v2 drops FlatCompat and uses native ESLint 10 flat configs throughout.
 
 1. Install ESLint 10+: `bun add --dev eslint@10`
 2. Replace `eslint-plugin-import` with `eslint-plugin-import-x`
-3. Remove unused deps: `@eslint/eslintrc`, `@eslint/js`, `eslint-config-prettier`, `eslint-import-resolver-typescript`
+3. Remove unused deps: `@eslint/eslintrc`, `@eslint/js`
+
+### What's new in v2.0.4
+
+- **`eslint-config-prettier` restored** — added back to peer deps (required by `eslint-plugin-prettier/recommended`)
+- **`eslint-import-resolver-typescript` restored** — added back as optional peer for TypeScript import resolution
+- **All packages declared as peer deps** — every config module's dependencies are declared with proper `peerDependenciesMeta`
+- **Flat config resolver fix** — switched from string-based `import-x/resolver` to `import-x/resolver-next` with `createTypeScriptImportResolver` for ESLint 10 compatibility
 
 ## Quick Start
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vijayhardaha/dev-config",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "Reusable development configurations for Next.js + TypeScript projects",
   "scripts": {
     "lint": "eslint .",
@@ -68,32 +68,55 @@
     "@commitlint/cli": "^21.0.2",
     "@commitlint/config-conventional": "^21.0.2",
     "@commitlint/types": "^21.0.1",
-    "@vitest/coverage-v8": "^4.1.7",
-    "eslint-config-next": "^16.2.6",
+    "@typescript-eslint/parser": "^8.60.1",
+    "@typescript-eslint/eslint-plugin": "^8.60.1",
+    "@vitest/coverage-v8": "^4.1.8",
+    "eslint": "^10.4.1",
+    "eslint-config-next": "^16.2.7",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-jsdoc": "^63.0.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.6",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
-    "next-sitemap": "^4.2.3",
-    "release-it": "^20.0.1",
-    "stylelint": "^17.12.0",
-    "stylelint-config-property-sort-order-smacss": "^11.2.0",
-    "stylelint-config-standard-scss": "^17.0.0",
-    "stylelint-order": "^8.1.1",
-    "vitest": "^4.1.7"
+    "globals": "^17.6.0",
+    "husky": "^9.1.7",
+    "prettier": "^3.8.3",
+    "@prettier/plugin-xml": "^3.4.2",
+    "release-it": "^20.2.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.60.1",
+    "vitest": "^4.1.8"
   },
   "peerDependencies": {
+    "@commitlint/cli": ">=21",
+    "@commitlint/config-conventional": ">=21",
+    "@commitlint/types": ">=21",
     "@eslint/compat": ">=2",
+    "@next/eslint-plugin-next": ">=16",
     "@prettier/plugin-xml": ">=3",
     "@typescript-eslint/eslint-plugin": ">=8",
     "@typescript-eslint/parser": ">=8",
     "eslint": ">=10",
+    "eslint-config-next": ">=16",
+    "eslint-config-prettier": ">=10",
+    "eslint-import-resolver-typescript": ">=4",
     "eslint-plugin-import-x": ">=4",
     "eslint-plugin-jsdoc": ">=62",
+    "eslint-plugin-jsx-a11y": ">=6",
     "eslint-plugin-prettier": ">=5",
+    "eslint-plugin-react": ">=7",
+    "eslint-plugin-react-hooks": ">=5",
     "globals": ">=17",
     "husky": ">=9",
-    "prettier": "^3.8.3",
-    "typescript": ">=6",
+    "next-sitemap": ">=4",
+    "prettier": ">=3",
+    "stylelint": ">=17",
+    "stylelint-config-property-sort-order-smacss": ">=11",
+    "stylelint-config-standard-scss": ">=17",
+    "stylelint-order": ">=8",
+    "typescript": ">=5",
     "typescript-eslint": ">=8"
   },
   "peerDependenciesMeta": {
@@ -109,9 +132,18 @@
     "@next/eslint-plugin-next": {
       "optional": true
     },
+    "@typescript-eslint/eslint-plugin": {
+      "optional": true
+    },
+    "@typescript-eslint/parser": {
+      "optional": true
+    },
     "eslint-config-next": {
       "optional": true
     },
+    "eslint-import-resolver-typescript": {
+      "optional": true
+    },
     "eslint-plugin-jsx-a11y": {
       "optional": true
     },
@@ -121,6 +153,9 @@
     "eslint-plugin-react-hooks": {
       "optional": true
     },
+    "husky": {
+      "optional": true
+    },
     "next-sitemap": {
       "optional": true
     },
@@ -135,12 +170,19 @@
     },
     "stylelint-order": {
       "optional": true
+    },
+    "typescript": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
     }
   },
   "overrides": {
     "undici": "^7.0.0"
   },
   "trustedDependencies": [
+    "sharp",
     "unrs-resolver"
   ]
 }

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

@@ -1,6 +1,9 @@
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+
 import { fixupPluginRules } from '@eslint/compat';
-import { defineConfig } from 'eslint/config';
-import importX from 'eslint-plugin-import-x';
+import { defineConfig, includeIgnoreFile } from 'eslint/config';
+import { createNodeResolver, flatConfigs as importXFlatConfigs } from 'eslint-plugin-import-x';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
 import prettierRecommended from 'eslint-plugin-prettier/recommended';
 
@@ -9,6 +12,13 @@ import { commonLanguageOptions } from './language-options.js';
 import { commonRules } from './rules.js';
 import { commonParser } from './setup.js';
 
+let createTypeScriptImportResolver;
+try {
+  createTypeScriptImportResolver = (await import('eslint-import-resolver-typescript')).createTypeScriptImportResolver;
+} catch {
+  createTypeScriptImportResolver = null;
+}
+
 /**
  * Filters conditional plugins based on user options.
  *
@@ -166,7 +176,12 @@ const buildConfigObject = ({
       ...(typescript && { parserOptions: { tsconfigRootDir: process.cwd(), ...parserOptions } }),
     },
     settings: {
-      ...(opts.importOrder && { 'import-x/resolver': { typescript: {} } }),
+      ...(opts.importOrder && {
+        'import-x/resolver-next': [
+          createNodeResolver(),
+          ...(createTypeScriptImportResolver ? [createTypeScriptImportResolver()] : []),
+        ],
+      }),
       ...(opts.jsdoc && { jsdoc: { mode: 'typescript' } }),
       ...extraSettings,
       ...settings,
@@ -215,7 +230,7 @@ export const buildConfig = ({
 
   const mergedPlugins = [
     ...builtinPlugins,
-    opts.importOrder && importX.flatConfigs.recommended,
+    opts.importOrder && importXFlatConfigs.recommended,
     opts.jsdoc && jsdocPlugin.configs['flat/recommended'],
     opts.prettier && prettierRecommended,
     ...conditionalPluginList,
@@ -228,6 +243,9 @@ export const buildConfig = ({
   const parsedConfigs = typescript ? stripParser(strippedConfigs) : strippedConfigs;
   const mergedGlobalIgnores = mergeGlobalIgnores(opts.globalIgnores);
 
+  const gitignorePath = path.resolve(process.cwd(), '.gitignore');
+  const gitignoreConfig = existsSync(gitignorePath) ? includeIgnoreFile(gitignorePath) : null;
+
   const configObject = buildConfigObject({
     filePatterns,
     opts,
@@ -239,5 +257,10 @@ export const buildConfig = ({
     extraRules,
   });
 
-  return defineConfig([...mergedGlobalIgnores, ...parsedConfigs, configObject]);
+  return defineConfig([
+    ...mergedGlobalIgnores,
+    ...(gitignoreConfig ? [gitignoreConfig] : []),
+    ...parsedConfigs,
+    configObject,
+  ]);
 };

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

@@ -49,4 +49,44 @@ describe('eslint/lib/build-config.js', () => {
     expect(configNames).toContain('test-flat-config');
     expect(configNames).toContain('test-flat-object');
   });
+
+  // Test that buildConfig sets import-x/resolver-next when importOrder is enabled.
+  it('should configure import-x/resolver-next with node resolver when importOrder is enabled', async () => {
+    const module = await import('./build-config.js');
+    const { files } = await import('./files.js');
+
+    const result = module.buildConfig({ files: files.withoutTs, options: { importOrder: true } });
+
+    // The last config object in the array should have the resolver settings
+    const configObject = result[result.length - 1];
+    expect(configObject.settings).toBeDefined();
+    expect(configObject.settings['import-x/resolver-next']).toBeDefined();
+    expect(Array.isArray(configObject.settings['import-x/resolver-next'])).toBe(true);
+    // Should at least have the node resolver
+    expect(configObject.settings['import-x/resolver-next'].length).toBeGreaterThanOrEqual(1);
+  });
+
+  // Test that buildConfig omits import-x/resolver-next when importOrder is disabled.
+  it('should omit import-x/resolver-next when importOrder is disabled', async () => {
+    const module = await import('./build-config.js');
+    const { files } = await import('./files.js');
+
+    const result = module.buildConfig({ files: files.withoutTs, options: { importOrder: false } });
+
+    const configObject = result[result.length - 1];
+    expect(configObject.settings).toBeDefined();
+    expect(configObject.settings['import-x/resolver-next']).toBeUndefined();
+  });
+
+  // Test that buildConfig includes .gitignore patterns via includeIgnoreFile.
+  it('should include .gitignore patterns from project root', async () => {
+    const module = await import('./build-config.js');
+    const { files } = await import('./files.js');
+
+    const result = module.buildConfig({ files: files.withoutTs, options: {} });
+
+    // When .gitignore exists at the project root, includeIgnoreFile adds a config with ignores.
+    const hasIgnoreConfig = result.some((config) => config.ignores && config.ignores.length > 0);
+    expect(hasIgnoreConfig).toBe(true);
+  });
 });

package/src/jsconfig/index.json

@@ -1,4 +1,4 @@
 {
-  "compilerOptions": { "jsx": "react-jsx", "resolveJsonModule": true, "baseUrl": ".", "paths": { "@/*": ["./src/*"] } },
+  "compilerOptions": { "jsx": "react-jsx", "resolveJsonModule": true, "paths": { "@/*": ["./src/*"] } },
   "exclude": ["node_modules", ".next", "out"]
 }