feat: Prompt action for deleted file (Close #314)

Author: edgardmessias

README.md

@@ -110,6 +110,8 @@ Example:
 |`svn.showOutput`|Show the output window when the extension starts|`false`|
 |`svn.conflicts.autoResolve`|Set file to status resolved after fix conflictss|`false`|
 |`svn.update.ignoreExternals`|Set to ignore externals definitions on update (add --ignore-externals)|`true`|
+|`svn.delete.actionForDeletedFiles`|When a file is deleted, what SVN should do? `none` - Do nothing, `prompt` - Ask the action, `remove` - automatically remove from SVN|`"prompt"`|
+|`svn.delete.ignoredRulesForDeletedFiles`|Ignored files/rules for `svn.delete.actionForDeletedFiles`(Ex.: file.txt or \*\*/\*.txt)|`[]`|
 |`svn.default.encoding`|Encoding of svn output if the output is not utf-8. When this parameter is null, the encoding is automatically detected. Example: 'windows-1252'.|`null`|
 |`svn.showUpdateMessage`|Show the update message when update is run|`true`|
 |`svn.remoteChanges.checkFrequency`|Set the interval in seconds to check changed files on remote repository and show in statusbar. 0 to disable|`300`|

package.json

@@ -726,6 +726,24 @@
           "description": "Set to ignore externals definitions on update (add --ignore-externals)",
           "default": true
         },
+        "svn.delete.actionForDeletedFiles": {
+          "type": "string",
+          "enum": [
+            "none",
+            "prompt",
+            "remove"
+          ],
+          "description": "When a file is deleted, what SVN should do? `none` - Do nothing, `prompt` - Ask the action, `remove` - automatically remove from SVN",
+          "default": "prompt"
+        },
+        "svn.delete.ignoredRulesForDeletedFiles": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Ignored files/rules for `svn.delete.actionForDeletedFiles`(Ex.: file.txt or **/*.txt)",
+          "default": []
+        },
         "svn.default.encoding": {
           "type": [
             "string",

src/commands.ts

@@ -1319,6 +1319,42 @@ export class SvnCommands implements IDisposable {
     return;
   }
 
+  @command("svn.promptRemove", { repository: true })
+  public async promptRemove(repository: Repository, ...uris: Uri[]) {
+    const files = uris.map(uri => uri.fsPath);
+
+    const relativeList = files
+      .map(file => repository.repository.removeAbsolutePath(file))
+      .sort();
+
+    const ignoreText = "Add to ignored list";
+
+    const resp = await window.showInformationMessage(
+      `The file(s) "${relativeList.join(
+        ", "
+      )}" are removed from disk.\nWould you like remove from SVN?`,
+      { modal: true },
+      "Yes",
+      ignoreText,
+      "No"
+    );
+
+    if (resp === "Yes") {
+      await repository.removeFiles(files, false);
+    } else if (resp === ignoreText) {
+      let ignoreList = configuration.get<string[]>(
+        "delete.ignoredRulesForDeletedFiles",
+        []
+      );
+
+      ignoreList.push(...relativeList);
+
+      ignoreList = [...new Set(ignoreList)]; // Remove duplicates
+
+      configuration.update("delete.ignoredRulesForDeletedFiles", ignoreList);
+    }
+  }
+
   private getSCMResource(uri?: Uri): Resource | undefined {
     uri = uri
       ? uri

src/repository.ts

@@ -69,6 +69,7 @@ export class Repository {
   public isIncomplete: boolean = false;
   public needCleanUp: boolean = false;
   private remoteChangedUpdateInterval?: NodeJS.Timer;
+  private deletedUris: Uri[] = [];
 
   private lastPromptAuth?: Thenable<boolean | undefined>;
 
@@ -245,6 +246,17 @@ export class Repository {
       })
     );
 
+    // For each deleted file, append to list
+    const onFsDelete = filterEvent(
+      fsWatcher.onDidDelete,
+      uri => !/[\\\/]\.svn[\\\/]/.test(uri.path)
+    );
+
+    onFsDelete(uri => this.deletedUris.push(uri), this, this.disposables);
+
+    // Only check deleted files after the status list is fully updated
+    this.onDidChangeStatus(this.actionForDeletedFiles, this, this.disposables);
+
     this.createRemoteChangedInterval();
 
     this.updateRemoteChangedFiles();
@@ -286,6 +298,70 @@ export class Repository {
     }, 1000 * updateFreq);
   }
 
+  /**
+   * Check all recently deleted files and compare with svn status "missing"
+   */
+  @debounce(1000)
+  private async actionForDeletedFiles() {
+    if (!this.deletedUris.length) {
+      return;
+    }
+
+    const allUris = this.deletedUris;
+    this.deletedUris = [];
+
+    const actionForDeletedFiles = configuration.get<string>(
+      "delete.actionForDeletedFiles",
+      "prompt"
+    );
+
+    if (actionForDeletedFiles === "none") {
+      return;
+    }
+
+    const resources = allUris
+      .map(uri => this.getResourceFromFile(uri))
+      .filter(
+        resource => resource && resource.type === Status.MISSING
+      ) as Resource[];
+
+    let uris = resources.map(resource => resource.resourceUri);
+
+    if (!uris.length) {
+      return;
+    }
+
+    const ignoredRulesForDeletedFiles = configuration.get<string[]>(
+      "delete.ignoredRulesForDeletedFiles",
+      []
+    );
+    const rules = ignoredRulesForDeletedFiles.map(
+      ignored => new Minimatch(ignored)
+    );
+
+    if (rules.length) {
+      uris = uris.filter(uri => {
+        // Check first for relative URL (Better for workspace configuration)
+        const relativePath = this.repository.removeAbsolutePath(uri.fsPath);
+
+        // If some match, remove from list
+        return !rules.some(
+          rule => rule.match(relativePath) || rule.match(uri.fsPath)
+        );
+      });
+    }
+
+    if (!uris.length) {
+      return;
+    }
+
+    if (actionForDeletedFiles === "remove") {
+      return await this.removeFiles(uris.map(uri => uri.fsPath), false);
+    } else if (actionForDeletedFiles === "prompt") {
+      return await commands.executeCommand("svn.promptRemove", ...uris);
+    }
+  }
+
   @debounce(1000)
   public async updateRemoteChangedFiles() {
     const updateFreq = configuration.get<number>(
@@ -727,7 +803,7 @@ export class Repository {
     );
   }
 
-  public async removeFiles(files: any[], keepLocal: boolean) {
+  public async removeFiles(files: string[], keepLocal: boolean) {
     return this.run(Operation.Remove, () =>
       this.repository.removeFiles(files, keepLocal)
     );

src/svnRepository.ts

@@ -432,7 +432,7 @@ export class Repository {
     return message;
   }
 
-  public async removeFiles(files: any[], keepLocal: boolean) {
+  public async removeFiles(files: string[], keepLocal: boolean) {
     files = files.map(file => this.removeAbsolutePath(file));
     const args = ["remove"];