implement a document symbol provider #45

devoncarew · 2016-08-08T00:15:07Z

Implement a document symbol provider based on the outline view notification. This is the 'go to symbol' command.

devoncarew · 2016-08-08T00:16:06Z

It's ~equivalent to the outline view in other tools, but w/o the UI being persistent (I'm used to using an outline view as an always open bit of UI on the right side of the editor).

DanTup · 2016-08-08T05:40:04Z

src/dart_document_symbol_provider.ts

+			subscriptions: { 'OUTLINE': [file] }
+		});
+
+		// TODO: Improve the presentation to make the file structure clearer?


What does this relate to; all seems fine to me (I think)!

It's not 100% clear from looking at the list when a member is contained in a class. It's a note to myself - we could remove it as well.

Oh, I see, I thought you meant the code presentation. Couldn't we prefix with the class name? Or isn't that what the containerName is supposed to do; does it not get rendered?

I removed this TODO: - looking at this, I think we're returning the right info from the POV of vscode; we'll rely on them to present things well so that user's can easily navigate the file.

DanTup · 2016-08-08T05:48:41Z

@devoncarew Looks good! I made a comment about parameters which I think would make it better?

Also - the mapping you moved to Analyzer.ts; does it all look good to you? I struggled to map many, so ended up picking fairly randomly (eg. module = compilation unit?!).

devoncarew · 2016-08-08T08:02:25Z

I'll take another spin through this tomorrow -

devoncarew · 2016-08-08T23:22:47Z

I took a look at the mapping - I updated one mapping for an enum_value from a constant to an enum. I'm not sure what a label in the analysis server represents. The other choices look good :) I think this is mostly about mapping things for the purpose of displaying icons, so rough approximations are ok :)

devoncarew · 2016-08-08T23:25:39Z

updated -

DanTup · 2016-08-09T05:23:38Z

src/dart_document_symbol_provider.ts

+
+		let name = element.name;
+		if (element.parameters)
+			name = `${name}()`;


What I meant here was, can't we do name = ${name}${parameters}`` (depending on TS handling of undef/null, it might not even need the if?). This way the results will show the parameters of the method too!

The names might get a little long, but it'd be worth experimenting with, to see how it looked. You may also want to see what other language integrations do here -

Yeah; I'll both compare with TS and see how it looks (and also review the workspace one for consistency, I don't think I added parens or anything there).

What I've done in full outline views in the past (where I was concerned about horizontal scrolling), was:

fooBar (a field or getter)

fooBar() (a method w/o args)

fooBar(...) (a method w/ args; the ellipsis is used to save space but indicate that there are params there)

But probably we should just aim for consistency w/ other language integrations into vscode -

Hmmm, TS doesn't even show parens on methods!

What do you think? Copy, or be better?

Hmm, the parens help me know when something's a method vs a field - I guess I'd want to keep those.

Here's a comparison with/without params. I think without is a bit weird (makes them look like they don't have params) however I think without colours the right one is just too busy. Prefer the left?

And the other suggestion:

I'm good w/ either (the ellipsis or the full params). The full params are useful, if a bit busy.

ok, let's go with the full params (I guess it's most accurate, even if lack of overloads make it less confusing) and we'll see how it goes. You're likely to use it more/on bigger files than me in the short-term so if you decide it's bad, do shout (or just change).

DanTup · 2016-08-09T05:36:07Z

I can't merge this inline due to conflicts, will do when at PC tonight. I don't mind testing the params change to see how it looks if I get to it before you.

devoncarew · 2016-08-09T05:43:11Z

Merged to master -

DanTup · 2016-08-09T05:48:28Z

I think AppVeyor got an ISE from GitHub downloading the TS defs!

> dart-code@0.6.3-dev postinstall C:\projects\dart-code
> node ./node_modules/vscode/bin/install
Detected VS Code engine version: ^1.4.0
Error installing vscode.d.ts: Error: Request returned status code: 500
Details: Internal Server Error
npm ERR! Windows_NT 6.3.9600
npm ERR! argv "C:\\Program Files (x86)\\nodejs\\node.exe" "C:\\Program Files (x86)\\nodejs\\node_modules\\npm\\bin\\npm-cli.js" "install"
npm ERR! node v4.4.6
npm ERR! npm  v2.15.5

There's nothing like a reliable build system! Forcing a rebuild..

DanTup · 2016-08-09T05:50:06Z

(Currently the only thing it's doing is running the TS compiler, though seeing if I can run automated tests there is on my list; though I'm concerned I might not be able to Code there... we'll see).

Unsurprisingly passes this time. Thanks!

implement a document symbol provider

bf6caf1

DanTup reviewed Aug 8, 2016
View reviewed changes

DanTup added this to the v0.7 milestone Aug 8, 2016

DanTup added the is enhancement label Aug 8, 2016

DanTup modified the milestones: v0.6.2, 0.7 Aug 8, 2016

merge to master

e2e7fc8

review comments

cab4d04

DanTup reviewed Aug 9, 2016
View reviewed changes

merge to master

d1a1154

DanTup merged commit 7c28be9 into Dart-Code:master Aug 9, 2016

This was referenced Aug 9, 2016

Review outline ranges in document symbol provider #52

Closed

(Request) Add a getOutline method (or similar) to the analysis service dart-lang/sdk#27064

Closed

DanTup mentioned this pull request Mar 7, 2018

Document symbol list includes constructor invocations #656

Closed

simondebbarma mentioned this pull request Feb 13, 2019

'The Dart Analyser has Terminated' occurs anytime I make changes after opening VSC. #1461

Closed

azambuilds mentioned this pull request Mar 27, 2019

The Dart Analyzer has terminated #1564

Closed

aircircle mentioned this pull request May 29, 2019

Cannot launch DevTools without having Chrome installed #1760

Closed

g-yashwanth mentioned this pull request Jul 4, 2019

DevTools fails to launch with a confusing message if Chrome is not installed #1830

Closed

prabhjotSL mentioned this pull request Jul 23, 2019

The Dart Analyzer could not be started in VSCode #1829

Closed

Maksimka101 mentioned this pull request Jul 15, 2020

Exception on vs code startup #2642

Closed

SenexTech mentioned this pull request Nov 13, 2025

Dart Tooling Daemon connection terminates after 60s idle with Norton antivirus installed #5794

Closed

implement a document symbol provider #45

implement a document symbol provider #45

Uh oh!

Conversation

devoncarew commented Aug 8, 2016

Uh oh!

devoncarew commented Aug 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanTup commented Aug 8, 2016

Uh oh!

devoncarew commented Aug 8, 2016

Uh oh!

devoncarew commented Aug 8, 2016

Uh oh!

devoncarew commented Aug 8, 2016

Uh oh!

DanTup Aug 9, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanTup commented Aug 9, 2016

Uh oh!

devoncarew commented Aug 9, 2016

Uh oh!

DanTup commented Aug 9, 2016

Uh oh!

DanTup commented Aug 9, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DanTup Aug 9, 2016 •

edited

Loading