commit 01ade44c5a857a8e149830d015c537efe2d8607f · kitten.sh/graphqlsp

+5

.changeset/bright-news-agree.md

···

       1
       1
       +
       ---

     

       2
       2
       +
       '@0no-co/graphqlsp': patch

     

       3
       3
       +
       ---

     

       4
       4
       +
       

     

       5
       5
       +
       Adjust documentation display

+1 -1

packages/example/src/Pokemon.ts

···

       1
       1
        
       import { TypedDocumentNode } from '@graphql-typed-document-node/core';

     

       2
       2
       -
       import { gql } from '@urql/core';

     

       2
       2
       +
       import { createClient, gql } from '@urql/core';

     

       3
       3
        
       

     

       4
       4
        
       export const PokemonFields = gql`

     

       5
       5
        
         fragment pokemonFields on Pokemon {

+1 -1

packages/example/src/index.ts

···

       15
       15
        
         .query(PokemonQuery, { id: '' })

     

       16
       16
        
         .toPromise()

     

       17
       17
        
         .then(result => {

     

       18
       18
       -
           result.data?.pokemon;

     

       18
       18
       +
           result.data?.pokemons;

     

       19
       19
        
         });

+13 -10

packages/graphqlsp/src/quickInfo.ts

···

       11
       11
        
       import { resolveTemplate } from './ast/resolve';

     

       12
       12
        
       import { getToken } from './ast/token';

     

       13
       13
        
       import { Cursor } from './ast/cursor';

     

       14
       14
       +
       import { Logger } from '.';

     

       14
       15
        
       

     

       15
       16
        
       export function getGraphQLQuickInfo(

     

       16
       17
        
         filename: string,

     
···

       18
       19
        
         schema: { current: GraphQLSchema | null },

     

       19
       20
        
         info: ts.server.PluginCreateInfo

     

       20
       21
        
       ): ts.QuickInfo | undefined {

     

       22
       22
       +
         const logger: Logger = (msg: string) =>

     

       23
       23
       +
           info.project.projectService.logger.info(`[GraphQLSP] ${msg}`);

     

       21
       24
        
         const tagTemplate = info.config.template || 'gql';

     

       22
       25
        
         const isCallExpression = info.config.templateIsCallExpression ?? false;

     

       23
       26
        
       

     
···

       51
       54
        
               start: cursorPosition,

     

       52
       55
        
               length: 1,

     

       53
       56
        
             },

     

       54
       54
       -
             kindModifiers: '',

     

       55
       55
       -
             displayParts: Array.isArray(hoverInfo)

     

       56
       56
       -
               ? hoverInfo.map(item => ({ kind: '', text: item as string }))

     

       57
       57
       -
               : [{ kind: '', text: hoverInfo as string }],

     

       57
       57
       +
             kindModifiers: 'text',

     

       58
       58
       +
             documentation: Array.isArray(hoverInfo)

     

       59
       59
       +
               ? hoverInfo.map(item => ({ kind: 'text', text: item as string }))

     

       60
       60
       +
               : [{ kind: 'text', text: hoverInfo as string }],

     

       58
       61
        
           };

     

       59
       62
        
         } else if (ts.isTaggedTemplateExpression(node)) {

     

       60
       63
        
           const { template, tag } = node;

     
···

       87
       90
        
           );

     

       88
       91
        
       

     

       89
       92
        
           return {

     

       90
       90
       -
             kind: ts.ScriptElementKind.string,

     

       93
       93
       +
             kind: ts.ScriptElementKind.label,

     

       91
       94
        
             textSpan: {

     

       92
       95
        
               start: cursorPosition,

     

       93
       96
        
               length: 1,

     

       94
       97
        
             },

     

       95
       95
       -
             kindModifiers: '',

     

       96
       96
       -
             displayParts: Array.isArray(hoverInfo)

     

       97
       97
       -
               ? hoverInfo.map(item => ({ kind: '', text: item as string }))

     

       98
       98
       -
               : [{ kind: '', text: hoverInfo as string }],

     

       99
       99
       -
           };

     

       98
       98
       +
             kindModifiers: 'text',

     

       99
       99
       +
             documentation: Array.isArray(hoverInfo)

     

       100
       100
       +
               ? hoverInfo.map(item => ({ kind: 'text', text: item as string }))

     

       101
       101
       +
               : [{ kind: 'text', text: hoverInfo as string }],

     

       102
       102
       +
           } as ts.QuickInfo;

     

       100
       103
        
         } else {

     

       101
       104
        
           return undefined;

     

       102
       105
        
         }

+2 -2

test/e2e/client-preset.test.ts

···

       148
       148
        
       

     

       149
       149
        
           expect(res).toBeDefined();

     

       150
       150
        
           expect(typeof res?.body).toEqual('object');

     

       151
       151
       -
           expect(res?.body.displayString).toEqual(`Pokemon.name: String!`);

     

       151
       151
       +
           expect(res?.body.documentation).toEqual(`Pokemon.name: String!`);

     

       152
       152
        
         }, 30000);

     

       153
       153
        
       

     

       154
       154
        
         it('gives quick-info with documents', async () => {

     
···

       174
       174
        
       

     

       175
       175
        
           expect(res).toBeDefined();

     

       176
       176
        
           expect(typeof res?.body).toEqual('object');

     

       177
       177
       -
           expect(res?.body.displayString).toEqual(

     

       177
       177
       +
           expect(res?.body.documentation).toEqual(

     

       178
       178
        
             `Query.pokemons: [Pokemon]

     

       179
       179
        
       

     

       180
       180
        
       List out all Pokémon, optionally in pages`

+1 -1

test/e2e/combinations.test.ts

···

       120
       120
        
       

     

       121
       121
        
           expect(res).toBeDefined();

     

       122
       122
        
           expect(typeof res?.body).toEqual('object');

     

       123
       123
       -
           expect(res?.body.displayString).toEqual(

     

       123
       123
       +
           expect(res?.body.documentation).toEqual(

     

       124
       124
        
             `Query.posts: [Post]\n\nList out all posts`

     

       125
       125
        
           );

     

       126
       126
        
         }, 30000);

+3 -3

test/e2e/graphqlsp.test.ts

···

       131
       131
        
             .find(resp => resp.type === 'response' && resp.command === 'quickinfo');

     

       132
       132
        
           expect(res).toBeDefined();

     

       133
       133
        
           expect(typeof res?.body).toEqual('object');

     

       134
       134
       -
           expect(res?.body.displayString).toEqual(`Query.posts: [Post]

     

       135
       135
       -
       

     

       136
       136
       -
       List out all posts`);

     

       134
       134
       +
           expect(res?.body.documentation).toEqual(

     

       135
       135
       +
             `Query.posts: [Post]\n\nList out all posts`

     

       136
       136
       +
           );

     

       137
       137
        
         }, 7500);

     

       138
       138
        
       });