Custom toml files not working

[5peak2me]

If we use a file named xxx.versions.toml to define our own dependency library, only the custom prompt will be displayed, and the dependency prompt of libs.versions.toml will not work.

AS:

[F43nd1r]

Unable to reproduce. Can you provide a minimal sample project?

[5peak2me]

hey, @F43nd1r
I'm sorry for the late reply. In the end, I found the cause of the issue. The background of this problem is as follows: In order to unify the versions of third-party dependency libraries, the configuration file in my project is pulled from the cloud. To prevent frequent commit operations due to changes in the configuration file, I chose not to track changes to this file. Therefore, I placed the standard libs.versions.toml file in the .gradle folder.

After reading the source code and debugging, I found that the main cause of this problem is the findInVersionsTomlKeyValues method in Utils.kt. This method uses the getAllFilesByExt method of FilenameIndex in the IDEA library to search for files with a specific extension. In the getVirtualFilesByNames method of FilenameIndex, the collection of VirtualFile is determined. This is where the problem lies. The Project file index does not include the contents of the ignored .gradle folder, which results in the inability to display the prompt information for the dependency libraries in .gradle/libs.versions.toml.

If we need to resolve this, we can customize the search method, but it depends on whether it aligns with your original design intentions. However, this is indeed a practical use case. Do you have any better suggestions or implementation solutions?

[F43nd1r]

Can you solve this by just using a different location and .gitignoring it there? Or would that also lead to intelliJ excluding it from indexing?

[5peak2me]

Finally, I found a solution. In the findInVersionsTomlKeyValues extension method of the Project, we can manually add a custom Toml file path to the VirtualFileSystem and then check if it's needed. This allows us to achieve the desired scenario. I can submit a pull request (PR) for this feature, and you can consider whether to merge it。

fun Project.findInVersionsTomlKeyValues(getKeyValues: (TomlFile) -> List<TomlKeyValue>, search: String): List<TomlKeyValue> {

    val tomlFiles = FilenameIndex.getAllFilesByExt(this, "toml").apply {
        if (basePath != null) {
            add(VfsUtil.findFile(Path.of(basePath!!, ".gradle", "libs.versions.toml"), true))
        }
    }

    return tomlFiles
        .filter { it.name.endsWith("versions.toml") }
        .map { it.toPsiFile(this) }
        .filterIsInstance<TomlFile>()
        .flatMap { file -> getKeyValues(file).filter { it.key.textMatches(search) } }
}

Here is how it turned out: