Link package URIs in terminal output

[audkar]

Stacktrace is printed out to Test Output as plain text. It would be useful if we could click on specific line and navigate to related code.

case:

e.g. test fails with such output in Test Output window:

ERROR: NoSuchMethodError: The method 'call' was called on null.
Receiver: null
Tried calling: call()
dart:core                                                                       Object.noSuchMethod
test/service/geocode_repository_mock.dart 12:7                                  MockGeocodeRepository.locationsFromCoordinates
package:mypackage/src/feature/location_picker/bloc/location_picker_bloc.dart 32:29
<...>

expectation:

clicking package:mypackage/src/feature/location_picker/bloc/location_picker_bloc.dart 32:29 navigates to location_picker_bloc.dart 32

[DanTup]

Unfortunately as far as I can tell, the Output window doesn't seem have an API for attaching source locations to messages. Automatic detection of links is something that would have to be done by VS Code (and would need to provide us an API to supply information for resolving package: paths).

When you run tests, the output should also appear in the Debug Console, which should have its stack frames linked to the source locations - does that work for you?

[audkar]

Maybe that would work. But I am not debugging my tests. I am simply running them. It should not be necessary to use debbuging only to get test result.

Other tools properly registers test tasks:

And also creates new task window for output.

[DanTup]

You can "run" the tests without debugging and still get the output to the Debug Console.

The test tasks you're showing are just running commands in the built-in terminal. There's no way for an extension to provide links for those since they can be any arbitrary task. In order to have links there, VS Code would need to support extensions being able to contribute rules for link detection (which as far as I am aware, it does not currently). I don't believe there's any way we can make package: URIs in the terminal be linked.

The best way would be to run the tests though the Dart debugger (you can "run" without debugging if you don't want them pausing). Not only would this allow for links in the output (in the Debug Console), you'll also see the tests in a tree (see https://dartcode.org/releases/v2-16/#dart-test-runner).

[audkar]

Hmmm 3 points:

1. I don't believe there's any way we can make package: URIs in the terminal be linked.

Not sure what magic these extensions does, but all links points to source files in these screenshots. It's is definitely possible unless VSCode has built-in linking for typescript only. Extension I am using is: Jest.

Top link points to test and bottom one to particular line which failed in test. Also if unexpected crash happens during test then printed out stacktrace is also clickable.

2. The best way would be to run the tests though the Dart debugger

Debug console prints out colored output. But stacktraces of applications crashes is still not clickable. Maybe because it contains full package paths? like:
package:mypackage/src/feature/location_picker/bloc/location_picker_bloc.dart 32:29

3. you'll also see the tests in a tree

Clicking on single test in test tree opens Output. Which contains nonclickable stack traces

[DanTup]

Not sure what magic these extensions does

Ah sorry, in your example above you said package: links, and the answer for that is slightly different.

Anything that starts with package: is not currently linkable - since VS Code doesn't know what a package: URI is, or how that relates to the content on disk. There's no API for us to tell it how to resolve them (some package URIs may be inside your workspace, and some may be elsewhere - for example in your pub cache).

For other links - in some places (like the debug console) VS Code is supposed to detect basic relative links itself. However for tasks, extensions can contribute a "problem matcher" which includes some regular expressions to extract paths too (main so errors/warnings can be extracted from tool output and mapped back to locations).

I'm not totally sure which of these is doing the links in your last screenshot - do those failures appear in the Problems window? If so, they're likely coming from a problem matcher. If not, then I'm not sure why that's linked there but a simple Dart path in the output is not - if you can give me an easy way to reproduce that sort of output, I can take a look.

Debug console prints out colored output. But stacktraces of applications crashes is still not clickable. Maybe because it contains full package paths? like:
package:mypackage/src/feature/location_picker/bloc/location_picker_bloc.dart 32:29

Can you provide a screenshot? Filenames should now be slit from the stacks and shown on the right (see https://dartcode.org/releases/v2-22/#clickable-stack-trace-locations-).

Clicking on single test in test tree opens Output. Which contains nonclickable stack traces

That's correct. The test output is streamed to the Debug Console while running (where they should be clickable), however we also capture all the output for each individual test so you can easily refer back to it later. Unfortunately that has to go into an output pane which we don't have the ability to link. If you're debugging a test I would recommend re-running it and using the debug console. The output view is not great, it was really just a convenience to see the output for a single test if you'd run the whole lot of tests.

[audkar]

If not, then I'm not sure why that's linked there but a simple Dart path in the output is not - if you can give me an easy way to reproduce that sort of output, I can take a look.

Simple example: https://github.com/audkar/jest-example . To reproduce that case I wrote steps in README file. Also you will need latest Node and yarn/npm installed.

[DanTup]

Ok, so I did some testing and I also saw that Dart files were not linked, yet your example JS giles were... So I did some digging, and I found that the filenames are only linked in the terminal/task output if there are no spaces in them. And I don't just mean in what's visible, I mean anywhere in the path.

This is what I see when my project folder is named dart-sample:

Yet if my folder is named dart sample, even though the output still says test/test.dart, it does not become clickable.

I found an issue collecting issues like this in the VS Code tracker, so I added a comment here:

microsoft/vscode#21125 (comment)

So, if you ensure your paths don't have spaces, then running the tests using a task should result in links in the terminal. I would still recommend using the Run/Debug options/CodeLens links and the output in the Debug Console though, it provides more than just running in the terminal with a task.