Linkify terminal paths without any path separators

[Tyriar]

Follow up from #22528, #22602

Currently we're limited to the current workspace (knowledge of shell's cwd is blocked on #20676), but it would be good to linkify files in the current directory that don't have path separators. This would linkify the files in ls for example:

❯ ls
build       node_modules  scripts  appveyor.yml     issue_template.md  npm-shrinkwrap.json  product.json           tsfmt.json
extensions  out           src      CONTRIBUTING.md  jsconfig.json      OSSREADME.json       README.md              tslint.json
i18n        resources     test     gulpfile.js      LICENSE.txt        package.json         ThirdPartyNotices.txt

[lifez]

@Tyriar Can i take this ?. Could you guide me a little

[Tyriar]

@lifez sure that would be great 😃

I'm a little concerned that this might be bad for perf if we're constantly checking whether files exist like this. It would be good to look into whether we could cache the results of an pfs.readdir so we don't need to stat each individual file. Let me know if you need more guidance.

[lifez]

@Tyriar Linkify is mean we can click to file within vscode terminal ?

[Tyriar]

@lifez yes linkify means add a link to the path.

[Tyriar]

Current we don't have knowledge of the cwd but eventually we will #27107 so if we're building some cache we would want to allow support for different cwd. Also when are they invalidated? Should the file watcher come into play here?

[Tyriar]

Related #25024

[ssbarnea]

This bug is more importan than it gives impression in its description before it breaks even linters with standardized output, like:

scripts/compare-reviews.py:64:1: H405: multi line docstring summary not separated with an empty line
testenv-client:68:80: E501 line too long (100 > 79 characters)

First one is linkified but the second one is not, just because it does not have a slash in the file name.

[Tyriar]

I would like to work on this. What would be a good starting point for adding this functionality?

@sohailrajdev97 I closed #82903 in favor of this one as thinking about it more I don't think we should invest in links specifically for java and instead improve all languages. I think this issue has a number of things we can do:

• Firstly we will need to be able to disable the current local link validation step that checks the file system, right now there is enableFileLinks which allows disabling outright:
  

  vscode/src/vs/workbench/contrib/terminal/browser/terminal.contribution.ts

  Line 320 in d0cbf56

  'terminal.integrated.enableFileLinks': {

  
  We could improve this by still allowing links but not validate them (until clicked). An exception or notification is probably shown when files don't exist right now, this might need some thinking if failures will become more prevalent.
• After the above is done we could allow just file names to be supported as there is no longer the risk on the file system
• An idea that came to me when reading Linkify unqualified file names in the terminal #82903 was that for files that do not have exact matches (cwd + file_link) we could open a quick pick and search the workspace for it, essentially a shortcut for ctrl/cmd+p

The above could be tackled as individual steps/PRs.

All terminal link code is in https://github.com/microsoft/vscode/blob/master/src/vs/workbench/contrib/terminal/browser/terminalLinkHandler.ts, it used this API in xterm.js to add the links: https://github.com/xtermjs/xterm.js/blob/d9f58c0dbbd73145779586a9a4caddba3871ffc1/typings/xterm.d.ts#L524-L534

[sohailrajdev97]

@Tyriar As we won't be validating the links with the filesystem until it's clicked, what can be the expected behavior when a link which points to a directory is clicked ?

In other words, how will this be handled in the new scenario ?

[Tyriar]

@sohailrajdev97 I actually did some thinking and a big write up on a proposal to change how links work all together in xterm.js which should also allow us to tackle this problem in a nicer way as well as fix a bunch of other problems/inconsistencies with the terminal's link detection. See xtermjs/xterm.js#583 (comment)

For that particular case in the new system that validation would happen on hover.

[Tyriar]

This is done 🎉 any link that doesn't have a high accuracy link will revert to searching the workspace and opening the file if there's one match or the quick pick if there are multiple.