Address feedback: use program.getCompilerOptions().configFilePath, base64url encoding, and sort files

Co-authored-by: dmichon-msft <[email protected]>

Author: Copilot

heft-plugins/heft-lint-plugin/src/LintPlugin.ts

@@ -39,7 +39,6 @@ interface ILintOptions {
   taskSession: IHeftTaskSession;
   heftConfiguration: HeftConfiguration;
   tsProgram: IExtendedProgram;
-  tsconfigFilePath: string;
   fix?: boolean;
   sarifLogPath?: string;
   changedFiles?: ReadonlySet<IExtendedSourceFile>;
@@ -105,8 +104,7 @@ export default class LintPlugin implements IHeftTaskPlugin<ILintPluginOptions> {
     let inTypescriptPhase: boolean = false;
 
     // Use the changed files hook to collect the files and programs from TypeScript
-    // Also track the tsconfig path for cache file naming
-    let typescriptChangedFiles: [IExtendedProgram, ReadonlySet<IExtendedSourceFile>, string][] = [];
+    let typescriptChangedFiles: [IExtendedProgram, ReadonlySet<IExtendedSourceFile>][] = [];
     taskSession.requestAccessToPluginByName(
       TYPESCRIPT_PLUGIN_PACKAGE_NAME,
       TYPESCRIPT_PLUGIN_NAME,
@@ -116,13 +114,9 @@ export default class LintPlugin implements IHeftTaskPlugin<ILintPluginOptions> {
 
         // Hook into the changed files hook to collect the changed files and their programs
         accessor.onChangedFilesHook.tap(PLUGIN_NAME, (changedFilesHookOptions: IChangedFilesHookOptions) => {
-          // When using the TypeScript plugin, we need to determine the tsconfig path
-          // The default tsconfig path is used when not explicitly specified
-          const tsconfigPath: string = path.resolve(heftConfiguration.buildFolderPath, 'tsconfig.json');
           typescriptChangedFiles.push([
             changedFilesHookOptions.program as IExtendedProgram,
-            changedFilesHookOptions.changedFiles as ReadonlySet<IExtendedSourceFile>,
-            tsconfigPath
+            changedFilesHookOptions.changedFiles as ReadonlySet<IExtendedSourceFile>
           ]);
         });
       }
@@ -132,22 +126,20 @@ export default class LintPlugin implements IHeftTaskPlugin<ILintPluginOptions> {
       // If we are not in the typescript phase, we need to create a typescript program
       // from the tsconfig file
       if (!inTypescriptPhase) {
-        const tsconfigPath: string = path.resolve(heftConfiguration.buildFolderPath, 'tsconfig.json');
         const tsProgram: IExtendedProgram = await this._createTypescriptProgramAsync(
           heftConfiguration,
           taskSession
         );
-        typescriptChangedFiles.push([tsProgram, new Set(tsProgram.getSourceFiles()), tsconfigPath]);
+        typescriptChangedFiles.push([tsProgram, new Set(tsProgram.getSourceFiles())]);
       }
 
       // Run the linters to completion. Linters emit errors and warnings to the logger.
-      for (const [tsProgram, changedFiles, tsconfigFilePath] of typescriptChangedFiles) {
+      for (const [tsProgram, changedFiles] of typescriptChangedFiles) {
         try {
           await this._lintAsync({
             taskSession,
             heftConfiguration,
             tsProgram,
-            tsconfigFilePath,
             changedFiles,
             fix,
             sarifLogPath
@@ -230,8 +222,7 @@ export default class LintPlugin implements IHeftTaskPlugin<ILintPluginOptions> {
   }
 
   private async _lintAsync(options: ILintOptions): Promise<void> {
-    const { taskSession, heftConfiguration, tsProgram, tsconfigFilePath, changedFiles, fix, sarifLogPath } =
-      options;
+    const { taskSession, heftConfiguration, tsProgram, changedFiles, fix, sarifLogPath } = options;
 
     // Ensure that we have initialized. This promise is cached, so calling init
     // multiple times will only init once.
@@ -241,7 +232,6 @@ export default class LintPlugin implements IHeftTaskPlugin<ILintPluginOptions> {
     if (this._eslintConfigFilePath && this._eslintToolPath) {
       const eslintLinter: Eslint = await Eslint.initializeAsync({
         tsProgram,
-        tsconfigFilePath,
         fix,
         sarifLogPath,
         scopedLogger: taskSession.logger,
@@ -256,7 +246,6 @@ export default class LintPlugin implements IHeftTaskPlugin<ILintPluginOptions> {
     if (this._tslintConfigFilePath && this._tslintToolPath) {
       const tslintLinter: Tslint = await Tslint.initializeAsync({
         tsProgram,
-        tsconfigFilePath,
         fix,
         scopedLogger: taskSession.logger,
         linterToolPath: this._tslintToolPath,

heft-plugins/heft-lint-plugin/src/LinterBase.ts

@@ -5,6 +5,8 @@ import * as path from 'node:path';
 import { performance } from 'node:perf_hooks';
 import { createHash, type Hash } from 'node:crypto';
 
+import type * as TTypescript from 'typescript';
+
 import { FileSystem, JsonFile, Path } from '@rushstack/node-core-library';
 import type { ITerminal } from '@rushstack/terminal';
 import type { IScopedLogger } from '@rushstack/heft';
@@ -21,7 +23,6 @@ export interface ILinterBaseOptions {
   linterToolPath: string;
   linterConfigFilePath: string;
   tsProgram: IExtendedProgram;
-  tsconfigFilePath: string;
   fix?: boolean;
   sarifLogPath?: string;
 }
@@ -66,7 +67,6 @@ export abstract class LinterBase<TLintResult> {
   protected readonly _buildFolderPath: string;
   protected readonly _buildMetadataFolderPath: string;
   protected readonly _linterConfigFilePath: string;
-  protected readonly _tsconfigFilePath: string;
   protected readonly _fix: boolean;
 
   protected _fixesPossible: boolean = false;
@@ -79,7 +79,6 @@ export abstract class LinterBase<TLintResult> {
     this._buildFolderPath = options.buildFolderPath;
     this._buildMetadataFolderPath = options.buildMetadataFolderPath;
     this._linterConfigFilePath = options.linterConfigFilePath;
-    this._tsconfigFilePath = options.tsconfigFilePath;
     this._linterName = linterName;
     this._fix = options.fix || false;
   }
@@ -94,31 +93,40 @@ export abstract class LinterBase<TLintResult> {
 
     const relativePaths: Map<string, string> = new Map();
 
-    // Calculate the hash of the list of filenames for verification purposes
-    const filesHash: Hash = createHash('md5');
+    // Collect and sort file paths for stable hashing
+    const relativePathsArray: string[] = [];
     for (const file of options.typeScriptFilenames) {
       // Need to use relative paths to ensure portability.
       const relative: string = Path.convertToSlashes(path.relative(commonDirectory, file));
       relativePaths.set(file, relative);
+      relativePathsArray.push(relative);
+    }
+    relativePathsArray.sort();
+
+    // Calculate the hash of the list of filenames for verification purposes
+    const filesHash: Hash = createHash('md5');
+    for (const relative of relativePathsArray) {
       filesHash.update(relative);
     }
-    const filesHashString: string = filesHash
-      .digest('base64')
-      .replace(/\+/g, '-')
-      .replace(/\//g, '_')
-      .slice(0, 8);
+    const filesHashString: string = filesHash.digest('base64url');
 
     // Calculate the hash suffix based on the project-relative path of the tsconfig file
-    const relativeTsconfigPath: string = Path.convertToSlashes(
-      path.relative(this._buildFolderPath, this._tsconfigFilePath)
-    );
-    const tsconfigHash: Hash = createHash('md5');
-    tsconfigHash.update(relativeTsconfigPath);
-    const hashSuffix: string = tsconfigHash
-      .digest('base64')
-      .replace(/\+/g, '-')
-      .replace(/\//g, '_')
-      .slice(0, 8);
+    // Extract the config file path from the program's compiler options
+    const compilerOptions: TTypescript.CompilerOptions = options.tsProgram.getCompilerOptions();
+    const tsconfigFilePath: string | undefined = compilerOptions.configFilePath as string | undefined;
+
+    let hashSuffix: string;
+    if (tsconfigFilePath) {
+      const relativeTsconfigPath: string = Path.convertToSlashes(
+        path.relative(this._buildFolderPath, tsconfigFilePath)
+      );
+      const tsconfigHash: Hash = createHash('md5');
+      tsconfigHash.update(relativeTsconfigPath);
+      hashSuffix = tsconfigHash.digest('base64url').slice(0, 8);
+    } else {
+      // Fallback to a default hash if configFilePath is not available
+      hashSuffix = 'default';
+    }
 
     const linterCacheVersion: string = await this.getCacheVersionAsync();
     const linterCacheFilePath: string = path.resolve(