-
Notifications
You must be signed in to change notification settings - Fork 1
/
package.json
733 lines (733 loc) · 40.3 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
{
"name": "coc-go",
"version": "0.13.3",
"description": "gopls extension for coc",
"author": "Josa Gesell <josa@gesell.me>",
"license": "MIT",
"main": "lib/extension.js",
"repository": {
"type": "git",
"url": "https://github.com/josa42/coc-go.git"
},
"engines": {
"coc": "^0.0.80",
"node": ">=10"
},
"keywords": [
"coc.nvim",
"languageserver",
"gopls",
"go",
"golang",
"vim",
"neovim"
],
"scripts": {
"test": "true || mocha --require ts-node/register '**/*.test.ts'",
"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": "yarn clean && yarn build",
"link:add": "node ./scripts/link.js add",
"link:remove": "node ./scripts/link.js remove",
"update": "yarn run update:snippets && yarn run update:options && yarn run update:readme && yarn 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",
"link": "coc-dev link",
"unlink": "coc-dev unlink"
},
"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"
]
},
{
"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`)"
}
}
},
"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"
},
"allowModfileModifications": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nallowModfileModifications disables -mod=readonly, allowing imports from\nout-of-scope modules. This option will eventually be 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\n[here](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 \"unusedparams\": true // Enable the unusedparams analyzer.\n}\n...\n```\n",
"additionalProperties": false,
"patternProperties": {
"^S[AT]?\\d{4}$": {
"type": "boolean"
}
},
"properties": {
"asmdecl": {
"type": "boolean",
"description": "report mismatches between assembly files and Go declarations",
"default": true
},
"assign": {
"type": "boolean",
"description": "check for useless assignments\nThis 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.",
"default": true
},
"atomic": {
"type": "boolean",
"description": "check for common mistakes using the sync/atomic package\nThe atomic checker looks for assignment statements of the form:\n\tx = atomic.AddUint64(&x, 1)\nwhich are not atomic.",
"default": true
},
"atomicalign": {
"type": "boolean",
"description": "check for non-64-bits-aligned arguments to sync/atomic functions",
"default": true
},
"bools": {
"type": "boolean",
"description": "check for common mistakes involving boolean operators",
"default": true
},
"buildtag": {
"type": "boolean",
"description": "check that +build tags are well-formed and correctly located",
"default": true
},
"cgocall": {
"type": "boolean",
"description": "detect some violations of the cgo pointer passing rules\nCheck 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.",
"default": true
},
"composites": {
"type": "boolean",
"description": "check for unkeyed composite literals\nThis 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}",
"default": true
},
"copylocks": {
"type": "boolean",
"description": "check for locks erroneously passed by value\nInadvertently 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.",
"default": true
},
"deepequalerrors": {
"type": "boolean",
"description": "check for calls of reflect.DeepEqual on error values\nThe 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.",
"default": true
},
"errorsas": {
"type": "boolean",
"description": "report passing non-pointer or non-error values to errors.As\nThe errorsas analysis reports calls to errors.As where the type\nof the second argument is not a pointer to a type implementing error.",
"default": true
},
"fieldalignment": {
"type": "boolean",
"description": "find structs that would take less memory if their fields were sorted\nThis analyzer find structs that can be rearranged to take less memory, and provides\na suggested edit with the optimal order.\n**Disabled by default. Enable it by setting `\"analyses\": {\"fieldalignment\": true}`.**"
},
"httpresponse": {
"type": "boolean",
"description": "check for mistakes using HTTP responses\nA 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.",
"default": true
},
"ifaceassert": {
"type": "boolean",
"description": "detect impossible interface-to-interface type assertions\nThis 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.",
"default": true
},
"loopclosure": {
"type": "boolean",
"description": "check references to loop variables from within nested functions\nThis analyzer checks for references to loop variables from within a\nfunction literal inside the loop body. It checks only instances where\nthe function literal is called in a defer or go statement that is the\nlast statement in the loop body, as otherwise we would need whole\nprogram analysis.\nFor example:\n\tfor i, v := range s {\n\t\tgo func() {\n\t\t\tprintln(i, v) // not what you might expect\n\t\t}()\n\t}\nSee: https://golang.org/doc/go_faq.html#closures_and_goroutines",
"default": true
},
"lostcancel": {
"type": "boolean",
"description": "check cancel func returned by context.WithCancel is called\nThe 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.)",
"default": true
},
"nilfunc": {
"type": "boolean",
"description": "check for useless comparisons between functions and nil\nA useless comparison is one like f == nil as opposed to f() == nil.",
"default": true
},
"printf": {
"type": "boolean",
"description": "check consistency of Printf format strings and arguments\nThe check applies to known functions (for example, those in package fmt)\nas well as any detected wrappers of known functions.\nA function that wants to avail itself of printf checking but is not\nfound by this analyzer's heuristics (for example, due to use of\ndynamic calls) can insert a bogus call:\n\tif false {\n\t\t_ = fmt.Sprintf(format, args...) // enable printf checking\n\t}\nThe -funcs flag specifies a comma-separated list of names of additional\nknown formatting functions or methods. If the name contains a period,\nit must denote a specific function using one of the following forms:\n\tdir/pkg.Function\n\tdir/pkg.Type.Method\n\t(*dir/pkg.Type).Method\nOtherwise the name is interpreted as a case-insensitive unqualified\nidentifier such as \"errorf\". Either way, if a listed name ends in f, the\nfunction is assumed to be Printf-like, taking a format string before the\nargument list. Otherwise it is assumed to be Print-like, taking a list\nof arguments with no format string.",
"default": true
},
"shadow": {
"type": "boolean",
"description": "check for possible unintended shadowing of variables\nThis 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}\n**Disabled by default. Enable it by setting `\"analyses\": {\"shadow\": true}`.**"
},
"shift": {
"type": "boolean",
"description": "check for shifts that equal or exceed the width of the integer",
"default": true
},
"simplifycompositelit": {
"type": "boolean",
"description": "check for composite literal simplifications\nAn 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.",
"default": true
},
"simplifyrange": {
"type": "boolean",
"description": "check for range statement simplifications\nA 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.",
"default": true
},
"simplifyslice": {
"type": "boolean",
"description": "check for slice simplifications\nA 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.",
"default": true
},
"sortslice": {
"type": "boolean",
"description": "check the argument type of sort.Slice\nsort.Slice requires an argument of a slice type. Check that\nthe interface{} value passed to sort.Slice is actually a slice.",
"default": true
},
"stdmethods": {
"type": "boolean",
"description": "check signature of methods of well-known interfaces\nSometimes 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 func (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",
"default": true
},
"stringintconv": {
"type": "boolean",
"description": "check for string(int) conversions\nThis 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.",
"default": true
},
"structtag": {
"type": "boolean",
"description": "check that struct field tags conform to reflect.StructTag.Get\nAlso report certain struct tags (json, xml) used with unexported fields.",
"default": true
},
"testinggoroutine": {
"type": "boolean",
"description": "report calls to (*testing.T).Fatal from goroutines started by a test.\nFunctions 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:\nfunc TestFoo(t *testing.T) {\n go func() {\n t.Fatal(\"oops\") // error: (*T).Fatal called from non-test goroutine\n }()\n}",
"default": true
},
"tests": {
"type": "boolean",
"description": "check for common mistaken usages of tests and examples\nThe tests checker walks Test, Benchmark 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.",
"default": true
},
"unmarshal": {
"type": "boolean",
"description": "report passing non-pointer or non-interface values to unmarshal\nThe unmarshal analysis reports calls to functions such as json.Unmarshal\nin which the argument type is not a pointer or an interface.",
"default": true
},
"unreachable": {
"type": "boolean",
"description": "check for unreachable code\nThe 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.",
"default": true
},
"unsafeptr": {
"type": "boolean",
"description": "check for invalid conversions of uintptr to unsafe.Pointer\nThe 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.",
"default": true
},
"unusedparams": {
"type": "boolean",
"description": "check for unused parameters of functions\nThe unusedparams analyzer checks functions to see if there are\nany parameters that are not being used.\nTo reduce false positives it ignores:\n- methods\n- parameters that do not have a name or are underscored\n- functions in test files\n- functions with empty bodies or those with just a return stmt\n**Disabled by default. Enable it by setting `\"analyses\": {\"unusedparams\": true}`.**"
},
"unusedresult": {
"type": "boolean",
"description": "check for unused results of calls to some functions\nSome functions like fmt.Errorf return a result and have no side effects,\nso it is always a mistake to discard the result. This analyzer reports\ncalls to certain functions in which the result of the call is ignored.\nThe set of functions may be controlled using flags.",
"default": true
},
"fillreturns": {
"type": "boolean",
"description": "suggested fixes for \"wrong number of return values (want %d, got %d)\"\nThis 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.",
"default": true
},
"nonewvars": {
"type": "boolean",
"description": "suggested fixes for \"no new vars on left side of :=\"\nThis 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",
"default": true
},
"noresultvalues": {
"type": "boolean",
"description": "suggested fixes for \"no result values expected\"\nThis checker provides suggested fixes for type errors of the\ntype \"no result values expected\". For example:\n\tfunc z() { return nil }\nwill turn into\n\tfunc z() { return }",
"default": true
},
"undeclaredname": {
"type": "boolean",
"description": "suggested fixes for \"undeclared name: <>\"\nThis checker provides suggested fixes for type errors of the\ntype \"undeclared name: <>\". It will insert a new statement:\n\"<> := \".",
"default": true
},
"fillstruct": {
"type": "boolean",
"description": "note incomplete struct initializations\nThis analyzer provides diagnostics for any struct literals that do not have\nany fields initialized. Because the suggested fix for this analysis is\nexpensive to compute, callers should compute it separately, using the\nSuggestedFix function below.",
"default": true
}
}
},
"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\nCan contain any of:\n\n* `\"bounds\"` controls bounds checking diagnostics.\n\n* `\"escape\"` controls diagnostics about escape choices.\n\n* `\"inline\"` controls diagnostics about inlining choices.\n\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 code lenses. See the\n\"Code Lenses\" section of the\n[Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md)\nfor the list of supported lenses.\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"codelens\": {\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
},
"tidy": {
"type": "boolean",
"default": true
},
"upgrade_dependency": {
"type": "boolean",
"default": true
},
"vendor": {
"type": "boolean",
"default": true
}
}
},
"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"
},
"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\nExamples:\nExclude node_modules: `-node_modules`\nInclude only project_a: `-` (exclude everything), `+project_a`\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 instructs `gopls` to adjust the scope of the\nworkspace to find the best available module root. `gopls` first looks for\na go.mod file in any parent directory of the workspace folder, expanding\nthe scope to that directory if it exists. If no viable parent directory is\nfound, gopls will check if there is exactly one child directory containing\na go.mod file, narrowing the scope to that directory if it exists.\n"
},
"experimentalDiagnosticsDelay": {
"type": "string",
"default": "250ms",
"description": "**This setting is experimental and may be deleted.**\n\nexperimentalDiagnosticsDelay 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"
},
"experimentalPackageCacheKey": {
"type": "boolean",
"default": true,
"description": "**This setting is experimental and may be deleted.**\n\nexperimentalPackageCacheKey controls whether to use a coarser cache key\nfor package type information to increase cache hits. This setting removes\nthe user's environment, build flags, and working directory from the cache\nkey, which should be a safe change as all relevant inputs into the type\nchecking pass are already hashed into the key. This is temporarily guarded\nby an experiment because caching behavior is subtle and difficult to\ncomprehensively test.\n"
},
"experimentalWorkspaceModule": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nexperimentalWorkspaceModule opts a user into the experimental support\nfor multi-module workspaces.\n"
},
"gofumpt": {
"type": "boolean",
"default": false,
"description": "gofumpt indicates if we should run gofumpt formatting.\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\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",
"default": true,
"description": "linksInHover toggles the presence of links to documentation in hover.\n"
},
"linkTarget": {
"type": "string",
"default": "pkg.go.dev",
"description": "linkTarget controls where documentation links go.\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"
},
"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"
},
"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"
},
"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"
},
"staticcheck": {
"type": "boolean",
"default": false,
"description": "**This setting is experimental and may be deleted.**\n\nstaticcheck enables additional analyses from staticcheck.io.\n"
},
"symbolMatcher": {
"type": "string",
"enum": [
"CaseInsensitive",
"CaseSensitive",
"Fuzzy"
],
"default": "Fuzzy",
"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* `\"Fuzzy\"`\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\n* `\"Full\"` is fully qualified symbols, i.e.\n\"path/to/pkg.Foo.Field\".\n\n* `\"Package\"` is package qualified symbols i.e.\n\"pkg.Foo.Field\".\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"
}
}
},
"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": "[EXPERIMENTAL] Check for gopls updates on start.",
"type": "string",
"default": "disabled",
"enum": [
"disabled",
"inform",
"ask",
"install"
]
}
}
},
"commands": [
{
"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/mocha": "^8.0.3",
"@types/node": "^14.11.1",
"@types/node-fetch": "^2.5.7",
"@types/tmp": "^0.2.0",
"@types/which": "^2.0.0",
"@typescript-eslint/eslint-plugin": "^4.1.1",
"@typescript-eslint/parser": "^4.1.1",
"coc-dev-tools": "^0.1.0",
"coc.nvim": "0.0.80",
"eslint": "^7.9.0",
"eslint-config-josa-typescript": "^0.1.2",
"mocha": "^8.1.3",
"rimraf": "^3.0.2",
"tmp": "^0.2.1",
"ts-node": "^9.0.0",
"typescript": "~4.1.2"
},
"dependencies": {
"node-fetch": "^2.6.1",
"tslib": "^2.0.0",
"vscode-languageserver-textdocument": "^1.0.1",
"vscode-uri": "^3.0.1",
"which": "^2.0.2"
}
}