feat: New Feature: outline extension BuildItems

[angelozerr]

feat: New Feature: outline extension BuildItems

Fixes #1094

Here a demo with the current PR:

Here how it works:

• you need to open a Java file to start the MicroProfile Language Server (it doesn"t work if the language server is not started). To fix this issue, LSP4IJ must be improved with Provide LSP workspace symbols for non started language server lsp4ij#439
• you need to select Project and libraries in the scope to retrieve BuildItem from the JARs
• As symbols is used for a lot of things like Java class, I decided to fill the list with BuildItem which starts with &

@gastaldi what do you think about that and the demo? Is it enough? Do you need more things?

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[gastaldi]

@angelozerr that looks really cool, good job! Can we somehow also show the javadoc next to the class name (that explains what the build item is for)?

[angelozerr]

@angelozerr that looks really cool, good job!

Thanks!

Can we somehow also show the javadoc next to the class name (that explains what the build item is for)?

I fear that it is not possible by using standard Symbols tab. To do that I think we should develop specific UI, but I don't know if it is easy to do that.

[fbricon]

My fear is about the need to use a specific prefix for triggering the builditem search, in this cas &. It's seems arbitrary/unnatural and would need to be documented extensively. I don't see a way to make it easily discoverable.

[fbricon]

header

[fbricon]

wrong doc

[angelozerr]

My fear is about the need to use a specific prefix for triggering the builditem search, in this cas &. It's seems arbitrary/unnatural and would need to be documented extensively. I don't see a way to make it easily discoverable.

The main problem is that I contribute to Symbol and it is difficult to retrieve BuildItem without special characters because Symbol return Java class. For JAX-REST we use special character@

[angelozerr]

@gastaldi do you think we can merge this feature:

• I decided to use & to search BuildItem, do you like that? Doyou prefer an another character?
• because of limitation of LSP WorkspaceSymbol and IJ too, we cannot shows Javadoc, so do you think it is helpfull to have this feature?

[gastaldi]

@angelozerr I agree with @fbricon's concerns here that using & seems arbitrary and unnatural. Although I understand the reason why it works that way, I think that having a separate window (listing the existing build items along with their description) would be more user-friendly.

[angelozerr]

, I think that having a separate window (listing the existing build items along with their description) would be more user-friendly.

Ok it wil require more work because it will require to develop a custom UI to show Javadoc.

[ia3andy]

@gastaldi could you elaborate on the need for this? using class search with BuildItem gives the same result and its easier to find

[ia3andy]

@gastaldi at some point, I was thinking about using AI to generate a better all BuildItems doc:

• with a generated doc when it's not documented
• with examples of usage from the Quarkus codebase
• showing what's internal and what's not

[gastaldi]

As I reported in #1094, the idea is to have a search mechanism to find the intended build item while developing an extension. Although searching for BuildItem may display the build items on the classpath, it doesn't help much, since you lack examples and you need the sources to understand what it does.

We have a list of all build items with their respective javadocs in https://quarkus.io/guides/all-builditems, that's what I use when trying to find a match for a build item when developing an extension, but having it easily findable in the IDE would be easier

[ia3andy]

@gastaldi what about introducing another plugin for Quarkus extension developers then (and not making the one for users heavier)?