Fix hover markdown escaping so links are usable (#1159)

* fix hover markdown escaping so links are usable

Signed-off-by: Morgan Chang <[email protected]>

* fix tests

Signed-off-by: Morgan Chang <[email protected]>

---------

Signed-off-by: Morgan Chang <[email protected]>

Author: shin19991207

src/languageservice/services/yamlHover.ts

@@ -211,7 +211,7 @@ export class YAMLHover {
   private toMarkdown(plain: string | undefined): string | undefined {
     if (plain) {
       let escaped = plain.replace(/([^\n\r])(\r?\n)([^\n\r])/gm, '$1\n\n$3'); // single new lines to \n\n (Markdown paragraph)
-      escaped = escaped.replace(/[\\`*_{}[\]()#+\-.!]/g, '\\$&'); // escape markdown syntax tokens: http://daringfireball.net/projects/markdown/syntax#backslash
+      escaped = escaped.replace(/[\\`*_{}[\]#+\-!]/g, '\\$&'); // escape some of the markdown syntax tokens http://daringfireball.net/projects/markdown/syntax#backslash to avoid unintended formatting
       if (this.indentation !== undefined) {
         // escape indentation whitespace to prevent it from being converted to markdown code blocks.
         const indentationMatchRegex = new RegExp(` {${this.indentation.length}}`, 'g');

test/hover.test.ts

@@ -86,7 +86,7 @@ describe('Hover Tests', () => {
       assert.strictEqual((hover.contents as MarkupContent).kind, 'markdown');
       assert.strictEqual(
         (hover.contents as MarkupContent).value,
-        `The directory from which bower should run\\. All relative paths will be calculated according to this setting\\.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `The directory from which bower should run. All relative paths will be calculated according to this setting.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
     });
 
@@ -108,7 +108,7 @@ describe('Hover Tests', () => {
       assert.strictEqual((result.contents as MarkupContent).kind, 'markdown');
       assert.strictEqual(
         (result.contents as MarkupContent).value,
-        `The directory from which bower should run\\. All relative paths will be calculated according to this setting\\.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `The directory from which bower should run. All relative paths will be calculated according to this setting.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
     });
 
@@ -303,7 +303,7 @@ describe('Hover Tests', () => {
       assert.strictEqual(MarkupContent.is(result.contents), true);
       assert.strictEqual(
         (result.contents as MarkupContent).value,
-        `Full name of the author\\.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `Full name of the author.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
     });
 
@@ -335,7 +335,7 @@ describe('Hover Tests', () => {
       assert.strictEqual(MarkupContent.is(result.contents), true);
       assert.strictEqual(
         (result.contents as MarkupContent).value,
-        `Email address of the author\\.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `Email address of the author.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
     });
 
@@ -425,7 +425,7 @@ storage:
       assert.strictEqual(MarkupContent.is(result.contents), true);
       assert.strictEqual(
         (result.contents as MarkupContent).value,
-        `#### no\\_proxy \\(list of strings\\):\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `#### no\\_proxy (list of strings):\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
 
       const content2 = `ignition:
@@ -444,7 +444,7 @@ storage:
       assert.strictEqual(MarkupContent.is(result.contents), true);
       assert.strictEqual(
         (result.contents as MarkupContent).value,
-        `#### devices \\(list of strings\\):\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `#### devices (list of strings):\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
     });
 
@@ -552,7 +552,7 @@ users:
       assert.strictEqual(MarkupContent.is(result.contents), true);
       assert.strictEqual(
         (result.contents as MarkupContent).value,
-        `#### Person\n\nAt the top level my\\_var is shown properly\\.\n\n  Issue with my\\_var2\n\n   here my\\_var3\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+        `#### Person\n\nAt the top level my\\_var is shown properly.\n\n  Issue with my\\_var2\n\n   here my\\_var3\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
       );
     });
 
@@ -860,6 +860,91 @@ Source: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
 
       expect(result).to.be.null;
     });
+    it('Hover preserves literal parentheses', async () => {
+      schemaProvider.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          parentheses: {
+            type: 'string',
+            description: 'Parentheses should be literal: (abc)(1).',
+          },
+        },
+      });
+
+      const content = 'parenth|e|ses: x';
+      const hover = await parseSetup(content);
+
+      assert.strictEqual(MarkupContent.is(hover.contents), true);
+      assert.strictEqual((hover.contents as MarkupContent).kind, 'markdown');
+      assert.strictEqual(
+        (hover.contents as MarkupContent).value,
+        `Parentheses should be literal: (abc)(1).\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+      );
+    });
+    it('Hover preserves literal dots', async () => {
+      schemaProvider.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          dotInText: {
+            type: 'string',
+            description: 'Dots should be literal in normal text: v1.2.3, 3.14159, example.com.',
+          },
+        },
+      });
+
+      const content = 'dot|I|nText: x';
+      const hover = await parseSetup(content);
+
+      assert.strictEqual(MarkupContent.is(hover.contents), true);
+      assert.strictEqual((hover.contents as MarkupContent).kind, 'markdown');
+      assert.strictEqual(
+        (hover.contents as MarkupContent).value,
+        `Dots should be literal in normal text: v1.2.3, 3.14159, example.com.\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+      );
+    });
+    it('Hover preserves bare URL in description (no escaping)', async () => {
+      schemaProvider.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          repo: {
+            type: 'string',
+            description: 'The YAML Language Server at https://github.com/redhat-developer/yaml-language-server',
+          },
+        },
+      });
+
+      const content = 'rep|o|: x';
+      const hover = await parseSetup(content);
+
+      assert.strictEqual(MarkupContent.is(hover.contents), true);
+      assert.strictEqual((hover.contents as MarkupContent).kind, 'markdown');
+      assert.strictEqual(
+        (hover.contents as MarkupContent).value,
+        `The YAML Language Server at https://github.com/redhat\\-developer/yaml\\-language\\-server\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+      );
+    });
+
+    it('Hover preserves URL wrapped in parentheses in description (no escaping)', async () => {
+      schemaProvider.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          repo: {
+            type: 'string',
+            description: 'Yaml Language Server (https://github.com/redhat-developer/yaml-language-server)',
+          },
+        },
+      });
+
+      const content = 'rep|o|: x';
+      const hover = await parseSetup(content);
+
+      assert.strictEqual(MarkupContent.is(hover.contents), true);
+      assert.strictEqual((hover.contents as MarkupContent).kind, 'markdown');
+      assert.strictEqual(
+        (hover.contents as MarkupContent).value,
+        `Yaml Language Server (https://github.com/redhat\\-developer/yaml\\-language\\-server)\n\nSource: [${SCHEMA_ID}](file:///${SCHEMA_ID})`
+      );
+    });
   });
 
   describe('Hover on anyOf', () => {

test/yamlLanguageService.test.ts

@@ -79,7 +79,7 @@ describe('getLanguageService()', () => {
       assert.deepEqual(result, {
         contents: {
           kind: 'markdown',
-          value: "The person's first name\\.\n\nSource: [my.schema.uri](my.schema.uri)",
+          value: "The person's first name.\n\nSource: [my.schema.uri](my.schema.uri)",
         },
         range: {
           start: {