@vijayhardaha/dev-config 1.0.11 → 1.1.0

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

@@ -0,0 +1,31 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint file patterns configuration module.
+describe('eslint/lib/files.js', () => {
+  // Test that the module exports a files object with TypeScript and non-TypeScript file arrays.
+  it('should export files object with withTs and withoutTs arrays', async () => {
+    // Dynamically import the files module to test its exports.
+    const module = await import('./files.js');
+
+    // Verify that files is an object.
+    expect(typeof module.files).toBe('object');
+
+    // Verify that withTs is an array (file patterns for TypeScript files).
+    expect(Array.isArray(module.files.withTs)).toBe(true);
+
+    // Verify that withoutTs is an array (file patterns for JavaScript files).
+    expect(Array.isArray(module.files.withoutTs)).toBe(true);
+  });
+
+  // Test that the file patterns are correctly defined for TypeScript and JavaScript files.
+  it('should have correct file patterns', async () => {
+    // Dynamically import the files module to test its exports.
+    const module = await import('./files.js');
+
+    // Verify that withTs array contains the pattern for TypeScript files.
+    expect(module.files.withTs).toContain('**/*.{js,jsx,mjs,cjs,ts,tsx}');
+
+    // Verify that withoutTs array contains the pattern for JavaScript-only files.
+    expect(module.files.withoutTs).toContain('**/*.{js,jsx,mjs,cjs}');
+  });
+});

package/src/eslint/lib/ignores.js

@@ -0,0 +1,184 @@
+import { globalIgnores as eslintGlobalIgnores } from 'eslint/config';
+
+/**
+ * Git-related ignore patterns.
+ */
+const gitIgnores = ['**/.git/', '**/.husky/'];
+
+/**
+ * IDE and editor ignore patterns.
+ */
+const ideIgnores = ['**/.idea/', '**/.vscode/'];
+
+/**
+ * Node.js and package manager ignore patterns.
+ */
+const nodeIgnores = ['**/node_modules/'];
+
+/**
+ * Build and output ignore patterns.
+ */
+const buildIgnores = [
+  '**/.next/',
+  '**/.turbo/',
+  '**/.vercel/',
+  '**/*.tsbuildinfo',
+  '**/assets/',
+  '**/build/',
+  '**/dist/',
+  '**/out/',
+];
+
+/**
+ * Test and coverage ignore patterns.
+ */
+const testIgnores = ['**/coverage/', '**/test-results/', '**/.playwright-report/'];
+
+/**
+ * Cache and temporary file ignore patterns.
+ */
+const cacheIgnores = ['**/.cache/', '**/*.log', '**/.DS_Store', '**/Thumbs.db', '**/*.tmp'];
+
+/**
+ * Environment and config file ignore patterns.
+ */
+const envIgnores = ['**/.env*', '**/next-env.d.ts'];
+
+/**
+ * OS-specific ignore patterns.
+ */
+const osIgnores = ['**/.DS_Store', '**/Thumbs.db'];
+
+/**
+ * Next.js-specific ignore patterns.
+ */
+const nextIgnores = ['**/.next/', '**/next-env.d.ts'];
+
+/**
+ * Netlify-specific ignore patterns.
+ */
+const netlifyIgnores = ['**/.netlify/'];
+
+/**
+ * Vercel-specific ignore patterns.
+ */
+const vercelIgnores = ['**/.vercel/'];
+
+/**
+ * Svelte-specific ignore patterns.
+ */
+const svelteIgnores = ['**/.svelte-kit/'];
+
+/**
+ * Webpack-specific ignore patterns.
+ */
+const webpackIgnores = ['**/webpack-cache/'];
+
+/**
+ * Gulp-specific ignore patterns.
+ */
+const gulpIgnores = ['**/.gulp/'];
+
+/**
+ * Grunt-specific ignore patterns.
+ */
+const gruntIgnores = ['**/.grunt/'];
+
+/**
+ * Public assets ignore patterns.
+ */
+const publicIgnores = ['**/public/'];
+
+/**
+ * AI coding tools ignore patterns.
+ */
+const aiIgnores = ['**/.claude/', '**/.codex/', '**/.kilo/', '**/.opencode/', '**/.qoder/', '**/.vibe/', '**/.droid/'];
+
+/**
+ * Minified files ignore patterns.
+ */
+const minifiedIgnores = ['**/*.min.js', '**/*.min.css', '**/*.min.js.map', '**/*.min.css.map'];
+
+/**
+ * WordPress-specific ignore patterns.
+ */
+const wordpressIgnores = [
+  '**/wp-admin/',
+  '**/wp-includes/',
+  '**/wp-content/uploads/',
+  '**/wp-content/cache/',
+  '**/wp-content/upgrade/',
+  '**/wp-config.php',
+  '**/wp-*.php',
+];
+
+/**
+ * WooCommerce-specific ignore patterns.
+ */
+const woocommerceIgnores = [
+  '**/wc-logs/',
+  '**/wc-transients/',
+  '**/wp-content/plugins/woocommerce/**/*.min.js',
+  '**/wp-content/plugins/woocommerce/**/*.min.css',
+];
+
+/**
+ * PHP-specific ignore patterns.
+ */
+const phpIgnores = ['**/vendor/', '**/.php-cs-fixer-cache', '**/composer.lock', '**/phpunit.xml', '**/coverage/'];
+
+/**
+ * Laravel-specific ignore patterns.
+ */
+const laravelIgnores = [
+  '**/vendor/',
+  '**/storage/',
+  '**/bootstrap/cache/',
+  '**/.env',
+  '**/.env.*',
+  '**/composer.lock',
+  '**/phpunit.xml',
+  '**/coverage/',
+];
+
+/**
+ * Default global ignore patterns - combines all common patterns.
+ */
+const defaultIgnores = [
+  ...gitIgnores,
+  ...ideIgnores,
+  ...nodeIgnores,
+  ...buildIgnores,
+  ...testIgnores,
+  ...cacheIgnores,
+  ...envIgnores,
+  ...osIgnores,
+  ...nextIgnores,
+  ...netlifyIgnores,
+  ...vercelIgnores,
+  ...svelteIgnores,
+  ...webpackIgnores,
+  ...gulpIgnores,
+  ...gruntIgnores,
+  ...publicIgnores,
+  ...aiIgnores,
+  ...wordpressIgnores,
+  ...woocommerceIgnores,
+  ...phpIgnores,
+  ...laravelIgnores,
+  ...minifiedIgnores,
+];
+
+/**
+ * Creates a global ignores configuration using ESLint's globalIgnores helper.
+ * Merges provided ignores with default ignores and filters for unique values.
+ *
+ * @param {string[]} [userIgnores] - Additional ignore patterns to merge.
+ *
+ * @returns {import('eslint').Linter.Config[]} Global ignores configuration.
+ */
+export const globalIgnores = (userIgnores = []) => {
+  const merged = [...defaultIgnores, ...userIgnores];
+  const unique = [...new Set(merged)];
+  return [eslintGlobalIgnores(unique)];
+};

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

@@ -0,0 +1,37 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint global ignores configuration module.
+describe('eslint/lib/ignores.js', () => {
+  // Test that the module exports the globalIgnores function.
+  it('should export globalIgnores function', async () => {
+    // Dynamically import the ignores module to test its exports.
+    const module = await import('./ignores.js');
+
+    // Verify that globalIgnores is a function.
+    expect(typeof module.globalIgnores).toBe('function');
+  });
+
+  // Test that globalIgnores returns an array (ESLint's expected format for ignores).
+  it('should return an array of config objects', async () => {
+    // Dynamically import the ignores module to test its function.
+    const module = await import('./ignores.js');
+
+    // Call globalIgnores with no parameters to get default ignores.
+    const result = module.globalIgnores();
+
+    // Verify that the result is an array (ESLint expects ignores as an array).
+    expect(Array.isArray(result)).toBe(true);
+  });
+
+  // Test that globalIgnores properly merges user-provided ignores with defaults.
+  it('should merge user ignores with default ignores', async () => {
+    // Dynamically import the ignores module to test its function.
+    const module = await import('./ignores.js');
+
+    // Call globalIgnores with a custom ignore pattern.
+    const result = module.globalIgnores(['**/custom-ignore/']);
+
+    // Verify that the result is still an array (merged ignores).
+    expect(Array.isArray(result)).toBe(true);
+  });
+});

package/src/eslint/lib/index.js

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

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

@@ -0,0 +1,37 @@
+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.
+    const module = await import('./index.js');
+
+    // Verify that files is an object.
+    expect(typeof module.files).toBe('object');
+
+    // Verify that files.withTs is an array (TypeScript file patterns).
+    expect(Array.isArray(module.files.withTs)).toBe(true);
+
+    // Verify that files.withoutTs is an array (JavaScript file patterns).
+    expect(Array.isArray(module.files.withoutTs)).toBe(true);
+  });
+
+  // Test that the module exports the buildConfig function.
+  it('should export buildConfig function', async () => {
+    // Dynamically import the index module to test its exports.
+    const module = await import('./index.js');
+
+    // Verify that buildConfig is a function.
+    expect(typeof module.buildConfig).toBe('function');
+  });
+});

package/src/eslint/lib/language-options.js

@@ -0,0 +1,13 @@
+import globals from 'globals';
+
+/**
+ * Common language options for ESLint including ECMAScript version,
+ * source type, and global variables.
+ *
+ * @type {import('eslint').Linter.LanguageOptions}
+ */
+export const commonLanguageOptions = {
+  ecmaVersion: 'latest',
+  sourceType: 'module',
+  globals: { ...globals.browser, ...globals.node },
+};

package/src/eslint/lib/language-options.test.js

@@ -0,0 +1,28 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint language options configuration module.
+describe('eslint/lib/language-options.js', () => {
+  // Test that the module exports the commonLanguageOptions object.
+  it('should export commonLanguageOptions object', async () => {
+    // Dynamically import the language-options module to test its exports.
+    const module = await import('./language-options.js');
+
+    // Verify that commonLanguageOptions is an object.
+    expect(typeof module.commonLanguageOptions).toBe('object');
+  });
+
+  // Test that the exported language options have the correct properties.
+  it('should have correct language options properties', async () => {
+    // Dynamically import the language-options module to test its exports.
+    const module = await import('./language-options.js');
+
+    // Verify that ecmaVersion is set to 'latest' (ESLint's latest ECMAScript version).
+    expect(module.commonLanguageOptions.ecmaVersion).toBe('latest');
+
+    // Verify that sourceType is set to 'module' (ES modules).
+    expect(module.commonLanguageOptions.sourceType).toBe('module');
+
+    // Verify that globals is an object (containing global variable definitions).
+    expect(typeof module.commonLanguageOptions.globals).toBe('object');
+  });
+});

package/src/eslint/{common.js → lib/rules.js}

@@ -1,94 +1,3 @@
-/**
- * =====================================================================.
- * Eslint Common Configuration
- * =====================================================================.
- * Purpose: Shared setup for all ESLint configurations including common
- *          ignores, parser setup, and rule definitions.
- * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
- * =====================================================================.
- */
-
-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';
-import { globalIgnores } from 'eslint/config';
-import globals from 'globals';
-
-/**
- * Global ignore patterns for ESLint to skip build artifacts, dependencies,
- * and generated files during linting.
- */
-export const ignores = [
-  '**/.git/',
-  '**/.idea/',
-  '**/.vscode/',
-  '**/.husky/',
-  '**/node_modules/',
-  '**/.next/',
-  '**/dist/',
-  '**/build/',
-  '**/out/',
-  '**/.vercel/',
-  '**/.cache/',
-  '**/.turbo/',
-  '**/*.tsbuildinfo',
-  '**/coverage/',
-  '**/test-results/',
-  '**/.playwright-report/',
-  '**/public/',
-  '**/.env*',
-  '**/next-env.d.ts',
-  '**/*.log',
-  '**/.DS_Store',
-  '**/Thumbs.db',
-  '**/*.tmp',
-];
-
-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 });
-
-/**
- * Global ignores configuration using ESLint's globalIgnores helper.
- *
- * @type {import('eslint').Linter.Config}
- */
-export const commonIgnores = [globalIgnores(ignores)];
-
-/**
- * Common parser configuration for TypeScript files.
- *
- * @type {{ parser: typeof tsParser }}
- */
-export const commonParser = { parser: tsParser };
-
-/**
- * Common language options for ESLint including ECMAScript version,
- * source type, and global variables.
- *
- * @type {import('eslint').Linter.LanguageOptions}
- */
-export const commonLanguageOptions = {
-  ecmaVersion: 'latest',
-  sourceType: 'module',
-  globals: { ...globals.browser, ...globals.node },
-};
-
 /**
  * Creates JSDoc rules for enforcing documentation on public/exported APIs.
  *
@@ -96,7 +5,7 @@ export const commonLanguageOptions = {
  *
  * @returns {object} JSDoc ESLint rules object.
  */
-export const jsdocRules = (jsdoc = true) =>
+const jsdocRules = (jsdoc = true) =>
   jsdoc
     ? {
         // ---- JSDoc Rules for PUBLIC / EXPORTED APIs ----
@@ -115,7 +24,6 @@ export const jsdocRules = (jsdoc = true) =>
 
         // Descriptions must exist and be meaningful
         'jsdoc/require-description': 'error',
-        'jsdoc/require-description-complete-sentence': ['error', { tags: ['param', 'returns'] }],
 
         // Params must be fully documented
         'jsdoc/require-param': 'error',
@@ -150,7 +58,7 @@ export const jsdocRules = (jsdoc = true) =>
 
         // Avoid useless docs
         'jsdoc/no-types': 'off',
-        'jsdoc/informative-docs': 'warn',
+        'jsdoc/informative-docs': 'off',
 
         // Enforce property docs in typedef-style (optional)
         'jsdoc/require-property-description': 'warn',
@@ -164,7 +72,7 @@ export const jsdocRules = (jsdoc = true) =>
  *
  * @returns {object} TypeScript ESLint rules object.
  */
-export const tsRules = (typescript = true) =>
+const tsRules = (typescript = true) =>
   typescript
     ? {
         '@typescript-eslint/no-unused-vars': [
@@ -188,7 +96,7 @@ export const tsRules = (typescript = true) =>
  *
  * @returns {object} Prettier ESLint rules object.
  */
-export const prettierRules = (prettier = true) => (prettier ? { 'prettier/prettier': 'warn' } : {});
+const prettierRules = (prettier = true) => (prettier ? { 'prettier/prettier': 'warn' } : {});
 
 /**
  * Creates import order rules.
@@ -197,7 +105,7 @@ export const prettierRules = (prettier = true) => (prettier ? { 'prettier/pretti
  *
  * @returns {object} Import order ESLint rules object.
  */
-export const importOrderRules = (importOrder = true) =>
+const importOrderRules = (importOrder = true) =>
   importOrder
     ? {
         'import/order': [
@@ -245,10 +153,3 @@ export const commonRules = (options = {}) => {
     ...jsdocRules(jsdoc),
   };
 };
-
-/**
- * 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}'] };

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

@@ -0,0 +1,73 @@
+import { describe, it, expect } from 'vitest';
+
+// Test suite for the ESLint rules configuration module.
+describe('eslint/lib/rules.js', () => {
+  // Test that the module exports the commonRules function.
+  it('should export commonRules function', async () => {
+    // Dynamically import the rules module to test its exports.
+    const module = await import('./rules.js');
+
+    // Verify that commonRules is a function.
+    expect(typeof module.commonRules).toBe('function');
+  });
+
+  // Test that commonRules returns an object containing ESLint rules.
+  it('should return an object with rules', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./rules.js');
+
+    // Call commonRules with no options to get base rules.
+    const result = module.commonRules();
+
+    // Verify that the result is an object (ESLint rules config).
+    expect(typeof result).toBe('object');
+  });
+
+  // Test that TypeScript rules are included when typescript option is true.
+  it('should include TypeScript rules when typescript is true', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./rules.js');
+
+    // Call commonRules with typescript option enabled.
+    const result = module.commonRules({ typescript: true });
+
+    // Verify that a TypeScript-specific rule is present in the config.
+    expect(result['@typescript-eslint/no-unused-vars']).toBeDefined();
+  });
+
+  // Test that import order rules are included when importOrder option is true.
+  it('should include import order rules when importOrder is true', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./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();
+  });
+
+  // Test that Prettier rules are included when prettier option is true.
+  it('should include Prettier rules when prettier is true', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./rules.js');
+
+    // Call commonRules with prettier option enabled.
+    const result = module.commonRules({ prettier: true });
+
+    // Verify that the prettier/prettier rule is present in the config.
+    expect(result['prettier/prettier']).toBeDefined();
+  });
+
+  // Test that JSDoc rules are included when jsdoc option is true.
+  it('should include JSDoc rules when jsdoc is true', async () => {
+    // Dynamically import the rules module to test its function.
+    const module = await import('./rules.js');
+
+    // Call commonRules with jsdoc option enabled.
+    const result = module.commonRules({ jsdoc: true });
+
+    // Verify that the jsdoc/require-jsdoc rule is present in the config.
+    expect(result['jsdoc/require-jsdoc']).toBeDefined();
+  });
+});

package/src/eslint/lib/setup.js

@@ -0,0 +1,29 @@
+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.
+ *
+ * @type {{ parser: typeof tsParser }}
+ */
+export const commonParser = { parser: tsParser };

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

@@ -0,0 +1,25 @@
+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.
+    const module = await import('./setup.js');
+
+    // Verify that commonParser is an object.
+    expect(typeof module.commonParser).toBe('object');
+
+    // Verify that commonParser has a parser property defined.
+    expect(module.commonParser.parser).toBeDefined();
+  });
+});