fix: adjust documentation display (#126)

* adjust documentation display * test fix
0no-co · Dec 21, 2023 · 01ade44 · 01ade44
1 parent a2180af
commit 01ade44
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 18 deletions.
diff --git a/.changeset/bright-news-agree.md b/.changeset/bright-news-agree.md
@@ -0,0 +1,5 @@
+---
+'@0no-co/graphqlsp': patch
+---
+
+Adjust documentation display
diff --git a/packages/example/src/Pokemon.ts b/packages/example/src/Pokemon.ts
@@ -1,5 +1,5 @@
 import { TypedDocumentNode } from '@graphql-typed-document-node/core';
-import { gql } from '@urql/core';
+import { createClient, gql } from '@urql/core';
 
 export const PokemonFields = gql`
   fragment pokemonFields on Pokemon {

diff --git a/packages/example/src/index.ts b/packages/example/src/index.ts
@@ -15,5 +15,5 @@ client
   .query(PokemonQuery, { id: '' })
   .toPromise()
   .then(result => {
-    result.data?.pokemon;
+    result.data?.pokemons;
   });
diff --git a/packages/graphqlsp/src/quickInfo.ts b/packages/graphqlsp/src/quickInfo.ts
@@ -11,13 +11,16 @@ import {
 import { resolveTemplate } from './ast/resolve';
 import { getToken } from './ast/token';
 import { Cursor } from './ast/cursor';
+import { Logger } from '.';
 
 export function getGraphQLQuickInfo(
   filename: string,
   cursorPosition: number,
   schema: { current: GraphQLSchema | null },
   info: ts.server.PluginCreateInfo
 ): ts.QuickInfo | undefined {
+  const logger: Logger = (msg: string) =>
+    info.project.projectService.logger.info(`[GraphQLSP] ${msg}`);
   const tagTemplate = info.config.template || 'gql';
   const isCallExpression = info.config.templateIsCallExpression ?? false;
 
@@ -51,10 +54,10 @@ export function getGraphQLQuickInfo(
         start: cursorPosition,
         length: 1,
       },
-      kindModifiers: '',
-      displayParts: Array.isArray(hoverInfo)
-        ? hoverInfo.map(item => ({ kind: '', text: item as string }))
-        : [{ kind: '', text: hoverInfo as string }],
+      kindModifiers: 'text',
+      documentation: Array.isArray(hoverInfo)
+        ? hoverInfo.map(item => ({ kind: 'text', text: item as string }))
+        : [{ kind: 'text', text: hoverInfo as string }],
     };
   } else if (ts.isTaggedTemplateExpression(node)) {
     const { template, tag } = node;
@@ -87,16 +90,16 @@ export function getGraphQLQuickInfo(
     );
 
     return {
-      kind: ts.ScriptElementKind.string,
+      kind: ts.ScriptElementKind.label,
       textSpan: {
         start: cursorPosition,
         length: 1,
       },
-      kindModifiers: '',
-      displayParts: Array.isArray(hoverInfo)
-        ? hoverInfo.map(item => ({ kind: '', text: item as string }))
-        : [{ kind: '', text: hoverInfo as string }],
-    };
+      kindModifiers: 'text',
+      documentation: Array.isArray(hoverInfo)
+        ? hoverInfo.map(item => ({ kind: 'text', text: item as string }))
+        : [{ kind: 'text', text: hoverInfo as string }],
+    } as ts.QuickInfo;
   } else {
     return undefined;
   }

diff --git a/test/e2e/client-preset.test.ts b/test/e2e/client-preset.test.ts
@@ -148,7 +148,7 @@ describe('Fragment + operations', () => {
 
     expect(res).toBeDefined();
     expect(typeof res?.body).toEqual('object');
-    expect(res?.body.displayString).toEqual(`Pokemon.name: String!`);
+    expect(res?.body.documentation).toEqual(`Pokemon.name: String!`);
   }, 30000);
 
   it('gives quick-info with documents', async () => {
@@ -174,7 +174,7 @@ describe('Fragment + operations', () => {
 
     expect(res).toBeDefined();
     expect(typeof res?.body).toEqual('object');
-    expect(res?.body.displayString).toEqual(
+    expect(res?.body.documentation).toEqual(
       `Query.pokemons: [Pokemon]
 
 List out all Pokémon, optionally in pages`

diff --git a/test/e2e/combinations.test.ts b/test/e2e/combinations.test.ts
@@ -120,7 +120,7 @@ describe('Fragment + operations', () => {
 
     expect(res).toBeDefined();
     expect(typeof res?.body).toEqual('object');
-    expect(res?.body.displayString).toEqual(
+    expect(res?.body.documentation).toEqual(
       `Query.posts: [Post]\n\nList out all posts`
     );
   }, 30000);

diff --git a/test/e2e/graphqlsp.test.ts b/test/e2e/graphqlsp.test.ts
@@ -131,8 +131,8 @@ describe('simple', () => {
       .find(resp => resp.type === 'response' && resp.command === 'quickinfo');
     expect(res).toBeDefined();
     expect(typeof res?.body).toEqual('object');
-    expect(res?.body.displayString).toEqual(`Query.posts: [Post]
-
-List out all posts`);
+    expect(res?.body.documentation).toEqual(
+      `Query.posts: [Post]\n\nList out all posts`
+    );
   }, 7500);
 });