@vijayhardaha/dev-config 1.0.10 → 1.0.12

package/README.md

@@ -25,7 +25,7 @@ npm install @vijayhardaha/dev-config --save-dev
 ### Install Required Packages
 
 ```bash
-npm install --save-dev eslint@9.39.4 @eslint/js@9.39.4 @eslint/compat @eslint/eslintrc eslint-config-prettier eslint-plugin-prettier globals prettier typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import eslint-import-resolver-typescript
+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
 ```
 
 ### Install Optional Packages
@@ -98,6 +98,7 @@ export default createConfig({
   importOrder: true, // Enable import ordering
   react: true, // Enable React rules
   a11y: true // Enable accessibility rules
+  jsdoc: true // Enable JSDoc rules
 });
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vijayhardaha/dev-config",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Reusable development configurations for Next.js + TypeScript projects",
   "author": {
     "name": "Vijay Hardaha",
@@ -15,7 +15,8 @@
     "format:check": "prettier --check .",
     "release": "release-it",
     "release:dry": "release-it --dry-run",
-    "prepare": "husky"
+    "prepare": "husky",
+    "gc": "source .tmp/git.md"
   },
   "files": [
     "src",
@@ -68,10 +69,11 @@
     "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-hooks": "^7",
     "eslint-plugin-react": "^7",
+    "eslint-plugin-react-hooks": "^7",
     "globals": "^17",
     "prettier": "^3",
     "stylelint": "^17",
@@ -123,6 +125,9 @@
     "eslint-plugin-jsx-a11y": {
       "optional": true
     },
+    "eslint-plugin-jsdoc": {
+      "optional": true
+    },
     "eslint-plugin-prettier": {
       "optional": false
     },
@@ -165,6 +170,7 @@
     "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",

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/eslint/common.js

@@ -1,11 +1,11 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * 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
- * =====================================================================
+ * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
+ * =====================================================================.
  */
 
 import path from 'node:path';
@@ -58,18 +58,21 @@ const compat = new FlatCompat({ baseDirectory: __dirname, recommendedConfig: js.
 
 /**
  * Returns the setup object containing shared utilities for ESLint configs.
- * @returns {{ compat: FlatCompat, tsParser: typeof tsParser, __dirname: string }}
+ *
+ * @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 };
@@ -77,6 +80,7 @@ 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 = {
@@ -85,61 +89,166 @@ export const commonLanguageOptions = {
   globals: { ...globals.browser, ...globals.node },
 };
 
+/**
+ * Creates JSDoc rules for enforcing documentation on public/exported APIs.
+ *
+ * @param {boolean} [jsdoc] - Enable JSDoc rules.
+ *
+ * @returns {object} JSDoc ESLint rules object.
+ */
+export const jsdocRules = (jsdoc = true) =>
+  jsdoc
+    ? {
+        // ---- JSDoc Rules for PUBLIC / EXPORTED APIs ----
+        'jsdoc/require-jsdoc': [
+          'error',
+          {
+            publicOnly: true,
+            require: {
+              FunctionDeclaration: true,
+              MethodDefinition: true,
+              ClassDeclaration: true,
+              ArrowFunctionExpression: 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',
+        'jsdoc/require-param-name': 'error',
+        'jsdoc/require-param-description': 'error',
+        'jsdoc/require-param-type': 'error',
+
+        // Returns must be documented
+        'jsdoc/require-returns': 'error',
+        'jsdoc/require-returns-description': 'error',
+        'jsdoc/require-returns-type': 'error',
+
+        // Throws must be documented
+        'jsdoc/require-throws': 'error',
+
+        // Strict correctness
+        'jsdoc/check-tag-names': 'error',
+        'jsdoc/no-undefined-types': ['error', { definedTypes: ['JSX.Element'] }],
+        'jsdoc/valid-types': 'error',
+
+        // Enforce clean structure
+        'jsdoc/tag-lines': ['error', 'any', { startLines: 1, endLines: 0, applyToEndTag: true }],
+
+        'jsdoc/check-alignment': 'error',
+        'jsdoc/check-indentation': 'off',
+
+        // Optional but powerful for large teams
+        'jsdoc/sort-tags': [
+          'warn',
+          { tagSequence: [{ tags: ['description'] }, { tags: ['param'] }, { tags: ['returns'] }] },
+        ],
+
+        // Avoid useless docs
+        'jsdoc/no-types': 'off',
+        'jsdoc/informative-docs': 'off',
+
+        // Enforce property docs in typedef-style (optional)
+        'jsdoc/require-property-description': 'warn',
+      }
+    : {};
+
+/**
+ * Creates TypeScript-specific rules.
+ *
+ * @param {boolean} [typescript] - Enable TypeScript rules.
+ *
+ * @returns {object} TypeScript ESLint rules object.
+ */
+export const tsRules = (typescript = true) =>
+  typescript
+    ? {
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {
+            vars: 'all',
+            args: 'after-used',
+            varsIgnorePattern: '^_',
+            argsIgnorePattern: '^_',
+            ignoreRestSiblings: true,
+            caughtErrors: 'all',
+          },
+        ],
+      }
+    : {};
+
+/**
+ * Creates Prettier formatting rules.
+ *
+ * @param {boolean} [prettier] - Enable Prettier rules.
+ *
+ * @returns {object} Prettier ESLint rules object.
+ */
+export const prettierRules = (prettier = true) => (prettier ? { 'prettier/prettier': 'warn' } : {});
+
+/**
+ * Creates import order rules.
+ *
+ * @param {boolean} [importOrder] - Enable import order rules.
+ *
+ * @returns {object} Import order ESLint rules object.
+ */
+export const importOrderRules = (importOrder = true) =>
+  importOrder
+    ? {
+        'import/order': [
+          'error',
+          {
+            groups: ['builtin', 'external', 'internal', ['parent', 'sibling'], 'index', 'object'],
+            pathGroups: [
+              { pattern: 'react', group: 'external', position: 'before' },
+              { pattern: '@/**', group: 'internal', position: 'after' },
+            ],
+            pathGroupsExcludedImportTypes: ['react'],
+            alphabetize: { order: 'asc', caseInsensitive: true },
+            'newlines-between': 'always',
+            warnOnUnassignedImports: true,
+          },
+        ],
+      }
+    : {};
+
 /**
  * Creates a rules object based on the provided options.
- * @param {Object} [options] - Configuration options
- * @param {boolean} [options.typescript=true] - Enable TypeScript-specific rules
- * @param {boolean} [options.importOrder=true] - Enable import order rules
- * @param {boolean} [options.prettier=true] - Enable Prettier integration
- * @returns {Object} ESLint rules object
+ *
+ * @param {object} [options] - Configuration options.
+ * @param {boolean} [options.typescript] - Enable TypeScript-specific rules.
+ * @param {boolean} [options.importOrder] - Enable import order rules.
+ * @param {boolean} [options.prettier] - Enable Prettier integration.
+ * @param {boolean} [options.jsdoc] - Enable JSDoc rules for public/exported APIs.
+ *
+ * @returns {object} ESLint rules object.
  */
 export const commonRules = (options = {}) => {
-  const { typescript = true, importOrder = true, prettier = true } = options;
+  const { typescript = true, importOrder = true, prettier = true, jsdoc = true } = options;
 
   return {
     // ---- TypeScript Rules ----
-    // Report unused variables with TypeScript-aware analysis
-    ...(typescript && {
-      '@typescript-eslint/no-unused-vars': [
-        'error',
-        {
-          vars: 'all',
-          args: 'after-used',
-          varsIgnorePattern: '^_',
-          argsIgnorePattern: '^_',
-          ignoreRestSiblings: true,
-          caughtErrors: 'all',
-        },
-      ],
-    }),
+    ...tsRules(typescript),
 
     // ---- Import Order Rules ----
-    // Enforce consistent import ordering with specific group priorities
-    ...(importOrder && {
-      'import/order': [
-        'error',
-        {
-          groups: ['builtin', 'external', 'internal', ['parent', 'sibling'], 'index', 'object'],
-          pathGroups: [
-            { pattern: 'react', group: 'external', position: 'before' },
-            { pattern: '@/**', group: 'internal', position: 'after' },
-          ],
-          pathGroupsExcludedImportTypes: ['react'],
-          alphabetize: { order: 'asc', caseInsensitive: true },
-          'newlines-between': 'always',
-          warnOnUnassignedImports: true,
-        },
-      ],
-    }),
+    ...importOrderRules(importOrder),
 
     // ---- Prettier Integration ----
-    // Report Prettier formatting issues as warnings
-    ...(prettier && { 'prettier/prettier': 'warn' }),
+    ...prettierRules(prettier),
+
+    // ---- JSDoc Integration ----
+    ...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/index.js

@@ -1,12 +1,12 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * 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 .
- * =====================================================================
+ * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
+ * Usage:   npx eslint .
+ * =====================================================================.
  */
 
 import { defineConfig } from 'eslint/config';
@@ -17,19 +17,24 @@ const { compat } = setup();
 
 /**
  * Creates an ESLint configuration object with optional features.
- * @param {Object} [options] - Configuration options
- * @param {boolean} [options.prettier=true] - Enable Prettier integration
- * @param {boolean} [options.importOrder=true] - Enable import order rules
- * @returns {import('eslint').Linter.Config[]} ESLint configuration array
+ *
+ * @param {object} [options] - Configuration options.
+ * @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.
+ *
+ * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
  */
 export const createConfig = (options = {}) => {
-  const { prettier = true, importOrder = true } = 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', prettier && 'plugin:prettier/recommended'].filter(
-    Boolean
-  );
+  const extendsConfigs = [
+    importOrder && 'plugin:import/recommended',
+    jsdoc && 'plugin:jsdoc/recommended',
+    prettier && 'plugin:prettier/recommended',
+  ].filter(Boolean);
 
   return defineConfig([
     // ---- Global Ignores ----
@@ -66,7 +71,7 @@ export const createConfig = (options = {}) => {
         ],
         // ---- Common Rules ----
         // Apply shared rules based on options
-        ...commonRules({ prettier, importOrder, typescript: false }),
+        ...commonRules({ prettier, importOrder, typescript: false, jsdoc }),
       },
     },
   ]);

package/src/eslint/next.js

@@ -1,12 +1,12 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * 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 .
- * =====================================================================
+ * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
+ * Usage:   npx eslint .
+ * =====================================================================.
  */
 
 import { defineConfig } from 'eslint/config';
@@ -18,26 +18,30 @@ const { compat } = setup();
 /**
  * Creates an ESLint configuration object for Next.js projects with TypeScript
  * and React support.
- * @param {Object} [options] - Configuration options
- * @param {boolean} [options.prettier=true] - Enable Prettier integration
- * @param {boolean} [options.react=true] - Enable React-specific rules
- * @param {boolean} [options.a11y=true] - Enable accessibility rules
- * @param {boolean} [options.importOrder=true] - Enable import order rules
- * @returns {import('eslint').Linter.Config[]} ESLint configuration array
+ *
+ * @param {object} [options] - Configuration options.
+ * @param {boolean} [options.prettier] - Enable Prettier integration.
+ * @param {boolean} [options.react] - Enable React-specific rules.
+ * @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.
+ *
+ * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
  */
 export const createConfig = (options = {}) => {
-  const { prettier = true, react = true, a11y = true, importOrder = true } = 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 = [
-    'plugin:import/recommended',
     'next/core-web-vitals',
     'next/typescript',
     react && 'plugin:react/recommended',
     react && 'plugin:react-hooks/recommended',
-    a11y && 'plugin:jsx-a11y/recommended',
     'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    a11y && 'plugin:jsx-a11y/recommended',
+    jsdoc && 'plugin:jsdoc/recommended',
     prettier && 'plugin:prettier/recommended',
   ].filter(Boolean);
 
@@ -77,7 +81,7 @@ export const createConfig = (options = {}) => {
         ...(react && { 'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }] }),
         // ---- Common Rules ----
         // Apply shared rules
-        ...commonRules({ prettier, importOrder }),
+        ...commonRules({ prettier, importOrder, jsdoc }),
       },
     },
   ]);

package/src/eslint/react.js

@@ -1,12 +1,12 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * 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 .
- * =====================================================================
+ * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
+ * Usage:   npx eslint .
+ * =====================================================================.
  */
 
 import { defineConfig } from 'eslint/config';
@@ -18,23 +18,27 @@ const { compat } = setup();
 /**
  * Creates an ESLint configuration object for React projects with TypeScript
  * support.
- * @param {Object} [options] - Configuration options
- * @param {boolean} [options.prettier=true] - Enable Prettier integration
- * @param {boolean} [options.a11y=true] - Enable accessibility rules
- * @param {boolean} [options.importOrder=true] - Enable import order rules
- * @returns {import('eslint').Linter.Config[]} ESLint configuration array
+ *
+ * @param {object} [options] - Configuration options.
+ * @param {boolean} [options.prettier] - Enable Prettier integration.
+ * @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.
+ *
+ * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
  */
 export const createConfig = (options = {}) => {
-  const { prettier = true, a11y = true, importOrder = true } = options;
+  const { prettier = true, a11y = true, importOrder = true, jsdoc = true } = options;
 
   // ---- Extends Configs ----
   // Build the extends array based on enabled features
   const extendsConfigs = [
-    'plugin:import/recommended',
     'plugin:react/recommended',
     'plugin:react-hooks/recommended',
-    a11y && 'plugin:jsx-a11y/recommended',
     'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    a11y && 'plugin:jsx-a11y/recommended',
+    jsdoc && 'plugin:jsdoc/recommended',
     prettier && 'plugin:prettier/recommended',
   ].filter(Boolean);
 
@@ -71,7 +75,7 @@ export const createConfig = (options = {}) => {
         'react/no-unknown-property': ['error', { ignore: ['jsx', 'global'] }],
         // ---- Common Rules ----
         // Apply shared rules
-        ...commonRules({ prettier, importOrder }),
+        ...commonRules({ prettier, importOrder, jsdoc }),
       },
     },
   ]);

package/src/eslint/typescript.js

@@ -1,12 +1,12 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * 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 .
- * =====================================================================
+ * Docs:    https://eslint.org/docs/latest/use/configure/configuration-files-new
+ * Usage:   npx eslint .
+ * =====================================================================.
  */
 
 import { defineConfig } from 'eslint/config';
@@ -17,19 +17,23 @@ const { compat } = setup();
 
 /**
  * Creates an ESLint configuration object for TypeScript projects.
- * @param {Object} [options] - Configuration options
- * @param {boolean} [options.prettier=true] - Enable Prettier integration
- * @param {boolean} [options.importOrder=true] - Enable import order rules
- * @returns {import('eslint').Linter.Config[]} ESLint configuration array
+ *
+ * @param {object} [options] - Configuration options.
+ * @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.
+ *
+ * @returns {import('eslint').Linter.Config[]} ESLint configuration array.
  */
 export const createConfig = (options = {}) => {
-  const { prettier = true, importOrder = true } = 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);
 
@@ -58,7 +62,7 @@ export const createConfig = (options = {}) => {
       settings: { ...(importOrder && { 'import/resolver': { typescript: {} } }) },
 
       // ---- Rules ----
-      rules: commonRules({ prettier, importOrder }),
+      rules: commonRules({ prettier, importOrder, jsdoc }),
     },
   ]);
 };

package/src/index.js

@@ -1,57 +1,65 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * 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
- * =====================================================================
+ * =====================================================================.
  */
 
 /**
  * ESLint configuration for JavaScript files.
+ *
  * @type {import('eslint').Linter.Config}
  */
 export { default as eslint, createConfig as createEslintConfig } from './eslint/index.js';
 
 /**
  * ESLint configuration for TypeScript files.
+ *
  * @type {import('eslint').Linter.Config}
  */
 export { default as eslintTs, createConfig as createEslintTsConfig } from './eslint/typescript.js';
 
 /**
  * ESLint configuration for React files.
+ *
  * @type {import('eslint').Linter.Config}
  */
 export { default as eslintReact, createConfig as createEslintReactConfig } from './eslint/react.js';
 
 /**
  * ESLint configuration for Next.js files.
+ *
  * @type {import('eslint').Linter.Config}
  */
 export { default as eslintNext, createConfig as createEslintNextConfig } from './eslint/next.js';
 
 /**
  * Prettier configuration.
+ *
  * @type {import('prettier').Config}
  */
 export { default as prettier } from './prettier/index.js';
 
 /**
  * Commitlint configuration.
+ *
  * @type {import('@commitlint/types').UserConfig}
  */
 export { default as commitlint } from './commitlint/index.js';
 
 /**
  * Next.js sitemap configuration.
+ *
  * @type {import('next-sitemap').IConfig}
  */
 export { default as nextSitemap, createSitemapConfig } from './next-sitemap/index.js';
 
 /**
  * Stylelint configuration.
+ *
  * @type {import('stylelint').Config}
  */
 export { default as stylelint } from './stylelint/index.js';

package/src/next-sitemap/index.js

@@ -1,20 +1,22 @@
 /**
- * =====================================================================
+ * =====================================================================.
  * Next Sitemap Configuration
- * =====================================================================
+ * =====================================================================.
  * Purpose: Next.js sitemap configuration for generating SEO-friendly
  *          sitemaps with robots.txt support.
- * Docs: https://github.com/iamvishnusankar/next-sitemap
- * =====================================================================
+ * Docs:    https://github.com/iamvishnusankar/next-sitemap
+ * =====================================================================.
  */
 
 /**
  * Creates a sitemap configuration object for next-sitemap.
- * @param {Object} [options] - Configuration options
- * @param {string} [options.siteUrl='https://example.com'] - Site base URL
- * @param {string} [options.outDir='./public'] - Output directory for sitemap files
- * @param {string[]} [options.exclude=['/404', '/500']] - Paths to exclude from sitemap
- * @returns {import('next-sitemap').IConfig} Sitemap configuration object
+ *
+ * @param {object} [options] - Configuration options.
+ * @param {string} [options.siteUrl] - Site base URL.
+ * @param {string} [options.outDir] - Output directory for sitemap files.
+ * @param {string[]} [options.exclude] - Paths to exclude from sitemap.
+ *
+ * @returns {import('next-sitemap').IConfig} Sitemap configuration object.
  */
 export function createSitemapConfig(options = {}) {
   const { siteUrl = 'https://example.com', outDir = './public', exclude = ['/404', '/500'] } = options;

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 .
- * =====================================================================
+ * Docs:    https://prettier.io/docs/en/configuration.html
+ * Usage:   npx prettier --write .
+ * =====================================================================.
  */
 
 /** @type {import("prettier").Config} */

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 .
- * =====================================================================
+ * Docs:    https://stylelint.io/user-guide/configure
+ * Usage:   npx stylelint .
+ * =====================================================================.
  */
 
 /** @type {import("stylelint").Config} */