Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

project

package

Go to main page

Versions in this module

v0

v0.0.2

Apr 25, 2026

Changes in this version

type Session

+ func (s *Session) GetLanguageServicesForDocuments(ctx context.Context, uris []lsproto.DocumentUri) []*ls.LanguageService

type Snapshot

+ func (s *Snapshot) FileExists(path string) bool

+ type Watchers struct

+ IgnoredPaths map[string]struct{}

+ OutsideWorkspaceWatchers []*lsproto.FileSystemWatcher

+ WatcherID WatcherID

+ WorkspaceWatchers []*lsproto.FileSystemWatcher

v0.0.1

Apr 11, 2026

Changes in this version

+ type APISnapshotRequest struct

+ CloseProjects *collections.Set[tspath.Path]

+ OpenProjects *collections.Set[string]

+ type ATAStateChange struct

+ Logs *logging.LogTree

+ ProjectID tspath.Path

+ TypingsFiles []string

+ TypingsFilesToWatch []string

+ TypingsInfo *ata.TypingsInfo

+ type CheckerPool struct

+ func (p *CheckerPool) GetChecker(ctx context.Context, file *ast.SourceFile) (*checker.Checker, func())

+ func (p *CheckerPool) GetGlobalDiagnostics() []*ast.Diagnostic

+ func (p *CheckerPool) TakeNewGlobalDiagnostics() bool

+ type Client interface

+ IsActive func() bool

+ ProgressFinish func(message *diagnostics.Message, args ...any)

+ ProgressStart func(message *diagnostics.Message, args ...any)

+ PublishDiagnostics func(ctx context.Context, params *lsproto.PublishDiagnosticsParams) error

+ RefreshCodeLens func(ctx context.Context) error

+ RefreshDiagnostics func(ctx context.Context) error

+ RefreshInlayHints func(ctx context.Context) error

+ SendTelemetry func(ctx context.Context, telemetry lsproto.TelemetryEvent) error

+ UnwatchFiles func(ctx context.Context, id WatcherID) error

+ WatchFiles func(ctx context.Context, id WatcherID, watchers []*lsproto.FileSystemWatcher) error

+ type ConfigFileRegistry struct

+ func (c *ConfigFileRegistry) ForEachTestConfigEntry(cb func(tspath.Path, *TestConfigEntry))

+ func (c *ConfigFileRegistry) ForEachTestConfigFileNamesEntry(cb func(tspath.Path, *TestConfigFileNamesEntry))

+ func (c *ConfigFileRegistry) GetAncestorConfigFileName(path tspath.Path, higherThanConfig string) string

+ func (c *ConfigFileRegistry) GetConfig(path tspath.Path) *tsoptions.ParsedCommandLine

+ func (c *ConfigFileRegistry) GetConfigFileName(path tspath.Path) string

+ func (c *ConfigFileRegistry) GetTestConfigEntry(path tspath.Path) *TestConfigEntry

+ func (c *ConfigFileRegistry) GetTestConfigFileNamesEntry(path tspath.Path) *TestConfigFileNamesEntry

+ type CreateProgramResult struct

+ CheckerPool *CheckerPool

+ Program *compiler.Program

+ UpdateKind ProgramUpdateKind

+ type ExtendedConfigCache = OwnerCache[tspath.Path, *ExtendedConfigCacheEntry, ExtendedConfigParseArgs]

+ func NewExtendedConfigCache() *ExtendedConfigCache

+ type ExtendedConfigCacheEntry struct

+ Hash xxh3.Uint128

+ type ExtendedConfigParseArgs struct

+ Cache tsoptions.ExtendedConfigCache

+ Content string

+ FS FileSource

+ FileName string

+ Host tsoptions.ParseConfigHost

+ ResolutionStack []string

+ type FileChange struct

+ Changes []lsproto.TextDocumentContentChangePartialOrWholeDocument

+ Content string

+ Kind FileChangeKind

+ LanguageKind lsproto.LanguageKind

+ URI lsproto.DocumentUri

+ Version int32

+ type FileChangeKind int

+ const FileChangeKindChange

+ const FileChangeKindClose

+ const FileChangeKindOpen

+ const FileChangeKindSave

+ const FileChangeKindWatchChange

+ const FileChangeKindWatchCreate

+ const FileChangeKindWatchDelete

+ func (k FileChangeKind) IsWatchKind() bool

+ type FileChangeSummary struct

+ Changed collections.Set[lsproto.DocumentUri]

+ Closed collections.Set[lsproto.DocumentUri]

+ Created collections.Set[lsproto.DocumentUri]

+ Deleted collections.Set[lsproto.DocumentUri]

+ IncludesWatchChangeOutsideNodeModules bool

+ InvalidateAll bool

+ Opened lsproto.DocumentUri

+ Reopened lsproto.DocumentUri

+ func (f FileChangeSummary) HasExcessiveNonCreateWatchEvents() bool

+ func (f FileChangeSummary) HasExcessiveWatchEvents() bool

+ func (f FileChangeSummary) IsEmpty() bool

+ type FileContent interface

+ Content func() string

+ Hash func() xxh3.Uint128

+ type FileHandle interface

+ ECMALineInfo func() *sourcemap.ECMALineInfo

+ FileName func() string

+ IsOverlay func() bool

+ Kind func() core.ScriptKind

+ LSPLineMap func() *lsconv.LSPLineMap

+ MatchesDiskText func() bool

+ Version func() int32

+ type FileSource interface

+ FS func() vfs.FS

+ FileExists func(fileName string, path tspath.Path) bool

+ GetAccessibleEntries func(path string) vfs.Entries

+ GetFile func(fileName string) FileHandle

+ GetFileByPath func(fileName string, path tspath.Path) FileHandle

+ type Kind int

+ const KindConfigured

+ const KindInferred

+ func (i Kind) String() string

+ type Overlay struct

+ func (f *Overlay) Content() string

+ func (f *Overlay) ECMALineInfo() *sourcemap.ECMALineInfo

+ func (f *Overlay) FileName() string

+ func (f *Overlay) Hash() xxh3.Uint128

+ func (f *Overlay) LSPLineMap() *lsconv.LSPLineMap

+ func (o *Overlay) IsOverlay() bool

+ func (o *Overlay) Kind() core.ScriptKind

+ func (o *Overlay) MatchesDiskText() bool

+ func (o *Overlay) Text() string

+ func (o *Overlay) Version() int32

+ type OwnerCache struct

+ func NewOwnerCache[K comparable, V any, LoadArgs any](parse func(K, LoadArgs) V, isExpired func(K, V, LoadArgs) bool) *OwnerCache[K, V, LoadArgs]

+ func (c *OwnerCache[K, V, LoadArgs]) Acquire(identity K, owner uint64, value V)

+ func (c *OwnerCache[K, V, LoadArgs]) AddOwner(identity K, owner uint64)

+ func (c *OwnerCache[K, V, LoadArgs]) Has(identity K) bool

+ func (c *OwnerCache[K, V, LoadArgs]) LoadAndAcquire(identity K, owner uint64, loadArgs LoadArgs) V

+ func (c *OwnerCache[K, V, LoadArgs]) Release(identity K, owner uint64)

+ type ParseCache = RefCountCache[ParseCacheKey, *ast.SourceFile, FileHandle]

+ func NewParseCache(options RefCountCacheOptions) *ParseCache

+ type ParseCacheKey struct

+ Hash xxh3.Uint128

+ ScriptKind core.ScriptKind

+ func NewParseCacheKey(options ast.SourceFileParseOptions, hash xxh3.Uint128, ...) ParseCacheKey

+ type PatternsAndIgnored struct

+ type PendingReload int

+ const PendingReloadFileNames

+ const PendingReloadFull

+ const PendingReloadNone

+ type ProgramUpdateKind int

+ const ProgramUpdateKindCloned

+ const ProgramUpdateKindNewFiles

+ const ProgramUpdateKindNone

+ const ProgramUpdateKindSameFileNames

+ type Project struct

+ CommandLine *tsoptions.ParsedCommandLine

+ Kind Kind

+ Program *compiler.Program

+ ProgramLastUpdate uint64

+ ProgramUpdateKind ProgramUpdateKind

+ func NewConfiguredProject(configFileName string, configFilePath tspath.Path, ...) *Project

+ func NewInferredProject(currentDirectory string, compilerOptions *core.CompilerOptions, ...) *Project

+ func NewProject(configFileName string, kind Kind, currentDirectory string, ...) *Project

+ func (p *Project) Clone() *Project

+ func (p *Project) CloneWatchers() *WatchedFiles[*collections.SyncSet[tspath.Path]]

+ func (p *Project) ComputeTypingsInfo() ata.TypingsInfo

+ func (p *Project) ConfigFileName() string

+ func (p *Project) ConfigFilePath() tspath.Path

+ func (p *Project) CreateProgram() CreateProgramResult

+ func (p *Project) DisplayName(cwd string) string

+ func (p *Project) GetProgram() *compiler.Program

+ func (p *Project) GetProjectDiagnostics(ctx context.Context) []*ast.Diagnostic

+ func (p *Project) GetTypeAcquisition() *core.TypeAcquisition

+ func (p *Project) GetUnresolvedImports() *collections.Set[string]

+ func (p *Project) HasFile(fileName string) bool

+ func (p *Project) ID() tspath.Path

+ func (p *Project) Id() tspath.Path

+ func (p *Project) IsSourceFromProjectReference(path tspath.Path) bool

+ func (p *Project) Name() string

+ func (p *Project) ShouldTriggerATA(snapshotID uint64) bool

+ type ProjectCollection struct

+ func (c *ProjectCollection) ConfigFileRegistry() *ConfigFileRegistry

+ func (c *ProjectCollection) ConfiguredProject(path tspath.Path) *Project

+ func (c *ProjectCollection) ConfiguredProjects() []*Project

+ func (c *ProjectCollection) GetDefaultProject(path tspath.Path) *Project

+ func (c *ProjectCollection) GetProjectByPath(projectPath tspath.Path) *Project

+ func (c *ProjectCollection) GetProjectsContainingFile(path tspath.Path) []ls.Project

+ func (c *ProjectCollection) InferredProject() *Project

+ func (c *ProjectCollection) Projects() []*Project

+ func (c *ProjectCollection) ProjectsByPath() *collections.OrderedMap[tspath.Path, *Project]

+ type ProjectCollectionBuilder struct

+ func (b *ProjectCollectionBuilder) DidChangeCustomConfigFileName(logger *logging.LogTree)

+ func (b *ProjectCollectionBuilder) DidChangeFiles(summary FileChangeSummary, logger *logging.LogTree)

+ func (b *ProjectCollectionBuilder) DidRequestFile(uri lsproto.DocumentUri, configuredProjectsOnly bool, logger *logging.LogTree)

+ func (b *ProjectCollectionBuilder) DidRequestProject(projectId tspath.Path, logger *logging.LogTree)

+ func (b *ProjectCollectionBuilder) DidRequestProjectTrees(projectTreeRequest *ProjectTreeRequest, logger *logging.LogTree)

+ func (b *ProjectCollectionBuilder) DidUpdateATAState(ataChanges map[tspath.Path]*ATAStateChange, logger *logging.LogTree)

+ func (b *ProjectCollectionBuilder) Finalize(logger *logging.LogTree) (*ProjectCollection, *ConfigFileRegistry)

+ func (b *ProjectCollectionBuilder) HandleAPIRequest(apiRequest *APISnapshotRequest, logger *logging.LogTree) error

+ type ProjectTreeRequest struct

+ func (p *ProjectTreeRequest) IsAllProjects() bool

+ func (p *ProjectTreeRequest) IsProjectReferenced(projectID tspath.Path) bool

+ func (p *ProjectTreeRequest) Projects() []tspath.Path

+ type RefCountCache struct

+ Options RefCountCacheOptions

+ func NewRefCountCache[K comparable, V any, AcquireArgs any](options RefCountCacheOptions, parse func(K, AcquireArgs) V) *RefCountCache[K, V, AcquireArgs]

+ func (c *RefCountCache[K, V, AcquireArgs]) Acquire(identity K, acquireArgs AcquireArgs) V

+ func (c *RefCountCache[K, V, AcquireArgs]) Deref(identity K)

+ func (c *RefCountCache[K, V, AcquireArgs]) Has(identity K) bool

+ func (c *RefCountCache[K, V, AcquireArgs]) Ref(identity K)

+ type RefCountCacheOptions struct

+ DisableDeletion bool

+ type ResourceRequest struct

+ AutoImports lsproto.DocumentUri

+ ConfiguredProjectDocuments []lsproto.DocumentUri

+ Documents []lsproto.DocumentUri

+ ProjectTree *ProjectTreeRequest

+ Projects []tspath.Path

+ type Session struct

+ func NewSession(init *SessionInit) *Session

+ func (s *Session) APIOpenProject(ctx context.Context, configFileName string, apiFileChanges FileChangeSummary) (*Project, *Snapshot, error)

+ func (s *Session) APIUpdateWithFileChanges(ctx context.Context, apiFileChanges FileChangeSummary) *Snapshot

+ func (s *Session) Close()

+ func (s *Session) Config() lsutil.UserPreferences

+ func (s *Session) Configure(config lsutil.UserPreferences)

+ func (s *Session) DidChangeCompilerOptionsForInferredProjects(ctx context.Context, options *core.CompilerOptions)

+ func (s *Session) DidChangeFile(ctx context.Context, uri lsproto.DocumentUri, version int32, ...)

+ func (s *Session) DidChangeWatchedFiles(ctx context.Context, changes []*lsproto.FileEvent)

+ func (s *Session) DidCloseFile(ctx context.Context, uri lsproto.DocumentUri)

+ func (s *Session) DidOpenFile(ctx context.Context, uri lsproto.DocumentUri, version int32, content string, ...)

+ func (s *Session) DidSaveFile(ctx context.Context, uri lsproto.DocumentUri)

+ func (s *Session) EnqueuePublishGlobalDiagnostics()

+ func (s *Session) FS() vfs.FS

+ func (s *Session) GetCurrentDirectory() string

+ func (s *Session) GetCurrentLanguageServiceWithAutoImports(ctx context.Context, uri lsproto.DocumentUri) (*ls.LanguageService, error)

+ func (s *Session) GetLanguageService(ctx context.Context, uri lsproto.DocumentUri) (*ls.LanguageService, error)

+ func (s *Session) GetLanguageServiceAndProjectsForFile(ctx context.Context, uri lsproto.DocumentUri) (*Project, *ls.LanguageService, []ls.Project, error)

+ func (s *Session) GetLanguageServiceForProjectWithFile(ctx context.Context, project *Project, uri lsproto.DocumentUri) *ls.LanguageService

+ func (s *Session) GetLanguageServiceWithAutoImports(ctx context.Context, baseSnapshot *Snapshot, uri lsproto.DocumentUri) (*ls.LanguageService, error)

+ func (s *Session) GetProjectsForFile(ctx context.Context, uri lsproto.DocumentUri) ([]ls.Project, error)

+ func (s *Session) InitializeWithUserConfig(config lsutil.UserPreferences)

+ func (s *Session) NpmInstall(cwd string, npmInstallArgs []string) ([]byte, error)

+ func (s *Session) ScheduleDiagnosticsRefresh()

+ func (s *Session) Snapshot() *Snapshot

+ func (s *Session) StartPerformanceTelemetry()

+ func (s *Session) Trace(msg string)

+ func (s *Session) UpdateSnapshot(ctx context.Context, overlays map[tspath.Path]*Overlay, change SnapshotChange)

+ func (s *Session) WaitForBackgroundTasks()

+ func (s *Session) WithLanguageServiceAndSnapshot(ctx context.Context, uri lsproto.DocumentUri, ...) (func() error, error)

+ func (s *Session) WithSnapshotLoadingProjectTree(ctx context.Context, requestedProjectTrees *collections.Set[tspath.Path], ...)

+ type SessionInit struct

+ BackgroundCtx context.Context

+ Client Client

+ FS vfs.FS

+ Logger logging.Logger

+ NpmExecutor ata.NpmExecutor

+ Options *SessionOptions

+ ParseCache *ParseCache

+ type SessionOptions struct

+ CurrentDirectory string

+ DebounceDelay time.Duration

+ DefaultLibraryPath string

+ Locale locale.Locale

+ LoggingEnabled bool

+ PositionEncoding lsproto.PositionEncodingKind

+ PushDiagnosticsEnabled bool

+ TelemetryEnabled bool

+ TypingsLocation string

+ WatchEnabled bool

+ type Snapshot struct

+ AutoImports *autoimport.Registry

+ ConfigFileRegistry *ConfigFileRegistry

+ ProjectCollection *ProjectCollection

+ func NewSnapshot(id uint64, fs *SnapshotFS, sessionOptions *SessionOptions, ...) *Snapshot

+ func (s *Snapshot) AutoImportRegistry() *autoimport.Registry

+ func (s *Snapshot) Clone(ctx context.Context, change SnapshotChange, overlays map[tspath.Path]*Overlay, ...) *Snapshot

+ func (s *Snapshot) Converters() *lsconv.Converters

+ func (s *Snapshot) Deref(session *Session)

+ func (s *Snapshot) DirectoryExists(path string) bool

+ func (s *Snapshot) GetDefaultProject(uri lsproto.DocumentUri) *Project

+ func (s *Snapshot) GetDirectories(path string) []string

+ func (s *Snapshot) GetECMALineInfo(fileName string) *sourcemap.ECMALineInfo

+ func (s *Snapshot) GetFile(fileName string) FileHandle

+ func (s *Snapshot) GetPreferences(activeFile string) lsutil.UserPreferences

+ func (s *Snapshot) GetProjectsContainingFile(uri lsproto.DocumentUri) []ls.Project

+ func (s *Snapshot) ID() uint64

+ func (s *Snapshot) LSPLineMap(fileName string) *lsconv.LSPLineMap

+ func (s *Snapshot) ReadDirectory(currentDir string, path string, extensions []string, excludes []string, ...) []string

+ func (s *Snapshot) ReadFile(fileName string) (string, bool)

+ func (s *Snapshot) UseCaseSensitiveFileNames() bool

+ func (s *Snapshot) UserPreferences() lsutil.UserPreferences

+ type SnapshotChange struct

+ type SnapshotFS struct

+ func (s *SnapshotFS) FS() vfs.FS

+ func (s *SnapshotFS) FileExists(fileName string, path tspath.Path) bool

+ func (s *SnapshotFS) GetAccessibleEntries(directoryName string) vfs.Entries

+ func (s *SnapshotFS) GetFile(fileName string) FileHandle

+ func (s *SnapshotFS) GetFileByPath(fileName string, path tspath.Path) FileHandle

+ type TestConfigEntry struct

+ FileName string

+ RetainingConfigs iter.Seq[tspath.Path]

+ RetainingOpenFiles iter.Seq[tspath.Path]

+ RetainingProjects iter.Seq[tspath.Path]

+ type TestConfigFileNamesEntry struct

+ Ancestors map[string]string

+ NearestConfigFileName string

+ type UpdateReason int

+ const UpdateReasonDidChangeCompilerOptionsForInferredProjects

+ const UpdateReasonDidOpenFile

+ const UpdateReasonIdleCleanDiskCache

+ const UpdateReasonRequestedLanguageServiceForFileNotOpen

+ const UpdateReasonRequestedLanguageServicePendingChanges

+ const UpdateReasonRequestedLanguageServiceProjectDirty

+ const UpdateReasonRequestedLanguageServiceProjectNotLoaded

+ const UpdateReasonRequestedLanguageServiceWithAutoImports

+ const UpdateReasonRequestedLoadProjectTree

+ const UpdateReasonUnknown

+ type WatchedFiles struct

+ func NewWatchedFiles[T any](name string, watchKind lsproto.WatchKind, ...) *WatchedFiles[T]

+ func (w *WatchedFiles[T]) Clone(input T) *WatchedFiles[T]

+ func (w *WatchedFiles[T]) ID() WatcherID

+ func (w *WatchedFiles[T]) Name() string

+ func (w *WatchedFiles[T]) WatchKind() lsproto.WatchKind

+ func (w *WatchedFiles[T]) Watchers() (WatcherID, []*lsproto.FileSystemWatcher, map[string]struct{})

+ type WatcherID string