@vijayhardaha/dev-config 1.0.12 → 1.1.1

package/src/eslint/next.js

@@ -1,17 +1,15 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Eslint Configuration (Flat)
- * =====================================================================.
+ * =====================================================================
  * Purpose: Project-wide ESLint configuration for Next.js, TypeScript, and
  *          React. Enforces code quality, accessibility, 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, commonParser, commonRules, commonLanguageOptions, files } from './common.js';
+import { setup, buildConfig, files } from './lib/index.js';
 
 const { compat } = setup();
 
@@ -25,66 +23,39 @@ const { compat } = setup();
  * @param {boolean} [options.a11y] - Enable accessibility rules.
  * @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, react = true, a11y = true, importOrder = true, jsdoc = true } = options;
 
-  // ---- Extends Configs ----
-  // Build the extends array based on enabled features
-  const extendsConfigs = [
-    'next/core-web-vitals',
-    'next/typescript',
-    react && 'plugin:react/recommended',
-    react && 'plugin:react-hooks/recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:import/recommended',
-    a11y && 'plugin:jsx-a11y/recommended',
-    jsdoc && 'plugin:jsdoc/recommended',
-    prettier && 'plugin:prettier/recommended',
-  ].filter(Boolean);
-
-  return defineConfig([
-    // ---- Global Ignores ----
-    ...commonIgnores,
-
-    // ---- Extends Configs ----
-    ...compat.extends(...extendsConfigs),
-
-    {
-      // ---- TypeScript Files Configuration ----
-      // Apply to TypeScript files
-      files: files.withTs,
-
-      // ---- Language Options ----
-      languageOptions: {
-        ...commonLanguageOptions,
-        ...commonParser,
-        // ---- Parser Options ----
-        // Configure TypeScript parser with React JSX support
-        parserOptions: { ecmaFeatures: { jsx: true }, tsconfigRootDir: process.cwd() },
-      },
-
-      // ---- Settings ----
-      settings: {
-        ...(react && { react: { version: 'detect' } }),
-        ...(importOrder && { 'import/resolver': { typescript: {} } }),
-      },
-
-      // ---- Rules ----
-      rules: {
-        // ---- React Rules ----
-        // Disable React import requirement (Next.js handles this)
-        ...(react && { 'react/react-in-jsx-scope': 'off' }),
-        // Allow JSX and global attributes
-        ...(react && { 'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }] }),
-        // ---- Common Rules ----
-        // Apply shared rules
-        ...commonRules({ prettier, importOrder, jsdoc }),
-      },
+  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',
+    },
+    parserOptions: { ecmaFeatures: { jsx: true } },
+    settings: { react: { version: 'detect' } },
+    rules: {
+      ...(react && {
+        'react/react-in-jsx-scope': 'off',
+        'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }],
+      }),
     },
-  ]);
+    typescript: true,
+    options: { ...options, prettier, react, a11y, importOrder, jsdoc },
+  });
 };
 
 export default createConfig();

package/src/eslint/next.test.js

@@ -0,0 +1,32 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint Next.js configuration module.
+describe('eslint/next.js', () => {
+  // Test that the module exports the createConfig function.
+  it('should export createConfig function', async () => {
+    try {
+      // Dynamically import the next.js module to test its exports.
+      const module = await import('./next.js');
+
+      // Verify that createConfig is a function (used to create ESLint config for Next.js).
+      expect(typeof module.createConfig).toBe('function');
+    } catch (error) {
+      // If import fails, expect an error to be defined.
+      expect(error).toBeDefined();
+    }
+  });
+
+  // Test that the module exports a default configuration object.
+  it('should export default config', async () => {
+    try {
+      // Dynamically import the next.js module to test its exports.
+      const module = await import('./next.js');
+
+      // Verify that the default export is defined (should be an ESLint config object).
+      expect(module.default).toBeDefined();
+    } catch (error) {
+      // If import fails, expect an error to be defined.
+      expect(error).toBeDefined();
+    }
+  });
+});

package/src/eslint/react.js

@@ -1,17 +1,15 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Eslint Configuration (Flat)
- * =====================================================================.
+ * =====================================================================
  * Purpose: Project-wide ESLint configuration for React with TypeScript.
  *          Enforces code quality, accessibility, 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, commonParser, commonRules, commonLanguageOptions, files } from './common.js';
+import { setup, buildConfig, files } from './lib/index.js';
 
 const { compat } = setup();
 
@@ -24,61 +22,35 @@ const { compat } = setup();
  * @param {boolean} [options.a11y] - Enable accessibility rules.
  * @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, a11y = true, importOrder = true, jsdoc = true } = options;
 
-  // ---- Extends Configs ----
-  // Build the extends array based on enabled features
-  const extendsConfigs = [
-    'plugin:react/recommended',
-    'plugin:react-hooks/recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:import/recommended',
-    a11y && 'plugin:jsx-a11y/recommended',
-    jsdoc && 'plugin:jsdoc/recommended',
-    prettier && 'plugin:prettier/recommended',
-  ].filter(Boolean);
-
-  return defineConfig([
-    // ---- Global Ignores ----
-    ...commonIgnores,
-
-    // ---- Extends Configs ----
-    ...compat.extends(...extendsConfigs),
-
-    {
-      // ---- TypeScript Files Configuration ----
-      // Apply to TypeScript files
-      files: files.withTs,
-
-      // ---- Language Options ----
-      languageOptions: {
-        ...commonLanguageOptions,
-        ...commonParser,
-        // ---- Parser Options ----
-        // Configure TypeScript parser with React JSX support
-        parserOptions: { ecmaFeatures: { jsx: true }, tsconfigRootDir: process.cwd() },
-      },
-
-      // ---- Settings ----
-      settings: { react: { version: 'detect' }, ...(importOrder && { 'import/resolver': { typescript: {} } }) },
-
-      // ---- Rules ----
-      rules: {
-        // ---- React Rules ----
-        // Disable React import requirement (Next.js handles this)
-        'react/react-in-jsx-scope': 'off',
-        // Allow JSX and global attributes
-        'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }],
-        // ---- Common Rules ----
-        // Apply shared rules
-        ...commonRules({ prettier, importOrder, jsdoc }),
-      },
-    },
-  ]);
+  return buildConfig({
+    compat,
+    files: files.withTs,
+    builtinPlugins: [
+      'plugin:react/recommended',
+      'plugin:react-hooks/recommended',
+      'plugin:@typescript-eslint/recommended',
+    ],
+    conditionalPlugins: { a11y: 'plugin:jsx-a11y/recommended' },
+    parserOptions: { ecmaFeatures: { jsx: true } },
+    settings: { react: { version: 'detect' } },
+    rules: { 'react/react-in-jsx-scope': 'off', 'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }] },
+    typescript: true,
+    options: { ...options, prettier, a11y, importOrder, jsdoc },
+  });
 };
 
 export default createConfig();

package/src/eslint/react.test.js

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

package/src/eslint/typescript.js

@@ -1,17 +1,15 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Eslint Configuration (Flat)
- * =====================================================================.
+ * =====================================================================
  * Purpose: Project-wide ESLint configuration for TypeScript.
  *          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, commonParser, commonRules, commonLanguageOptions, files } from './common.js';
+import { setup, buildConfig, files } from './lib/index.js';
 
 const { compat } = setup();
 
@@ -22,49 +20,27 @@ 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 = [
-    'plugin:@typescript-eslint/recommended',
-    importOrder && 'plugin:import/recommended',
-    jsdoc && 'plugin:jsdoc/recommended',
-    prettier && 'plugin:prettier/recommended',
-  ].filter(Boolean);
-
-  return defineConfig([
-    // ---- Global Ignores ----
-    ...commonIgnores,
-
-    // ---- Extends Configs ----
-    ...compat.extends(...extendsConfigs),
-
-    {
-      // ---- TypeScript Files Configuration ----
-      // Apply to TypeScript files
-      files: files.withTs,
-
-      // ---- Language Options ----
-      languageOptions: {
-        ...commonLanguageOptions,
-        ...commonParser,
-        // ---- Parser Options ----
-        // Configure TypeScript parser
-        parserOptions: { tsconfigRootDir: process.cwd() },
-      },
-
-      // ---- Settings ----
-      settings: { ...(importOrder && { 'import/resolver': { typescript: {} } }) },
-
-      // ---- Rules ----
-      rules: commonRules({ prettier, importOrder, jsdoc }),
-    },
-  ]);
+  return buildConfig({
+    compat,
+    files: files.withTs,
+    builtinPlugins: ['plugin:@typescript-eslint/recommended'],
+    typescript: true,
+    options: { ...options, prettier, importOrder, jsdoc },
+  });
 };
 
 export default createConfig();

package/src/eslint/typescript.test.js

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

package/src/index.js

@@ -1,11 +1,11 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Dev Configurations Index
- * =====================================================================.
+ * =====================================================================
  * Purpose: Central index file that re-exports all configuration presets
  *          for easy consumption by root-level config files.
  * Docs: https://github.com/vijay/repositories/projects/dev-config
- * =====================================================================.
+ * =====================================================================
  */
 
 /**

package/src/index.test.js

@@ -0,0 +1,36 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the main index.js exports.
+describe('index.js exports', () => {
+  // Test that all expected functions and objects are exported from the module.
+  it('should export functions', async () => {
+    try {
+      // Dynamically import the module to test its exports.
+      const module = await import('./index.js');
+
+      // Verify ESLint-related exports are functions.
+      expect(typeof module.eslint).toBe('function');
+      expect(typeof module.createEslintConfig).toBe('function');
+      expect(typeof module.eslintTs).toBe('function');
+      expect(typeof module.createEslintTsConfig).toBe('function');
+      expect(typeof module.eslintReact).toBe('function');
+      expect(typeof module.createEslintReactConfig).toBe('function');
+      expect(typeof module.eslintNext).toBe('function');
+      expect(typeof module.createEslintNextConfig).toBe('function');
+
+      // Verify config objects are exported.
+      expect(typeof module.prettier).toBe('object');
+      expect(typeof module.commitlint).toBe('object');
+      expect(typeof module.nextSitemap).toBe('object');
+
+      // Verify sitemap config function is exported.
+      expect(typeof module.createSitemapConfig).toBe('function');
+
+      // Verify Stylelint config object is exported.
+      expect(typeof module.stylelint).toBe('object');
+    } catch (error) {
+      // If import fails, expect an error to be defined.
+      expect(error).toBeDefined();
+    }
+  });
+});

package/src/jsconfig/index.test.js

@@ -0,0 +1,34 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the JavaScript base configuration file.
+describe('jsconfig/index.json', () => {
+  // Test that the jsconfig file is valid JSON and exports an object.
+  it('should be a valid JSON file', async () => {
+    // Dynamically import the JSON file with JSON assertion.
+    const module = await import('./index.json', { assert: { type: 'json' } });
+
+    // Verify that the default export is an object (valid JSON object).
+    expect(typeof module.default).toBe('object');
+  });
+
+  // Test that the jsconfig contains compilerOptions.
+  it('should have compilerOptions', async () => {
+    // Dynamically import the JSON file with JSON assertion.
+    const module = await import('./index.json', { assert: { type: 'json' } });
+
+    // Verify that compilerOptions property exists on the config object.
+    expect(module.default.compilerOptions).toBeDefined();
+
+    // Verify that compilerOptions is an object.
+    expect(typeof module.default.compilerOptions).toBe('object');
+  });
+
+  // Test that the jsconfig has exclude patterns defined as an array.
+  it('should have exclude patterns', async () => {
+    // Dynamically import the JSON file with JSON assertion.
+    const module = await import('./index.json', { assert: { type: 'json' } });
+
+    // Verify that exclude property exists and is an array (list of file patterns to exclude).
+    expect(Array.isArray(module.default.exclude)).toBe(true);
+  });
+});

package/src/next-sitemap/index.js

@@ -1,11 +1,11 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Next Sitemap Configuration
- * =====================================================================.
+ * =====================================================================
  * Purpose: Next.js sitemap configuration for generating SEO-friendly
  *          sitemaps with robots.txt support.
  * Docs:    https://github.com/iamvishnusankar/next-sitemap
- * =====================================================================.
+ * =====================================================================
  */
 
 /**

package/src/next-sitemap/index.test.js

@@ -0,0 +1,59 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for next-sitemap module's main entry point.
+describe('next-sitemap/index.js', () => {
+  // Test that the module exports the createSitemapConfig function.
+  it('should export createSitemapConfig function', async () => {
+    // Dynamically import the module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that createSitemapConfig is a function.
+    expect(typeof module.createSitemapConfig).toBe('function');
+  });
+
+  // Test that the module exports a default config object.
+  it('should export default config object', async () => {
+    // Dynamically import the module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that the default export is an object.
+    expect(typeof module.default).toBe('object');
+  });
+
+  // Test that createSitemapConfig returns config with provided siteUrl.
+  it('should return config with siteUrl', async () => {
+    // Dynamically import the module to test its function.
+    const module = await import('./index.js');
+
+    // Call createSitemapConfig with a siteUrl parameter.
+    const config = module.createSitemapConfig({ siteUrl: 'https://example.com' });
+
+    // Verify that the returned config contains the provided siteUrl.
+    expect(config.siteUrl).toBe('https://example.com');
+  });
+
+  // Test that createSitemapConfig returns config with default values when no params provided.
+  it('should return config with default values', async () => {
+    // Dynamically import the module to test its function.
+    const module = await import('./index.js');
+
+    // Call createSitemapConfig without parameters to get defaults.
+    const config = module.createSitemapConfig();
+
+    // Verify default siteUrl and outDir values.
+    expect(config.siteUrl).toBe('https://example.com');
+    expect(config.outDir).toBe('./public');
+  });
+
+  // Test that generateRobotsTxt is enabled by default in the config.
+  it('should have generateRobotsTxt enabled', async () => {
+    // Dynamically import the module to test its function.
+    const module = await import('./index.js');
+
+    // Call createSitemapConfig to get default config.
+    const config = module.createSitemapConfig();
+
+    // Verify that generateRobotsTxt is enabled by default.
+    expect(config.generateRobotsTxt).toBe(true);
+  });
+});

package/src/prettier/index.js

@@ -1,12 +1,12 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Prettier Configuration
- * =====================================================================.
+ * =====================================================================
  * Purpose: Code formatting configuration for consistent style across
  *          the project.
  * Docs:    https://prettier.io/docs/en/configuration.html
  * Usage:   npx prettier --write .
- * =====================================================================.
+ * =====================================================================
  */
 
 /** @type {import("prettier").Config} */
@@ -38,6 +38,11 @@ const config = {
   experimentalOperatorPosition: 'start',
   // Collapse object literals
   objectWrap: 'collapse',
+  // Ensures that whitespace in XML is preserved as-is
+  xmlWhitespaceSensitivity: 'strict',
+
+  // ---- Plugins ----
+  plugins: ['@prettier/plugin-xml'],
 
   // ---- Overrides ----
   // Different formatting rules for different file types
@@ -63,6 +68,10 @@ const config = {
     // ---- YAML ----
     // Use yaml parser with 2-space indentation
     { files: ['*.yml', '*.yaml'], options: { parser: 'yaml', tabWidth: 2 } },
+
+    // ---- XML ----
+    // Use 2-space indentation for XML files
+    { files: ['.xml', '.xsd', '.xsl', '.xslt'], options: { tabWidth: 2 } },
   ],
 };
 

package/src/prettier/index.test.js

@@ -0,0 +1,39 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the Prettier configuration.
+describe('prettier/index.js', () => {
+  // Test that the module exports a default config object.
+  it('should export default config object', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./index.js');
+
+    // Verify default export is an object.
+    expect(typeof module.default).toBe('object');
+  });
+
+  // Test that the config has the correct Prettier properties.
+  it('should have correct Prettier configuration properties', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./index.js');
+    const config = module.default;
+
+    // Verify basic formatting options.
+    expect(config.printWidth).toBe(120);
+    expect(config.tabWidth).toBe(2);
+    expect(config.useTabs).toBe(false);
+    expect(config.semi).toBe(true);
+    expect(config.singleQuote).toBe(false);
+    expect(config.trailingComma).toBe('es5');
+  });
+
+  // Test that the config has overrides for different file types.
+  it('should have overrides for different file types', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./index.js');
+    const config = module.default;
+
+    // Verify overrides array exists and has entries.
+    expect(Array.isArray(config.overrides)).toBe(true);
+    expect(config.overrides.length).toBeGreaterThan(0);
+  });
+});

package/src/stylelint/index.js

@@ -1,12 +1,12 @@
 /**
- * =====================================================================.
+ * =====================================================================
  * Stylelint Configuration
- * =====================================================================.
+ * =====================================================================
  * Purpose: CSS/SCSS linting configuration for consistent styling and
  *          proper property ordering.
  * Docs:    https://stylelint.io/user-guide/configure
  * Usage:   npx stylelint .
- * =====================================================================.
+ * =====================================================================
  */
 
 /** @type {import("stylelint").Config} */