commit 7bb841b950782040bbaadce44f6049228a2821bf · kitten.sh/graphqlsp

.changeset/thin-fishes-fry.md

···

       1
       +
       ---

     

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

     

       3
       +
       ---

     

       4
       +
       

     

       5
       +
       Bubble up unused fields to their closest parent

+1 -1

package.json

···

       9
        
           "prepare": "husky install",

     

       10
        
           "dev": "pnpm --filter @0no-co/graphqlsp dev",

     

       11
        
           "launch-debug": "./scripts/launch-debug.sh",

     

       12
       -
           "test:e2e": "vitest run --single-thread"

     

       13
        
         },

     

       14
        
         "prettier": {

     

       15
        
           "singleQuote": true,

···

       9
        
           "prepare": "husky install",

     

       10
        
           "dev": "pnpm --filter @0no-co/graphqlsp dev",

     

       11
        
           "launch-debug": "./scripts/launch-debug.sh",

     

       12
       +
           "test:e2e": "vitest run unused -u --single-thread"

     

       13
        
         },

     

       14
        
         "prettier": {

     

       15
        
           "singleQuote": true,

+28 -6

packages/graphqlsp/src/fieldUsage.ts

···

       364
        
               Field: {

     

       365
        
                 enter(node) {

     

       366
        
                   const alias = node.alias ? node.alias.value : node.name.value;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       367
        
                   if (!node.selectionSet && !reservedKeys.has(node.name.value)) {

     

       368
       -
                     const path = inProgress.length

     

       369
       -
                       ? `${inProgress.join('.')}.${alias}`

     

       370
       -
                       : alias;

     

       371
        
                     allPaths.push(path);

     

       372
        
                     fieldToLoc.set(path, {

     

       373
        
                       start: node.name.loc!.start,

     
···

       375
        
                     });

     

       376
        
                   } else if (node.selectionSet) {

     

       377
        
                     inProgress.push(alias);

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       378
        
                   }

     

       379
        
                 },

     

       380
        
                 leave(node) {

     
···

       463
        
             }

     

       464
        
       

     

       465
        
             const unused = allPaths.filter(x => !allAccess.includes(x));

     

       466
       -
       

     

       0
        
       
     

       467
        
             unused.forEach(unusedField => {

     

       468
       -
               const loc = fieldToLoc.get(unusedField);

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       469
        
               if (!loc) return;

     

       470
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       471
        
               diagnostics.push({

     

       472
        
                 file: source,

     

       473
        
                 length: loc.length,

     

       474
        
                 start: node.getStart() + loc.start + 1,

     

       475
        
                 category: ts.DiagnosticCategory.Warning,

     

       476
        
                 code: UNUSED_FIELD_CODE,

     

       477
       -
                 messageText: `Field '${unusedField}' is not used.`,

     

       0
        
       
     

       0
        
       
     

       478
        
               });

     

       479
        
             });

     

       480
        
           });

···

       364
        
               Field: {

     

       365
        
                 enter(node) {

     

       366
        
                   const alias = node.alias ? node.alias.value : node.name.value;

     

       367
       +
                   const path = inProgress.length

     

       368
       +
                     ? `${inProgress.join('.')}.${alias}`

     

       369
       +
                     : alias;

     

       370
       +
       

     

       371
        
                   if (!node.selectionSet && !reservedKeys.has(node.name.value)) {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       372
        
                     allPaths.push(path);

     

       373
        
                     fieldToLoc.set(path, {

     

       374
        
                       start: node.name.loc!.start,

     
···

       376
        
                     });

     

       377
        
                   } else if (node.selectionSet) {

     

       378
        
                     inProgress.push(alias);

     

       379
       +
                     fieldToLoc.set(path, {

     

       380
       +
                       start: node.name.loc!.start,

     

       381
       +
                       length: node.name.loc!.end - node.name.loc!.start,

     

       382
       +
                     });

     

       383
        
                   }

     

       384
        
                 },

     

       385
        
                 leave(node) {

     
···

       468
        
             }

     

       469
        
       

     

       470
        
             const unused = allPaths.filter(x => !allAccess.includes(x));

     

       471
       +
             const aggregatedUnusedFields = new Set<string>();

     

       472
       +
             const unusedChildren: { [key: string]: Set<string> } = {};

     

       473
        
             unused.forEach(unusedField => {

     

       474
       +
               const split = unusedField.split('.');

     

       475
       +
               split.pop();

     

       476
       +
               const parentField = split.join('.');

     

       477
       +
               const loc = fieldToLoc.get(parentField);

     

       478
        
               if (!loc) return;

     

       479
        
       

     

       480
       +
               aggregatedUnusedFields.add(parentField);

     

       481
       +
               if (unusedChildren[parentField]) {

     

       482
       +
                 unusedChildren[parentField].add(unusedField);

     

       483
       +
               } else {

     

       484
       +
                 unusedChildren[parentField] = new Set([unusedField]);

     

       485
       +
               }

     

       486
       +
             });

     

       487
       +
       

     

       488
       +
             aggregatedUnusedFields.forEach(field => {

     

       489
       +
               const loc = fieldToLoc.get(field)!;

     

       490
       +
               const unusedFields = unusedChildren[field]!;

     

       491
        
               diagnostics.push({

     

       492
        
                 file: source,

     

       493
        
                 length: loc.length,

     

       494
        
                 start: node.getStart() + loc.start + 1,

     

       495
        
                 category: ts.DiagnosticCategory.Warning,

     

       496
        
                 code: UNUSED_FIELD_CODE,

     

       497
       +
                 messageText: `Field(s) ${[...unusedFields]

     

       498
       +
                   .map(x => `'${x}'`)

     

       499
       +
                   .join(', ')} are not used.`,

     

       500
        
               });

     

       501
        
             });

     

       502
        
           });

+43 -108

test/e2e/unused-fieds.test.ts

···

       142
        
                 "category": "warning",

     

       143
        
                 "code": 52005,

     

       144
        
                 "end": {

     

       145
       -
                   "line": 10,

     

       146
       -
                   "offset": 15,

     

       147
        
                 },

     

       148
        
                 "start": {

     

       149
       -
                   "line": 10,

     

       150
       -
                   "offset": 9,

     

       151
       -
                 },

     

       152
       -
                 "text": "Field 'attacks.fast.damage' is not used.",

     

       153
       -
               },

     

       154
       -
               {

     

       155
       -
                 "category": "warning",

     

       156
       -
                 "code": 52005,

     

       157
       -
                 "end": {

     

       158
       -
                   "line": 11,

     

       159
       -
                   "offset": 13,

     

       160
       -
                 },

     

       161
       -
                 "start": {

     

       162
       -
                   "line": 11,

     

       163
       -
                   "offset": 9,

     

       164
        
                 },

     

       165
       -
                 "text": "Field 'attacks.fast.name' is not used.",

     

       166
        
               },

     

       167
        
             ]

     

       168
        
           `);

     
···

       187
        
                 "category": "warning",

     

       188
        
                 "code": 52005,

     

       189
        
                 "end": {

     

       190
       -
                   "line": 10,

     

       191
       -
                   "offset": 15,

     

       192
       -
                 },

     

       193
       -
                 "start": {

     

       194
       -
                   "line": 10,

     

       195
       -
                   "offset": 9,

     

       196
       -
                 },

     

       197
       -
                 "text": "Field 'attacks.fast.damage' is not used.",

     

       198
       -
               },

     

       199
       -
               {

     

       200
       -
                 "category": "warning",

     

       201
       -
                 "code": 52005,

     

       202
       -
                 "end": {

     

       203
       -
                   "line": 11,

     

       204
       -
                   "offset": 13,

     

       205
        
                 },

     

       206
        
                 "start": {

     

       207
       -
                   "line": 11,

     

       208
       -
                   "offset": 9,

     

       209
        
                 },

     

       210
       -
                 "text": "Field 'attacks.fast.name' is not used.",

     

       211
        
               },

     

       212
        
             ]

     

       213
        
           `);

     
···

       232
        
                 "category": "warning",

     

       233
        
                 "code": 52005,

     

       234
        
                 "end": {

     

       235
       -
                   "line": 11,

     

       236
       -
                   "offset": 15,

     

       237
       -
                 },

     

       238
       -
                 "start": {

     

       239
       -
                   "line": 11,

     

       240
       -
                   "offset": 7,

     

       241
       -
                 },

     

       242
       -
                 "text": "Field 'pokemon.fleeRate' is not used.",

     

       243
       -
               },

     

       244
       -
               {

     

       245
       -
                 "category": "warning",

     

       246
       -
                 "code": 52005,

     

       247
       -
                 "end": {

     

       248
       -
                   "line": 16,

     

       249
       -
                   "offset": 17,

     

       250
        
                 },

     

       251
        
                 "start": {

     

       252
       -
                   "line": 16,

     

       253
       -
                   "offset": 11,

     

       254
        
                 },

     

       255
       -
                 "text": "Field 'pokemon.attacks.special.damage' is not used.",

     

       256
        
               },

     

       257
        
               {

     

       258
        
                 "category": "warning",

     

       259
        
                 "code": 52005,

     

       260
        
                 "end": {

     

       261
       -
                   "line": 20,

     

       262
        
                   "offset": 16,

     

       263
        
                 },

     

       264
        
                 "start": {

     

       265
       -
                   "line": 20,

     

       266
        
                   "offset": 9,

     

       267
        
                 },

     

       268
       -
                 "text": "Field 'pokemon.weight.minimum' is not used.",

     

       269
        
               },

     

       270
        
               {

     

       271
        
                 "category": "warning",

     

       272
        
                 "code": 52005,

     

       273
        
                 "end": {

     

       274
       -
                   "line": 21,

     

       275
       -
                   "offset": 16,

     

       276
        
                 },

     

       277
        
                 "start": {

     

       278
       -
                   "line": 21,

     

       279
       -
                   "offset": 9,

     

       280
        
                 },

     

       281
       -
                 "text": "Field 'pokemon.weight.maximum' is not used.",

     

       282
        
               },

     

       283
        
               {

     

       284
        
                 "category": "error",

     
···

       310
        
                 "category": "warning",

     

       311
        
                 "code": 52005,

     

       312
        
                 "end": {

     

       313
       -
                   "line": 15,

     

       314
       -
                   "offset": 15,

     

       315
        
                 },

     

       316
        
                 "start": {

     

       317
       -
                   "line": 15,

     

       318
       -
                   "offset": 11,

     

       319
        
                 },

     

       320
       -
                 "text": "Field 'pokemon.attacks.special.name' is not used.",

     

       321
        
               },

     

       322
        
               {

     

       323
        
                 "category": "warning",

     

       324
        
                 "code": 52005,

     

       325
        
                 "end": {

     

       326
       -
                   "line": 16,

     

       327
       -
                   "offset": 17,

     

       328
        
                 },

     

       329
        
                 "start": {

     

       330
       -
                   "line": 16,

     

       331
       -
                   "offset": 11,

     

       332
        
                 },

     

       333
       -
                 "text": "Field 'pokemon.attacks.special.damage' is not used.",

     

       334
       -
               },

     

       335
       -
               {

     

       336
       -
                 "category": "warning",

     

       337
       -
                 "code": 52005,

     

       338
       -
                 "end": {

     

       339
       -
                   "line": 23,

     

       340
       -
                   "offset": 11,

     

       341
       -
                 },

     

       342
       -
                 "start": {

     

       343
       -
                   "line": 23,

     

       344
       -
                   "offset": 7,

     

       345
       -
                 },

     

       346
       -
                 "text": "Field 'pokemon.name' is not used.",

     

       347
        
               },

     

       348
        
               {

     

       349
        
                 "category": "error",

     
···

       375
        
                 "category": "warning",

     

       376
        
                 "code": 52005,

     

       377
        
                 "end": {

     

       378
       -
                   "line": 15,

     

       379
       -
                   "offset": 15,

     

       380
        
                 },

     

       381
        
                 "start": {

     

       382
       -
                   "line": 15,

     

       383
       -
                   "offset": 11,

     

       384
        
                 },

     

       385
       -
                 "text": "Field 'pokemon.attacks.special.name' is not used.",

     

       386
        
               },

     

       387
        
               {

     

       388
        
                 "category": "warning",

     

       389
        
                 "code": 52005,

     

       390
        
                 "end": {

     

       391
       -
                   "line": 16,

     

       392
       -
                   "offset": 17,

     

       393
        
                 },

     

       394
        
                 "start": {

     

       395
       -
                   "line": 16,

     

       396
       -
                   "offset": 11,

     

       397
       -
                 },

     

       398
       -
                 "text": "Field 'pokemon.attacks.special.damage' is not used.",

     

       399
       -
               },

     

       400
       -
               {

     

       401
       -
                 "category": "warning",

     

       402
       -
                 "code": 52005,

     

       403
       -
                 "end": {

     

       404
       -
                   "line": 23,

     

       405
       -
                   "offset": 11,

     

       406
        
                 },

     

       407
       -
                 "start": {

     

       408
       -
                   "line": 23,

     

       409
       -
                   "offset": 7,

     

       410
       -
                 },

     

       411
       -
                 "text": "Field 'pokemon.name' is not used.",

     

       412
        
               },

     

       413
        
               {

     

       414
        
                 "category": "error",

···

       142
        
                 "category": "warning",

     

       143
        
                 "code": 52005,

     

       144
        
                 "end": {

     

       145
       +
                   "line": 9,

     

       146
       +
                   "offset": 11,

     

       147
        
                 },

     

       148
        
                 "start": {

     

       149
       +
                   "line": 9,

     

       150
       +
                   "offset": 7,

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       151
        
                 },

     

       152
       +
                 "text": "Field(s) 'attacks.fast.damage', 'attacks.fast.name' are not used.",

     

       153
        
               },

     

       154
        
             ]

     

       155
        
           `);

     
···

       174
        
                 "category": "warning",

     

       175
        
                 "code": 52005,

     

       176
        
                 "end": {

     

       177
       +
                   "line": 9,

     

       178
       +
                   "offset": 11,

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       179
        
                 },

     

       180
        
                 "start": {

     

       181
       +
                   "line": 9,

     

       182
       +
                   "offset": 7,

     

       183
        
                 },

     

       184
       +
                 "text": "Field(s) 'attacks.fast.damage', 'attacks.fast.name' are not used.",

     

       185
        
               },

     

       186
        
             ]

     

       187
        
           `);

     
···

       206
        
                 "category": "warning",

     

       207
        
                 "code": 52005,

     

       208
        
                 "end": {

     

       209
       +
                   "line": 9,

     

       210
       +
                   "offset": 12,

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       211
        
                 },

     

       212
        
                 "start": {

     

       213
       +
                   "line": 9,

     

       214
       +
                   "offset": 5,

     

       215
        
                 },

     

       216
       +
                 "text": "Field(s) 'pokemon.fleeRate' are not used.",

     

       217
        
               },

     

       218
        
               {

     

       219
        
                 "category": "warning",

     

       220
        
                 "code": 52005,

     

       221
        
                 "end": {

     

       222
       +
                   "line": 14,

     

       223
        
                   "offset": 16,

     

       224
        
                 },

     

       225
        
                 "start": {

     

       226
       +
                   "line": 14,

     

       227
        
                   "offset": 9,

     

       228
        
                 },

     

       229
       +
                 "text": "Field(s) 'pokemon.attacks.special.damage' are not used.",

     

       230
        
               },

     

       231
        
               {

     

       232
        
                 "category": "warning",

     

       233
        
                 "code": 52005,

     

       234
        
                 "end": {

     

       235
       +
                   "line": 19,

     

       236
       +
                   "offset": 13,

     

       237
        
                 },

     

       238
        
                 "start": {

     

       239
       +
                   "line": 19,

     

       240
       +
                   "offset": 7,

     

       241
        
                 },

     

       242
       +
                 "text": "Field(s) 'pokemon.weight.minimum', 'pokemon.weight.maximum' are not used.",

     

       243
        
               },

     

       244
        
               {

     

       245
        
                 "category": "error",

     
···

       271
        
                 "category": "warning",

     

       272
        
                 "code": 52005,

     

       273
        
                 "end": {

     

       274
       +
                   "line": 14,

     

       275
       +
                   "offset": 16,

     

       276
        
                 },

     

       277
        
                 "start": {

     

       278
       +
                   "line": 14,

     

       279
       +
                   "offset": 9,

     

       280
        
                 },

     

       281
       +
                 "text": "Field(s) 'pokemon.attacks.special.name', 'pokemon.attacks.special.damage' are not used.",

     

       282
        
               },

     

       283
        
               {

     

       284
        
                 "category": "warning",

     

       285
        
                 "code": 52005,

     

       286
        
                 "end": {

     

       287
       +
                   "line": 9,

     

       288
       +
                   "offset": 12,

     

       289
        
                 },

     

       290
        
                 "start": {

     

       291
       +
                   "line": 9,

     

       292
       +
                   "offset": 5,

     

       293
        
                 },

     

       294
       +
                 "text": "Field(s) 'pokemon.name' are not used.",

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       295
        
               },

     

       296
        
               {

     

       297
        
                 "category": "error",

     
···

       323
        
                 "category": "warning",

     

       324
        
                 "code": 52005,

     

       325
        
                 "end": {

     

       326
       +
                   "line": 14,

     

       327
       +
                   "offset": 16,

     

       328
        
                 },

     

       329
        
                 "start": {

     

       330
       +
                   "line": 14,

     

       331
       +
                   "offset": 9,

     

       332
        
                 },

     

       333
       +
                 "text": "Field(s) 'pokemon.attacks.special.name', 'pokemon.attacks.special.damage' are not used.",

     

       334
        
               },

     

       335
        
               {

     

       336
        
                 "category": "warning",

     

       337
        
                 "code": 52005,

     

       338
        
                 "end": {

     

       339
       +
                   "line": 9,

     

       340
       +
                   "offset": 12,

     

       341
        
                 },

     

       342
        
                 "start": {

     

       343
       +
                   "line": 9,

     

       344
       +
                   "offset": 5,

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       345
        
                 },

     

       346
       +
                 "text": "Field(s) 'pokemon.name' are not used.",

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       347
        
               },

     

       348
        
               {

     

       349
        
                 "category": "error",

-7

tsconfig.json

···

       1
        
       {

     

       2
        
         "compilerOptions": {

     

       3
       -
           "plugins": [

     

       4
       -
             {

     

       5
       -
               "name": "@0no-co/graphqlsp",

     

       6
       -
               "schema": "./packages/example-tada/schema.graphql",

     

       7
       -
               "tadaOutputLocation": "./packages/example-tada/introspection.ts"

     

       8
       -
             }

     

       9
       -
           ],

     

       10
        
           "jsx": "react-jsx",

     

       11
        
           /* Language and Environment */

     

       12
        
           "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,

···

       1
        
       {

     

       2
        
         "compilerOptions": {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       3
        
           "jsx": "react-jsx",

     

       4
        
           /* Language and Environment */

     

       5
        
           "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,