This pull request wants to change the LuaFileAdditionalResolver.find behaviour. Suppose that there are many directories in LuaSettings.additionalSourcesRoot. Now, LuaFileAdditionalResolver.find will return the first not-null result VirtualFileManager.getInstance().findFileByUrl returned. Here, I want to change it to return the first result in project folder. If there is no VirtualFileManager.getInstance().findFileByUrl result in project folder, like before, it will return first not-null result.
Below is the reason I make this change.
The order of luaFileResolver used in ILuaFileResolver.findLuaFile is defined in emmylua-core.xml:
If we mark the root folder as souces root, and file can be found by LuaFileSourcesRootResolver.
As Lua is widely used in Unity game development, it would be convenient to use Rider to edit C# and Lua code in one IDE. However, if we use Rider, there is no menu like that in Idea or Pycharm (at least I have not found it...). This leads to ILuaFileResolver.findLuaFile using LuaFileAdditionalResolver. In normal cases, it works well. But additionalSourcesRoot is a global setting, it means all of projects will share it. If we have many projects with similar folder structure (for example, many subversion branches of one project in the computer), we must add all of "sources root" in additionalSourcesRoot.
Suppose that we want to go to a file of a LuaRequireReference, as files are similar in each additional source root, VirtualFileManager.findFileByUrl can find the target file in each of it. Here, LuaFileAdditionalResolver.find will return the first not-null result. However, this file may be in another project folder. If we want to jump to edit the reference file in this project folder, there is only two way:
Use Ctrl+Shift+N hotkeys to navigate the file. This is a little bothering.
Remove other folders in additionalSourcesRoot, and then Go To will work. But it is still bothering when we change to edit another project.
So here, I want to change LuaFileAdditionalResolver.find in this PR.
For matching the previous behaviour, variable firstMatch record the first not-null result. And then, it will check the found file's canonicalPath and project.basePath. If this file is in project folder (I'm not sure whether there is a better way except string matching), this function will directly return the file. If no any result in project folder, this function returns firstMatch, which could be null when no file is found.
After this change, LuaFileAdditionalResolver.find will return matched file in project folder firstly. Thus, LuaRequireReference can navigate to the project file in above case.
(It is my first time to read and write Java/Kotlin code. It will be welcome to point out any inappropriate code in this PR.)
This pull request wants to change the
LuaFileAdditionalResolver.findbehaviour. Suppose that there are many directories inLuaSettings.additionalSourcesRoot. Now,LuaFileAdditionalResolver.findwill return the first not-null resultVirtualFileManager.getInstance().findFileByUrlreturned. Here, I want to change it to return the first result in project folder. If there is noVirtualFileManager.getInstance().findFileByUrlresult in project folder, like before, it will return first not-null result. Below is the reason I make this change.The order of
luaFileResolverused inILuaFileResolver.findLuaFileis defined in emmylua-core.xml:If we mark the root folder as souces root, and file can be found by
LuaFileSourcesRootResolver. As Lua is widely used in Unity game development, it would be convenient to use Rider to edit C# and Lua code in one IDE. However, if we use Rider, there is no menu like that in Idea or Pycharm (at least I have not found it...). This leads toILuaFileResolver.findLuaFileusingLuaFileAdditionalResolver. In normal cases, it works well. ButadditionalSourcesRootis a global setting, it means all of projects will share it. If we have many projects with similar folder structure (for example, many subversion branches of one project in the computer), we must add all of "sources root" inadditionalSourcesRoot. Suppose that we want to go to a file of aLuaRequireReference, as files are similar in each additional source root,VirtualFileManager.findFileByUrlcan find the target file in each of it. Here,LuaFileAdditionalResolver.findwill return the first not-null result. However, this file may be in another project folder. If we want to jump to edit the reference file in this project folder, there is only two way:additionalSourcesRoot, and then Go To will work. But it is still bothering when we change to edit another project.So here, I want to change
LuaFileAdditionalResolver.findin this PR. For matching the previous behaviour, variablefirstMatchrecord the first not-null result. And then, it will check the found file'scanonicalPathandproject.basePath. If this file is in project folder (I'm not sure whether there is a better way except string matching), this function will directly return the file. If no any result in project folder, this function returnsfirstMatch, which could be null when no file is found. After this change,LuaFileAdditionalResolver.findwill return matched file in project folder firstly. Thus,LuaRequireReferencecan navigate to the project file in above case.(It is my first time to read and write Java/Kotlin code. It will be welcome to point out any inappropriate code in this PR.)