Allows editing of start/end tag simultaneously

Under the preference xml.autoSelectingMatchingTags Fixes #130 Signed-off-by: Nikolas Komonen <[email protected]>
redhat-developer · Dec 13, 2019 · 9f32fc1 · 9f32fc1
1 parent 29e8e52
commit 9f32fc1
Show file tree

Hide file tree

Showing 3 changed files with 348 additions and 10 deletions.
diff --git a/package.json b/package.json
@@ -192,6 +192,12 @@
           "description": "Enable/disable autoclosing of XML tags. \n\nIMPORTANT: Turn off editor.autoClosingTags for this to work",
           "scope": "window"
         },
+        "xml.mirrorCursorOnMatchingTag": {
+          "type": "boolean",
+          "scope": "resource",
+          "default": false,
+          "description": "Adds an additional cursor on the matching tag, allows for start/end tag editing."
+        },
         "xml.codeLens.enabled": {
           "type": "boolean",
           "default": false,
@@ -294,6 +300,14 @@
         "fileMatch": "package.json",
         "url": "./schemas/package.schema.json"
       }
+    ],
+    "keybindings":[
+      {
+        "command": "xml.toggleMatchingTagEdit",
+        "key": "ctrl+shift+f2",
+        "mac": "cmd+shift+f2",
+        "when": "editorFocus"
+      }
     ]
   }
 }
diff --git a/src/extension.ts b/src/extension.ts
@@ -13,24 +13,27 @@
 import { prepareExecutable } from './javaServerStarter';
 import { LanguageClientOptions, RevealOutputChannelOn, LanguageClient, DidChangeConfigurationNotification, RequestType, TextDocumentPositionParams, ReferencesRequest } from 'vscode-languageclient';
 import * as requirements from './requirements';
-import { languages, IndentAction, workspace, window, commands, ExtensionContext, TextDocument, Position, LanguageConfiguration, Uri, extensions } from "vscode";
+import { languages, ConfigurationTarget, IndentAction, workspace, window, commands, ExtensionContext, TextDocument, Position, LanguageConfiguration, Uri, WorkspaceConfiguration, extensions } from "vscode";
 import * as path from 'path';
 import * as os from 'os';
 import { activateTagClosing, AutoCloseResult } from './tagClosing';
 import { Commands } from './commands';
 import { onConfigurationChange, subscribeJDKChangeConfiguration } from './settings';
 import { collectXmlJavaExtensions, onExtensionChange } from './plugin';
+import { activateMirrorCursor } from './mirrorCursor';
 
 export interface ScopeInfo {
-  scope : "default" | "global" | "workspace" | "folder";
+  scope: "default" | "global" | "workspace" | "folder";
   configurationTarget: boolean;
 }
 
 namespace TagCloseRequest {
   export const type: RequestType<TextDocumentPositionParams, AutoCloseResult, any, any> = new RequestType('xml/closeTag');
 }
 
-
+namespace MatchingTagPositionRequest {
+  export const type: RequestType<TextDocumentPositionParams, Position | null, any, any> = new RequestType('xml/matchingTagPosition');
+}
 
 export function activate(context: ExtensionContext) {
   let storagePath = context.storagePath;
@@ -70,7 +73,7 @@ export function activate(context: ExtensionContext) {
             }
           }
         }
-      }, 
+      },
       synchronize: {
         //preferences starting with these will trigger didChangeConfiguration
         configurationSection: ['xml', '[xml]']
@@ -114,14 +117,38 @@ export function activate(context: ExtensionContext) {
         return text;
       };
 
+      disposable = activateTagClosing(tagProvider, { xml: true, xsl: true }, Commands.AUTO_CLOSE_TAGS);
+      toDispose.push(disposable);
+
+      //Setup mirrored tag rename request
+      const matchingTagPositionRequestor = (document: TextDocument, position: Position) => {
+        let param = languageClient.code2ProtocolConverter.asTextDocumentPositionParams(document, position);
+        return languageClient.sendRequest(MatchingTagPositionRequest.type, param);
+      };
+
+      disposable = activateMirrorCursor(context, matchingTagPositionRequestor, { xml: true }, 'xml.mirrorCursorOnMatchingTag');
+      toDispose.push(disposable);
+
+      const matchingTagEditCommand = 'xml.toggleMatchingTagEdit';
+
+      const matchingTagEditHandler = async () => {
+        let xmlConfiguration: WorkspaceConfiguration;
+        if (window.activeTextEditor) {
+          xmlConfiguration = workspace.getConfiguration('xml', window.activeTextEditor.document.uri);
+        } else {
+          xmlConfiguration = workspace.getConfiguration('xml');
+        }
+        const current = xmlConfiguration.mirrorCursorOnMatchingTag;
+        await updateConfig(xmlConfiguration, 'mirrorCursorOnMatchingTag', !current);
+      }
+
+      toDispose.push(commands.registerCommand(matchingTagEditCommand, matchingTagEditHandler));
+
       if (extensions.onDidChange) {// Theia doesn't support this API yet
         extensions.onDidChange(() => {
           onExtensionChange(extensions.all);
         });
       }
-
-      disposable = activateTagClosing(tagProvider, { xml: true, xsl: true }, Commands.AUTO_CLOSE_TAGS);
-      toDispose.push(disposable);
     });
     languages.setLanguageConfiguration('xml', getIndentationRules());
     languages.setLanguageConfiguration('xsl', getIndentationRules());
@@ -139,7 +166,7 @@ export function activate(context: ExtensionContext) {
     let configXML = workspace.getConfiguration().get('xml');
     let xml;
     if (!configXML) { //Set default preferences if not provided
-      const defaultValue = 
+      const defaultValue =
       {
         xml: {
           trace: {
@@ -160,7 +187,7 @@ export function activate(context: ExtensionContext) {
       xml = defaultValue;
     } else {
       let x = JSON.stringify(configXML); //configXML is not a JSON type
-      xml = { "xml" : JSON.parse(x)};
+      xml = { "xml": JSON.parse(x) };
     }
     xml['xml']['logs']['file'] = logfile;
     xml['xml']['useCache'] = true;
@@ -171,7 +198,7 @@ export function activate(context: ExtensionContext) {
 
 function getIndentationRules(): LanguageConfiguration {
   return {
-    
+
     // indentationRules referenced from:
     // https://github.com/microsoft/vscode/blob/d00558037359acceea329e718036c19625f91a1a/extensions/html-language-features/client/src/htmlMain.ts#L114-L115
     indentationRules: {
@@ -192,3 +219,24 @@ function getIndentationRules(): LanguageConfiguration {
   };
 }
 
+/**
+ * Update config with the following precedence: WorkspaceFolder -> Workspace -> Global
+ * @param config  config containing the section to update
+ * @param section section to update
+ * @param value   new value
+ */
+async function updateConfig(config: WorkspaceConfiguration, section: string, value: any): Promise<void> {
+  try {
+    await config.update(section, value);
+    return;
+  } catch(e) {
+    // try ConfigurationTarget.Global
+  }
+
+  try {
+    await config.update(section, value, ConfigurationTarget.Global);
+    return;
+  } catch(e) {
+    throw 'Failed to update config';
+  }
+}