snyk-ls AGENTS.md

Project Overview

snyk-ls (snyk/snyk-ls) is the Snyk Language Server, a Go implementation of the Language Server Protocol (LSP) that IDE plugins (vscode-extension, snyk-intellij-plugin, snyk-eclipse-plugin, snyk-visual-studio-plugin) embed via stdio/JSON-RPC to run Snyk scans. It integrates Snyk Open Source (SCA), Snyk Code (SAST), Snyk Infrastructure as Code (IaC), and Snyk Secrets. OSS and IaC use the Snyk CLI as a data provider; Code uses the Snyk Code API. It also exposes an MCP server (mcp_extension/) and a go-application-framework workflow (ls_extension/) that lets the Snyk CLI invoke the language server as an extension.

Build & Development Commands

make tools               # install golangci-lint, go-licenses, pact, and git hooks
make build                # go build -> build/snyk-ls.<GOOS>.<GOARCH>
make run                  # go run main.go --reportErrors
make test                 # go test -timeout=90m -failfast ./... (+ make test-js)
make test-integ           # alias for INTEG_TESTS=1 make test
make test-smoke           # SMOKE_TESTS=1, all 4 shards
make test-all             # INTEG_TESTS=1 SMOKE_TESTS=1 + all smoke shards
make test-coverage        # adds -cover -coverprofile=build/coverage.out
make test-live PKG=./application/server/ ARGS="-race"   # stream failures as they happen
make lint                 # golangci-lint run ./...
make lint-fix             # go fmt + golangci-lint run --fix
make generate             # go generate ./... (regenerates gomock mocks)
make verify-generate      # fails if `make generate` produces a diff

Tests use testify with a table-driven style (tests := []struct{...}). INTEG_TESTS=1/SMOKE_TESTS=1 (plus SMOKE_SHARD_1..4) gate integration/smoke stages inside make test.

Architecture

• main.go is the entry point: it parses flags, initializes the go-application-framework engine/config, and calls server.Start(engine, ts).
• application/ handles process wiring: application/server (LSP/JSON-RPC handlers), application/di (dependency injection), application/config, application/codeaction, application/watcher, application/entrypoint.
• domain/ holds core business logic: domain/ide (workspace, hover, codelens, treeview, initialize, all LSP-facing) and domain/snyk (scanner, persistence, remediation, delta, for scan orchestration).
• infrastructure/ contains product/backend integrations: code, oss, iac, secrets, cli (Snyk CLI executor), authentication, learn, analytics, snyk_api, featureflag, filesystem, sentry.
• internal/ holds shared utilities: types (core interfaces/mocks), product (product enum), uri, progress, notification, logging, mcp, storage, vcs, fflags, testsupport/testutil.
• ast/ does lightweight source parsing (e.g. ast/maven/parser.go) used for range/dependency resolution.
• ls_extension/ is a go-application-framework workflow letting the Snyk CLI invoke the LS as an extension (WORKFLOWID_LS).
• mcp_extension/ is an MCP server extension exposing Snyk scanning to MCP clients.