@vijayhardaha/dev-config 1.0.1 → 1.0.3

package/README.md

@@ -18,6 +18,38 @@ Reusable development configuration package for Next.js + TypeScript projects.
 npm install @vijayhardaha/dev-config --save-dev
 ```
 
+### Install Required Packages
+
+```bash
+npm install --save-dev eslint@9.39.4 @eslint/js@9.39.4 @eslint/compat @eslint/eslintrc eslint-config-prettier eslint-plugin-prettier globals prettier typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser
+```
+
+### Install Optional Packages
+
+#### Stylelint
+
+```bash
+npm install --save-dev stylelint stylelint-config-property-sort-order-smacss stylelint-config-standard-scss stylelint-order
+```
+
+#### React
+
+```bash
+npm install --save-dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-import
+```
+
+#### Next.js
+
+```bash
+npm install --save-dev @next/eslint-plugin-next eslint-config-next
+```
+
+#### Commitlint
+
+```bash
+npm install --save-dev @commitlint/cli @commitlint/config-conventional
+```
+
 ## Quick Start
 
 ### ESLint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vijayhardaha/dev-config",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Reusable development configurations for Next.js + TypeScript projects",
   "author": "Vijay Hardaha",
   "license": "MIT",
@@ -24,7 +24,7 @@
     "./commitlint": "./src/commitlint/index.js",
     "./stylelint": "./src/stylelint/index.js",
     "./next-sitemap": "./src/next-sitemap/index.js",
-    "./typescript": "./src/typescript/base.json",
+    "./tsconfig": "./src/tsconfig/index.json",
     "./jsconfig": "./src/jsconfig/index.json"
   },
   "files": [
@@ -75,18 +75,94 @@
     "stylelint-order": "^8",
     "typescript": "^5"
   },
+  "peerDependenciesMeta": {
+    "@commitlint/cli": {
+      "optional": false
+    },
+    "@commitlint/config-conventional": {
+      "optional": false
+    },
+    "@eslint/compat": {
+      "optional": false
+    },
+    "@eslint/eslintrc": {
+      "optional": false
+    },
+    "@eslint/js": {
+      "optional": false
+    },
+    "@next/eslint-plugin-next": {
+      "optional": true
+    },
+    "@typescript-eslint/eslint-plugin": {
+      "optional": true
+    },
+    "@typescript-eslint/parser": {
+      "optional": true
+    },
+    "eslint": {
+      "optional": false
+    },
+    "eslint-config-next": {
+      "optional": true
+    },
+    "eslint-config-prettier": {
+      "optional": false
+    },
+    "eslint-plugin-import": {
+      "optional": true
+    },
+    "eslint-plugin-jsx-a11y": {
+      "optional": true
+    },
+    "eslint-plugin-prettier": {
+      "optional": false
+    },
+    "eslint-plugin-react": {
+      "optional": true
+    },
+    "eslint-plugin-react-hooks": {
+      "optional": true
+    },
+    "globals": {
+      "optional": false
+    },
+    "prettier": {
+      "optional": false
+    },
+    "stylelint": {
+      "optional": true
+    },
+    "stylelint-config-property-sort-order-smacss": {
+      "optional": true
+    },
+    "stylelint-config-standard-scss": {
+      "optional": true
+    },
+    "stylelint-order": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": false
+    }
+  },
   "devDependencies": {
     "@commitlint/cli": "^20.5.0",
     "@commitlint/config-conventional": "^20.5.0",
     "@eslint/compat": "^2.0.3",
     "@eslint/eslintrc": "^3.3.5",
     "@eslint/js": "^9.39.4",
+    "@typescript-eslint/parser": "^8.57.2",
     "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-prettier": "^5.5.5",
     "globals": "^17.4.0",
     "husky": "^9.1.7",
     "prettier": "^3.8.1",
     "release-it": "^19.2.4"
+  },
+  "overrides": {
+    "undici": "^7.0.0"
   }
 }

package/src/commitlint/index.js

@@ -16,16 +16,18 @@ const config = {
 
   // ---- Rules ----
   // Maximum length for the commit header (first line)
-  'header-max-length': [2, 'always', 50],
+  rules: {
+    'header-max-length': [2, 'always', 50],
 
-  // Maximum length for any line in the commit body
-  'body-max-line-length': [2, 'always', 72],
+    // Maximum length for any line in the commit body
+    'body-max-line-length': [2, 'always', 72],
 
-  // Commit body must be in sentence case or lower case
-  'body-case': [2, 'always', ['sentence-case', 'lower-case']],
+    // Commit body must be in sentence case or lower case
+    'body-case': [2, 'always', ['sentence-case', 'lower-case']],
 
-  // Subject case is not enforced (allows flexibility)
-  'subject-case': [0],
+    // Subject case is not enforced (allows flexibility)
+    'subject-case': [0],
+  },
 };
 
 export default config;

package/src/eslint/next.js

@@ -13,7 +13,7 @@ import { defineConfig } from 'eslint/config';
 
 import { setup, commonIgnores, commonParser, commonRules, commonLanguageOptions, files } from './common.js';
 
-const { compat, __dirname } = setup();
+const { compat } = setup();
 
 /**
  * Creates an ESLint configuration object for Next.js projects with TypeScript
@@ -58,7 +58,7 @@ export const createConfig = (options = {}) => {
         ...commonParser,
         // ---- Parser Options ----
         // Configure TypeScript parser with React JSX support
-        parserOptions: { ecmaFeatures: { jsx: true }, tsconfigRootDir: __dirname },
+        parserOptions: { ecmaFeatures: { jsx: true }, tsconfigRootDir: process.cwd() },
       },
 
       // ---- React Settings ----

package/src/eslint/react.js

@@ -13,7 +13,7 @@ import { defineConfig } from 'eslint/config';
 
 import { setup, commonIgnores, commonParser, commonRules, commonLanguageOptions, files } from './common.js';
 
-const { compat, __dirname } = setup();
+const { compat } = setup();
 
 /**
  * Creates an ESLint configuration object for React projects with TypeScript
@@ -55,7 +55,7 @@ export const createConfig = (options = {}) => {
         ...commonParser,
         // ---- Parser Options ----
         // Configure TypeScript parser with React JSX support
-        parserOptions: { ecmaFeatures: { jsx: true }, tsconfigRootDir: __dirname },
+        parserOptions: { ecmaFeatures: { jsx: true }, tsconfigRootDir: process.cwd() },
       },
 
       // ---- React Settings ----

package/src/eslint/typescript.js

@@ -13,7 +13,7 @@ import { defineConfig } from 'eslint/config';
 
 import { setup, commonIgnores, commonParser, commonRules, commonLanguageOptions, files } from './common.js';
 
-const { compat, __dirname } = setup();
+const { compat } = setup();
 
 /**
  * Creates an ESLint configuration object for TypeScript projects.
@@ -50,7 +50,7 @@ export const createConfig = (options = {}) => {
         ...commonParser,
         // ---- Parser Options ----
         // Configure TypeScript parser
-        parserOptions: { tsconfigRootDir: __dirname },
+        parserOptions: { tsconfigRootDir: process.cwd() },
       },
 
       rules: commonRules({ prettier, importOrder }),

package/src/index.js

@@ -55,9 +55,3 @@ export { default as nextSitemap, createSitemapConfig } from './next-sitemap/inde
  * @type {import('stylelint').Config}
  */
 export { default as stylelint } from './stylelint/index.js';
-
-/**
- * TypeScript base configuration.
- * @type {import('typescript').CompilerOptions}
- */
-export { default as typescriptBase } from './typescript/base.json';

package/src/{typescript/base.json → tsconfig/index.json}

@@ -23,20 +23,5 @@
     "useDefineForClassFields": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true
-  },
-  "include": [
-    ".next/dev/types/**/*.ts",
-    ".next/types/**/*.ts",
-    "*.config.mjs",
-    "*.config.ts",
-    "*.d.ts",
-    "**/*.js",
-    "**/*.jsx",
-    "**/*.ts",
-    "**/*.tsx",
-    "**/*.mjs",
-    "**/*.cjs",
-    "next-env.d.ts"
-  ],
-  "exclude": ["node_modules"]
+  }
 }