2.6.5

changelog.md

@@ -1,5 +1,60 @@
 # Changelog
 
+## 2025-08-18 - 2.6.5 - fix(dependencies)
+Bump dependencies and add pnpm-workspace configuration
+
+- Updated @git.zone/tspublish from ^1.9.1 to ^1.10.1
+- Updated @push.rocks/smartfile from ^11.2.4 to ^11.2.7
+- Updated @push.rocks/smartpath from ^5.0.18 to ^6.0.0
+- Updated typescript from 5.8.3 to 5.9.2
+- Updated devDependency @git.zone/tstest from ^1.10.1 to ^2.3.4
+- Added pnpm-workspace.yaml with onlyBuiltDependencies list (esbuild, mongodb-memory-server, puppeteer)
+
+## 2025-05-24 - 2.6.4 - fix(dependencies)
+Add .npmrc and update dependency versions for smartfile and tstest
+
+- Add .npmrc with registry configuration for npm
+- Bump @push.rocks/smartfile version from ^11.2.3 to ^11.2.4
+- Bump @git.zone/tstest version from ^1.9.0 to ^1.10.1
+
+## 2025-05-21 - 2.6.3 - fix(tsbuild)
+minor maintenance updates and documentation improvements
+
+- Updated commit metadata to align with project version
+- Refined CLI command parsing and diagnostics logging for better clarity
+- Improved code readability in compiler options merging
+
+## 2025-05-21 - 2.6.2 - fix(npm configuration)
+Remove .npmrc file to default npm registry behavior
+
+- Deleted .npmrc file that hard-coded the npm registry URL to https://registry.npmjs.org/
+- This change leverages npm's default registry settings and reduces configuration clutter
+
+## 2025-05-21 - 2.6.1 - fix(tsbuild.classes)
+Improve error diagnostics handling by removing legacy helper and integrating more robust error summaries in the compilation process
+
+- Removed the handleDiagnostics method and its legacy usage
+- Replaced legacy calls with inline processDiagnostics checks for pre-emit and emit phases
+- Combined error summaries for clearer reporting during emit checks and type validation
+- Enhanced error output to guide users on resolving TypeScript errors before emission
+
+## 2025-05-21 - 2.6.0 - feat(tsbuild)
+Improve task logging and update dependencies
+
+- Add .npmrc file with npm registry configuration
+- Update test script to use '--verbose' flag
+- Bump dependency versions for @push.rocks packages and TypeScript
+- Enhance TsBuild logging by incorporating task info (e.g. task number, total tasks, output folder, and compile durations)
+- Propagate task info in compileFileArrayWithErrorTracking for better task tracking
+
+## 2025-05-21 - 2.5.2 - fix(tsbuild)
+Improve diagnostic error handling and summary reporting for TypeScript compilation by refactoring diagnostic processing and adding pre-emit error checks.
+
+- Introduce a dedicated processDiagnostics function that categorizes errors by file and computes error totals.
+- Refactor displayErrorSummary to provide clearer, color-coded output of error details.
+- Add pre-emit error checking in compileWithErrorTracking to prevent emission when errors exist.
+- Consolidate error summary merging in compileFileArrayWithErrorTracking for improved reporting.
+
 ## 2025-05-15 - 2.5.1 - fix(commitinfo)
 Update commit information and metadata to synchronize release data
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@git.zone/tsbuild",
-  "version": "2.5.1",
+  "version": "2.6.5",
   "private": false,
   "description": "A tool for compiling TypeScript files using the latest nightly features, offering flexible APIs and a CLI for streamlined development.",
   "main": "dist_ts/index.js",
@@ -10,7 +10,7 @@
     "tsbuild": "./cli.js"
   },
   "scripts": {
-    "test": "tsrun test/test.ts",
+    "test": "tsrun test/test.ts --verbose",
     "build": "node cli.ts.js --web",
     "buildDocs": "tsdoc"
   },
@@ -36,20 +36,20 @@
   },
   "homepage": "https://code.foss.global/git.zone/tsbuild#README",
   "dependencies": {
-    "@git.zone/tspublish": "^1.9.1",
+    "@git.zone/tspublish": "^1.10.1",
     "@push.rocks/early": "^4.0.4",
     "@push.rocks/smartcli": "^4.0.11",
     "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartfile": "^11.1.5",
-    "@push.rocks/smartlog": "^3.0.7",
-    "@push.rocks/smartpath": "^5.0.18",
-    "@push.rocks/smartpromise": "^4.2.2",
-    "typescript": "5.7.3"
+    "@push.rocks/smartfile": "^11.2.7",
+    "@push.rocks/smartlog": "^3.1.8",
+    "@push.rocks/smartpath": "^6.0.0",
+    "@push.rocks/smartpromise": "^4.2.3",
+    "typescript": "5.9.2"
   },
   "devDependencies": {
     "@git.zone/tsrun": "^1.2.47",
-    "@push.rocks/tapbundle": "^5.5.6",
-    "@types/node": "^22.12.0"
+    "@git.zone/tstest": "^2.3.4",
+    "@types/node": "^22.15.21"
   },
   "files": [
     "ts/**/*",

pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+onlyBuiltDependencies:
+  - esbuild
+  - mongodb-memory-server
+  - puppeteer

test/test.ts

@@ -1,4 +1,4 @@
-import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
+import { tap, expect } from '@git.zone/tstest/tapbundle';
 
 import * as tsbuild from '../ts/index.js';
 

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tsbuild',
-  version: '2.5.1',
+  version: '2.6.5',
   description: 'A tool for compiling TypeScript files using the latest nightly features, offering flexible APIs and a CLI for streamlined development.'
 }

ts/tsbuild.classes.tsbuild.ts

@@ -3,6 +3,16 @@ import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import type { CompilerOptions, ScriptTarget, ModuleKind } from './tsbuild.exports.js';
 
+/**
+ * Interface for error summary data
+ */
+export interface IErrorSummary {
+  errorsByFile: Record<string, plugins.typescript.Diagnostic[]>;
+  generalErrors: plugins.typescript.Diagnostic[];
+  totalErrors: number;
+  totalFiles: number;
+}
+
 /**
  * Default compiler options for TypeScript compilation
  */
@@ -31,6 +41,7 @@ export class TsBuild {
   private fileNames: string[] = [];
   private options: plugins.typescript.CompilerOptions;
   private argvArg?: any;
+  private taskInfo?: any;
 
   /**
    * Create a new TsBuild instance
@@ -38,10 +49,12 @@ export class TsBuild {
   constructor(
     fileNames: string[] = [], 
     customOptions: CompilerOptions = {}, 
-    argvArg?: any
+    argvArg?: any,
+    taskInfo?: any
   ) {
     this.fileNames = fileNames;
     this.argvArg = argvArg;
+    this.taskInfo = taskInfo;
     this.options = this.mergeCompilerOptions(customOptions, argvArg);
   }
 
@@ -166,14 +179,9 @@ export class TsBuild {
   }
 
   /**
-   * Helper function to handle and log TypeScript diagnostics
+   * Helper function to process TypeScript diagnostics and return error summary
    */
-  private handleDiagnostics(diagnostics: readonly plugins.typescript.Diagnostic[]): boolean {
-    if (diagnostics.length === 0) {
-      return false;
-    }
-    
-    // Group errors by file for better readability
+  private processDiagnostics(diagnostics: readonly plugins.typescript.Diagnostic[]): IErrorSummary {
     const errorsByFile: Record<string, plugins.typescript.Diagnostic[]> = {};
     const generalErrors: plugins.typescript.Diagnostic[] = [];
     
@@ -190,12 +198,27 @@ export class TsBuild {
       }
     });
     
-    // Print error summary header
-    const totalErrorCount = diagnostics.length;
-    const fileCount = Object.keys(errorsByFile).length;
+    return {
+      errorsByFile,
+      generalErrors,
+      totalErrors: diagnostics.length,
+      totalFiles: Object.keys(errorsByFile).length
+    };
+  }
+
+  /**
+   * Helper function to display error summary
+   */
+  private displayErrorSummary(errorSummary: IErrorSummary): void {
+    if (errorSummary.totalErrors === 0) {
+      return;
+    }
     
+    const { errorsByFile, generalErrors, totalErrors, totalFiles } = errorSummary;
+    
+    // Print error summary header
     console.log('\n' + '='.repeat(80));
-    console.log(`❌ Found ${totalErrorCount} error${totalErrorCount !== 1 ? 's' : ''} in ${fileCount} file${fileCount !== 1 ? 's' : ''}:`);
+    console.log(`❌ Found ${totalErrors} error${totalErrors !== 1 ? 's' : ''} in ${totalFiles} file${totalFiles !== 1 ? 's' : ''}:`);
     console.log('='.repeat(80));
     
     // Color codes for error formatting
@@ -255,10 +278,9 @@ export class TsBuild {
     }
     
     console.log('\n' + '='.repeat(80) + '\n');
-    
-    return diagnostics.length > 0;
   }
 
+
   /**
    * Creates a TypeScript program from file names and options
    */
@@ -282,6 +304,90 @@ export class TsBuild {
     this.options = { ...this.options, ...options };
   }
 
+  /**
+   * The main compiler function that compiles the files and returns error summary
+   */
+  public async compileWithErrorTracking(): Promise<{ emittedFiles: any[], errorSummary: IErrorSummary }> {
+    if (this.options.skipLibCheck) {
+      console.log('\n⚠️  WARNING ⚠️');
+      console.log('You are skipping libcheck... Is that really wanted?');
+      console.log('Continuing in 5 seconds...\n');
+      await plugins.smartdelay.delayFor(5000);
+    }
+    
+    // Enhanced logging with task info
+    const startTime = Date.now();
+    if (this.taskInfo) {
+      const { taskNumber, totalTasks, sourcePattern, destDir, fileCount } = this.taskInfo;
+      const relativeDestDir = destDir.replace(process.cwd(), '').replace(/^\//, '');
+      console.log(`\n🔨 [${taskNumber}/${totalTasks}] Compiling ${fileCount} file${fileCount !== 1 ? 's' : ''} from ${sourcePattern}`);
+      console.log(`   📁 Output: ${relativeDestDir}`);
+    } else {
+      console.log(`🔨 Compiling ${this.fileNames.length} files...`);
+    }
+    
+    const done = plugins.smartpromise.defer<{ emittedFiles: any[], errorSummary: IErrorSummary }>();
+    const program = this.createProgram();
+    
+    // Check for pre-emit diagnostics first
+    const preEmitDiagnostics = plugins.typescript.getPreEmitDiagnostics(program);
+    const preEmitErrorSummary = this.processDiagnostics(preEmitDiagnostics);
+    
+    // Only continue to emit phase if no pre-emit errors
+    if (preEmitErrorSummary.totalErrors > 0) {
+      this.displayErrorSummary(preEmitErrorSummary);
+      console.error('\n❌ TypeScript pre-emit checks failed. Please fix the issues listed above before proceeding.');
+      console.error('   Type errors must be resolved before the compiler can emit output files.\n');
+      // Return error summary instead of exiting to allow final summary display
+      done.resolve({ emittedFiles: [], errorSummary: preEmitErrorSummary });
+      return done.promise;
+    }
+    
+    // If no pre-emit errors, proceed with emit
+    const emitResult = program.emit();
+    const emitErrorSummary = this.processDiagnostics(emitResult.diagnostics);
+    
+    // Combine error summaries
+    const combinedErrorSummary: IErrorSummary = {
+      errorsByFile: { ...preEmitErrorSummary.errorsByFile, ...emitErrorSummary.errorsByFile },
+      generalErrors: [...preEmitErrorSummary.generalErrors, ...emitErrorSummary.generalErrors],
+      totalErrors: preEmitErrorSummary.totalErrors + emitErrorSummary.totalErrors,
+      totalFiles: Object.keys({ ...preEmitErrorSummary.errorsByFile, ...emitErrorSummary.errorsByFile }).length
+    };
+
+    const exitCode = emitResult.emitSkipped ? 1 : 0;
+    if (exitCode === 0) {
+      const endTime = Date.now();
+      const duration = endTime - startTime;
+      
+      if (this.taskInfo) {
+        const { taskNumber, totalTasks } = this.taskInfo;
+        console.log(`✅ [${taskNumber}/${totalTasks}] Task completed in ${duration}ms`);
+      } else {
+        console.log(`✅ TypeScript emit succeeded! (${duration}ms)`);
+      }
+      
+      // Get count of emitted files by type
+      const jsFiles = emitResult.emittedFiles?.filter(f => f.endsWith('.js')).length || 0;
+      const dtsFiles = emitResult.emittedFiles?.filter(f => f.endsWith('.d.ts')).length || 0;
+      const mapFiles = emitResult.emittedFiles?.filter(f => f.endsWith('.map')).length || 0;
+      
+      // If we have emitted files, show a summary
+      if (emitResult.emittedFiles && emitResult.emittedFiles.length > 0) {
+        console.log(`   📄 Generated ${emitResult.emittedFiles.length} files: ${jsFiles} .js, ${dtsFiles} .d.ts, ${mapFiles} source maps`);
+      }
+      
+      done.resolve({ emittedFiles: emitResult.emittedFiles || [], errorSummary: combinedErrorSummary });
+    } else {
+      this.displayErrorSummary(combinedErrorSummary);
+      console.error('\n❌ TypeScript emit failed. Please investigate the errors listed above!');
+      console.error('   No output files have been generated.\n');
+      process.exit(exitCode);
+    }
+
+    return done.promise;
+  }
+
   /**
    * The main compiler function that compiles the files
    */
@@ -299,10 +405,11 @@ export class TsBuild {
     
     // Check for pre-emit diagnostics first
     const preEmitDiagnostics = plugins.typescript.getPreEmitDiagnostics(program);
-    const hasPreEmitErrors = this.handleDiagnostics(preEmitDiagnostics);
+    const preEmitErrorSummary = this.processDiagnostics(preEmitDiagnostics);
     
     // Only continue to emit phase if no pre-emit errors
-    if (hasPreEmitErrors) {
+    if (preEmitErrorSummary.totalErrors > 0) {
+      this.displayErrorSummary(preEmitErrorSummary);
       console.error('\n❌ TypeScript pre-emit checks failed. Please fix the issues listed above before proceeding.');
       console.error('   Type errors must be resolved before the compiler can emit output files.\n');
       process.exit(1);
@@ -310,7 +417,7 @@ export class TsBuild {
     
     // If no pre-emit errors, proceed with emit
     const emitResult = program.emit();
-    const hasEmitErrors = this.handleDiagnostics(emitResult.diagnostics);
+    const emitErrorSummary = this.processDiagnostics(emitResult.diagnostics);
 
     const exitCode = emitResult.emitSkipped ? 1 : 0;
     if (exitCode === 0) {
@@ -328,6 +435,7 @@ export class TsBuild {
       
       done.resolve(emitResult.emittedFiles);
     } else {
+      this.displayErrorSummary(emitErrorSummary);
       console.error('\n❌ TypeScript emit failed. Please investigate the errors listed above!');
       console.error('   No output files have been generated.\n');
       process.exit(exitCode);
@@ -351,18 +459,27 @@ export class TsBuild {
     
     // Check for pre-emit diagnostics
     const preEmitDiagnostics = plugins.typescript.getPreEmitDiagnostics(program);
-    const hasPreEmitErrors = this.handleDiagnostics(preEmitDiagnostics);
+    const preEmitErrorSummary = this.processDiagnostics(preEmitDiagnostics);
     
     // Run the emit phase but with noEmit: true to check for emit errors without producing files
     const emitResult = program.emit(undefined, undefined, undefined, true);
-    const hasEmitErrors = this.handleDiagnostics(emitResult.diagnostics);
+    const emitErrorSummary = this.processDiagnostics(emitResult.diagnostics);
     
-    const success = !hasPreEmitErrors && !hasEmitErrors && !emitResult.emitSkipped;
+    // Combine error summaries
+    const combinedErrorSummary: IErrorSummary = {
+      errorsByFile: { ...preEmitErrorSummary.errorsByFile, ...emitErrorSummary.errorsByFile },
+      generalErrors: [...preEmitErrorSummary.generalErrors, ...emitErrorSummary.generalErrors],
+      totalErrors: preEmitErrorSummary.totalErrors + emitErrorSummary.totalErrors,
+      totalFiles: Object.keys({ ...preEmitErrorSummary.errorsByFile, ...emitErrorSummary.errorsByFile }).length
+    };
+    
+    const success = combinedErrorSummary.totalErrors === 0 && !emitResult.emitSkipped;
     
     if (success) {
       console.log('\n✅ TypeScript emit check passed! All files can be emitted successfully.');
       console.log(`   ${fileCount} file${fileCount !== 1 ? 's' : ''} ${fileCount !== 1 ? 'are' : 'is'} ready to be compiled.\n`);
     } else {
+      this.displayErrorSummary(combinedErrorSummary);
       console.error('\n❌ TypeScript emit check failed. Please fix the issues listed above.');
       console.error('   The compilation cannot proceed until these errors are resolved.\n');
     }
@@ -385,15 +502,16 @@ export class TsBuild {
     
     // Check for type errors
     const diagnostics = plugins.typescript.getPreEmitDiagnostics(program);
-    const hasErrors = this.handleDiagnostics(diagnostics);
+    const errorSummary = this.processDiagnostics(diagnostics);
     
     // Set success flag
-    const success = !hasErrors;
+    const success = errorSummary.totalErrors === 0;
     
     if (success) {
       console.log('\n✅ TypeScript type check passed! No type errors found.');
       console.log(`   All ${fileCount} file${fileCount !== 1 ? 's' : ''} passed type checking successfully.\n`);
     } else {
+      this.displayErrorSummary(errorSummary);
       console.error('\n❌ TypeScript type check failed. Please fix the type errors listed above.');
       console.error('   The type checker found issues that need to be resolved.\n');
     }

ts/tsbuild.exports.ts

@@ -6,6 +6,31 @@ export type { CompilerOptions, ScriptTarget, ModuleKind };
 
 export * from './tsbuild.classes.tsbuild.js';
 
+/**
+ * Interface for task information
+ */
+export interface ITaskInfo {
+  taskNumber: number;
+  totalTasks: number;
+  sourcePattern: string;
+  destDir: string;
+  fileCount: number;
+}
+
+/**
+ * compile an array of absolute file paths with error tracking
+ */
+export let compileFileArrayWithErrorTracking = async (
+  fileStringArrayArg: string[],
+  compilerOptionsArg: CompilerOptions = {},
+  argvArg?: any,
+  taskInfo?: ITaskInfo
+): Promise<{ emittedFiles: any[], errorSummary: import('./tsbuild.classes.tsbuild.js').IErrorSummary }> => {
+  const { TsBuild } = await import('./tsbuild.classes.tsbuild.js');
+  const tsBuild = new TsBuild(fileStringArrayArg, compilerOptionsArg, argvArg, taskInfo);
+  return tsBuild.compileWithErrorTracking();
+};
+
 /**
  * compile am array of absolute file paths
  */
@@ -17,6 +42,75 @@ export let compileFileArray = (
   return compiler(fileStringArrayArg, mergeCompilerOptions(compilerOptionsArg, argvArg), argvArg);
 };
 
+/**
+ * Helper function to merge error summaries
+ */
+function mergeErrorSummaries(summaries: import('./tsbuild.classes.tsbuild.js').IErrorSummary[]): import('./tsbuild.classes.tsbuild.js').IErrorSummary {
+  const mergedErrorsByFile: Record<string, plugins.typescript.Diagnostic[]> = {};
+  const mergedGeneralErrors: plugins.typescript.Diagnostic[] = [];
+  let totalErrors = 0;
+  
+  summaries.forEach(summary => {
+    // Merge errors by file
+    Object.entries(summary.errorsByFile).forEach(([fileName, errors]) => {
+      if (!mergedErrorsByFile[fileName]) {
+        mergedErrorsByFile[fileName] = [];
+      }
+      mergedErrorsByFile[fileName] = mergedErrorsByFile[fileName].concat(errors);
+    });
+    
+    // Merge general errors
+    mergedGeneralErrors.push(...summary.generalErrors);
+    totalErrors += summary.totalErrors;
+  });
+  
+  return {
+    errorsByFile: mergedErrorsByFile,
+    generalErrors: mergedGeneralErrors,
+    totalErrors,
+    totalFiles: Object.keys(mergedErrorsByFile).length
+  };
+}
+
+/**
+ * Helper function to display final compilation summary
+ */
+function displayFinalErrorSummary(errorSummary: import('./tsbuild.classes.tsbuild.js').IErrorSummary): void {
+  if (errorSummary.totalErrors === 0) {
+    console.log('\n📊 \x1b[32mCompilation Summary: All tasks completed successfully! ✅\x1b[0m\n');
+    return;
+  }
+  
+  const colors = {
+    reset: '\x1b[0m',
+    red: '\x1b[31m',
+    yellow: '\x1b[33m',
+    cyan: '\x1b[36m',
+    brightRed: '\x1b[91m',
+    brightYellow: '\x1b[93m'
+  };
+  
+  console.log('\n' + '='.repeat(80));
+  console.log(`📊 ${colors.brightYellow}Final Compilation Summary${colors.reset}`);
+  console.log('='.repeat(80));
+  
+  if (errorSummary.totalFiles > 0) {
+    console.log(`${colors.brightRed}❌ Files with errors (${errorSummary.totalFiles}):${colors.reset}`);
+    
+    Object.entries(errorSummary.errorsByFile).forEach(([fileName, errors]) => {
+      const displayPath = fileName.replace(process.cwd(), '').replace(/^\//, '');
+      console.log(`  ${colors.red}•${colors.reset} ${colors.cyan}${displayPath}${colors.reset} ${colors.yellow}(${errors.length} error${errors.length !== 1 ? 's' : ''})${colors.reset}`);
+    });
+  }
+  
+  if (errorSummary.generalErrors.length > 0) {
+    console.log(`${colors.brightRed}❌ General errors: ${errorSummary.generalErrors.length}${colors.reset}`);
+  }
+  
+  console.log(`\n${colors.brightRed}Total: ${errorSummary.totalErrors} error${errorSummary.totalErrors !== 1 ? 's' : ''} across ${errorSummary.totalFiles} file${errorSummary.totalFiles !== 1 ? 's' : ''}${colors.reset}`);
+  console.log('='.repeat(80) + '\n');
+}
+
 /**
  * compile advanced glob configurations
  * @param globStringArrayArg a array of glob strings
@@ -31,9 +125,13 @@ export let compileGlobStringObject = async (
   argvArg?: any
 ) => {
   let compiledFiles: any[] = [];
+  const errorSummaries: import('./tsbuild.classes.tsbuild.js').IErrorSummary[] = [];
+  
+  const totalTasks = Object.keys(globStringObjectArg).length;
+  let currentTask = 0;
   
   // Log the compilation tasks in a nice format
-  console.log('\n👷 TypeScript Compilation Tasks:');
+  console.log(`\n👷 TypeScript Compilation Tasks (${totalTasks} task${totalTasks !== 1 ? 's' : ''}):`);
   Object.entries(globStringObjectArg).forEach(([source, dest]) => {
     console.log(`  📂 ${source} → ${dest}`);
   });
@@ -69,12 +167,25 @@ export let compileGlobStringObject = async (
         outDir: destDir,
       };
       
-      // Compile the files and correctly concat the results
-      // Fixed: removed duplicating compiledFiles in the concat operation
-      const newlyCompiledFiles = await compileFileArray(absoluteFilePathArray, updatedTsOptions, argvArg);
-      compiledFiles = compiledFiles.concat(newlyCompiledFiles);
+      // Compile with error tracking
+      currentTask++;
+      const taskInfo = {
+        taskNumber: currentTask,
+        totalTasks,
+        sourcePattern: keyArg,
+        destDir: globStringObjectArg[keyArg],
+        fileCount: absoluteFilePathArray.length
+      };
+      
+      const result = await compileFileArrayWithErrorTracking(absoluteFilePathArray, updatedTsOptions, argvArg, taskInfo);
+      compiledFiles = compiledFiles.concat(result.emittedFiles);
+      errorSummaries.push(result.errorSummary);
     }
   }
   
+  // Display final error summary after all compilation tasks
+  const finalErrorSummary = mergeErrorSummaries(errorSummaries);
+  displayFinalErrorSummary(finalErrorSummary);
+  
   return compiledFiles;
 };