Fix for files modified by post-fix commands causing incorrect detection of misspellings

Author: Rhys Koedijk

task/index.ts

@@ -51,7 +51,7 @@ async function run() {
             if (config.commitSuggestions) {
                 await ado.commitSuggestionsToPullRequest({
                     pullRequestId: config.pullRequestId,
-                    fixedFiles: codespell.fixed,
+                    files: [...new Set([...codespell.fixed, ...codespell.modified])],
                     suggestions: config.commentSuggestions ? codespell.suggestions : []
                 });
             }
@@ -64,7 +64,7 @@ async function run() {
         }
 
         // Report task result
-        const noMisspellingsFound = (codespell.suggestions.length === 0 && codespell.fixed.length === 0);
+        const noMisspellingsFound = (codespell.suggestions.length === 0);
         setResult(
             noMisspellingsFound
                 ? TaskResult.Succeeded

task/services/azureDevOpsClient.ts

@@ -92,7 +92,7 @@ export class AzureDevOpsClient {
 
   public async commitSuggestionsToPullRequest(options: {
     pullRequestId: number,
-    fixedFiles: IFile[],
+    files: IFile[],
     suggestions: IFileSuggestion[]
   }) {
     try {
@@ -110,10 +110,10 @@ export class AzureDevOpsClient {
         .filter(thread => !thread.isDeleted && thread.status === CommentThreadStatus.Active);
 
       // Commit all files which have been automatically fixed or have suggestions that aren't already in an active thread
-      const fixedFilesToCommit = (options.fixedFiles || []);
+      const filesToCommit = (options.files || []);
       const sugestionsToCommit = (options.suggestions || [])
         .filter(suggestion => !activeThreads.some(thread => this.isThreadForSuggestion(userId, thread, suggestion)));
-      const filePathsToCommit = [...new Set(fixedFilesToCommit.concat(sugestionsToCommit).map(f => f.path))];
+      const filePathsToCommit = [...new Set(filesToCommit.concat(sugestionsToCommit).map(f => f.path))];
       if (filePathsToCommit.length === 0) {
         return;
       }

task/services/codespellRunner.ts

@@ -5,8 +5,9 @@ import { IFile, IFileSuggestion } from "./types";
 
 export interface ICodeSpellResult {
     returnCode: number;
-    fixed: IFile[];
-    suggestions: IFileSuggestion[];
+    modified: IFile[];                  // auto-modified by post-fix commands
+    fixed: IFile[];                     // auto-fixed by codespell
+    suggestions: IFileSuggestion[];     // manual fixes are needed
 }
 
 export class CodespellRunner {
@@ -98,8 +99,7 @@ export class CodespellRunner {
 
         // Include any locally modified files in the list of fixed files
         // These could be from the post-fix command or from comment commands
-        const modifiedFiles = await this.getModifiedFilePaths();
-        fixedFiles.push(...modifiedFiles.map(f => ({ path: f })));
+        const modifiedFiles: IFile[] = (await this.getModifiedFilePaths()).map(f => ({ path: f }));
 
         // Tell the user what we found
         const noMisspellingsFound = (suggestions.length === 0 && fixedFiles.length === 0);
@@ -117,6 +117,7 @@ export class CodespellRunner {
 
         return {
             returnCode: returnCode,
+            modified: modifiedFiles,
             fixed: fixedFiles,
             suggestions: suggestions
         };