@vijayhardaha/dev-config 2.2.0 → 2.3.0

package/src/lib/validators.js

@@ -0,0 +1,225 @@
+/**
+ * =====================================================================
+ * Configuration Validators
+ * =====================================================================
+ * Purpose: Centralized validation functions for all configuration builders.
+ *          Ensures consistent error handling and helpful error messages.
+ * Usage:   Import validators and use in createConfig functions
+ * =====================================================================
+ */
+
+/**
+ * Validates that a URL is properly formatted.
+ *
+ * @param {string} url - URL to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If url is not a string.
+ * @throws {Error} If url is empty.
+ * @throws {Error} If url is not a valid URL.
+ */
+export function validateUrl(url, fieldName = 'URL') {
+  if (typeof url !== 'string') {
+    throw new TypeError(`${fieldName} must be a string, got ${typeof url}`);
+  }
+
+  if (url.trim().length === 0) {
+    throw new Error(`${fieldName} cannot be empty`);
+  }
+
+  try {
+    new URL(url);
+  } catch {
+    throw new Error(`Invalid ${fieldName}: "${url}" is not a valid URL`);
+  }
+}
+
+/**
+ * Validates that a value is an array.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not an array.
+ */
+export function validateArray(value, fieldName = 'Array') {
+  if (!Array.isArray(value)) {
+    throw new TypeError(`${fieldName} must be an array, got ${typeof value}`);
+  }
+}
+
+/**
+ * Validates that an array is not empty.
+ *
+ * @param {unknown[]} array - Array to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If array is not an array.
+ * @throws {Error} If array is empty.
+ */
+export function validateNonEmptyArray(array, fieldName = 'Array') {
+  validateArray(array, fieldName);
+
+  if (array.length === 0) {
+    throw new Error(`${fieldName} cannot be empty`);
+  }
+}
+
+/**
+ * Validates that a value is an object.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not an object or is null.
+ */
+export function validateObject(value, fieldName = 'Object') {
+  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+    throw new TypeError(`${fieldName} must be an object, got ${typeof value}`);
+  }
+}
+
+/**
+ * Validates that a value is a string.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not a string.
+ */
+export function validateString(value, fieldName = 'String') {
+  if (typeof value !== 'string') {
+    throw new TypeError(`${fieldName} must be a string, got ${typeof value}`);
+  }
+}
+
+/**
+ * Validates that a string is not empty.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not a string.
+ * @throws {Error} If value is empty.
+ */
+export function validateNonEmptyString(value, fieldName = 'String') {
+  validateString(value, fieldName);
+
+  if (value.trim().length === 0) {
+    throw new Error(`${fieldName} cannot be empty`);
+  }
+}
+
+/**
+ * Validates that a value is a boolean.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not a boolean.
+ */
+export function validateBoolean(value, fieldName = 'Boolean') {
+  if (typeof value !== 'boolean') {
+    throw new TypeError(`${fieldName} must be a boolean, got ${typeof value}`);
+  }
+}
+
+/**
+ * Validates that a value is a number.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not a number.
+ * @throws {Error} If value is NaN or Infinity.
+ */
+export function validateNumber(value, fieldName = 'Number') {
+  if (typeof value !== 'number' || !Number.isFinite(value)) {
+    throw new TypeError(`${fieldName} must be a valid number, got ${typeof value}`);
+  }
+}
+
+/**
+ * Validates that a number is within a specific range.
+ *
+ * @param {unknown} value - Value to validate.
+ * @param {number} min - Minimum allowed value (inclusive).
+ * @param {number} max - Maximum allowed value (inclusive).
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If value is not a valid number.
+ * @throws {Error} If value is outside the range.
+ */
+export function validateNumberInRange(value, min, max, fieldName = 'Number') {
+  validateNumber(value, fieldName);
+
+  if (value < min || value > max) {
+    throw new Error(`${fieldName} must be between ${min} and ${max}, got ${value}`);
+  }
+}
+
+/**
+ * Validates that all array items are strings.
+ *
+ * @param {unknown[]} array - Array to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If array is not an array.
+ * @throws {TypeError} If any item is not a string.
+ */
+export function validateStringArray(array, fieldName = 'Array') {
+  validateArray(array, fieldName);
+
+  for (let i = 0; i < array.length; i++) {
+    if (typeof array[i] !== 'string') {
+      throw new TypeError(`${fieldName}[${i}] must be a string, got ${typeof array[i]}`);
+    }
+  }
+}
+
+/**
+ * Validates that an object has specific required keys.
+ *
+ * @param {unknown} obj - Object to validate.
+ * @param {string[]} requiredKeys - Keys that must exist.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If obj is not an object.
+ * @throws {Error} If any required key is missing.
+ */
+export function validateObjectKeys(obj, requiredKeys, fieldName = 'Object') {
+  validateObject(obj, fieldName);
+
+  for (const key of requiredKeys) {
+    if (!(key in obj)) {
+      throw new Error(`${fieldName} is missing required key: "${key}"`);
+    }
+  }
+}
+
+/**
+ * Validates configuration rules object.
+ *
+ * @param {unknown} rules - Rules object to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If rules is not an object.
+ */
+export function validateRules(rules, fieldName = 'Rules') {
+  if (typeof rules !== 'object' || rules === null || Array.isArray(rules)) {
+    throw new TypeError(`${fieldName} must be an object, got ${typeof rules}`);
+  }
+}
+
+/**
+ * Validates file patterns array.
+ *
+ * @param {unknown} patterns - File patterns to validate.
+ * @param {string} [fieldName] - Field name for error message.
+ *
+ * @throws {TypeError} If patterns is not an array.
+ * @throws {TypeError} If any pattern is not a string.
+ */
+export function validateFilePatterns(patterns, fieldName = 'File patterns') {
+  validateStringArray(patterns, fieldName);
+}

package/src/next-sitemap/{index.test.js → __tests__/index.test.js}

@@ -5,7 +5,7 @@ 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');
+    const module = await import('../index.js');
 
     // Verify that createSitemapConfig is a function.
     expect(typeof module.createSitemapConfig).toBe('function');
@@ -14,7 +14,7 @@ describe('next-sitemap/index.js', () => {
   // 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');
+    const module = await import('../index.js');
 
     // Verify that the default export is an object.
     expect(typeof module.default).toBe('object');
@@ -23,7 +23,7 @@ describe('next-sitemap/index.js', () => {
   // 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');
+    const module = await import('../index.js');
 
     // Call createSitemapConfig with a siteUrl parameter.
     const config = module.createSitemapConfig({ siteUrl: 'https://example.com' });
@@ -35,7 +35,7 @@ describe('next-sitemap/index.js', () => {
   // 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');
+    const module = await import('../index.js');
 
     // Call createSitemapConfig without parameters to get defaults.
     const config = module.createSitemapConfig();
@@ -48,7 +48,7 @@ describe('next-sitemap/index.js', () => {
   // 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');
+    const module = await import('../index.js');
 
     // Call createSitemapConfig to get default config.
     const config = module.createSitemapConfig();
@@ -56,4 +56,30 @@ describe('next-sitemap/index.js', () => {
     // Verify that generateRobotsTxt is enabled by default.
     expect(config.generateRobotsTxt).toBe(true);
   });
+
+  // Test that transformRobotsTxt removes the Host header from generated robots.txt.
+  it('should remove Host header in transformRobotsTxt', async () => {
+    // Dynamically import the module to test its function.
+    const module = await import('../index.js');
+
+    // Call createSitemapConfig with a test siteUrl.
+    const config = module.createSitemapConfig({ siteUrl: 'https://example.com' });
+
+    // Verify that robotsTxtOptions has the transformRobotsTxt function.
+    expect(typeof config.robotsTxtOptions.transformRobotsTxt).toBe('function');
+
+    // Mock a robots.txt output with the Host header that next-sitemap generates.
+    const mockRobotsTxt = `# Host\nHost: https://example.com\n\nUser-agent: *\nAllow: /\n`;
+
+    // Call the transformRobotsTxt function with mock data.
+    const transformed = await config.robotsTxtOptions.transformRobotsTxt(config, mockRobotsTxt);
+
+    // Verify that the Host header has been removed from the output.
+    expect(transformed).not.toContain('# Host');
+    expect(transformed).not.toContain('Host: https://example.com');
+
+    // Verify that the rest of the robots.txt content is preserved.
+    expect(transformed).toContain('User-agent: *');
+    expect(transformed).toContain('Allow: /');
+  });
 });

package/src/next-sitemap/index.js

@@ -8,6 +8,9 @@
  * =====================================================================
  */
 
+import { SITEMAP } from '../config-constants.js';
+import { validateUrl, validateStringArray, validateNonEmptyString } from '../lib/validators.js';
+
 /**
  * Creates a sitemap configuration object for next-sitemap.
  *
@@ -17,9 +20,20 @@
  * @param {string[]} [options.exclude] - Paths to exclude from sitemap.
  *
  * @returns {import('next-sitemap').IConfig} Sitemap configuration object.
+ *
+ * @throws {Error} If required parameters are invalid.
  */
 export function createSitemapConfig(options = {}) {
-  const { siteUrl = 'https://example.com', outDir = './public', exclude = ['/404', '/500'] } = options;
+  const {
+    siteUrl = SITEMAP.DEFAULTS.SITE_URL,
+    outDir = SITEMAP.DEFAULTS.OUTPUT_DIR,
+    exclude = SITEMAP.DEFAULTS.EXCLUDE_PATHS,
+  } = options;
+
+  // ---- Validation ----
+  validateUrl(siteUrl, 'siteUrl');
+  validateNonEmptyString(outDir, 'outDir');
+  validateStringArray(exclude, 'exclude');
 
   // ---- Last Modified ----
   // Use current timestamp for all sitemap entries
@@ -28,13 +42,13 @@ export function createSitemapConfig(options = {}) {
   return {
     // ---- Basic Settings ----
     siteUrl,
-    sitemapBaseFileName: 'sitemap',
-    trailingSlash: false,
+    sitemapBaseFileName: SITEMAP.DEFAULTS.SITEMAP_FILENAME,
+    trailingSlash: SITEMAP.DEFAULTS.TRAILING_SLASH,
 
     // ---- Output Settings ----
     outDir,
-    changefreq: 'weekly',
-    priority: 0.7,
+    changefreq: SITEMAP.DEFAULTS.CHANGE_FREQUENCY,
+    priority: SITEMAP.DEFAULTS.PRIORITY,
     exclude,
 
     // ---- Transform Function ----
@@ -44,13 +58,13 @@ export function createSitemapConfig(options = {}) {
     },
 
     // ---- Robots.txt Generation ----
-    generateRobotsTxt: true,
+    generateRobotsTxt: SITEMAP.DEFAULTS.GENERATE_ROBOTS_TXT,
     robotsTxtOptions: {
-      policies: [{ userAgent: '*', allow: '/' }],
+      policies: [{ userAgent: SITEMAP.ROBOTS_TXT.USER_AGENT, allow: SITEMAP.ROBOTS_TXT.ALLOW }],
       // ---- Custom Robots.txt Transform ----
       // Remove the default Host header from generated robots.txt
       transformRobotsTxt: async (_config, robotsTxt) => {
-        const hostHeader = `# Host\nHost: ${siteUrl}\n\n`;
+        const hostHeader = `${SITEMAP.HEADERS.HOST}\nHost: ${siteUrl}\n\n`;
         return robotsTxt.replace(hostHeader, '');
       },
     },

package/src/prettier/{index.test.js → __tests__/index.test.js}

@@ -5,7 +5,7 @@ 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');
+    const module = await import('../index.js');
 
     // Verify default export is an object.
     expect(typeof module.default).toBe('object');
@@ -14,7 +14,7 @@ describe('prettier/index.js', () => {
   // 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 module = await import('../index.js');
     const config = module.default;
 
     // Verify basic formatting options.
@@ -29,7 +29,7 @@ describe('prettier/index.js', () => {
   // 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 module = await import('../index.js');
     const config = module.default;
 
     // Verify overrides array exists and has entries.
@@ -39,7 +39,7 @@ describe('prettier/index.js', () => {
 
   // Test that XML-like extensions are matched as normal file globs.
   it('should use XML glob patterns that match normal files', async () => {
-    const module = await import('./index.js');
+    const module = await import('../index.js');
     const xmlOverride = module.default.overrides.find((override) => override.options?.xmlWhitespaceSensitivity);
 
     expect(xmlOverride.files).toEqual(['**/*.xml', '**/*.xsd', '**/*.xsl', '**/*.xslt']);

package/src/prettier/index.js

@@ -9,72 +9,36 @@
  * =====================================================================
  */
 
+import { PRETTIER } from '../config-constants.js';
+
 /** @type {import("prettier").Config} */
 const config = {
   // ---- Basic Settings ----
-  // Maximum line width before wrapping
-  printWidth: 120,
-  // Number of spaces per indentation
-  tabWidth: 2,
-  // Use spaces instead of tabs
-  useTabs: false,
-  // Add semicolons at the end of statements
-  semi: true,
-  // Use single quotes for strings
-  singleQuote: false,
-  // Handle line endings automatically
-  endOfLine: 'auto',
-  // Always include parentheses around arrow function parameters
-  arrowParens: 'always',
-  // Trailing commas in multi-line structures
-  trailingComma: 'es5',
-  // Add spaces between object braces
-  bracketSpacing: true,
-  // Do not put single-line objects on a single line
-  bracketSameLine: false,
-  // Preserve prose wrapping in Markdown files
-  proseWrap: 'preserve',
-  // Experimental operator position at start
-  experimentalOperatorPosition: 'start',
-  // Collapse object literals
-  objectWrap: 'collapse',
-  // Ensures that whitespace in XML is preserved as-is
-  xmlWhitespaceSensitivity: 'preserve',
+  ...PRETTIER.BASE,
 
   // ---- Plugins ----
-  plugins: ['@prettier/plugin-xml'],
+  plugins: [PRETTIER.PLUGINS.XML],
 
   // ---- Overrides ----
   // Different formatting rules for different file types
   overrides: [
     // ---- Backend Languages ----
-    // Use 4-space indentation for Python and PHP
-    { files: ['*.py', '*.php'], options: { tabWidth: 4, useTabs: false } },
+    { files: PRETTIER.FILE_PATTERNS.BACKEND, options: PRETTIER.OVERRIDES.BACKEND },
 
     // ---- JavaScript/TypeScript ----
-    // Use 2-space indentation and single quotes for JS/TS
-    { files: ['*.js', '*.ts', '*.mjs', '*.cjs', '*.jsx', '*.tsx'], options: { tabWidth: 2, singleQuote: true } },
+    { files: PRETTIER.FILE_PATTERNS.JAVASCRIPT, options: PRETTIER.OVERRIDES.JAVASCRIPT },
 
     // ---- Stylesheet Languages ----
-    // Use 2-space indentation for CSS/SCSS/SASS
-    { files: ['*.css', '*.scss', '*.sass'], options: { tabWidth: 2 } },
+    { files: PRETTIER.FILE_PATTERNS.STYLESHEETS, options: PRETTIER.OVERRIDES.STYLESHEETS },
 
     // ---- Data & Documentation ----
-    // Use 2-space indentation and no trailing commas for JSON/YAML/Markdown
-    {
-      files: ['*.json', '*.jsonc', '*.yml', '*.yaml', '*.md', '*.mdx'],
-      options: { tabWidth: 2, trailingComma: 'none' },
-    },
+    { files: PRETTIER.FILE_PATTERNS.DATA_AND_DOCS, options: PRETTIER.OVERRIDES.DATA_AND_DOCS },
+
     // ---- YAML ----
-    // Use yaml parser with 2-space indentation
-    { files: ['*.yml', '*.yaml'], options: { parser: 'yaml', tabWidth: 2 } },
+    { files: PRETTIER.FILE_PATTERNS.YAML, options: PRETTIER.OVERRIDES.YAML },
 
     // ---- XML ----
-    // Use 2-space indentation for XML files
-    {
-      files: ['**/*.xml', '**/*.xsd', '**/*.xsl', '**/*.xslt'],
-      options: { tabWidth: 2, xmlWhitespaceSensitivity: 'preserve' },
-    },
+    { files: PRETTIER.FILE_PATTERNS.XML, options: PRETTIER.OVERRIDES.XML },
   ],
 };
 

package/src/stylelint/{index.test.js → __tests__/index.test.js}

@@ -5,7 +5,7 @@ describe('stylelint/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');
+    const module = await import('../index.js');
 
     // Verify that the default export is an object (Stylelint config).
     expect(typeof module.default).toBe('object');
@@ -14,7 +14,7 @@ describe('stylelint/index.js', () => {
   // 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');
+    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);
@@ -23,7 +23,7 @@ describe('stylelint/index.js', () => {
   // Test that the config has a plugins array (contains Stylelint plugins).
   it('should have plugins property', async () => {
     // Dynamically import the index.js module to test its exports.
-    const module = await import('./index.js');
+    const module = await import('../index.js');
 
     // Verify that plugins is an array (list of Stylelint plugins).
     expect(Array.isArray(module.default.plugins)).toBe(true);
@@ -32,7 +32,7 @@ describe('stylelint/index.js', () => {
   // Test that the config has a rules object (contains Stylelint rules).
   it('should have rules property', async () => {
     // Dynamically import the index.js module to test its exports.
-    const module = await import('./index.js');
+    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');
@@ -41,7 +41,7 @@ describe('stylelint/index.js', () => {
   // Test that specific rules are disabled (set to null).
   it('should have disabled rules', async () => {
     // Dynamically import the index.js module to test its exports.
-    const module = await import('./index.js');
+    const module = await import('../index.js');
 
     // Verify that selector-class-pattern rule is disabled (null).
     expect(module.default.rules['selector-class-pattern']).toBeNull();

package/src/stylelint/index.js

@@ -9,15 +9,17 @@
  * =====================================================================
  */
 
+import { STYLELINT } from '../config-constants.js';
+
 /** @type {import("stylelint").Config} */
 const config = {
   // ---- Extends ----
   // Use standard SCSS configuration and property sort order
-  extends: ['stylelint-config-standard-scss', 'stylelint-config-property-sort-order-smacss'],
+  ...STYLELINT.DEFAULTS,
 
   // ---- Plugins ----
   // Use stylelint-order for property sorting
-  plugins: ['stylelint-order'],
+  plugins: [STYLELINT.PLUGINS.ORDER],
 
   // ---- Rules ----
   // Disable specific rules that are too strict or conflict with team style

package/src/tsconfig/{index.test.js → __tests__/index.test.js}

@@ -5,7 +5,7 @@ describe('tsconfig/index.json', () => {
   // Test that the tsconfig 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' } });
+    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');
@@ -14,7 +14,7 @@ describe('tsconfig/index.json', () => {
   // Test that the tsconfig contains compilerOptions.
   it('should have compilerOptions', async () => {
     // Dynamically import the JSON file with JSON assertion.
-    const module = await import('./index.json', { assert: { type: 'json' } });
+    const module = await import('../index.json', { assert: { type: 'json' } });
 
     // Verify that compilerOptions property exists on the config object.
     expect(module.default.compilerOptions).toBeDefined();
@@ -26,7 +26,7 @@ describe('tsconfig/index.json', () => {
   // Test that the tsconfig has the correct ECMAScript target.
   it('should have correct target', async () => {
     // Dynamically import the JSON file with JSON assertion.
-    const module = await import('./index.json', { assert: { type: 'json' } });
+    const module = await import('../index.json', { assert: { type: 'json' } });
 
     // Verify that the target is set to ES2024 (modern JavaScript).
     expect(module.default.compilerOptions.target).toBe('ES2024');
@@ -35,7 +35,7 @@ describe('tsconfig/index.json', () => {
   // Test that the tsconfig has JSX configured for React.
   it('should have jsx configured', async () => {
     // Dynamically import the JSON file with JSON assertion.
-    const module = await import('./index.json', { assert: { type: 'json' } });
+    const module = await import('../index.json', { assert: { type: 'json' } });
 
     // Verify that JSX is configured to use react-jsx preset.
     expect(module.default.compilerOptions.jsx).toBe('react-jsx');
@@ -44,7 +44,7 @@ describe('tsconfig/index.json', () => {
   // Test that the tsconfig has strict mode enabled.
   it('should have strict mode enabled', async () => {
     // Dynamically import the JSON file with JSON assertion.
-    const module = await import('./index.json', { assert: { type: 'json' } });
+    const module = await import('../index.json', { assert: { type: 'json' } });
 
     // Verify that strict type checking options are enabled.
     expect(module.default.compilerOptions.strict).toBe(true);