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
|
package langserver
import (
"bytes"
"context"
"fmt"
"log"
"net/url"
"os"
"os/exec"
"path/filepath"
"runtime"
"strconv"
"strings"
"sync"
"time"
"unicode"
"unicode/utf16"
"github.com/reviewdog/errorformat"
"github.com/sourcegraph/jsonrpc2"
"github.com/mattn/go-unicodeclass"
)
type eventType int
const (
eventTypeChange eventType = iota
eventTypeSave
eventTypeOpen
)
type lintRequest struct {
URI DocumentURI
EventType eventType
}
// Config is
type Config struct {
Version int `yaml:"version"`
LogFile string `yaml:"log-file"`
LogLevel int `yaml:"log-level" json:"logLevel"`
Commands *[]Command `yaml:"commands" json:"commands"`
Languages *map[string][]Language `yaml:"languages" json:"languages"`
RootMarkers *[]string `yaml:"root-markers" json:"rootMarkers"`
TriggerChars []string `yaml:"trigger-chars" json:"triggerChars"`
LintDebounce Duration `yaml:"lint-debounce" json:"lintDebounce"`
FormatDebounce Duration `yaml:"format-debounce" json:"formatDebounce"`
// Toggle support for "go to definition" requests.
ProvideDefinition bool `yaml:"provide-definition"`
Filename string `yaml:"-"`
Logger *log.Logger `yaml:"-"`
}
// Config1 is
type Config1 struct {
Version int `yaml:"version"`
Logger *log.Logger `yaml:"-"`
Commands []Command `yaml:"commands"`
Languages map[string]Language `yaml:"languages"`
}
// Language is
type Language struct {
Prefix string `yaml:"prefix" json:"prefix"`
LintFormats []string `yaml:"lint-formats" json:"lintFormats"`
LintStdin bool `yaml:"lint-stdin" json:"lintStdin"`
LintOffset int `yaml:"lint-offset" json:"lintOffset"`
LintOffsetColumns int `yaml:"lint-offset-columns" json:"lintOffsetColumns"`
LintCommand string `yaml:"lint-command" json:"lintCommand"`
LintIgnoreExitCode bool `yaml:"lint-ignore-exit-code" json:"lintIgnoreExitCode"`
LintCategoryMap map[string]string `yaml:"lint-category-map" json:"lintCategoryMap"`
LintSource string `yaml:"lint-source" json:"lintSource"`
LintSeverity int `yaml:"lint-severity" json:"lintSeverity"`
LintWorkspace bool `yaml:"lint-workspace" json:"lintWorkspace"`
LintAfterOpen bool `yaml:"lint-after-open" json:"lintAfterOpen"`
LintOnSave bool `yaml:"lint-on-save" json:"lintOnSave"`
FormatCommand string `yaml:"format-command" json:"formatCommand"`
FormatCanRange bool `yaml:"format-can-range" json:"formatCanRange"`
FormatStdin bool `yaml:"format-stdin" json:"formatStdin"`
SymbolCommand string `yaml:"symbol-command" json:"symbolCommand"`
SymbolStdin bool `yaml:"symbol-stdin" json:"symbolStdin"`
SymbolFormats []string `yaml:"symbol-formats" json:"symbolFormats"`
CompletionCommand string `yaml:"completion-command" json:"completionCommand"`
CompletionStdin bool `yaml:"completion-stdin" json:"completionStdin"`
HoverCommand string `yaml:"hover-command" json:"hoverCommand"`
HoverStdin bool `yaml:"hover-stdin" json:"hoverStdin"`
HoverType string `yaml:"hover-type" json:"hoverType"`
HoverChars string `yaml:"hover-chars" json:"hoverChars"`
Env []string `yaml:"env" json:"env"`
RootMarkers []string `yaml:"root-markers" json:"rootMarkers"`
RequireMarker bool `yaml:"require-marker" json:"requireMarker"`
Commands []Command `yaml:"commands" json:"commands"`
}
// NewHandler create JSON-RPC handler for this language server.
func NewHandler(config *Config) jsonrpc2.Handler {
if config.Logger == nil {
config.Logger = log.New(os.Stderr, "", log.LstdFlags)
}
handler := &langHandler{
loglevel: config.LogLevel,
logger: config.Logger,
commands: *config.Commands,
configs: *config.Languages,
provideDefinition: config.ProvideDefinition,
files: make(map[DocumentURI]*File),
request: make(chan lintRequest),
lintDebounce: time.Duration(config.LintDebounce),
lintTimer: nil,
formatDebounce: time.Duration(config.FormatDebounce),
formatTimer: nil,
conn: nil,
filename: config.Filename,
rootMarkers: *config.RootMarkers,
triggerChars: config.TriggerChars,
lastPublishedURIs: make(map[string]map[DocumentURI]struct{}),
}
go handler.linter()
return jsonrpc2.HandlerWithError(handler.handle)
}
type langHandler struct {
mu sync.Mutex
loglevel int
logger *log.Logger
commands []Command
configs map[string][]Language
provideDefinition bool
files map[DocumentURI]*File
request chan lintRequest
lintDebounce time.Duration
lintTimer *time.Timer
formatDebounce time.Duration
formatTimer *time.Timer
conn *jsonrpc2.Conn
rootPath string
filename string
folders []string
rootMarkers []string
triggerChars []string
// lastPublishedURIs is mapping from LanguageID string to mapping of
// whether diagnostics are published in a DocumentURI or not.
lastPublishedURIs map[string]map[DocumentURI]struct{}
}
// File is
type File struct {
LanguageID string
Text string
Version int
}
// WordAt is
func (f *File) WordAt(pos Position) string {
lines := strings.Split(f.Text, "\n")
if pos.Line < 0 || pos.Line >= len(lines) {
return ""
}
chars := utf16.Encode([]rune(lines[pos.Line]))
if pos.Character < 0 || pos.Character > len(chars) {
return ""
}
prevPos := 0
currPos := -1
prevCls := unicodeclass.Invalid
for i, char := range chars {
currCls := unicodeclass.Is(rune(char))
if currCls != prevCls {
if i <= pos.Character {
prevPos = i
} else {
if char == '_' {
continue
}
currPos = i
break
}
}
prevCls = currCls
}
if currPos == -1 {
currPos = len(chars)
}
return string(utf16.Decode(chars[prevPos:currPos]))
}
func isWindowsDrivePath(path string) bool {
if len(path) < 4 {
return false
}
return unicode.IsLetter(rune(path[0])) && path[1] == ':'
}
func isWindowsDriveURI(uri string) bool {
if len(uri) < 4 {
return false
}
return uri[0] == '/' && unicode.IsLetter(rune(uri[1])) && uri[2] == ':'
}
func fromURI(uri DocumentURI) (string, error) {
u, err := url.ParseRequestURI(string(uri))
if err != nil {
return "", err
}
if u.Scheme != "file" {
return "", fmt.Errorf("only file URIs are supported, got %v", u.Scheme)
}
if isWindowsDriveURI(u.Path) {
u.Path = u.Path[1:]
}
return u.Path, nil
}
func toURI(path string) DocumentURI {
if isWindowsDrivePath(path) {
path = "/" + path
}
return DocumentURI((&url.URL{
Scheme: "file",
Path: filepath.ToSlash(path),
}).String())
}
func (h *langHandler) lintRequest(uri DocumentURI, eventType eventType) {
if h.lintTimer != nil {
h.lintTimer.Reset(h.lintDebounce)
return
}
h.lintTimer = time.AfterFunc(h.lintDebounce, func() {
h.lintTimer = nil
h.request <- lintRequest{URI: uri, EventType: eventType}
})
}
func (h *langHandler) logMessage(typ MessageType, message string) {
h.conn.Notify(
context.Background(),
"window/logMessage",
&LogMessageParams{
Type: typ,
Message: message,
})
}
func (h *langHandler) linter() {
running := make(map[DocumentURI]context.CancelFunc)
for {
lintReq, ok := <-h.request
if !ok {
break
}
cancel, ok := running[lintReq.URI]
if ok {
cancel()
}
ctx, cancel := context.WithCancel(context.Background())
running[lintReq.URI] = cancel
go func() {
uriToDiagnostics, err := h.lint(ctx, lintReq.URI, lintReq.EventType)
if err != nil {
h.logger.Println(err)
return
}
for diagURI, diagnostics := range uriToDiagnostics {
if diagURI == "file:" {
diagURI = lintReq.URI
}
version := 0
if _, ok := h.files[lintReq.URI]; ok {
version = h.files[lintReq.URI].Version
}
h.conn.Notify(
ctx,
"textDocument/publishDiagnostics",
&PublishDiagnosticsParams{
URI: diagURI,
Diagnostics: diagnostics,
Version: version,
})
}
}()
}
}
func matchRootPath(fname string, markers []string) string {
dir := filepath.Dir(filepath.Clean(fname))
var prev string
for dir != prev {
files, _ := os.ReadDir(dir)
for _, file := range files {
name := file.Name()
isDir := file.IsDir()
for _, marker := range markers {
if strings.HasSuffix(marker, "/") {
if !isDir {
continue
}
marker = strings.TrimRight(marker, "/")
if ok, _ := filepath.Match(marker, name); ok {
return dir
}
} else {
if isDir {
continue
}
if ok, _ := filepath.Match(marker, name); ok {
return dir
}
}
}
}
prev = dir
dir = filepath.Dir(dir)
}
return ""
}
func (h *langHandler) findRootPath(fname string, lang Language) string {
if dir := matchRootPath(fname, lang.RootMarkers); dir != "" {
return dir
}
if dir := matchRootPath(fname, h.rootMarkers); dir != "" {
return dir
}
for _, folder := range h.folders {
if len(fname) > len(folder) && strings.EqualFold(fname[:len(folder)], folder) {
return folder
}
}
return h.rootPath
}
func isFilename(s string) bool {
switch s {
case "stdin", "-", "<text>", "<stdin>":
return true
default:
return false
}
}
func (h *langHandler) lint(ctx context.Context, uri DocumentURI, eventType eventType) (map[DocumentURI][]Diagnostic, error) {
f, ok := h.files[uri]
if !ok {
return nil, fmt.Errorf("document not found: %v", uri)
}
fname, err := fromURI(uri)
if err != nil {
return nil, fmt.Errorf("invalid uri: %v: %v", err, uri)
}
fname = filepath.ToSlash(fname)
var configs []Language
if cfgs, ok := h.configs[f.LanguageID]; ok {
for _, cfg := range cfgs {
// if we require markers and find that they dont exist we do not add the configuration
if dir := matchRootPath(fname, cfg.RootMarkers); dir == "" && cfg.RequireMarker == true {
continue
}
switch eventType {
case eventTypeOpen:
// if LintAfterOpen is not true, ignore didOpen
if !cfg.LintAfterOpen {
continue
}
case eventTypeChange:
// if LintOnSave is true, ignore didChange
if cfg.LintOnSave {
continue
}
default:
}
if cfg.LintCommand != "" {
configs = append(configs, cfg)
}
}
}
if cfgs, ok := h.configs[wildcard]; ok {
for _, cfg := range cfgs {
if cfg.LintCommand != "" {
configs = append(configs, cfg)
}
}
}
if len(configs) == 0 {
if h.loglevel >= 1 {
h.logger.Printf("lint for LanguageID not supported: %v", f.LanguageID)
}
return map[DocumentURI][]Diagnostic{}, nil
}
uriToDiagnostics := map[DocumentURI][]Diagnostic{
uri: {},
}
publishedURIs := make(map[DocumentURI]struct{})
for i, config := range configs {
// To publish empty diagnostics when errors are fixed
if config.LintWorkspace {
for lastPublishedURI := range h.lastPublishedURIs[f.LanguageID] {
if _, ok := uriToDiagnostics[lastPublishedURI]; !ok {
uriToDiagnostics[lastPublishedURI] = []Diagnostic{}
}
}
}
if config.LintCommand == "" {
continue
}
command := config.LintCommand
if !config.LintStdin && !config.LintWorkspace && !strings.Contains(command, "${INPUT}") {
command = command + " ${INPUT}"
}
rootPath := h.findRootPath(fname, config)
command = replaceCommandInputFilename(command, fname, rootPath)
formats := config.LintFormats
if len(formats) == 0 {
formats = []string{"%f:%l:%m", "%f:%l:%c:%m"}
}
efms, err := errorformat.NewErrorformat(formats)
if err != nil {
return nil, fmt.Errorf("invalid error-format: %v", config.LintFormats)
}
var cmd *exec.Cmd
if runtime.GOOS == "windows" {
cmd = exec.CommandContext(ctx, "cmd", "/c", command)
} else {
cmd = exec.CommandContext(ctx, "sh", "-c", command)
}
cmd.Dir = rootPath
cmd.Env = append(os.Environ(), config.Env...)
if config.LintStdin {
cmd.Stdin = strings.NewReader(f.Text)
}
b, err := cmd.CombinedOutput()
if err != nil {
if succeeded(err) {
return nil, nil
}
}
// Most of lint tools exit with non-zero value. But some commands
// return with zero value. We can not handle the output is real result
// or output of usage. So efm-langserver ignore that command exiting
// with zero-value. So if you want to handle the command which exit
// with zero value, please specify lint-ignore-exit-code.
if err == nil && !config.LintIgnoreExitCode {
h.logMessage(LogError, "command `"+command+"` exit with zero. probably you forgot to specify `lint-ignore-exit-code: true`.")
continue
}
if h.loglevel >= 3 {
h.logger.Println(command+":", string(b))
}
var source *string
if config.LintSource != "" {
source = &configs[i].LintSource
}
var prefix string
if config.Prefix != "" {
prefix = fmt.Sprintf("[%s] ", config.Prefix)
}
scanner := efms.NewScanner(bytes.NewReader(b))
for scanner.Scan() {
entry := scanner.Entry()
if !entry.Valid {
continue
}
if config.LintStdin && isFilename(entry.Filename) {
entry.Filename = fname
path, err := filepath.Abs(entry.Filename)
if err != nil {
continue
}
path = filepath.ToSlash(path)
if runtime.GOOS == "windows" && strings.ToLower(path) != strings.ToLower(fname) {
continue
} else if path != fname {
continue
}
} else {
entry.Filename = filepath.ToSlash(entry.Filename)
}
word := ""
// entry.Col is expected to be one based, if the linter returns zero based we
// have the ability to add an offset here.
// We only add the offset if the linter reports entry.Col > 0 because 0 means the whole line
if config.LintOffsetColumns > 0 && entry.Col > 0 {
entry.Col = entry.Col + config.LintOffsetColumns
}
if entry.Lnum == 0 {
entry.Lnum = 1 // entry.Lnum == 0 indicates the top line, set to 1 because it is subtracted later
}
if entry.Col == 0 {
entry.Col = 1 // entry.Col == 0 indicates the whole line without column, set to 1 because it is subtracted later
} else {
word = f.WordAt(Position{Line: entry.Lnum - 1 - config.LintOffset, Character: entry.Col - 1})
}
// we allow the config to provide a mapping between LSP types E,W,I,N and whatever categories the linter has
if len(config.LintCategoryMap) > 0 {
entry.Type = []rune(config.LintCategoryMap[string(entry.Type)])[0]
}
severity := 1
if config.LintSeverity != 0 {
severity = config.LintSeverity
}
switch entry.Type {
case 'E', 'e':
severity = 1
case 'W', 'w':
severity = 2
case 'I', 'i':
severity = 3
case 'N', 'n':
severity = 4
}
diagURI := uri
if entry.Filename != "" {
if filepath.IsAbs(entry.Filename) {
diagURI = toURI(entry.Filename)
} else {
diagURI = toURI(filepath.Join(rootPath, entry.Filename))
}
}
if runtime.GOOS == "windows" {
if strings.ToLower(string(diagURI)) != strings.ToLower(string(uri)) && !config.LintWorkspace {
continue
}
} else {
if diagURI != uri && !config.LintWorkspace {
continue
}
}
if config.LintWorkspace {
publishedURIs[diagURI] = struct{}{}
}
uriToDiagnostics[diagURI] = append(uriToDiagnostics[diagURI], Diagnostic{
Range: Range{
Start: Position{Line: entry.Lnum - 1 - config.LintOffset, Character: entry.Col - 1},
End: Position{Line: entry.Lnum - 1 - config.LintOffset, Character: entry.Col - 1 + len([]rune(word))},
},
Code: itoaPtrIfNotZero(entry.Nr),
Message: prefix + entry.Text,
Severity: severity,
Source: source,
})
}
}
// Update state here as no possibility of cancelation
for _, config := range configs {
if config.LintWorkspace {
h.lastPublishedURIs[f.LanguageID] = publishedURIs
break
}
}
return uriToDiagnostics, nil
}
func itoaPtrIfNotZero(n int) *string {
if n == 0 {
return nil
}
s := strconv.Itoa(n)
return &s
}
func (h *langHandler) closeFile(uri DocumentURI) error {
delete(h.files, uri)
return nil
}
func (h *langHandler) saveFile(uri DocumentURI) error {
h.lintRequest(uri, eventTypeSave)
return nil
}
func (h *langHandler) openFile(uri DocumentURI, languageID string, version int) error {
f := &File{
Text: "",
LanguageID: languageID,
Version: version,
}
h.files[uri] = f
return nil
}
func (h *langHandler) updateFile(uri DocumentURI, text string, version *int, eventType eventType) error {
f, ok := h.files[uri]
if !ok {
return fmt.Errorf("document not found: %v", uri)
}
f.Text = text
if version != nil {
f.Version = *version
}
h.lintRequest(uri, eventType)
return nil
}
func (h *langHandler) configFor(uri DocumentURI) []Language {
f, ok := h.files[uri]
if !ok {
return []Language{}
}
c, ok := h.configs[f.LanguageID]
if !ok {
return []Language{}
}
return c
}
func (h *langHandler) addFolder(folder string) {
folder = filepath.Clean(folder)
found := false
for _, cur := range h.folders {
if cur == folder {
found = true
break
}
}
if !found {
h.folders = append(h.folders, folder)
}
}
func (h *langHandler) handle(ctx context.Context, conn *jsonrpc2.Conn, req *jsonrpc2.Request) (result any, err error) {
switch req.Method {
case "initialize":
return h.handleInitialize(ctx, conn, req)
case "initialized":
return
case "shutdown":
return h.handleShutdown(ctx, conn, req)
case "textDocument/didOpen":
return h.handleTextDocumentDidOpen(ctx, conn, req)
case "textDocument/didChange":
return h.handleTextDocumentDidChange(ctx, conn, req)
case "textDocument/didSave":
return h.handleTextDocumentDidSave(ctx, conn, req)
case "textDocument/didClose":
return h.handleTextDocumentDidClose(ctx, conn, req)
case "textDocument/formatting":
return h.handleTextDocumentFormatting(ctx, conn, req)
case "textDocument/rangeFormatting":
return h.handleTextDocumentRangeFormatting(ctx, conn, req)
case "textDocument/documentSymbol":
return h.handleTextDocumentSymbol(ctx, conn, req)
case "textDocument/completion":
return h.handleTextDocumentCompletion(ctx, conn, req)
case "textDocument/definition":
return h.handleTextDocumentDefinition(ctx, conn, req)
case "textDocument/hover":
return h.handleTextDocumentHover(ctx, conn, req)
case "textDocument/codeAction":
return h.handleTextDocumentCodeAction(ctx, conn, req)
case "workspace/executeCommand":
return h.handleWorkspaceExecuteCommand(ctx, conn, req)
case "workspace/didChangeConfiguration":
return h.handleWorkspaceDidChangeConfiguration(ctx, conn, req)
case "workspace/didChangeWorkspaceFolders":
return h.handleDidChangeWorkspaceWorkspaceFolders(ctx, conn, req)
case "workspace/workspaceFolders":
return h.handleWorkspaceWorkspaceFolders(ctx, conn, req)
}
return nil, &jsonrpc2.Error{Code: jsonrpc2.CodeMethodNotFound, Message: fmt.Sprintf("method not supported: %s", req.Method)}
}
func replaceCommandInputFilename(command, fname, rootPath string) string {
ext := filepath.Ext(fname)
ext = strings.TrimPrefix(ext, ".")
command = strings.Replace(command, "${INPUT}", escapeBrackets(fname), -1)
command = strings.Replace(command, "${FILEEXT}", ext, -1)
command = strings.Replace(command, "${FILENAME}", escapeBrackets(filepath.FromSlash(fname)), -1)
command = strings.Replace(command, "${ROOT}", escapeBrackets(rootPath), -1)
return command
}
func escapeBrackets(path string) string {
path = strings.Replace(path, "(", `\(`, -1)
path = strings.Replace(path, ")", `\)`, -1)
return path
}
func succeeded(err error) bool {
exitErr, ok := err.(*exec.ExitError)
// When the context is canceled, the process is killed,
// and the exit code is -1
return ok && exitErr.ExitCode() < 0
}
|