Resolve links to workspace files in terminal #13498
Conversation
AlexandraBuzila
force-pushed
the
fix/terminal-links
branch
from
13418c3
to
799f702
Compare
There was a problem hiding this comment.
Thank you @AlexandraBuzila! This definitely improves the file linking in the terminal and the code looks fine to me.
The only thing I miss is that simple file names don't work (e.g. package.json). They only work if they start with ./ as in ./package.json. Is that something we could fix easily? This seems to work in VS Code.
Probably beyond the scope of this PR, but VS Code is a bit more clever when choosing the CWD. VS Code seems to remember the CWD of each command output in the terminal history and keeps it, whereas we switch for the entire terminal. This is nice of course, if you ran a build and then cd'd into another folder, it keeps the correct linking. If this is easy to do (which I don't expect), it may be worth adding. Otherwise, using the current CWD should be good enough for now.
I have added to OPTIONAL remarks inline. If you disagree, feel free to ignore them.
| searchTerm = searchTerm.replace(/^(\.+[\\/])+/, ''); | ||
| // try and find a matching file in the workspace | ||
| const files = (await this.searchService.find(searchTerm, { | ||
| rootUris: [cwd.toString()], |
There was a problem hiding this comment.
I wonder whether it makes sense to add the workspace root(s) here too as a fallback, if no matches are found in CWD?
Try and provide links for workspace files in the terminal, by searching for matching files. Contributed on behalf of STMicroelectronics
AlexandraBuzila
force-pushed
the
fix/terminal-links
branch
from
799f702
to
2969442
Compare
- match files without a starting separator, e.g. 'yarn.lock:25:2'
AlexandraBuzila
force-pushed
the
fix/terminal-links
branch
from
2969442
to
5018d50
Compare
|
Thank you @planger for the review! I also had a look at improving the support for CWD and it wasn't so straightforward. It might be worth investigating this in a separate ticket. |
There was a problem hiding this comment.
Thank you for the update @AlexandraBuzila! Works great and code looks good. Thank you!
What it does
Try and provide links for paths pointing to workspace files in the terminal. The links are created by searching for matching files based on the provided path.
Fixes #13047
Contributed on behalf of STMicroelectronics
How to test
Open the theia workspace and echo some partial paths in the terminal. All paths that can be resolved to a workspace file should have valid links that can be used to open the files from the terminal, e.g.:
Review checklist
Reminder for reviewers