# This is a combination of 2 commits.

Add codelens and command to register/unregister catalog

Signed-off-by: Jessica He <jhe@redhat.com>

Author: JessicaJHee

README.md

@@ -40,7 +40,7 @@ This VS Code extension provides support for creating and editing XML documents,
   * XSD based code completion
   * XSL support
   * [XInclude support](https://github.com/redhat-developer/vscode-xml/blob/main/docs/Features/XIncludeFeatures.md#Validation)
-  * [XML catalogs](https://github.com/redhat-developer/vscode-xml/blob/main/docs/Validation.md#xml-catalog-with-xsd)
+  * [XML catalogs](https://github.com/redhat-developer/vscode-xml/blob/main/docs/Features/XMLCatalogFeatures.md#xml-catalog-features)
   * File associations
   * Code actions
   * Schema Caching

docs/Features.md

@@ -7,3 +7,4 @@
 - [DTD features](Features/DTDFeatures.md#dtd-features)
 - [RelaxNG features](Features/RelaxNGFeatures.md#relaxng-features)
 - [XInclude features](Features/XIncludeFeatures.md#xinclude-features)
+- [XML Catalog features](Features/XMLCatalogFeatures.md#xml-catalog-features)

docs/Features/XMLCatalogFeatures.md

@@ -0,0 +1,12 @@
+# XML Catalog Features
+
+## Validation
+
+XML Catalog is supported with both DTD and XSD. Please see here for more information on the usage of [XML Catalog With DTD](../Validation.md#xml-catalog-with-dtd) and [XML Catalog With XSD](../Validation.md#xml-catalog-with-xsd).
+
+## Code Lens
+
+CodeLens is supported for XML catalogs, which shows whether the catalog is registered or not.
+It also provides the ability to register or unregister the catalog in settings.json.
+
+![CodeLens Catalog Registration](../images/Features/CodeLensCatalogRegistration.gif)

docs/images/Features/CodeLensCatalogRegistration.gif

@@ -0,0 +1,9 @@
+/**
+ * LSP Command Constants.
+ */
+
+ /**
+ * Command to register/unregister catalog.
+ */
+ export const UPDATE_CONFIGURATION = 'xml.update.configuration'
+ 

src/commands/lspCommandConstants.ts

@@ -3,6 +3,7 @@ import * as vscode from 'vscode';
 import { commands, ConfigurationTarget, env, ExtensionContext, OpenDialogOptions, Position, QuickPickItem, SnippetString, TextDocument, Uri, window, workspace, WorkspaceEdit, Selection } from "vscode";
 import { CancellationToken, ExecuteCommandParams, ExecuteCommandRequest, ReferencesRequest, TextDocumentEdit, TextDocumentIdentifier, TextEdit } from "vscode-languageclient";
 import { LanguageClient } from 'vscode-languageclient/node';
+import { registerConfigurationUpdateCommand } from '../lsp-commands';
 import { markdownPreviewProvider } from "../markdownPreviewProvider";
 import { DEBUG } from '../server/java/javaServerStarter';
 import { getDirectoryPath, getFileName, getRelativePath, getWorkspaceUri } from '../utils/fileUtils';
@@ -33,6 +34,7 @@ export async function registerClientServerCommands(context: ExtensionContext, la
   registerRefactorCommands(context, languageClient);
   registerAssociationCommands(context, languageClient);
   registerRestartLanguageServerCommand(context, languageClient);
+  registerConfigurationUpdateCommand();
 
   // Register client command to execute custom XML Language Server command
   context.subscriptions.push(commands.registerCommand(ClientCommandConstants.EXECUTE_WORKSPACE_COMMAND, (command, ...rest) => {

src/commands/registerCommands.ts

@@ -0,0 +1,80 @@
+/**
+ * Copyright 2022 Red Hat, Inc. and others.
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+
+ *     http://www.apache.org/licenses/LICENSE-2.0
+
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { commands, ConfigurationTarget, Disposable, workspace, window } from 'vscode';
+import { getDirectoryPath, getRelativePath, getWorkspaceUri } from './utils/fileUtils';
+import * as CommandKind from './commands/lspCommandConstants';
+
+/**
+ * Registers the `CommandKind.UPDATE_CONFIGURATION` command
+ */
+export function registerConfigurationUpdateCommand(): Disposable {
+  return commands.registerCommand(CommandKind.UPDATE_CONFIGURATION, resolveConfigurationItemEdit);
+}
+
+function resolveConfigurationItemEdit<T>(configurationItemEdit: ConfigurationItemEdit) {
+  if (configurationItemEdit.valueKind == ConfigurationItemValueKind.file) {
+    configurationItemEdit.value = resolveFilePath(configurationItemEdit.value);
+  }
+  switch (configurationItemEdit.editType) {
+    case ConfigurationItemEditType.Add:
+      addToPreferenceArray<T>(configurationItemEdit.section, configurationItemEdit.value);
+      break;
+    case ConfigurationItemEditType.Delete: {
+      removeFromPreferenceArray<T>(configurationItemEdit.section, configurationItemEdit.value);
+    }
+  }
+}
+
+function resolveFilePath(filePath: any): any {
+  const currentWorkspaceUri = getWorkspaceUri(window.activeTextEditor.document).toString();
+  return getDirectoryPath(filePath).includes(currentWorkspaceUri) ? getRelativePath(currentWorkspaceUri, filePath) : filePath;
+
+}
+
+function addToPreferenceArray<T>(key: string, value: T): void {
+  const configArray: T[] = workspace.getConfiguration().get<T[]>(key, []);
+  if (configArray.includes(value)) {
+    return;
+  }
+  configArray.push(value);
+  workspace.getConfiguration().update(key, configArray, ConfigurationTarget.Workspace);
+}
+
+function removeFromPreferenceArray<T>(key: string, value: T): void {
+  const configArray: T[] = workspace.getConfiguration().get<T[]>(key, []);
+  if (!configArray.includes(value)) {
+    return;
+  }
+  const resultPref = configArray.filter(i => i != value);
+  workspace.getConfiguration().update(key, resultPref, ConfigurationTarget.Workspace);
+}
+
+interface ConfigurationItemEdit {
+  section: string;
+  value: any;
+  editType: ConfigurationItemEditType;
+  valueKind: ConfigurationItemValueKind;
+}
+
+enum ConfigurationItemEditType {
+  Add = 0,
+  Delete = 1
+}
+
+enum ConfigurationItemValueKind {
+  file = 0
+}