commit e2faba4b25a10a40c9f4c7d46bffed686a4b1e9e · kitten.sh/graphqlsp

.changeset/grumpy-toes-serve.md

···

       1
       1
       +
       ---

     

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

     

       3
       3
       +
       ---

     

       4
       4
       +
       

     

       5
       5
       +
       Display some documentation alongside fields and fragments, for fields it will show the documentation or the type and for fragmentSpreads the typeCondition will be displayed

+31 -13

src/index.ts

···

       8
       8
        
         isTemplateExpression,

     

       9
       9
        
         isImportTypeNode,

     

       10
       10
        
         ImportTypeNode,

     

       11
       11
       +
         CompletionEntry,

     

       11
       12
        
       } from 'typescript';

     

       12
       13
        
       import {

     

       13
       14
        
         getHoverInformation,

     
···

       305
       306
        
       

     

       306
       307
        
             if (!foundToken || !schema.current) return originalCompletions;

     

       307
       308
        
       

     

       308
       308
       -
             const suggestions = getAutocompleteSuggestions(

     

       309
       309
       -
               schema.current,

     

       310
       310
       -
               text,

     

       311
       311
       -
               new Cursor(foundToken.line, foundToken.start)

     

       312
       312
       -
             );

     

       313
       313
       -
       

     

       314
       309
        
             let fragments: Array<FragmentDefinitionNode> = [];

     

       315
       310
        
             try {

     

       316
       311
        
               const parsed = parse(text);

     
···

       319
       314
        
               ) as Array<FragmentDefinitionNode>;

     

       320
       315
        
             } catch (e) {}

     

       321
       316
        
       

     

       317
       317
       +
             const suggestions = getAutocompleteSuggestions(

     

       318
       318
       +
               schema.current,

     

       319
       319
       +
               text,

     

       320
       320
       +
               new Cursor(foundToken.line, foundToken.start),

     

       321
       321
       +
               undefined,

     

       322
       322
       +
               fragments

     

       323
       323
       +
             );

     

       324
       324
       +
       

     

       322
       325
        
             const result: ts.WithMetadata<ts.CompletionInfo> = {

     

       323
       326
        
               isGlobalCompletion: false,

     

       324
       327
        
               isMemberCompletion: false,

     

       325
       328
        
               isNewIdentifierLocation: false,

     

       326
       326
       -
               // TODO: check whether we can add descriptions to the entries

     

       327
       329
        
               entries: [

     

       328
       328
       -
                 ...suggestions.map(suggestion => ({

     

       329
       329
       -
                   kind: ScriptElementKind.variableElement,

     

       330
       330
       -
                   name: suggestion.label,

     

       331
       331
       -
                   kindModifiers: 'declare',

     

       332
       332
       -
                   sortText: suggestion.sortText || '0',

     

       333
       333
       -
                 })),

     

       330
       330
       +
                 ...suggestions.map(

     

       331
       331
       +
                   suggestion =>

     

       332
       332
       +
                     ({

     

       333
       333
       +
                       kind: ScriptElementKind.variableElement,

     

       334
       334
       +
                       name: suggestion.label,

     

       335
       335
       +
                       kindModifiers: 'declare',

     

       336
       336
       +
                       sortText: suggestion.sortText || '0',

     

       337
       337
       +
                       labelDetails: {

     

       338
       338
       +
                         detail:

     

       339
       339
       +
                           ' ' + suggestion.documentation ||

     

       340
       340
       +
                           suggestion.labelDetails?.detail ||

     

       341
       341
       +
                           suggestion.type,

     

       342
       342
       +
                         description:

     

       343
       343
       +
                           ' ' + suggestion.labelDetails?.description ||

     

       344
       344
       +
                           suggestion.documentation,

     

       345
       345
       +
                       },

     

       346
       346
       +
                     } as CompletionEntry)

     

       347
       347
       +
                 ),

     

       334
       348
        
                 ...fragments.map(fragment => ({

     

       335
       349
        
                   kind: ScriptElementKind.variableElement,

     

       336
       350
        
                   name: fragment.name.value,

     

       337
       351
        
                   insertText: '...' + fragment.name.value,

     

       338
       352
        
                   kindModifiers: 'declare',

     

       339
       353
        
                   sortText: '0',

     

       354
       354
       +
                   labelDetails: {

     

       355
       355
       +
                     detail: ' on type ' + fragment.typeCondition.name.value,

     

       356
       356
       +
                     description: ' on type ' + fragment.typeCondition.name.value,

     

       357
       357
       +
                   },

     

       340
       358
        
                 })),

     

       341
       359
        
                 ...originalCompletions.entries,

     

       342
       360
        
               ],