@futdevpro/dynamo-eslint 1.14.2 → 1.14.4

package/build/scripts/dynamo-fix.js

@@ -1,11 +1,48 @@
 #!/usr/bin/env node
 "use strict";
+/**
+ * @fileoverview Dynamo ESLint Auto-Fix Script
+ *
+ * This script runs ESLint with auto-fix capabilities on TypeScript files across the project.
+ * It processes all .ts and .tsx files, applies Dynamo-specific rules, and automatically
+ * fixes issues where possible.
+ *
+ * @usage
+ * ```bash
+ * dynamo-fix
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Fix all TypeScript files in the project
+ * npx dynamo-fix
+ *
+ * # Or run via npm script
+ * npm run fix
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
 const eslint_1 = require("eslint");
 const fs_1 = require("fs");
+/**
+ * Fixes a single TypeScript file using ESLint with auto-fix capabilities
+ *
+ * @param filePath - Path to the TypeScript file to fix
+ * @returns Promise that resolves to a FixResult object containing fix statistics
+ *
+ * @example
+ * ```typescript
+ * const result = await fixFile('./src/components/Button.tsx');
+ * console.log(`Fixed ${result.fixes} issues in ${result.file}`);
+ * ```
+ */
 async function fixFile(filePath) {
+    // Configure ESLint with Dynamo-specific rules and auto-fix enabled
     const eslint = new eslint_1.ESLint({
         baseConfig: [
             { ignores: ['build/**', 'dist/**', 'node_modules/**'] },
@@ -31,12 +68,14 @@ async function fixFile(filePath) {
         ],
         fix: true, // Enable auto-fixing
     });
+    // Run ESLint on the file
     const results = await eslint.lintFiles([filePath]);
     const result = results[0];
+    // Write the fixed content back to the file if changes were made
     if (result && result.output) {
-        // Write the fixed content back to the file
         (0, fs_1.writeFileSync)(filePath, result.output);
     }
+    // Return comprehensive fix statistics
     return {
         file: filePath,
         fixed: result && result.output !== undefined,
@@ -45,7 +84,18 @@ async function fixFile(filePath) {
         fixes: result.fixableErrorCount + result.fixableWarningCount,
     };
 }
+/**
+ * Main function that processes all TypeScript files in the project
+ *
+ * Scans for all .ts and .tsx files, applies ESLint fixes, and provides
+ * comprehensive reporting on the results.
+ *
+ * @returns Promise that resolves when all files have been processed
+ *
+ * @throws {Error} When file processing fails
+ */
 async function main() {
+    // Find all TypeScript files, excluding common directories and test files
     const files = await (0, fast_glob_1.default)(['**/*.{ts,tsx}'], {
         ignore: ['**/node_modules/**', '**/build/**', '**/dist/**', '**/*.spec.ts', '**/*.test.ts'],
     });
@@ -55,14 +105,17 @@ async function main() {
     let totalErrors = 0;
     let totalWarnings = 0;
     let totalFixes = 0;
+    // Process each file individually
     for (const file of files) {
         try {
             const result = await fixFile(file);
             results.push(result);
+            // Track successful fixes
             if (result.fixed) {
                 totalFixed++;
                 console.log(`✅ Fixed: ${result.file}`);
             }
+            // Accumulate statistics
             totalErrors += result.errors;
             totalWarnings += result.warnings;
             totalFixes += result.fixes;
@@ -71,13 +124,14 @@ async function main() {
             console.error(`❌ Error processing ${file}:`, error);
         }
     }
-    // Report results
+    // Generate comprehensive summary report
     console.log(`\n📊 Fix Summary:`);
     console.log(`   Files processed: ${files.length}`);
     console.log(`   Files fixed: ${totalFixed}`);
     console.log(`   Total errors: ${totalErrors}`);
     console.log(`   Total warnings: ${totalWarnings}`);
     console.log(`   Total fixes applied: ${totalFixes}`);
+    // Provide appropriate success/failure message
     if (totalFixed === 0) {
         console.log('✅ No files needed fixing!');
     }
@@ -85,6 +139,7 @@ async function main() {
         console.log(`\n🎉 Successfully fixed ${totalFixed} files!`);
     }
 }
+// Execute the main function and handle any errors
 main().catch((err) => {
     console.error('Fix failed:', err);
     process.exit(1);

package/build/scripts/dynamo-fix.js.map

@@ -1 +1 @@
-{"version":3,"file":"dynamo-fix.js","sourceRoot":"","sources":["../../src/scripts/dynamo-fix.ts"],"names":[],"mappings":";;;;AACA,kEAA2B;AAC3B,mCAAgC;AAChC,2BAAmC;AAUnC,KAAK,UAAU,OAAO,CAAC,QAAgB;IACrC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;QACxB,UAAU,EAAE;YACV,EAAE,OAAO,EAAE,CAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,CAAE,EAAE;YACzD;gBACE,KAAK,EAAE,CAAE,eAAe,CAAE;gBAC1B,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO,CAAC,2BAA2B,CAAC;oBAC5C,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE;iBAC3D;gBACD,OAAO,EAAE;oBACP,mBAAmB,EAAE;wBACnB,KAAK,EAAE;4BACL,cAAc,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC,OAAO;4BAC/D,iBAAiB,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC,OAAO;yBACtE;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,gCAAgC,EAAE,OAAO;oBACzC,mCAAmC,EAAE,MAAM;iBAC5C;aACF;SACF;QACD,GAAG,EAAE,IAAI,EAAE,qBAAqB;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAE,QAAQ,CAAE,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAE1B,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAC5B,2CAA2C;QAC3C,IAAA,kBAAa,EAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;QAC5C,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,MAAM;QAChE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,MAAM;QAClE,KAAK,EAAE,MAAM,CAAC,iBAAiB,GAAG,MAAM,CAAC,mBAAmB;KAC7D,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAE,EAAC,CAAE,eAAe,CAAE,EAAE;QAC1C,MAAM,EAAE,CAAE,oBAAoB,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,CAAE;KAC9F,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,MAAM,WAAW,CAAC,CAAC;IAE5D,MAAM,OAAO,GAAgB,EAAE,CAAC;IAChC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YAEnC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAErB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,UAAU,EAAE,CAAC;gBACb,OAAO,CAAC,GAAG,CAAC,YAAY,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,CAAC;YAED,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC;YAC7B,aAAa,IAAI,MAAM,CAAC,QAAQ,CAAC;YACjC,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sBAAsB,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,iBAAiB;IACjB,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACjC,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,oBAAoB,WAAW,EAAE,CAAC,CAAC;IAC/C,OAAO,CAAC,GAAG,CAAC,sBAAsB,aAAa,EAAE,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,2BAA2B,UAAU,EAAE,CAAC,CAAC;IAErD,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,2BAA2B,UAAU,SAAS,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;IAClC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"dynamo-fix.js","sourceRoot":"","sources":["../../src/scripts/dynamo-fix.ts"],"names":[],"mappings":";;AACA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAEH,kEAA2B;AAC3B,mCAAgC;AAChC,2BAAmC;AAkBnC;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,OAAO,CAAC,QAAgB;IACrC,mEAAmE;IACnE,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;QACxB,UAAU,EAAE;YACV,EAAE,OAAO,EAAE,CAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,CAAE,EAAE;YACzD;gBACE,KAAK,EAAE,CAAE,eAAe,CAAE;gBAC1B,eAAe,EAAE;oBACf,MAAM,EAAE,OAAO,CAAC,2BAA2B,CAAC;oBAC5C,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE;iBAC3D;gBACD,OAAO,EAAE;oBACP,mBAAmB,EAAE;wBACnB,KAAK,EAAE;4BACL,cAAc,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC,OAAO;4BAC/D,iBAAiB,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC,OAAO;yBACtE;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,gCAAgC,EAAE,OAAO;oBACzC,mCAAmC,EAAE,MAAM;iBAC5C;aACF;SACF;QACD,GAAG,EAAE,IAAI,EAAE,qBAAqB;KACjC,CAAC,CAAC;IAEH,yBAAyB;IACzB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAE,QAAQ,CAAE,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAE1B,gEAAgE;IAChE,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAC5B,IAAA,kBAAa,EAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,sCAAsC;IACtC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;QAC5C,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,MAAM;QAChE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,MAAM;QAClE,KAAK,EAAE,MAAM,CAAC,iBAAiB,GAAG,MAAM,CAAC,mBAAmB;KAC7D,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,IAAI;IACjB,yEAAyE;IACzE,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAE,EAAC,CAAE,eAAe,CAAE,EAAE;QAC1C,MAAM,EAAE,CAAE,oBAAoB,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,CAAE;KAC9F,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,MAAM,WAAW,CAAC,CAAC;IAE5D,MAAM,OAAO,GAAgB,EAAE,CAAC;IAChC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,iCAAiC;IACjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YAEnC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAErB,yBAAyB;YACzB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,UAAU,EAAE,CAAC;gBACb,OAAO,CAAC,GAAG,CAAC,YAAY,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,CAAC;YAED,wBAAwB;YACxB,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC;YAC7B,aAAa,IAAI,MAAM,CAAC,QAAQ,CAAC;YACjC,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sBAAsB,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,wCAAwC;IACxC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACjC,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,oBAAoB,WAAW,EAAE,CAAC,CAAC;IAC/C,OAAO,CAAC,GAAG,CAAC,sBAAsB,aAAa,EAAE,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,2BAA2B,UAAU,EAAE,CAAC,CAAC;IAErD,8CAA8C;IAC9C,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,2BAA2B,UAAU,SAAS,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED,kDAAkD;AAClD,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;IAClC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/scripts/eslintrc-audit.d.ts

@@ -1,3 +1,27 @@
 #!/usr/bin/env node
+/**
+ * @fileoverview ESLint Configuration Audit Script
+ *
+ * This script analyzes ESLint configuration files (.eslintrc.json) across the project
+ * to provide statistics on rule usage. It helps identify commonly used rules and
+ * potential configuration inconsistencies.
+ *
+ * @usage
+ * ```bash
+ * dynamo-eslintrc-audit
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Audit all ESLint configurations in the project
+ * npx dynamo-eslintrc-audit
+ *
+ * # Or run via npm script
+ * npm run audit:eslintrc
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 export {};
 //# sourceMappingURL=eslintrc-audit.d.ts.map

package/build/scripts/eslintrc-audit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eslintrc-audit.d.ts","sourceRoot":"","sources":["../../src/scripts/eslintrc-audit.ts"],"names":[],"mappings":""}
+{"version":3,"file":"eslintrc-audit.d.ts","sourceRoot":"","sources":["../../src/scripts/eslintrc-audit.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;;;GAuBG"}

package/build/scripts/eslintrc-audit.js

@@ -1,34 +1,99 @@
 #!/usr/bin/env node
 "use strict";
+/**
+ * @fileoverview ESLint Configuration Audit Script
+ *
+ * This script analyzes ESLint configuration files (.eslintrc.json) across the project
+ * to provide statistics on rule usage. It helps identify commonly used rules and
+ * potential configuration inconsistencies.
+ *
+ * @usage
+ * ```bash
+ * dynamo-eslintrc-audit
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Audit all ESLint configurations in the project
+ * npx dynamo-eslintrc-audit
+ *
+ * # Or run via npm script
+ * npm run audit:eslintrc
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
 const fs_1 = require("fs");
+/**
+ * Safely parses a JSON file and returns the parsed object or null if parsing fails
+ *
+ * @param jsonPath - Path to the JSON file to parse
+ * @returns Parsed JSON object or null if parsing fails
+ *
+ * @example
+ * ```typescript
+ * const config = safeParse('./.eslintrc.json');
+ * if (config) {
+ *   console.log('Rules:', Object.keys(config.rules || {}));
+ * }
+ * ```
+ */
 function safeParse(jsonPath) {
     try {
         const content = (0, fs_1.readFileSync)(jsonPath, 'utf8');
         return JSON.parse(content);
     }
     catch {
+        // Return null for any parsing errors (malformed JSON, file not found, etc.)
         return null;
     }
 }
+/**
+ * Main function that analyzes ESLint configuration files and generates rule usage statistics
+ *
+ * Scans for all .eslintrc.json files in the project, extracts rule configurations,
+ * and provides a sorted table of the most commonly used rules.
+ *
+ * @returns Promise that resolves when analysis is complete
+ *
+ * @example
+ * ```typescript
+ * // The function will output a table like:
+ * // ┌─────────┬─────────────────────────┬───────┐
+ * // │ (index) │          rule           │ count │
+ * // ├─────────┼─────────────────────────┼───────┤
+ * // │    0    │    'no-unused-vars'     │   5   │
+ * // │    1    │    'semi'               │   4   │
+ * // └─────────┴─────────────────────────┴───────┘
+ * ```
+ */
 async function main() {
+    // Find all ESLint configuration files, excluding node_modules
     const files = await (0, fast_glob_1.default)(['**/.eslintrc.json'], { ignore: ['**/node_modules/**'] });
     const ruleCounts = {};
     const total = files.length;
+    // Process each configuration file
     for (const p of files) {
         const cfg = safeParse(p);
+        // Skip files without rules configuration
         if (!cfg?.rules)
             continue;
+        // Count each rule occurrence
         for (const key of Object.keys(cfg.rules)) {
             ruleCounts[key] = (ruleCounts[key] ?? 0) + 1;
         }
     }
+    // Sort rules by usage count (most used first)
     const entries = Object.entries(ruleCounts).sort((a, b) => b[1] - a[1]);
+    // Display results
     console.log(`[dynamo-eslintrc-audit] analyzed ${total} files`);
     console.table(entries.slice(0, 50).map(([rule, count]) => ({ rule, count })));
 }
+// Execute the main function and handle any errors
 main().catch((err) => {
     console.error(err);
     process.exit(1);

package/build/scripts/eslintrc-audit.js.map

@@ -1 +1 @@
-{"version":3,"file":"eslintrc-audit.js","sourceRoot":"","sources":["../../src/scripts/eslintrc-audit.ts"],"names":[],"mappings":";;;;AACA,kEAA2B;AAC3B,2BAAkC;AAIlC,SAAS,SAAS,CAAC,QAAgB;IACjC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAE,EAAC,CAAE,mBAAmB,CAAE,EAAE,EAAE,MAAM,EAAE,CAAE,oBAAoB,CAAE,EAAE,CAAC,CAAC;IACtF,MAAM,UAAU,GAA2B,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;IAE3B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAEzB,IAAI,CAAC,GAAG,EAAE,KAAK;YAAE,SAAS;QAE1B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvE,OAAO,CAAC,GAAG,CAAC,oCAAoC,KAAK,QAAQ,CAAC,CAAC;IAC/D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,IAAI,EAAE,KAAK,CAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"eslintrc-audit.js","sourceRoot":"","sources":["../../src/scripts/eslintrc-audit.ts"],"names":[],"mappings":";;AACA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAEH,kEAA2B;AAC3B,2BAAkC;AAIlC;;;;;;;;;;;;;GAaG;AACH,SAAS,SAAS,CAAC,QAAgB;IACjC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,4EAA4E;QAC5E,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,KAAK,UAAU,IAAI;IACjB,8DAA8D;IAC9D,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAE,EAAC,CAAE,mBAAmB,CAAE,EAAE,EAAE,MAAM,EAAE,CAAE,oBAAoB,CAAE,EAAE,CAAC,CAAC;IACtF,MAAM,UAAU,GAA2B,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;IAE3B,kCAAkC;IAClC,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAEzB,yCAAyC;QACzC,IAAI,CAAC,GAAG,EAAE,KAAK;YAAE,SAAS;QAE1B,6BAA6B;QAC7B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvE,kBAAkB;IAClB,OAAO,CAAC,GAAG,CAAC,oCAAoC,KAAK,QAAQ,CAAC,CAAC;IAC/D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,IAAI,EAAE,KAAK,CAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,kDAAkD;AAClD,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/scripts/fix-return-types.d.ts

@@ -1,3 +1,28 @@
 #!/usr/bin/env node
+/**
+ * @fileoverview TypeScript Type Annotation Fix Script
+ *
+ * This script uses TypeScript's AST (Abstract Syntax Tree) to automatically add
+ * type annotations to functions and arrow functions. It analyzes TypeScript files,
+ * infers return types using the TypeScript compiler, and adds explicit type
+ * annotations where missing.
+ *
+ * @usage
+ * ```bash
+ * dynamo-fix-return-types
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Fix type annotations in all TypeScript files
+ * npx dynamo-fix-return-types
+ *
+ * # Or run via npm script
+ * npm run fix:types
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 export {};
 //# sourceMappingURL=fix-return-types.d.ts.map

package/build/scripts/fix-return-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fix-return-types.d.ts","sourceRoot":"","sources":["../../src/scripts/fix-return-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"fix-return-types.d.ts","sourceRoot":"","sources":["../../src/scripts/fix-return-types.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG"}

package/build/scripts/fix-return-types.js

@@ -1,14 +1,56 @@
 #!/usr/bin/env node
 "use strict";
+/**
+ * @fileoverview TypeScript Type Annotation Fix Script
+ *
+ * This script uses TypeScript's AST (Abstract Syntax Tree) to automatically add
+ * type annotations to functions and arrow functions. It analyzes TypeScript files,
+ * infers return types using the TypeScript compiler, and adds explicit type
+ * annotations where missing.
+ *
+ * @usage
+ * ```bash
+ * dynamo-fix-return-types
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Fix type annotations in all TypeScript files
+ * npx dynamo-fix-return-types
+ *
+ * # Or run via npm script
+ * npm run fix:types
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const ts = tslib_1.__importStar(require("typescript"));
 const fs = tslib_1.__importStar(require("fs"));
 const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
 const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
-function addReturnTypesToFile(filePath) {
+/**
+ * Adds type annotations to functions and arrow functions in a TypeScript file
+ *
+ * Uses TypeScript's compiler API to analyze the file, infer return types,
+ * and automatically add explicit type annotations where missing.
+ *
+ * @param filePath - Path to the TypeScript file to process
+ * @returns FixResult object containing statistics about the changes made
+ *
+ * @example
+ * ```typescript
+ * const result = addTypesToFile('./src/utils.ts');
+ * console.log(`Added ${result.changes} type annotations to ${result.file}`);
+ * ```
+ */
+function addTypesToFile(filePath) {
+    // Read and parse the source file
     const sourceCode = fs.readFileSync(filePath, 'utf8');
     const sourceFile = ts.createSourceFile(filePath, sourceCode, ts.ScriptTarget.Latest, true);
+    // Create TypeScript program for type checking
     const program = ts.createProgram([filePath], {
         target: ts.ScriptTarget.Latest,
         module: ts.ModuleKind.ESNext,
@@ -18,13 +60,20 @@ function addReturnTypesToFile(filePath) {
     const checker = program.getTypeChecker();
     let changes = 0;
     let hasChanges = false;
+    /**
+     * Recursively visits AST nodes and adds type annotations where needed
+     *
+     * @param node - The current AST node being visited
+     * @returns The potentially modified AST node
+     */
     function visit(node) {
-        // Handle function declarations
+        // Handle function declarations without return types
         if (ts.isFunctionDeclaration(node) && !node.type) {
             const signature = checker.getSignatureFromDeclaration(node);
             if (signature) {
                 const returnType = checker.getReturnTypeOfSignature(signature);
                 const typeString = checker.typeToString(returnType);
+                // Add type annotation if it's not void or any
                 if (typeString !== 'void' && typeString !== 'any') {
                     const newType = ts.factory.createTypeReferenceNode(typeString);
                     const updatedNode = ts.factory.updateFunctionDeclaration(node, node.modifiers, node.asteriskToken, node.name, node.typeParameters, node.parameters, newType, node.body);
@@ -34,12 +83,13 @@ function addReturnTypesToFile(filePath) {
                 }
             }
         }
-        // Handle arrow functions
+        // Handle arrow functions without return types
         if (ts.isArrowFunction(node) && !node.type) {
             const signature = checker.getSignatureFromDeclaration(node);
             if (signature) {
                 const returnType = checker.getReturnTypeOfSignature(signature);
                 const typeString = checker.typeToString(returnType);
+                // Add type annotation if it's not void or any
                 if (typeString !== 'void' && typeString !== 'any') {
                     const newType = ts.factory.createTypeReferenceNode(typeString);
                     const updatedNode = ts.factory.updateArrowFunction(node, node.modifiers, node.typeParameters, node.parameters, newType, node.equalsGreaterThanToken, node.body);
@@ -49,9 +99,14 @@ function addReturnTypesToFile(filePath) {
                 }
             }
         }
+        // Note: Variable declarations, parameters, and class properties
+        // are handled by the existing @typescript-eslint/typedef rule
+        // and can be auto-fixed with eslint --fix
         return ts.visitEachChild(node, visit, {});
     }
+    // Transform the AST and apply changes
     const result = ts.visitEachChild(sourceFile, visit, {});
+    // Write the modified code back to the file if changes were made
     if (hasChanges) {
         const printer = ts.createPrinter();
         const newSourceCode = printer.printFile(result);
@@ -63,7 +118,18 @@ function addReturnTypesToFile(filePath) {
         changes,
     };
 }
+/**
+ * Main function that processes all TypeScript files and adds type annotations
+ *
+ * Scans for all .ts and .tsx files in the project, processes each file to add
+ * missing type annotations, and provides comprehensive reporting on the results.
+ *
+ * @returns Promise that resolves when all files have been processed
+ *
+ * @throws {Error} When file processing fails
+ */
 async function main() {
+    // Find all TypeScript files, excluding common directories and test files
     const files = await (0, fast_glob_1.default)(['**/*.{ts,tsx}'], {
         ignore: [
             '**/node_modules/**',
@@ -73,35 +139,40 @@ async function main() {
             '**/*.test.ts',
         ],
     });
-    fsm_dynamo_1.DyFM_Log.log(`[fix-return-types] Processing ${files.length} files...`);
+    fsm_dynamo_1.DyFM_Log.log(`[fix-types] Processing ${files.length} files...`);
     const results = [];
     let totalFixed = 0;
     let totalChanges = 0;
+    // Process each file individually
     for (const file of files) {
         try {
-            const result = addReturnTypesToFile(file);
+            const result = addTypesToFile(file);
             results.push(result);
+            // Track successful fixes
             if (result.fixed) {
                 totalFixed++;
                 totalChanges += result.changes;
-                fsm_dynamo_1.DyFM_Log.log(`✅ Fixed ${result.changes} return types in ${file}`);
+                fsm_dynamo_1.DyFM_Log.log(`✅ Fixed ${result.changes} type annotations in ${file}`);
             }
         }
         catch (error) {
             fsm_dynamo_1.DyFM_Log.error(`❌ Error processing ${file}:`, error);
         }
     }
+    // Generate comprehensive summary report
     fsm_dynamo_1.DyFM_Log.log(`\n📊 Fix Summary:`);
     fsm_dynamo_1.DyFM_Log.log(`   Files processed: ${files.length}`);
     fsm_dynamo_1.DyFM_Log.log(`   Files fixed: ${totalFixed}`);
-    fsm_dynamo_1.DyFM_Log.log(`   Total return types added: ${totalChanges}`);
+    fsm_dynamo_1.DyFM_Log.log(`   Total type annotations added: ${totalChanges}`);
+    // Provide appropriate success/failure message
     if (totalFixed > 0) {
-        fsm_dynamo_1.DyFM_Log.log(`🎉 Successfully added return types to ${totalFixed} files!`);
+        fsm_dynamo_1.DyFM_Log.log(`🎉 Successfully added type annotations to ${totalFixed} files!`);
     }
     else {
-        fsm_dynamo_1.DyFM_Log.log('✅ No files needed return type fixes!');
+        fsm_dynamo_1.DyFM_Log.log('✅ No files needed type annotation fixes!');
     }
 }
+// Execute the main function and handle any errors
 main().catch((err) => {
     fsm_dynamo_1.DyFM_Log.error('Fix script failed:', err);
     process.exit(1);

package/build/scripts/fix-return-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"fix-return-types.js","sourceRoot":"","sources":["../../src/scripts/fix-return-types.ts"],"names":[],"mappings":";;;;AACA,uDAAiC;AACjC,+CAAyB;AAEzB,kEAA2B;AAC3B,sDAAiD;AAQjD,SAAS,oBAAoB,CAAC,QAAgB;IAC5C,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE3F,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,EAAE;QAC3C,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM;QAC9B,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM;QAC5B,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,SAAS,KAAK,CAAC,IAAa;QAC1B,+BAA+B;QAC/B,IAAI,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC5D,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;gBAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;gBAEpD,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAC/D,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,yBAAyB,CACtD,IAAI,EACJ,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,UAAU,EACf,OAAO,EACP,IAAI,CAAC,IAAI,CACV,CAAC;oBACF,OAAO,EAAE,CAAC;oBACV,UAAU,GAAG,IAAI,CAAC;oBAClB,OAAO,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;QACH,CAAC;QAED,yBAAyB;QACzB,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC5D,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;gBAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;gBAEpD,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAC/D,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAChD,IAAI,EACJ,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,UAAU,EACf,OAAO,EACP,IAAI,CAAC,sBAAsB,EAC3B,IAAI,CAAC,IAAI,CACV,CAAC;oBACF,OAAO,EAAE,CAAC;oBACV,UAAU,GAAG,IAAI,CAAC;oBAClB,OAAO,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,MAAM,GAAG,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;IAEpF,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC;QACnC,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAChD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,UAAU;QACjB,OAAO;KACR,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAE,EAAC,CAAE,eAAe,CAAE,EAAE;QAC1C,MAAM,EAAE;YACN,oBAAoB;YACpB,aAAa;YACb,YAAY;YACZ,cAAc;YACd,cAAc;SACf;KACF,CAAC,CAAC;IAEH,qBAAQ,CAAC,GAAG,CAAC,iCAAiC,KAAK,CAAC,MAAM,WAAW,CAAC,CAAC;IAEvE,MAAM,OAAO,GAAgB,EAAE,CAAC;IAChC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC1C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAErB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,UAAU,EAAE,CAAC;gBACb,YAAY,IAAI,MAAM,CAAC,OAAO,CAAC;gBAC/B,qBAAQ,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,OAAO,oBAAoB,IAAI,EAAE,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qBAAQ,CAAC,KAAK,CAAC,sBAAsB,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,qBAAQ,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAClC,qBAAQ,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpD,qBAAQ,CAAC,GAAG,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;IAC9C,qBAAQ,CAAC,GAAG,CAAC,gCAAgC,YAAY,EAAE,CAAC,CAAC;IAE7D,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,qBAAQ,CAAC,GAAG,CAAC,yCAAyC,UAAU,SAAS,CAAC,CAAC;IAC7E,CAAC;SAAM,CAAC;QACN,qBAAQ,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,qBAAQ,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;IAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fix-return-types.js","sourceRoot":"","sources":["../../src/scripts/fix-return-types.ts"],"names":[],"mappings":";;AACA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;;AAEH,uDAAiC;AACjC,+CAAyB;AAEzB,kEAA2B;AAC3B,sDAAiD;AAcjD;;;;;;;;;;;;;;GAcG;AACH,SAAS,cAAc,CAAC,QAAgB;IACtC,iCAAiC;IACjC,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE3F,8CAA8C;IAC9C,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,EAAE;QAC3C,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM;QAC9B,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM;QAC5B,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB;;;;;OAKG;IACH,SAAS,KAAK,CAAC,IAAa;QAC1B,oDAAoD;QACpD,IAAI,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAE5D,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;gBAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;gBAEpD,8CAA8C;gBAC9C,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAC/D,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,yBAAyB,CACtD,IAAI,EACJ,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,UAAU,EACf,OAAO,EACP,IAAI,CAAC,IAAI,CACV,CAAC;oBACF,OAAO,EAAE,CAAC;oBACV,UAAU,GAAG,IAAI,CAAC;oBAClB,OAAO,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;QACH,CAAC;QAED,8CAA8C;QAC9C,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAE5D,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;gBAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;gBAEpD,8CAA8C;gBAC9C,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAC/D,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAChD,IAAI,EACJ,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,UAAU,EACf,OAAO,EACP,IAAI,CAAC,sBAAsB,EAC3B,IAAI,CAAC,IAAI,CACV,CAAC;oBACF,OAAO,EAAE,CAAC;oBACV,UAAU,GAAG,IAAI,CAAC;oBAClB,OAAO,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;QACH,CAAC;QAED,gEAAgE;QAChE,8DAA8D;QAC9D,0CAA0C;QAE1C,OAAO,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;IACxE,CAAC;IAED,sCAAsC;IACtC,MAAM,MAAM,GAAG,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,KAAK,EAAE,EAA8B,CAAC,CAAC;IAEpF,gEAAgE;IAChE,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC;QACnC,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAChD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,UAAU;QACjB,OAAO;KACR,CAAC;AACJ,CAAC;AAGD;;;;;;;;;GASG;AACH,KAAK,UAAU,IAAI;IACjB,yEAAyE;IACzE,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAE,EAAC,CAAE,eAAe,CAAE,EAAE;QAC1C,MAAM,EAAE;YACN,oBAAoB;YACpB,aAAa;YACb,YAAY;YACZ,cAAc;YACd,cAAc;SACf;KACF,CAAC,CAAC;IAEH,qBAAQ,CAAC,GAAG,CAAC,0BAA0B,KAAK,CAAC,MAAM,WAAW,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAgB,EAAE,CAAC;IAChC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,iCAAiC;IACjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;YACpC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAErB,yBAAyB;YACzB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,UAAU,EAAE,CAAC;gBACb,YAAY,IAAI,MAAM,CAAC,OAAO,CAAC;gBAC/B,qBAAQ,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,OAAO,wBAAwB,IAAI,EAAE,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qBAAQ,CAAC,KAAK,CAAC,sBAAsB,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,wCAAwC;IACxC,qBAAQ,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAClC,qBAAQ,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpD,qBAAQ,CAAC,GAAG,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;IAC9C,qBAAQ,CAAC,GAAG,CAAC,oCAAoC,YAAY,EAAE,CAAC,CAAC;IAEjE,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,qBAAQ,CAAC,GAAG,CAAC,6CAA6C,UAAU,SAAS,CAAC,CAAC;IACjF,CAAC;SAAM,CAAC;QACN,qBAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC;AAED,kDAAkD;AAClD,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,qBAAQ,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;IAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/scripts/validate-imports.d.ts

@@ -1,3 +1,27 @@
 #!/usr/bin/env node
+/**
+ * @fileoverview Import Validation Script
+ *
+ * This script validates import ordering across all TypeScript files in the project
+ * using the Dynamo import-order ESLint rule. It scans files, runs ESLint validation,
+ * and reports any import ordering violations.
+ *
+ * @usage
+ * ```bash
+ * dynamo-validate-imports
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Validate import ordering in all TypeScript files
+ * npx dynamo-validate-imports
+ *
+ * # Or run via npm script
+ * npm run validate:imports
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 export {};
 //# sourceMappingURL=validate-imports.d.ts.map

package/build/scripts/validate-imports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validate-imports.d.ts","sourceRoot":"","sources":["../../src/scripts/validate-imports.ts"],"names":[],"mappings":""}
+{"version":3,"file":"validate-imports.d.ts","sourceRoot":"","sources":["../../src/scripts/validate-imports.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;;;GAuBG"}

package/build/scripts/validate-imports.js

@@ -1,11 +1,53 @@
 #!/usr/bin/env node
 "use strict";
+/**
+ * @fileoverview Import Validation Script
+ *
+ * This script validates import ordering across all TypeScript files in the project
+ * using the Dynamo import-order ESLint rule. It scans files, runs ESLint validation,
+ * and reports any import ordering violations.
+ *
+ * @usage
+ * ```bash
+ * dynamo-validate-imports
+ * ```
+ *
+ * @example
+ * ```bash
+ * # Validate import ordering in all TypeScript files
+ * npx dynamo-validate-imports
+ *
+ * # Or run via npm script
+ * npm run validate:imports
+ * ```
+ *
+ * @author Future Development Program Ltd.
+ * @version 1.14.3
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
 const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
 const eslint_1 = require("eslint");
+/**
+ * Validates import ordering in a single TypeScript file
+ *
+ * Uses ESLint with the Dynamo import-order rule to check for import ordering
+ * violations and returns detailed error information.
+ *
+ * @param filePath - Path to the TypeScript file to validate
+ * @returns Promise that resolves to an ImportValidationResult object
+ *
+ * @example
+ * ```typescript
+ * const result = await validateImportsInFile('./src/components/Button.tsx');
+ * if (result.errors.length > 0) {
+ *   console.log(`Found ${result.errors.length} import violations`);
+ * }
+ * ```
+ */
 async function validateImportsInFile(filePath) {
+    // Configure ESLint with Dynamo import-order rule
     const eslint = new eslint_1.ESLint({
         baseConfig: {
             parser: '@typescript-eslint/parser',
@@ -25,8 +67,10 @@ async function validateImportsInFile(filePath) {
             },
         },
     });
+    // Run ESLint on the file
     const results = await eslint.lintFiles([filePath]);
     const result = results[0];
+    // Transform ESLint messages into our result format
     return {
         file: filePath,
         errors: result.messages.map(msg => ({
@@ -37,13 +81,26 @@ async function validateImportsInFile(filePath) {
         })),
     };
 }
+/**
+ * Main function that validates import ordering across all TypeScript files
+ *
+ * Scans for all .ts and .tsx files in the project, validates import ordering
+ * using the Dynamo import-order rule, and provides detailed reporting on any
+ * violations found.
+ *
+ * @returns Promise that resolves when all files have been validated
+ *
+ * @throws {Error} When validation fails and process exits with code 1
+ */
 async function main() {
+    // Find all TypeScript files, excluding common directories and test files
     const files = await (0, fast_glob_1.default)(['**/*.{ts,tsx}'], {
         ignore: ['**/node_modules/**', '**/build/**', '**/dist/**', '**/*.spec.ts', '**/*.test.ts'],
     });
     fsm_dynamo_1.DyFM_Log.log(`[dynamo-validate-imports] Scanning ${files.length} files...`);
     const results = [];
     let totalErrors = 0;
+    // Process each file individually
     for (const file of files) {
         try {
             const result = await validateImportsInFile(file);
@@ -54,12 +111,14 @@ async function main() {
             fsm_dynamo_1.DyFM_Log.error(`Error processing ${file}:`, error);
         }
     }
-    // Report results
+    // Filter files that have import violations
     const filesWithErrors = results.filter(r => r.errors.length > 0);
+    // Report success if no violations found
     if (filesWithErrors.length === 0) {
         fsm_dynamo_1.DyFM_Log.log('✅ All import validations passed!');
         return;
     }
+    // Report detailed error information
     fsm_dynamo_1.DyFM_Log.warn(`\n❌ Found ${totalErrors} import validation errors in ${filesWithErrors.length} files:\n`);
     filesWithErrors.forEach(result => {
         fsm_dynamo_1.DyFM_Log.log(`📁 ${result.file}:`);
@@ -68,8 +127,10 @@ async function main() {
         });
         fsm_dynamo_1.DyFM_Log.log('');
     });
+    // Exit with error code to indicate validation failure
     process.exit(1);
 }
+// Execute the main function and handle any errors
 main().catch((err) => {
     fsm_dynamo_1.DyFM_Log.error('Validation failed:', err);
     process.exit(1);