Index uninitalized modules

[radeksimko]

Background

The server implements an "indexer" (internally called "walker") which indexes modules by walking the file hierarchy. This allows the server to maintain data about modules which can be used for sourcing (more) relevant schema, providing cross-module references etc.

Use-cases

We have historically only indexed initialized modules (i.e. those which have .terraform directory). This was partially to reduce performance impact in the early versions of LS when we were indexing "synchronously" as part of responding to the initialize request and secondly because we only used the module manifest and provider binaries, not the configuration itself.

A new use case comes into play with cross-module "go-to-definition" and "go-to-references" (introduced in #700), where it would be beneficial to index all modules, even uninitialized ones.

Proposal

• (helpful for reducing the pressure in workspace with many modules) consider removing builtin watcher in favour of LSP-native watching capability
  • Support workspace/didChangeWatchedFiles #15 / internal/service: add support for didChangeWatchedFiles #790
  • Replace internal watcher with LSP's DidChangeWatchedFilesRegistrationOptions #867
  • Reduce noise & improve performance of module hooks #925
• walker: Decouple WalkFunc to reduce walker dependencies #881
• Introduce ast.IsFilenameIndexable(file string) bool to ast package
• replace .terraform conditional logic with some logic which detects any first indexable file in a directory and schedules the module for indexing and skips any other files within that directory

  terraform-ls/internal/terraform/module/walker.go

  Lines 187 to 197 in 40a6ae8

  	if w.isSkippableDir(info.Name()) {
  	w.logger.Printf("skipping %s", path)
  	return filepath.SkipDir
  	}
  	if _, ok := w.excludeModulePaths[dir]; ok {
  	return filepath.SkipDir
  	}
  	if info.Name() == datadir.DataDirName {
  	w.logger.Printf("found module %s", dir)

[danishprakash]

Hey @radeksimko, is there anything I can pick up? I see a few recent enhancement-related issues filed by you, do you have a plan in mind for those or can I look into one of them? Please reply only when you've some time. Thanks.

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.