-
Notifications
You must be signed in to change notification settings - Fork 30
/
package.json
925 lines (925 loc) · 61.2 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
{
"name": "coc-go",
"version": "1.3.35",
"description": "gopls extension for coc",
"author": "Josa Gesell <[email protected]>",
"license": "MIT",
"main": "lib/extension.js",
"repository": {
"type": "git",
"url": "https://github.com/josa42/coc-go.git"
},
"engines": {
"coc": "^0.0.82",
"node": ">=16"
},
"keywords": [
"coc.nvim",
"languageserver",
"gopls",
"go",
"golang",
"vim",
"neovim"
],
"scripts": {
"test": "jest",
"test:watch": "mocha --watch --watch-files '**/*.ts' --require ts-node/register '**/*.test.ts'",
"clean": "rimraf lib",
"build": "tsc -p tsconfig.json",
"build:watch": "tsc --watch -p tsconfig.json",
"prepare": "npm run clean && npm run build",
"link:add": "node ./scripts/link.js add",
"link:remove": "node ./scripts/link.js remove",
"update": "npm run update:snippets && npm run update:options && npm run update:readme && npm run update:readme",
"update:snippets": "./scripts/update-snippets.js",
"update:options": "./scripts/update-options.sh && node ./scripts/update-options-interface.js",
"update:commands": "./scripts/update-commands.js",
"update:readme": "./scripts/update-tables.sh",
"lint": "eslint . --ext .ts,.js"
},
"activationEvents": [
"onLanguage:go",
"onLanguage:gomod",
"onCommand:go.install.gomodifytags",
"onCommand:go.install.goplay",
"onCommand:go.install.gopls",
"onCommand:go.install.gotests",
"onCommand:go.install.impl",
"onCommand:go.install.tools",
"onCommand:go.version"
],
"contributes": {
"rootPatterns": [
{
"filetype": "go",
"patterns": [
"go.mod",
"go.work"
]
},
{
"filetype": "gomod",
"patterns": [
"go.mod"
]
}
],
"configuration": {
"type": "object",
"title": "gols",
"properties": {
"go.enable": {
"type": "boolean",
"default": true,
"description": "Enable Go extension"
},
"go.trace.server": {
"type": "string",
"default": "off",
"enum": [
"off",
"messages",
"verbose"
],
"description": "Trace level of gopls"
},
"go.goplsPath": {
"type": "string",
"description": "Path to `gopls` bin (Change requires `:CocRestart`)"
},
"go.goplsArgs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arguments passed to `gopls` (Change requires `:CocRestart`)"
},
"go.goplsEnv": {
"type": "object",
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"description": "ENV passed to `gopls` (Change requires `:CocRestart`)"
},
"go.goplsUseDaemon": {
"type": "boolean",
"default": true,
"description": "Run gopls as daemon"
},
"go.disable": {
"type": "object",
"description": "Disable gopls features",
"default": {},
"properties": {
"workspaceFolders": {
"type": "boolean",
"default": false,
"description": "Disable workspaceFolders feature (Change requires `:CocRestart`)"
},
"diagnostics": {
"type": "boolean",
"default": false,
"description": "Disable handle diagnostics (Change requires `:CocRestart`)"
},
"completion": {
"type": "boolean",
"default": false,
"description": "Disable completion feature (Change requires `:CocRestart`)"
},
"snippetCompletion": {
"type": "boolean",
"default": false,
"description": "Disable snippet completion (Change requires `:CocRestart`)"
},
"features": {
"type": "array",
"default": [],
"description": "Disabled features (Change requires `:CocRestart`)",
"items": {
"type": "string",
"enum": [
"completion",
"configuration",
"workspaceFolders",
"diagnostics",
"willSave",
"willSaveUntil",
"didSaveTextDocument",
"fileSystemWatcher",
"hover",
"signatureHelp",
"definition",
"references",
"documentHighlight",
"documentSymbol",
"workspaceSymbol",
"codeAction",
"codeLens",
"formatting",
"documentFormatting",
"documentRangeFormatting",
"documentOnTypeFormatting",
"rename",
"documentLink",
"executeCommand",
"pullConfiguration",
"typeDefinition",
"implementation",
"declaration",
"color",
"foldingRange",
"selectionRange",
"progress",
"callHierarchy",
"linkedEditing",
"fileEvents",
"semanticTokens"
]
}
}
}
},
"go.goplsOptions": {
"type": "object",
"description": "See `gopls` documentation: https://github.com/golang/tools/blob/master/gopls/doc/settings.md",
"properties": {
"allowImplicitNetworkAccess": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nallowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module\ndownloads rather than requiring user action. This option will eventually\nbe removed.\n"
},
"analyses": {
"type": "object",
"description": "analyses specify analyses that the user would like to enable or disable.\nA map of the names of analysis passes that should be enabled/disabled.\nA full list of analyzers that gopls uses can be found in\n[analyzers.md](https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md).\n\nExample Usage:\n\n```json5\n...\n\"analyses\": {\n \"unreachable\": false, // Disable the unreachable analyzer.\n \"unusedvariable\": true // Enable the unusedvariable analyzer.\n}\n...\n```\n",
"additionalProperties": false,
"patternProperties": {
"^S[AT]?\\d{4}$": {
"type": "boolean"
}
},
"properties": {
"appends": {
"type": "boolean",
"description": "This checker reports calls to append that pass\nno values to be appended to the slice.\n\ts := []string{\"a\", \"b\", \"c\"}\n\t_ = append(s)\nSuch calls are always no-ops and often indicate an\nunderlying mistake.\nPackage documentation: [appends](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/appends)\n<a id='asmdecl'></a>",
"default": true
},
"asmdecl": {
"type": "boolean",
"description": "Package documentation: [asmdecl](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/asmdecl)\n<a id='assign'></a>",
"default": true
},
"assign": {
"type": "boolean",
"description": "This checker reports assignments of the form x = x or a[i] = a[i].\nThese are almost always useless, and even when they aren't they are\nusually a mistake.\nPackage documentation: [assign](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/assign)\n<a id='atomic'></a>",
"default": true
},
"atomic": {
"type": "boolean",
"description": "The atomic checker looks for assignment statements of the form:\n\tx = atomic.AddUint64(&x, 1)\nwhich are not atomic.\nPackage documentation: [atomic](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/atomic)\n<a id='atomicalign'></a>",
"default": true
},
"atomicalign": {
"type": "boolean",
"description": "Package documentation: [atomicalign](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/atomicalign)\n<a id='bools'></a>",
"default": true
},
"bools": {
"type": "boolean",
"description": "Package documentation: [bools](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/bools)\n<a id='buildtag'></a>",
"default": true
},
"buildtag": {
"type": "boolean",
"description": "Package documentation: [buildtag](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/buildtag)\n<a id='cgocall'></a>",
"default": true
},
"cgocall": {
"type": "boolean",
"description": "Check for invalid cgo pointer passing.\nThis looks for code that uses cgo to call C code passing values\nwhose types are almost always invalid according to the cgo pointer\nsharing rules.\nSpecifically, it warns about attempts to pass a Go chan, map, func,\nor slice to C, either directly, or via a pointer, array, or struct.\nPackage documentation: [cgocall](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/cgocall)\n<a id='composites'></a>",
"default": true
},
"composites": {
"type": "boolean",
"description": "This analyzer reports a diagnostic for composite literals of struct\ntypes imported from another package that do not use the field-keyed\nsyntax. Such literals are fragile because the addition of a new field\n(even if unexported) to the struct will cause compilation to fail.\nAs an example,\n\terr = &net.DNSConfigError{err}\nshould be replaced by:\n\terr = &net.DNSConfigError{Err: err}\nPackage documentation: [composites](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/composite)\n<a id='copylocks'></a>",
"default": true
},
"copylocks": {
"type": "boolean",
"description": "Inadvertently copying a value containing a lock, such as sync.Mutex or\nsync.WaitGroup, may cause both copies to malfunction. Generally such\nvalues should be referred to through a pointer.\nPackage documentation: [copylocks](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/copylock)\n<a id='deepequalerrors'></a>",
"default": true
},
"deepequalerrors": {
"type": "boolean",
"description": "The deepequalerrors checker looks for calls of the form:\n reflect.DeepEqual(err1, err2)\nwhere err1 and err2 are errors. Using reflect.DeepEqual to compare\nerrors is discouraged.\nPackage documentation: [deepequalerrors](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/deepequalerrors)\n<a id='defers'></a>",
"default": true
},
"defers": {
"type": "boolean",
"description": "The defers analyzer reports a diagnostic when a defer statement would\nresult in a non-deferred call to time.Since, as experience has shown\nthat this is nearly always a mistake.\nFor example:\n\tstart := time.Now()\n\t...\n\tdefer recordLatency(time.Since(start)) // error: call to time.Since is not deferred\nThe correct code is:\n\tdefer func() { recordLatency(time.Since(start)) }()\nPackage documentation: [defers](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/defers)\n<a id='deprecated'></a>",
"default": true
},
"deprecated": {
"type": "boolean",
"description": "The deprecated analyzer looks for deprecated symbols and package\nimports.\nSee https://go.dev/wiki/Deprecated to learn about Go's convention\nfor documenting and signaling deprecated identifiers.\nPackage documentation: [deprecated](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/deprecated)\n<a id='directive'></a>",
"default": true
},
"directive": {
"type": "boolean",
"description": "This analyzer checks for problems with known Go toolchain directives\nin all Go source files in a package directory, even those excluded by\n//go:build constraints, and all non-Go source files too.\nFor //go:debug (see https://go.dev/doc/godebug), the analyzer checks\nthat the directives are placed only in Go source files, only above the\npackage comment, and only in package main or *_test.go files.\nSupport for other known directives may be added in the future.\nThis analyzer does not check //go:build, which is handled by the\nbuildtag analyzer.\nPackage documentation: [directive](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/directive)\n<a id='embed'></a>",
"default": true
},
"embed": {
"type": "boolean",
"description": "This analyzer checks that the embed package is imported if //go:embed\ndirectives are present, providing a suggested fix to add the import if\nit is missing.\nThis analyzer also checks that //go:embed directives precede the\ndeclaration of a single variable.\nPackage documentation: [embed](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/embeddirective)\n<a id='errorsas'></a>",
"default": true
},
"errorsas": {
"type": "boolean",
"description": "The errorsas analysis reports calls to errors.As where the type\nof the second argument is not a pointer to a type implementing error.\nPackage documentation: [errorsas](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/errorsas)\n<a id='fillreturns'></a>",
"default": true
},
"fillreturns": {
"type": "boolean",
"description": "This checker provides suggested fixes for type errors of the\ntype \"wrong number of return values (want %d, got %d)\". For example:\n\tfunc m() (int, string, *bool, error) {\n\t\treturn\n\t}\nwill turn into\n\tfunc m() (int, string, *bool, error) {\n\t\treturn 0, \"\", nil, nil\n\t}\nThis functionality is similar to https://github.com/sqs/goreturns.\nPackage documentation: [fillreturns](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/fillreturns)\n<a id='framepointer'></a>",
"default": true
},
"framepointer": {
"type": "boolean",
"description": "Package documentation: [framepointer](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/framepointer)\n<a id='httpresponse'></a>",
"default": true
},
"httpresponse": {
"type": "boolean",
"description": "A common mistake when using the net/http package is to defer a function\ncall to close the http.Response Body before checking the error that\ndetermines whether the response is valid:\n\tresp, err := http.Head(url)\n\tdefer resp.Body.Close()\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t// (defer statement belongs here)\nThis checker helps uncover latent nil dereference bugs by reporting a\ndiagnostic for such mistakes.\nPackage documentation: [httpresponse](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/httpresponse)\n<a id='ifaceassert'></a>",
"default": true
},
"ifaceassert": {
"type": "boolean",
"description": "This checker flags type assertions v.(T) and corresponding type-switch cases\nin which the static type V of v is an interface that cannot possibly implement\nthe target interface T. This occurs when V and T contain methods with the same\nname but different signatures. Example:\n\tvar v interface {\n\t\tRead()\n\t}\n\t_ = v.(io.Reader)\nThe Read method in v has a different signature than the Read method in\nio.Reader, so this assertion cannot succeed.\nPackage documentation: [ifaceassert](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/ifaceassert)\n<a id='infertypeargs'></a>",
"default": true
},
"infertypeargs": {
"type": "boolean",
"description": "Explicit type arguments may be omitted from call expressions if they can be\ninferred from function arguments, or from other type arguments:\n\tfunc f[T any](T) {}\n\t\n\tfunc _() {\n\t\tf[string](\"foo\") // string could be inferred\n\t}\nPackage documentation: [infertypeargs](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/infertypeargs)\n<a id='loopclosure'></a>",
"default": true
},
"loopclosure": {
"type": "boolean",
"description": "This analyzer reports places where a function literal references the\niteration variable of an enclosing loop, and the loop calls the function\nin such a way (e.g. with go or defer) that it may outlive the loop\niteration and possibly observe the wrong value of the variable.\nNote: An iteration variable can only outlive a loop iteration in Go versions <=1.21.\nIn Go 1.22 and later, the loop variable lifetimes changed to create a new\niteration variable per loop iteration. (See go.dev/issue/60078.)\nIn this example, all the deferred functions run after the loop has\ncompleted, so all observe the final value of v [<go1.22].\n\tfor _, v := range list {\n\t defer func() {\n\t use(v) // incorrect\n\t }()\n\t}\nOne fix is to create a new variable for each iteration of the loop:\n\tfor _, v := range list {\n\t v := v // new var per iteration\n\t defer func() {\n\t use(v) // ok\n\t }()\n\t}\nAfter Go version 1.22, the previous two for loops are equivalent\nand both are correct.\nThe next example uses a go statement and has a similar problem [<go1.22].\nIn addition, it has a data race because the loop updates v\nconcurrent with the goroutines accessing it.\n\tfor _, v := range elem {\n\t go func() {\n\t use(v) // incorrect, and a data race\n\t }()\n\t}\nA fix is the same as before. The checker also reports problems\nin goroutines started by golang.org/x/sync/errgroup.Group.\nA hard-to-spot variant of this form is common in parallel tests:\n\tfunc Test(t *testing.T) {\n\t for _, test := range tests {\n\t t.Run(test.name, func(t *testing.T) {\n\t t.Parallel()\n\t use(test) // incorrect, and a data race\n\t })\n\t }\n\t}\nThe t.Parallel() call causes the rest of the function to execute\nconcurrent with the loop [<go1.22].\nThe analyzer reports references only in the last statement,\nas it is not deep enough to understand the effects of subsequent\nstatements that might render the reference benign.\n(\"Last statement\" is defined recursively in compound\nstatements such as if, switch, and select.)\nSee: https://golang.org/doc/go_faq.html#closures_and_goroutines\nPackage documentation: [loopclosure](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/loopclosure)\n<a id='lostcancel'></a>",
"default": true
},
"lostcancel": {
"type": "boolean",
"description": "The cancellation function returned by context.WithCancel, WithTimeout,\nand WithDeadline must be called or the new context will remain live\nuntil its parent context is cancelled.\n(The background context is never cancelled.)\nPackage documentation: [lostcancel](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/lostcancel)\n<a id='nilfunc'></a>",
"default": true
},
"nilfunc": {
"type": "boolean",
"description": "A useless comparison is one like f == nil as opposed to f() == nil.\nPackage documentation: [nilfunc](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/nilfunc)\n<a id='nilness'></a>",
"default": true
},
"nilness": {
"type": "boolean",
"description": "The nilness checker inspects the control-flow graph of each function in\na package and reports nil pointer dereferences, degenerate nil\npointers, and panics with nil values. A degenerate comparison is of the form\nx==nil or x!=nil where x is statically known to be nil or non-nil. These are\noften a mistake, especially in control flow related to errors. Panics with nil\nvalues are checked because they are not detectable by\n\tif r := recover(); r != nil {\nThis check reports conditions such as:\n\tif f == nil { // impossible condition (f is a function)\n\t}\nand:\n\tp := &v\n\t...\n\tif p != nil { // tautological condition\n\t}\nand:\n\tif p == nil {\n\t\tprint(*p) // nil dereference\n\t}\nand:\n\tif p == nil {\n\t\tpanic(p)\n\t}\nSometimes the control flow may be quite complex, making bugs hard\nto spot. In the example below, the err.Error expression is\nguaranteed to panic because, after the first return, err must be\nnil. The intervening loop is just a distraction.\n\t...\n\terr := g.Wait()\n\tif err != nil {\n\t\treturn err\n\t}\n\tpartialSuccess := false\n\tfor _, err := range errs {\n\t\tif err == nil {\n\t\t\tpartialSuccess = true\n\t\t\tbreak\n\t\t}\n\t}\n\tif partialSuccess {\n\t\treportStatus(StatusMessage{\n\t\t\tCode: code.ERROR,\n\t\t\tDetail: err.Error(), // \"nil dereference in dynamic method call\"\n\t\t})\n\t\treturn nil\n\t}\n...\nPackage documentation: [nilness](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/nilness)\n<a id='nonewvars'></a>",
"default": true
},
"nonewvars": {
"type": "boolean",
"description": "This checker provides suggested fixes for type errors of the\ntype \"no new vars on left side of :=\". For example:\n\tz := 1\n\tz := 2\nwill turn into\n\tz := 1\n\tz = 2\nPackage documentation: [nonewvars](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/nonewvars)\n<a id='noresultvalues'></a>",
"default": true
},
"noresultvalues": {
"type": "boolean",
"description": "This checker provides suggested fixes for type errors of the\ntype \"no result values expected\" or \"too many return values\".\nFor example:\n\tfunc z() { return nil }\nwill turn into\n\tfunc z() { return }\nPackage documentation: [noresultvalues](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/noresultvalues)\n<a id='printf'></a>",
"default": true
},
"printf": {
"type": "boolean",
"description": "The check applies to calls of the formatting functions such as\n[fmt.Printf] and [fmt.Sprintf], as well as any detected wrappers of\nthose functions such as [log.Printf]. It reports a variety of\nmistakes such as syntax errors in the format string and mismatches\n(of number and type) between the verbs and their arguments.\nSee the documentation of the fmt package for the complete set of\nformat operators and their operand types.\nPackage documentation: [printf](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/printf)\n<a id='shadow'></a>",
"default": true
},
"shadow": {
"type": "boolean",
"description": "This analyzer check for shadowed variables.\nA shadowed variable is a variable declared in an inner scope\nwith the same name and type as a variable in an outer scope,\nand where the outer variable is mentioned after the inner one\nis declared.\n(This definition can be refined; the module generates too many\nfalse positives and is not yet enabled by default.)\nFor example:\n\tfunc BadRead(f *os.File, buf []byte) error {\n\t\tvar err error\n\t\tfor {\n\t\t\tn, err := f.Read(buf) // shadows the function variable 'err'\n\t\t\tif err != nil {\n\t\t\t\tbreak // causes return of wrong value\n\t\t\t}\n\t\t\tfoo(buf)\n\t\t}\n\t\treturn err\n\t}\nDefault: off. Enable by setting `\"analyses\": {\"shadow\": true}`.\nPackage documentation: [shadow](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/shadow)\n<a id='shift'></a>"
},
"shift": {
"type": "boolean",
"description": "Package documentation: [shift](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/shift)\n<a id='sigchanyzer'></a>",
"default": true
},
"sigchanyzer": {
"type": "boolean",
"description": "This checker reports call expression of the form\n\tsignal.Notify(c <-chan os.Signal, sig ...os.Signal),\nwhere c is an unbuffered channel, which can be at risk of missing the signal.\nPackage documentation: [sigchanyzer](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/sigchanyzer)\n<a id='simplifycompositelit'></a>",
"default": true
},
"simplifycompositelit": {
"type": "boolean",
"description": "An array, slice, or map composite literal of the form:\n\t[]T{T{}, T{}}\nwill be simplified to:\n\t[]T{{}, {}}\nThis is one of the simplifications that \"gofmt -s\" applies.\nThis analyzer ignores generated code.\nPackage documentation: [simplifycompositelit](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/simplifycompositelit)\n<a id='simplifyrange'></a>",
"default": true
},
"simplifyrange": {
"type": "boolean",
"description": "A range of the form:\n\tfor x, _ = range v {...}\nwill be simplified to:\n\tfor x = range v {...}\nA range of the form:\n\tfor _ = range v {...}\nwill be simplified to:\n\tfor range v {...}\nThis is one of the simplifications that \"gofmt -s\" applies.\nThis analyzer ignores generated code.\nPackage documentation: [simplifyrange](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/simplifyrange)\n<a id='simplifyslice'></a>",
"default": true
},
"simplifyslice": {
"type": "boolean",
"description": "A slice expression of the form:\n\ts[a:len(s)]\nwill be simplified to:\n\ts[a:]\nThis is one of the simplifications that \"gofmt -s\" applies.\nThis analyzer ignores generated code.\nPackage documentation: [simplifyslice](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/simplifyslice)\n<a id='slog'></a>",
"default": true
},
"slog": {
"type": "boolean",
"description": "The slog checker looks for calls to functions from the log/slog\npackage that take alternating key-value pairs. It reports calls\nwhere an argument in a key position is neither a string nor a\nslog.Attr, and where a final key is missing its value.\nFor example,it would report\n\tslog.Warn(\"message\", 11, \"k\") // slog.Warn arg \"11\" should be a string or a slog.Attr\nand\n\tslog.Info(\"message\", \"k1\", v1, \"k2\") // call to slog.Info missing a final value\nPackage documentation: [slog](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/slog)\n<a id='sortslice'></a>",
"default": true
},
"sortslice": {
"type": "boolean",
"description": "sort.Slice requires an argument of a slice type. Check that\nthe interface{} value passed to sort.Slice is actually a slice.\nPackage documentation: [sortslice](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/sortslice)\n<a id='stdmethods'></a>",
"default": true
},
"stdmethods": {
"type": "boolean",
"description": "Sometimes a type may be intended to satisfy an interface but may fail to\ndo so because of a mistake in its method signature.\nFor example, the result of this WriteTo method should be (int64, error),\nnot error, to satisfy io.WriterTo:\n\ttype myWriterTo struct{...}\n\tfunc (myWriterTo) WriteTo(w io.Writer) error { ... }\nThis check ensures that each method whose name matches one of several\nwell-known interface methods from the standard library has the correct\nsignature for that interface.\nChecked method names include:\n\tFormat GobEncode GobDecode MarshalJSON MarshalXML\n\tPeek ReadByte ReadFrom ReadRune Scan Seek\n\tUnmarshalJSON UnreadByte UnreadRune WriteByte\n\tWriteTo\nPackage documentation: [stdmethods](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/stdmethods)\n<a id='stdversion'></a>",
"default": true
},
"stdversion": {
"type": "boolean",
"description": "The stdversion analyzer reports references to symbols in the standard\nlibrary that were introduced by a Go release higher than the one in\nforce in the referring file. (Recall that the file's Go version is\ndefined by the 'go' directive its module's go.mod file, or by a\n\"//go:build go1.X\" build tag at the top of the file.)\nThe analyzer does not report a diagnostic for a reference to a \"too\nnew\" field or method of a type that is itself \"too new\", as this may\nhave false positives, for example if fields or methods are accessed\nthrough a type alias that is guarded by a Go version constraint.\nPackage documentation: [stdversion](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/stdversion)\n<a id='stringintconv'></a>",
"default": true
},
"stringintconv": {
"type": "boolean",
"description": "This checker flags conversions of the form string(x) where x is an integer\n(but not byte or rune) type. Such conversions are discouraged because they\nreturn the UTF-8 representation of the Unicode code point x, and not a decimal\nstring representation of x as one might expect. Furthermore, if x denotes an\ninvalid code point, the conversion cannot be statically rejected.\nFor conversions that intend on using the code point, consider replacing them\nwith string(rune(x)). Otherwise, strconv.Itoa and its equivalents return the\nstring representation of the value in the desired base.\nPackage documentation: [stringintconv](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/stringintconv)\n<a id='structtag'></a>",
"default": true
},
"structtag": {
"type": "boolean",
"description": "Also report certain struct tags (json, xml) used with unexported fields.\nPackage documentation: [structtag](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/structtag)\n<a id='testinggoroutine'></a>",
"default": true
},
"testinggoroutine": {
"type": "boolean",
"description": "Functions that abruptly terminate a test, such as the Fatal, Fatalf, FailNow, and\nSkip{,f,Now} methods of *testing.T, must be called from the test goroutine itself.\nThis checker detects calls to these functions that occur within a goroutine\nstarted by the test. For example:\n\tfunc TestFoo(t *testing.T) {\n\t go func() {\n\t t.Fatal(\"oops\") // error: (*T).Fatal called from non-test goroutine\n\t }()\n\t}\nPackage documentation: [testinggoroutine](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/testinggoroutine)\n<a id='tests'></a>",
"default": true
},
"tests": {
"type": "boolean",
"description": "The tests checker walks Test, Benchmark, Fuzzing and Example functions checking\nmalformed names, wrong signatures and examples documenting non-existent\nidentifiers.\nPlease see the documentation for package testing in golang.org/pkg/testing\nfor the conventions that are enforced for Tests, Benchmarks, and Examples.\nPackage documentation: [tests](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/tests)\n<a id='timeformat'></a>",
"default": true
},
"timeformat": {
"type": "boolean",
"description": "The timeformat checker looks for time formats with the 2006-02-01 (yyyy-dd-mm)\nformat. Internationally, \"yyyy-dd-mm\" does not occur in common calendar date\nstandards, and so it is more likely that 2006-01-02 (yyyy-mm-dd) was intended.\nPackage documentation: [timeformat](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/timeformat)\n<a id='undeclaredname'></a>",
"default": true
},
"undeclaredname": {
"type": "boolean",
"description": "This checker provides suggested fixes for type errors of the\ntype \"undeclared name: <>\". It will either insert a new statement,\nsuch as:\n\t<> :=\nor a new function declaration, such as:\n\tfunc <>(inferred parameters) {\n\t\tpanic(\"implement me!\")\n\t}\nPackage documentation: [undeclaredname](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/undeclaredname)\n<a id='unmarshal'></a>",
"default": true
},
"unmarshal": {
"type": "boolean",
"description": "The unmarshal analysis reports calls to functions such as json.Unmarshal\nin which the argument type is not a pointer or an interface.\nPackage documentation: [unmarshal](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/unmarshal)\n<a id='unreachable'></a>",
"default": true
},
"unreachable": {
"type": "boolean",
"description": "The unreachable analyzer finds statements that execution can never reach\nbecause they are preceded by an return statement, a call to panic, an\ninfinite loop, or similar constructs.\nPackage documentation: [unreachable](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/unreachable)\n<a id='unsafeptr'></a>",
"default": true
},
"unsafeptr": {
"type": "boolean",
"description": "The unsafeptr analyzer reports likely incorrect uses of unsafe.Pointer\nto convert integers to pointers. A conversion from uintptr to\nunsafe.Pointer is invalid if it implies that there is a uintptr-typed\nword in memory that holds a pointer value, because that word will be\ninvisible to stack copying and to the garbage collector.\nPackage documentation: [unsafeptr](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/unsafeptr)\n<a id='unusedparams'></a>",
"default": true
},
"unusedparams": {
"type": "boolean",
"description": "The unusedparams analyzer checks functions to see if there are\nany parameters that are not being used.\nTo ensure soundness, it ignores:\n - \"address-taken\" functions, that is, functions that are used as\n a value rather than being called directly; their signatures may\n be required to conform to a func type.\n - exported functions or methods, since they may be address-taken\n in another package.\n - unexported methods whose name matches an interface method\n declared in the same package, since the method's signature\n may be required to conform to the interface type.\n - functions with empty bodies, or containing just a call to panic.\n - parameters that are unnamed, or named \"_\", the blank identifier.\nThe analyzer suggests a fix of replacing the parameter name by \"_\",\nbut in such cases a deeper fix can be obtained by invoking the\n\"Refactor: remove unused parameter\" code action, which will\neliminate the parameter entirely, along with all corresponding\narguments at call sites, while taking care to preserve any side\neffects in the argument expressions; see\nhttps://github.com/golang/tools/releases/tag/gopls%2Fv0.14.\nPackage documentation: [unusedparams](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/unusedparams)\n<a id='unusedresult'></a>",
"default": true
},
"unusedresult": {
"type": "boolean",
"description": "Some functions like fmt.Errorf return a result and have no side\neffects, so it is always a mistake to discard the result. Other\nfunctions may return an error that must not be ignored, or a cleanup\noperation that must be called. This analyzer reports calls to\nfunctions like these when the result of the call is ignored.\nThe set of functions may be controlled using flags.\nPackage documentation: [unusedresult](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/unusedresult)\n<a id='unusedvariable'></a>",
"default": true
},
"unusedvariable": {
"type": "boolean",
"description": "Default: off. Enable by setting `\"analyses\": {\"unusedvariable\": true}`.\nPackage documentation: [unusedvariable](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/unusedvariable)\n<a id='unusedwrite'></a>"
},
"unusedwrite": {
"type": "boolean",
"description": "The analyzer reports instances of writes to struct fields and\narrays that are never read. Specifically, when a struct object\nor an array is copied, its elements are copied implicitly by\nthe compiler, and any element write to this copy does nothing\nwith the original object.\nFor example:\n\ttype T struct { x int }\n\tfunc f(input []T) {\n\t\tfor i, v := range input { // v is a copy\n\t\t\tv.x = i // unused write to field x\n\t\t}\n\t}\nAnother example is about non-pointer receiver:\n\ttype T struct { x int }\n\tfunc (t T) f() { // t is a copy\n\t\tt.x = i // unused write to field x\n\t}\nPackage documentation: [unusedwrite](https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/unusedwrite)\n<a id='useany'></a>",
"default": true
},
"useany": {
"type": "boolean",
"description": "Default: off. Enable by setting `\"analyses\": {\"useany\": true}`.\nPackage documentation: [useany](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/useany)"
}
}
},
"analysisProgressReporting": {
"type": "boolean",
"default": true,
"description": "analysisProgressReporting controls whether gopls sends progress\nnotifications when construction of its index of analysis facts is taking a\nlong time. Cancelling these notifications will cancel the indexing task,\nthough it will restart after the next change in the workspace.\n\nWhen a package is opened for the first time and heavyweight analyses such as\nstaticcheck are enabled, it can take a while to construct the index of\nanalysis facts for all its dependencies. The index is cached in the\nfilesystem, so subsequent analysis should be faster.\n"
},
"annotations": {
"type": "object",
"patternProperties": {
".+": {
"type": "boolean"
}
},
"description": "**This setting is experimental and may be deleted.**\n\nannotations specifies the various kinds of optimization diagnostics\nthat should be reported by the gc_details command.\n\nEach enum must be one of:\n\n* `\"bounds\"` controls bounds checking diagnostics.\n* `\"escape\"` controls diagnostics about escape choices.\n* `\"inline\"` controls diagnostics about inlining choices.\n* `\"nil\"` controls nil checks.\n"
},
"buildFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "buildFlags is the set of flags passed on to the build system when invoked.\nIt is applied to queries like `go list`, which is used when discovering files.\nThe most common use is to set `-tags`.\n"
},
"codelenses": {
"type": "object",
"description": "codelenses overrides the enabled/disabled state of each of gopls'\nsources of [Code Lenses](codelenses.md).\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"codelenses\": {\n \"generate\": false, // Don't show the `go generate` lens.\n \"gc_details\": true // Show a code lens toggling the display of gc's choices.\n }\n...\n}\n```\n",
"additionalProperties": false,
"properties": {
"gc_details": {
"type": "boolean",
"default": false
},
"generate": {
"type": "boolean",
"default": true
},
"regenerate_cgo": {
"type": "boolean",
"default": true
},
"run_govulncheck": {
"type": "boolean",
"default": false
},
"tidy": {
"type": "boolean",
"default": true
},
"upgrade_dependency": {
"type": "boolean",
"default": true
},
"vendor": {
"type": "boolean",
"default": true
}
}
},
"completeFunctionCalls": {
"type": "boolean",
"default": true,
"description": "completeFunctionCalls enables function call completion.\n\nWhen completing a statement, or when a function return type matches the\nexpected of the expression being completed, completion may suggest call\nexpressions (i.e. may include parentheses).\n"
},
"completionBudget": {
"type": "string",
"default": "100ms",
"description": "**This setting is for debugging purposes only.**\n\ncompletionBudget is the soft latency goal for completion requests. Most\nrequests finish in a couple milliseconds, but in some cases deep\ncompletions can take much longer. As we use up our budget we\ndynamically reduce the search scope to ensure we return timely\nresults. Zero means unlimited.\n"
},
"diagnosticsDelay": {
"type": "string",
"default": "1s",
"description": "**This is an advanced setting and should not be configured by most `gopls` users.**\n\ndiagnosticsDelay controls the amount of time that gopls waits\nafter the most recent file modification before computing deep diagnostics.\nSimple diagnostics (parsing and type-checking) are always run immediately\non recently modified packages.\n\nThis option must be set to a valid duration string, for example `\"250ms\"`.\n"
},
"diagnosticsTrigger": {
"type": "string",
"enum": [
"Edit",
"Save"
],
"default": "Edit",
"description": "**This setting is experimental and may be deleted.**\n\ndiagnosticsTrigger controls when to run diagnostics.\n\nMust be one of:\n\n* `\"Edit\"`: Trigger diagnostics on file edit and save. (default)\n* `\"Save\"`: Trigger diagnostics only on file save. Events like initial workspace load\nor configuration change will still trigger diagnostics.\n"
},
"directoryFilters": {
"type": "array",
"items": {
"type": "string"
},
"description": "directoryFilters can be used to exclude unwanted directories from the\nworkspace. By default, all directories are included. Filters are an\noperator, `+` to include and `-` to exclude, followed by a path prefix\nrelative to the workspace folder. They are evaluated in order, and\nthe last filter that applies to a path controls whether it is included.\nThe path prefix can be empty, so an initial `-` excludes everything.\n\nDirectoryFilters also supports the `**` operator to match 0 or more directories.\n\nExamples:\n\nExclude node_modules at current depth: `-node_modules`\n\nExclude node_modules at any depth: `-**/node_modules`\n\nInclude only project_a: `-` (exclude everything), `+project_a`\n\nInclude only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules`\n"
},
"env": {
"type": "object",
"patternProperties": {
".+": {
"type": "string"
}
},
"description": "env adds environment variables to external commands run by `gopls`, most notably `go list`.\n"
},
"expandWorkspaceToModule": {
"type": "boolean",
"default": true,
"description": "**This setting is experimental and may be deleted.**\n\nexpandWorkspaceToModule determines which packages are considered\n\"workspace packages\" when the workspace is using modules.\n\nWorkspace packages affect the scope of workspace-wide operations. Notably,\ngopls diagnoses all packages considered to be part of the workspace after\nevery keystroke, so by setting \"ExpandWorkspaceToModule\" to false, and\nopening a nested workspace directory, you can reduce the amount of work\ngopls has to do to keep your workspace up to date.\n"
},
"experimentalPostfixCompletions": {
"type": "boolean",
"default": true,
"description": "**This setting is experimental and may be deleted.**\n\nexperimentalPostfixCompletions enables artificial method snippets\nsuch as \"someSlice.sort!\".\n"
},
"gofumpt": {
"type": "boolean",
"default": false,
"description": "gofumpt indicates if we should run gofumpt formatting.\n"
},
"hints": {
"type": "object",
"patternProperties": {
".+": {
"type": "boolean"
}
},
"description": "**This setting is experimental and may be deleted.**\n\nhints specify inlay hints that users want to see. A full list of hints\nthat gopls uses can be found in\n[inlayHints.md](https://github.com/golang/tools/blob/master/gopls/doc/inlayHints.md).\n"
},
"hoverKind": {
"type": "string",
"enum": [
"FullDocumentation",
"NoDocumentation",
"SingleLine",
"Structured",
"SynopsisDocumentation"
],
"default": "FullDocumentation",
"description": "hoverKind controls the information that appears in the hover text.\nSingleLine and Structured are intended for use only by authors of editor plugins.\n\nMust be one of:\n\n* `\"FullDocumentation\"`\n* `\"NoDocumentation\"`\n* `\"SingleLine\"`\n* `\"Structured\"` is an experimental setting that returns a structured hover format.\nThis format separates the signature from the documentation, so that the client\ncan do more manipulation of these fields.\\\nThis should only be used by clients that support this behavior.\n* `\"SynopsisDocumentation\"`\n"
},
"importShortcut": {
"type": "string",
"enum": [
"Both",
"Definition",
"Link"
],
"default": "Both",
"description": "importShortcut specifies whether import statements should link to\ndocumentation or go to definitions.\n\nMust be one of:\n\n* `\"Both\"`\n* `\"Definition\"`\n* `\"Link\"`\n"
},
"linksInHover": {
"type": "boolean | string",
"enum": [
false,
true,
"gopls"
],
"default": true,
"description": "linksInHover controls the presence of documentation links in hover markdown.\n\nMust be one of:\n\n* false: do not show links\n* true: show links to the `linkTarget` domain\n* `\"gopls\"`: show links to gopls' internal documentation viewer\n"
},
"linkTarget": {
"type": "string",
"default": "pkg.go.dev",
"description": "linkTarget is the base URL for links to Go package\ndocumentation returned by LSP operations such as Hover and\nDocumentLinks and in the CodeDescription field of each\nDiagnostic.\n\nIt might be one of:\n\n* `\"godoc.org\"`\n* `\"pkg.go.dev\"`\n\nIf company chooses to use its own `godoc.org`, its address can be used as well.\n\nModules matching the GOPRIVATE environment variable will not have\ndocumentation links in hover.\n"
},
"local": {
"type": "string",
"default": "",
"description": "local is the equivalent of the `goimports -local` flag, which puts\nimports beginning with this string after third-party packages. It should\nbe the prefix of the import path whose imports should be grouped\nseparately.\n\nIt is used when tidying imports (during an LSP Organize\nImports request) or when inserting new ones (for example,\nduring completion); an LSP Formatting request merely sorts the\nexisting imports.\n"
},
"matcher": {
"type": "string",
"enum": [
"CaseInsensitive",
"CaseSensitive",
"Fuzzy"
],
"default": "Fuzzy",
"description": "**This is an advanced setting and should not be configured by most `gopls` users.**\n\nmatcher sets the algorithm that is used when calculating completion\ncandidates.\n\nMust be one of:\n\n* `\"CaseInsensitive\"`\n* `\"CaseSensitive\"`\n* `\"Fuzzy\"`\n"
},
"memoryMode": {
"type": "string",
"default": "",
"description": "**This setting is experimental and may be deleted.**\n\nobsolete, no effect\n"
},
"noSemanticNumber": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nnoSemanticNumber turns off the sending of the semantic token 'number'\n"
},
"noSemanticString": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nnoSemanticString turns off the sending of the semantic token 'string'\n"
},
"semanticTokens": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nsemanticTokens controls whether the LSP server will send\nsemantic tokens to the client.\n"
},
"standaloneTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "standaloneTags specifies a set of build constraints that identify\nindividual Go source files that make up the entire main package of an\nexecutable.\n\nA common example of standalone main files is the convention of using the\ndirective `//go:build ignore` to denote files that are not intended to be\nincluded in any package, for example because they are invoked directly by\nthe developer using `go run`.\n\nGopls considers a file to be a standalone main file if and only if it has\npackage name \"main\" and has a build directive of the exact form\n\"//go:build tag\" or \"// +build tag\", where tag is among the list of tags\nconfigured by this setting. Notably, if the build constraint is more\ncomplicated than a simple tag (such as the composite constraint\n`//go:build tag && go1.18`), the file is not considered to be a standalone\nmain file.\n\nThis setting is only supported when gopls is built with Go 1.16 or later.\n"
},
"staticcheck": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nstaticcheck enables additional analyses from staticcheck.io.\nThese analyses are documented on\n[Staticcheck's website](https://staticcheck.io/docs/checks/).\n"
},
"symbolMatcher": {
"type": "string",
"enum": [
"CaseInsensitive",
"CaseSensitive",
"FastFuzzy",
"Fuzzy"
],
"default": "FastFuzzy",
"description": "**This is an advanced setting and should not be configured by most `gopls` users.**\n\nsymbolMatcher sets the algorithm that is used when finding workspace symbols.\n\nMust be one of:\n\n* `\"CaseInsensitive\"`\n* `\"CaseSensitive\"`\n* `\"FastFuzzy\"`\n* `\"Fuzzy\"`\n"
},
"symbolScope": {
"type": "string",
"enum": [
"all",
"workspace"
],
"default": "all",
"description": "symbolScope controls which packages are searched for workspace/symbol\nrequests. When the scope is \"workspace\", gopls searches only workspace\npackages. When the scope is \"all\", gopls searches all loaded packages,\nincluding dependencies and the standard library.\n\nMust be one of:\n\n* `\"all\"` matches symbols in any loaded package, including\ndependencies.\n* `\"workspace\"` matches symbols in workspace packages only.\n"
},
"symbolStyle": {
"type": "string",
"enum": [
"Dynamic",
"Full",
"Package"
],
"default": "Dynamic",
"description": "**This is an advanced setting and should not be configured by most `gopls` users.**\n\nsymbolStyle controls how symbols are qualified in symbol responses.\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"symbolStyle\": \"Dynamic\",\n...\n}\n```\n\nMust be one of:\n\n* `\"Dynamic\"` uses whichever qualifier results in the highest scoring\nmatch for the given symbol query. Here a \"qualifier\" is any \"/\" or \".\"\ndelimited suffix of the fully qualified symbol. i.e. \"to/pkg.Foo.Field\" or\njust \"Foo.Field\".\n* `\"Full\"` is fully qualified symbols, i.e.\n\"path/to/pkg.Foo.Field\".\n* `\"Package\"` is package qualified symbols i.e.\n\"pkg.Foo.Field\".\n"
},
"templateExtensions": {
"type": "array",
"items": {
"type": "string"
},
"description": "templateExtensions gives the extensions of file names that are treated\nas template files. (The extension\nis the part of the file name after the final dot.)\n"
},
"usePlaceholders": {
"type": "boolean",
"default": false,
"description": "placeholders enables placeholders for function parameters or struct\nfields in completion responses.\n"
},
"verboseOutput": {
"type": "boolean",
"default": false,
"description": "**This setting is for debugging purposes only.**\n\nverboseOutput enables additional debug logging.\n"
},
"vulncheck": {
"type": "string",
"enum": [
"Imports",
"Off"
],
"default": "Off",
"description": "**This setting is experimental and may be deleted.**\n\nvulncheck enables vulnerability scanning.\n\nMust be one of:\n\n* `\"Imports\"`: In Imports mode, `gopls` will report vulnerabilities that affect packages\ndirectly and indirectly used by the analyzed main module.\n* `\"Off\"`: Disable vulnerability analysis.\n"
}
}
},
"go.tags": {
"type": "object",
"properties": {
"tags": {
"type": "string",
"default": "json",
"description": "Comma separated tags to be used by `go.tags.add` command"
},
"options": {
"type": "string",
"default": "json=omitempty",
"description": "Comma separated tag=options pairs to be used by `go.tags.add` command"
},
"transform": {
"type": "string",
"enum": [
"snakecase",
"camelcase"
],
"default": "snakecase",
"description": "Transformation rule used by `go.tags.add` command to add tags"
},
"skipUnexported": {
"type": "boolean",
"default": false,
"description": "If true, skip unexported fields"
}
}
},
"go.tests": {
"type": "object",
"properties": {
"generateFlags": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Additional command line flags to pass to `gotests` for generating tests."
}
}
},
"go.checkForUpdates": {
"description": "Check for gopls updates on start.",
"type": "string",
"default": "install",
"enum": [
"disabled",
"inform",
"ask",
"install"
]
}
}
},
"commands": [
{
"title": "Run gopls.tidy LSP command",
"category": "Go",
"command": "go.gopls.tidy"
},
{
"title": "Generate interface stubs",
"category": "Go",
"command": "go.impl.cursor"
},
{
"title": "Install / update gomodifytags",
"category": "Go",
"command": "go.install.gomodifytags"
},
{
"title": "Install / update goplay",
"category": "Go",
"command": "go.install.goplay"
},
{
"title": "Install / update gopls",
"category": "Go",
"command": "go.install.gopls"
},
{
"title": "Install / update gotests",
"category": "Go",
"command": "go.install.gotests"
},
{
"title": "Install / update impl",
"category": "Go",
"command": "go.install.impl"
},
{
"title": "Install / update all tools",
"category": "Go",
"command": "go.install.tools"
},
{
"title": "Run on go playground",
"category": "Go",
"command": "go.playground"
},
{
"title": "Add tags to struct fields",
"category": "Go",
"command": "go.tags.add"
},
{
"title": "Add tags to struct field in current line",
"category": "Go",
"command": "go.tags.add.line"
},
{
"title": "Add tags to struct fields (prompt)",
"category": "Go",
"command": "go.tags.add.prompt"
},
{
"title": "Remove all tags from struct fields",
"category": "Go",
"command": "go.tags.clear"
},
{
"title": "Remove all tags from struct fields in current line",
"category": "Go",
"command": "go.tags.clear.line"
},
{
"title": "Remove tags from struct fields",
"category": "Go",
"command": "go.tags.remove"
},
{
"title": "Remove tags from struct field in current line",
"category": "Go",
"command": "go.tags.remove.line"
},
{
"title": "Remove tags from struct fields (prompt)",
"category": "Go",
"command": "go.tags.remove.prompt"
},
{
"title": "Generate unit tests for exported functions in file",
"category": "Go",
"command": "go.test.generate.exported"
},
{
"title": "Generate unit tests for file",
"category": "Go",
"command": "go.test.generate.file"
},
{
"title": "Generate unit tests for current function",
"category": "Go",
"command": "go.test.generate.function"
},
{
"title": "Toggle test file",
"category": "Go",
"command": "go.test.toggle"
},
{
"title": "Print extension version",
"category": "Go",
"command": "go.version"
}
],
"snippets": [
{
"language": "go",
"path": "./snippets/go.json"
},
{
"language": "gomod",
"path": "./snippets/gomod.json"
}
]
},
"devDependencies": {
"@types/jest": "^29",
"@types/node": "^22",
"@types/tmp": "^0",
"@types/which": "^3",
"@typescript-eslint/eslint-plugin": "^5.52.0",
"@typescript-eslint/parser": "^5.52.0",
"coc.nvim": "^0.0.82",
"eslint": "^9.12.0",
"eslint-config-josa-typescript": "^0.1.2",
"jest": "^29.7.0",
"rimraf": "^6.0.1",
"tmp": "^0.2.3",
"ts-jest": "^29.2.5",
"typescript": "^5.6.3"
},
"dependencies": {
"tslib": "^2.8.0",
"vscode-languageserver-textdocument": "^1.0.12",
"vscode-uri": "^3.0.8",
"which": "^5.0.0"
}
}