Fix generateOptionsSchema to add Locked array entry (#6413)

In #6387, the generator was partially modified to support generating correct localization comments, but the generated output was missing the `Locked` entry. This updates it to match.

Author: gregg-miskelly

package.nls.json

@@ -243,7 +243,7 @@
     "message": "Array of symbol server URLs (example: http\u200b://MyExampleSymbolServer) or directories (example: /build/symbols) to search for .pdb files. These directories will be searched in addition to the default locations -- next to the module and the path where the pdb was originally dropped to.",
     "comment": [
       "We use '\u200b' (unicode zero-length space character) to break VS Code's URL detection regex for URLs that are examples. Please do not translate or localized the URL.",
-      "{Locked='(example: http\u200b://MyExampleSymbolServer)'}"
+      "{Locked='http\u200b://MyExampleSymbolServer'}"
     ]
   },
   "generateOptionsSchema.symbolOptions.searchMicrosoftSymbolServer.description": {
@@ -307,4 +307,4 @@
       "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
     ]
   }
-}
+}

src/tools/generateOptionsSchema.ts

@@ -159,9 +159,31 @@ function generateCommentArrayForDescription(description: string): string[] {
 
     // If the description contains '\u200b', it is used to prevent vscode from rendering a URL.
     if (description.includes('\u200b')) {
+        const urlRegEx = new RegExp('https?\\u200b:[\\w/\\.\u200b]+', 'g');
+        let result = urlRegEx.exec(description);
+        if (!result) {
+            throw `Found zero-with unicode space outside of expected URL in '${description}'`;
+        }
+
         comments.push(
             "We use '\u200b' (unicode zero-length space character) to break VS Code's URL detection regex for URLs that are examples. Please do not translate or localized the URL."
         );
+        while (result !== null) {
+            let foundText = result[0];
+
+            // check if the match is surrounded by `()`, and if so, include them
+            if (
+                result.index > 0 &&
+                result.index + foundText.length < description.length &&
+                description[result.index - 1] === '(' &&
+                description[result.index + foundText.length] === ')'
+            ) {
+                foundText = `(${foundText})`;
+            }
+
+            comments.push(`{Locked='${foundText}'}`);
+            result = urlRegEx.exec(description);
+        }
     }
 
     return comments;