feat(apidom-ls): expand provided symbols

Author: frantuma

packages/apidom-ls/src/services/symbols/symbols-service.ts

@@ -4,7 +4,7 @@ import { Range, SymbolInformation } from 'vscode-languageserver-protocol';
 import { ArraySlice, Element, filter, MemberElement } from '@swagger-api/apidom-core';
 import { SymbolKind } from 'vscode-languageserver-types';
 
-import { getSourceMap, isMember, SourceMap } from '../../utils/utils';
+import { buildPath, getSourceMap, isMember, SourceMap } from '../../utils/utils';
 import { LanguageSettings, SymbolsContext } from '../../apidom-language-types';
 
 export interface SymbolsService {
@@ -54,6 +54,14 @@ export class DefaultSymbolsService implements SymbolsService {
       'components-parameters',
       'paths',
       'channels',
+      'channelItem',
+      'schema',
+      'server',
+      'servers',
+      'channel-binding',
+      'contact',
+      'identifier',
+      'message',
       'servers',
       'components-messages',
     ];
@@ -105,7 +113,10 @@ export class DefaultSymbolsService implements SymbolsService {
             si.containerName = key.toValue() as string;
             symbols.push(si);
           } else {
-            symbols.push(SymbolInformation.create(s, SymbolKind.Property, r));
+            const si: SymbolInformation = SymbolInformation.create(s, SymbolKind.Property, r);
+            const path = buildPath(e);
+            si.containerName = path;
+            symbols.push(si);
           }
         }
       });

packages/apidom-ls/src/utils/utils.ts

@@ -328,6 +328,38 @@ export function processPath(element: Element, path: string, api: Element): Eleme
   return targetEl;
 }
 
+export function buildPath(element: Element): string {
+  try {
+    const path: string[] = [];
+    if (!element.parent) return '';
+    let targetEl = element;
+    while (isArray(targetEl.parent)) {
+      path.unshift('[]');
+      targetEl = targetEl.parent;
+    }
+
+    if (targetEl.parent && isMember(targetEl.parent)) {
+      // @ts-ignore
+      path.unshift(targetEl.parent.key.toValue() as string);
+    }
+
+    while (targetEl.parent?.parent) {
+      targetEl = targetEl.parent.parent;
+      while (isArray(targetEl.parent)) {
+        path.unshift('[]');
+        targetEl = targetEl.parent;
+      }
+      if (targetEl.parent && isMember(targetEl.parent)) {
+        // @ts-ignore
+        path.unshift(targetEl.parent.key.toValue() as string);
+      }
+    }
+    return `/${path.join('/')}`;
+  } catch (e) {
+    return '';
+  }
+}
+
 export function getCurrentWord(document: TextDocument | string, offset: number) {
   let i = offset - 1;
   const text = typeof document === 'string' ? document : document.getText();

packages/apidom-ls/test/asyncapi-json.ts

@@ -109,7 +109,7 @@ const completionTestInput = [
         },
         {
           label: 'servers',
-          insertText: '"servers": [\n  $1\n],',
+          insertText: '"servers": {\n  $1\n},',
           kind: 14,
           insertTextFormat: 2,
           documentation: {
@@ -207,7 +207,7 @@ const completionTestInput = [
         },
         {
           label: 'servers',
-          insertText: '"servers": [\n  $1\n],\n',
+          insertText: '"servers": {\n  $1\n},\n',
           kind: 14,
           insertTextFormat: 2,
           documentation: {
@@ -305,7 +305,7 @@ const completionTestInput = [
         },
         {
           label: 'servers',
-          insertText: '"servers": [\n  $1\n],\n',
+          insertText: '"servers": {\n  $1\n},\n',
           kind: 14,
           insertTextFormat: 2,
           documentation: {

packages/apidom-ls/test/asyncapi-yaml.ts

@@ -149,7 +149,7 @@ const completionTestInput = [
         },
         {
           label: 'servers',
-          insertText: 'servers: \n  - $1\n',
+          insertText: 'servers: \n  $1\n',
           kind: 14,
           insertTextFormat: 2,
           documentation: {
@@ -236,7 +236,7 @@ const completionTestInput = [
         },
         {
           label: 'servers',
-          insertText: 'servers: \n  - $1\n',
+          insertText: 'servers: \n  $1\n',
           kind: 14,
           insertTextFormat: 2,
           documentation: {

packages/apidom-ls/test/complete.ts

@@ -203,7 +203,7 @@ describe('apidom-ls-complete', function () {
           },
           {
             label: 'servers',
-            insertText: 'servers: \n  - $1',
+            insertText: 'servers: \n  $1',
             kind: 14,
             insertTextFormat: 2,
             documentation: {

packages/apidom-ls/test/fixtures/async-schema-prop-last.yaml

@@ -0,0 +1,13 @@
+asyncapi: '2.2.0'
+components:
+  schemas:
+    foo:
+
+    bad:
+      type: object
+      properties:
+        car:
+          
+    bar:
+      type: string
+      

packages/apidom-ls/test/openapi-yaml-parse.ts

@@ -98,14 +98,13 @@ describe('apidom-parse-test', function () {
         console.log(
           node.element,
           node.getMetaProperty('classes', []).toValue(),
-          node.getMetaProperty('httpMethod', []).toValue(),
           `[${sm.offset} / ${sm.line}:${sm.column} - ${sm.endLine}:${sm.endColumn}]`,
           node.toValue(),
         );
       }
 
       // traverse(printSourceMap, api);
-      traverse(printSourceMap, api);
+      traverse(printContent, api);
 
       if (result.annotations) {
         for (const annotation of result.annotations) {