@vijayhardaha/dev-config 1.0.12 → 1.1.1

package/README.md

@@ -19,39 +19,51 @@ Reusable development configuration package for Next.js + TypeScript projects.
 ## Installation
 
 ```bash
-npm install @vijayhardaha/dev-config --save-dev
+bun 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 eslint-plugin-jsdoc eslint-plugin-import eslint-import-resolver-typescript
+bun add --save-dev eslint@9.39.4 @eslint/js@9.39.4 @next/eslint-plugin-next@15.5.15 eslint-config-next@15.5.15 prettier @prettier/plugin-xml vitest husky @eslint/compat @eslint/eslintrc eslint-config-prettier eslint-plugin-prettier globals typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-jsdoc eslint-plugin-import eslint-import-resolver-typescript
 ```
 
 ### Install Optional Packages
 
+### Prettier
+
+```bash
+bun add --save-dev prettier @prettier/plugin-xml
+```
+
 #### Stylelint
 
 ```bash
-npm install --save-dev stylelint stylelint-config-property-sort-order-smacss stylelint-config-standard-scss stylelint-order
+bun add --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
+bun add --save-dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
 ```
 
 #### Next.js
 
 ```bash
-npm install --save-dev @next/eslint-plugin-next eslint-config-next
+bun add --save-dev @next/eslint-plugin-next eslint-config-next
 ```
 
 #### Commitlint
 
 ```bash
-npm install --save-dev husky @commitlint/cli @commitlint/config-conventional
+bun add --save-dev @commitlint/cli @commitlint/config-conventional @commitlint/types
+```
+
+#### Next Sitemap
+
+```bash
+bun add --save-dev next-sitemap
 ```
 
 ## Quick Start
@@ -86,6 +98,42 @@ import commitlintConfig from "@vijayhardaha/dev-config/commitlint";
 export default commitlintConfig;
 ```
 
+### Stylelint
+
+Create `stylelint.config.mjs` in your project root:
+
+```javascript
+import stylelintConfig from "@vijayhardaha/dev-config/stylelint";
+
+export default stylelintConfig;
+```
+
+### Next Sitemap
+
+Create `next-sitemap.config.mjs` in your project root:
+
+```javascript
+import { createSitemapConfig } from "@vijayhardaha/dev-config/next-sitemap";
+
+export default createSitemapConfig({ siteUrl: "https://yourdomain.com" });
+```
+
+### TypeScript
+
+Create `tsconfig.json` in your project root:
+
+```json
+{ "extends": "@vijayhardaha/dev-config/tsconfig" }
+```
+
+### JavaScript
+
+Create `jsconfig.json` in your project root:
+
+```json
+{ "extends": "@vijayhardaha/dev-config/jsconfig" }
+```
+
 ## Configuration Options
 
 ### ESLint
@@ -97,7 +145,7 @@ export default createConfig({
   prettier: true, // Enable Prettier integration
   importOrder: true, // Enable import ordering
   react: true, // Enable React rules
-  a11y: true // Enable accessibility rules
+  a11y: true, // Enable accessibility rules
   jsdoc: true // Enable JSDoc rules
 });
 ```
@@ -111,12 +159,30 @@ Available configs:
 
 ## Scripts
 
-| Command                | Description            |
-| ---------------------- | ---------------------- |
-| `npm run lint`         | Run ESLint             |
-| `npm run lint:fix`     | Auto-fix ESLint issues |
-| `npm run format`       | Format with Prettier   |
-| `npm run format:check` | Check formatting       |
+| Command                 | Description             |
+| ----------------------- | ----------------------- |
+| `bun run lint`          | Run ESLint              |
+| `bun run lint:fix`      | Auto-fix ESLint issues  |
+| `bun run format`        | Format with Prettier    |
+| `bun run format:check`  | Check formatting        |
+| `bun run test`          | Run tests with Vitest   |
+| `bun run test:watch`    | Run tests in watch mode |
+| `bun run test:coverage` | Run tests with coverage |
+
+## Testing
+
+This package includes comprehensive tests for all configuration modules:
+
+- ESLint configs (JavaScript, TypeScript, React, Next.js)
+- ESLint lib modules (setup, files, build-config, ignores, language-options, rules)
+- Prettier, Commitlint, Stylelint configs
+- Next Sitemap, TypeScript, and JavaScript configs
+
+Run tests with:
+
+```bash
+bun run test
+```
 
 ## License
 

package/package.json

@@ -1,28 +1,31 @@
 {
   "name": "@vijayhardaha/dev-config",
-  "version": "1.0.12",
+  "version": "1.1.1",
   "description": "Reusable development configurations for Next.js + TypeScript projects",
-  "author": {
-    "name": "Vijay Hardaha",
-    "url": "https://github.com/vijayhardaha"
-  },
-  "license": "MIT",
-  "type": "module",
   "scripts": {
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
+    "lint:fix": "eslint --fix .",
+    "format": "prettier --write --log-level error .",
+    "format:check": "prettier --check --log-level error .",
     "release": "release-it",
     "release:dry": "release-it --dry-run",
-    "prepare": "husky",
-    "gc": "source .tmp/git.md"
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "gc": "read -p 'Execute git commands from .tmp/git.txt? [Y/n] ' ans; [ \"$ans\" = \"n\" ] || [ \"$ans\" = \"N\" ] && echo 'Aborted.' || source .tmp/git.txt",
+    "prepare": "husky"
   },
   "files": [
     "src",
     "LICENSE",
     "README.md"
   ],
+  "author": {
+    "name": "Vijay Hardaha",
+    "url": "https://github.com/vijayhardaha"
+  },
+  "license": "MIT",
+  "type": "module",
   "main": "./src/index.js",
   "homepage": "https://github.com/vijayhardaha/dev-config#readme",
   "repository": {
@@ -55,93 +58,71 @@
     "next-sitemap",
     "typescript"
   ],
+  "devDependencies": {
+    "@commitlint/cli": "^20.5.3",
+    "@commitlint/config-conventional": "^20.5.3",
+    "@commitlint/types": "^20.5.0",
+    "@next/eslint-plugin-next": "^15.5.15",
+    "@prettier/plugin-xml": "^3.4.2",
+    "@vitest/coverage-v8": "^4.1.5",
+    "eslint-config-next": "^15.5.15",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "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.11.0",
+    "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"
+  },
   "peerDependencies": {
-    "@commitlint/cli": "^20",
-    "@commitlint/config-conventional": "^20",
-    "@eslint/compat": "^2",
-    "@eslint/eslintrc": "^3",
-    "@eslint/js": "^9",
-    "@next/eslint-plugin-next": "^15",
-    "@typescript-eslint/eslint-plugin": "^8",
-    "@typescript-eslint/parser": "^8",
-    "eslint": "^9",
-    "eslint-config-next": "^15",
-    "eslint-config-prettier": "^10",
-    "eslint-import-resolver-typescript": "^4",
-    "eslint-plugin-import": "^2",
-    "eslint-plugin-jsdoc": "^62",
-    "eslint-plugin-jsx-a11y": "^6",
-    "eslint-plugin-prettier": "^5",
-    "eslint-plugin-react": "^7",
-    "eslint-plugin-react-hooks": "^7",
-    "globals": "^17",
-    "prettier": "^3",
-    "stylelint": "^17",
-    "stylelint-config-property-sort-order-smacss": "^11",
-    "stylelint-config-standard-scss": "^17",
-    "stylelint-order": "^8",
-    "typescript": "^5"
+    "@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-plugin-jsdoc": ">=62",
+    "eslint-plugin-prettier": ">=5",
+    "eslint": ">=9",
+    "globals": ">=17",
+    "husky": ">=9",
+    "prettier": ">=3",
+    "typescript": ">=6",
+    "vitest": ">=4"
   },
   "peerDependenciesMeta": {
     "@commitlint/cli": {
-      "optional": false
+      "optional": true
     },
     "@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": {
+    "@commitlint/types": {
       "optional": true
     },
-    "@typescript-eslint/parser": {
+    "@next/eslint-plugin-next": {
       "optional": true
     },
-    "eslint": {
-      "optional": false
-    },
     "eslint-config-next": {
       "optional": true
     },
-    "eslint-config-prettier": {
-      "optional": false
-    },
-    "eslint-import-resolver-typescript": {
-      "optional": true
-    },
-    "eslint-plugin-import": {
-      "optional": true
-    },
     "eslint-plugin-jsx-a11y": {
       "optional": true
     },
-    "eslint-plugin-jsdoc": {
-      "optional": true
-    },
-    "eslint-plugin-prettier": {
-      "optional": false
-    },
     "eslint-plugin-react": {
       "optional": true
     },
     "eslint-plugin-react-hooks": {
       "optional": true
     },
-    "globals": {
-      "optional": false
-    },
-    "prettier": {
-      "optional": false
+    "next-sitemap": {
+      "optional": true
     },
     "stylelint": {
       "optional": true
@@ -154,30 +135,12 @@
     },
     "stylelint-order": {
       "optional": true
-    },
-    "typescript": {
-      "optional": false
     }
   },
-  "devDependencies": {
-    "@commitlint/cli": "^20.5.0",
-    "@commitlint/config-conventional": "^20.5.0",
-    "@eslint/compat": "^2.0.4",
-    "@eslint/eslintrc": "^3.3.5",
-    "@eslint/js": "^9.39.4",
-    "@typescript-eslint/parser": "^8.58.0",
-    "eslint": "^9.39.4",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsdoc": "^62.9.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"
-  }
+  },
+  "trustedDependencies": [
+    "unrs-resolver"
+  ]
 }

package/src/commitlint/index.js

@@ -1,11 +1,11 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Commitlint Configuration
- * =====================================================================.
+ * =====================================================================
  * Purpose: Enforce conventional commit message standards for consistent
  *          and meaningful Git commit history.
  * Docs:    https://commitlint.js.org/#/
- * =====================================================================.
+ * =====================================================================
  */
 
 /** @type {import('@commitlint/types').UserConfig} */

package/src/commitlint/index.test.js

@@ -0,0 +1,49 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the Commitlint configuration module.
+describe('commitlint/index.js', () => {
+  // Test that the module exports a default configuration object.
+  it('should export default config object', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that the default export is an object (Commitlint config).
+    expect(typeof module.default).toBe('object');
+  });
+
+  // Test that the config has an extends array (inherits from base configs).
+  it('should have extends property', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that extends is an array (list of config files to extend).
+    expect(Array.isArray(module.default.extends)).toBe(true);
+  });
+
+  // Test that the config has a rules object (contains Commitlint rules).
+  it('should have rules property', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that rules is an object (key-value pairs of rule configurations).
+    expect(typeof module.default.rules).toBe('object');
+  });
+
+  // Test that the header-max-length rule is defined (commit header length limit).
+  it('should have header-max-length rule', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that the header-max-length rule exists in the config.
+    expect(module.default.rules['header-max-length']).toBeDefined();
+  });
+
+  // Test that the scope-case rule is defined (enforces case style for commit scopes).
+  it('should have scope-case rule', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that the scope-case rule exists in the config.
+    expect(module.default.rules['scope-case']).toBeDefined();
+  });
+});

package/src/eslint/index.js

@@ -1,17 +1,15 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Eslint Configuration (Flat)
- * =====================================================================.
+ * =====================================================================
  * Purpose: Project-wide ESLint configuration for JavaScript.
  *          Enforces code quality and consistent styling.
  * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
  * Usage:   npx eslint .
- * =====================================================================.
+ * =====================================================================
  */
 
-import { defineConfig } from 'eslint/config';
-
-import { setup, commonIgnores, commonRules, commonLanguageOptions, files } from './common.js';
+import { setup, buildConfig, files } from './lib/index.js';
 
 const { compat } = setup();
 
@@ -22,59 +20,25 @@ const { compat } = setup();
  * @param {boolean} [options.prettier] - Enable Prettier integration.
  * @param {boolean} [options.importOrder] - Enable import order rules.
  * @param {boolean} [options.jsdoc] - Enable JSDoc rules for public/exported APIs.
+ * @param {string[]} [options.ignores] - Additional ignore patterns.
+ * @param {object} [options.rules] - Additional or overridden rules.
+ * @param {object} [options.settings] - Additional settings.
+ * @param {string[]} [options.files] - Additional file patterns to lint.
+ * @param {object} [options.languageOptions] - Additional language options.
+ * @param {string[]} [options.plugins] - Additional plugin configs to extend.
+ * @param {string[]} [options.globalIgnores] - Additional global ignore patterns.
+ * @param {object} [options.extend] - Additional config properties to extend.
  *
  * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
  */
 export const createConfig = (options = {}) => {
   const { prettier = true, importOrder = true, jsdoc = true } = options;
 
-  // ---- Extends Configs ----
-  // Build the extends array based on enabled features
-  const extendsConfigs = [
-    importOrder && 'plugin:import/recommended',
-    jsdoc && 'plugin:jsdoc/recommended',
-    prettier && 'plugin:prettier/recommended',
-  ].filter(Boolean);
-
-  return defineConfig([
-    // ---- Global Ignores ----
-    ...commonIgnores,
-
-    // ---- Extends Configs ----
-    ...compat.extends(...extendsConfigs),
-
-    {
-      // ---- JavaScript Files Configuration ----
-      // Apply to JavaScript files without TypeScript
-      files: files.withoutTs,
-
-      // ---- Language Options ----
-      languageOptions: commonLanguageOptions,
-
-      // ---- Settings ----
-      settings: { ...(importOrder && { 'import/resolver': { typescript: {} } }) },
-
-      // ---- Rules ----
-      rules: {
-        // ---- Unused Variables Rule ----
-        // Report unused variables for JavaScript files
-        'no-unused-vars': [
-          'error',
-          {
-            vars: 'all',
-            args: 'after-used',
-            varsIgnorePattern: '^_',
-            argsIgnorePattern: '^_',
-            ignoreRestSiblings: true,
-            caughtErrors: 'all',
-          },
-        ],
-        // ---- Common Rules ----
-        // Apply shared rules based on options
-        ...commonRules({ prettier, importOrder, typescript: false, jsdoc }),
-      },
-    },
-  ]);
+  return buildConfig({
+    compat,
+    files: [...files.withoutTs, ...(options.files || [])],
+    options: { ...options, prettier, importOrder, jsdoc },
+  });
 };
 
 export default createConfig();

package/src/eslint/index.test.js

@@ -0,0 +1,22 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint module's main entry point.
+describe('eslint/index.js', () => {
+  // Test that the module exports the createConfig function.
+  it('should export createConfig function', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that createConfig is a function (used to create ESLint configs).
+    expect(typeof module.createConfig).toBe('function');
+  });
+
+  // Test that the module exports a default configuration object.
+  it('should export default config', async () => {
+    // Dynamically import the index.js module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that the default export is defined (should be a base ESLint config object).
+    expect(module.default).toBeDefined();
+  });
+});

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

@@ -0,0 +1,85 @@
+import { defineConfig } from 'eslint/config';
+
+import { globalIgnores } from './ignores.js';
+import { commonLanguageOptions } from './language-options.js';
+import { commonRules } from './rules.js';
+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 {object} [config.languageOptions] - Additional language options.
+ * @param {object} [config.parserOptions] - Parser options.
+ * @param {object} [config.settings] - Settings object.
+ * @param {object} [config.rules] - Additional rules.
+ * @param {object} [config.options] - User-provided options.
+ * @param {boolean} [config.typescript] - Enable TypeScript support.
+ *
+ * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
+ */
+export const buildConfig = ({
+  compat,
+  files: filePatterns,
+  builtinPlugins = [],
+  conditionalPlugins = {},
+  languageOptions: extraLanguageOptions = {},
+  parserOptions = {},
+  settings: extraSettings = {},
+  rules: extraRules = {},
+  options = {},
+  typescript = false,
+}) => {
+  const {
+    prettier = true,
+    importOrder = true,
+    jsdoc = true,
+    ignores,
+    rules,
+    settings,
+    languageOptions,
+    plugins: userPlugins,
+    globalIgnores: userGlobalIgnores,
+    extend,
+  } = options;
+
+  // ---- Build extends configs ----
+  const conditionalPluginList = Object.entries(conditionalPlugins)
+    .filter(([key]) => options[key])
+    .flatMap(([, value]) => (Array.isArray(value) ? value : [value]));
+
+  const builtPlugins = [
+    ...builtinPlugins,
+    importOrder && 'plugin:import/recommended',
+    jsdoc && 'plugin:jsdoc/recommended',
+    prettier && 'plugin:prettier/recommended',
+    ...conditionalPluginList,
+  ].filter(Boolean);
+
+  const plugins = [...builtPlugins, ...(userPlugins || [])];
+
+  // ---- Build config object ----
+  const configObject = {
+    files: [...filePatterns],
+    ...(ignores && { ignores }),
+    languageOptions: {
+      ...commonLanguageOptions,
+      ...(typescript && commonParser),
+      ...extraLanguageOptions,
+      ...languageOptions,
+      ...(typescript && { parserOptions: { tsconfigRootDir: process.cwd(), ...parserOptions } }),
+    },
+    settings: { ...(importOrder && { 'import/resolver': { typescript: {} } }), ...extraSettings, ...settings },
+    rules: { ...commonRules({ prettier, importOrder, typescript, jsdoc }), ...extraRules, ...rules },
+    ...extend,
+  };
+
+  // Merge user global ignores with common global ignores
+  const mergedGlobalIgnores = Array.isArray(userGlobalIgnores) ? globalIgnores(userGlobalIgnores) : globalIgnores();
+
+  return defineConfig([...mergedGlobalIgnores, ...compat.extends(...plugins), configObject]);
+};

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

@@ -0,0 +1,30 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint build-config utility module.
+describe('eslint/lib/build-config.js', () => {
+  // Test that the module exports the buildConfig function.
+  it('should export buildConfig function', async () => {
+    // Dynamically import the build-config module to test its exports.
+    const module = await import('./build-config.js');
+
+    // Verify that buildConfig is a function (used to build ESLint configs).
+    expect(typeof module.buildConfig).toBe('function');
+  });
+
+  // Test that buildConfig returns an array of ESLint config objects.
+  it('should return an array of config objects', async () => {
+    // Dynamically import the build-config module to test its function.
+    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: {} });
+
+    // Verify that the result is an array (ESLint expects configs as an array).
+    expect(Array.isArray(result)).toBe(true);
+  });
+});

package/src/eslint/lib/files.js

@@ -0,0 +1,6 @@
+/**
+ * File patterns for ESLint configuration.
+ *
+ * @type {{ withTs: string[], withoutTs: string[] }}
+ */
+export const files = { withTs: ['**/*.{js,jsx,mjs,cjs,ts,tsx}'], withoutTs: ['**/*.{js,jsx,mjs,cjs}'] };