fix(indentation): hover behavior when indentation not set

The previous behavior of hover replaces indentations with the &emsp; entity, because Markdown treats whitespace at the beginning of a line in a special way. However, when the indentation setting wasn't set, the regex that does that replace was set to empty ("") and so would include an &emsp; entity between every character. Signed-off-by: Kasama <robertoaall@gmail.com>
redhat-developer · Mar 27, 2023 · c7b8877 · c7b8877
1 parent 762209c
commit c7b8877
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 11 deletions.
diff --git a/src/languageservice/services/yamlHover.ts b/src/languageservice/services/yamlHover.ts
@@ -91,7 +91,7 @@ export class YAMLHover {
       const regex = new RegExp(this.indentation, 'g');
       const markupContent: MarkupContent = {
         kind: MarkupKind.Markdown,
-        value: contents.replace(regex, '&emsp;'),
+        value: this.indentation ? contents.replace(regex, '&emsp;') : contents,
       };
       const result: Hover = {
         contents: markupContent,

diff --git a/test/hover.test.ts b/test/hover.test.ts
@@ -20,13 +20,10 @@ describe('Hover Tests', () => {
   let telemetry: TestTelemetry;
 
   before(() => {
-    languageSettingsSetup = new ServiceSetup()
-      .withHover()
-      .withIndentation('  ')
-      .withSchemaFileMatch({
-        uri: 'http://google.com',
-        fileMatch: ['bad-schema.yaml'],
-      });
+    languageSettingsSetup = new ServiceSetup().withHover().withSchemaFileMatch({
+      uri: 'http://google.com',
+      fileMatch: ['bad-schema.yaml'],
+    });
     const {
       languageService: langService,
       languageHandler: langHandler,
@@ -65,7 +62,7 @@ describe('Hover Tests', () => {
     });
   }
 
-  describe('Hover', function () {
+  describe('Hover', function() {
     it('Hover on key on root', async () => {
       languageService.addSchema(SCHEMA_ID, {
         type: 'object',
@@ -513,7 +510,26 @@ users:
       );
     });
 
-    it('hover on value and its description has multiline, indentationa and special string', async () => {
+    it('hover on value and its description has multiline, indentation and special string', async () => {
+      (() => {
+        languageSettingsSetup = new ServiceSetup()
+          .withHover()
+          .withIndentation('  ')
+          .withSchemaFileMatch({
+            uri: 'http://google.com',
+            fileMatch: ['bad-schema.yaml'],
+          });
+        const {
+          languageService: langService,
+          languageHandler: langHandler,
+          yamlSettings: settings,
+          telemetry: testTelemetry,
+        } = setupLanguageService(languageSettingsSetup.languageSettings);
+        languageService = langService;
+        languageHandler = langHandler;
+        yamlSettings = settings;
+        telemetry = testTelemetry;
+      })();
       //https://github.com/redhat-developer/vscode-yaml/issues/886
       languageService.addSchema(SCHEMA_ID, {
         type: 'object',

diff --git a/test/integration.test.ts b/test/integration.test.ts
@@ -22,7 +22,6 @@ describe('Kubernetes Integration Tests', () => {
     const fileMatch = ['*.yml', '*.yaml'];
     languageSettingsSetup = new ServiceSetup()
       .withHover()
-      .withIndentation('  ')
       .withValidate()
       .withCompletion()
       .withSchemaFileMatch({