redhat-developer / redhat-developer/quarkus-ls

Avoid hardcoding the template folder for Qute

Open
#840 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug qute
Dominant language
Java
Stars
50
Forks
18
Avg merge
22h 11m
Merged PRs (30d)
3

Description

See https://github.com/redhat-developer/quarkus-ls/pull/834#issuecomment-1488897566

In a few spots, we hard code the folder that the templates are expected to be in. However, in Eclipse, Maven, and Gradle projects, you can configure the resources directory to be in a different location. It would be nice if we avoided hardcoding the value so that qute-ls works properly with projects that change the location of the resource folder.

Some features that currently break when you change the location of the resources folder are:

  • CodeLens in Java files that reference a type-checked template (see https://quarkus.io/guides/qute-reference#typesafe_templates for an example)
  • vscode-quarkus doesn't recognize files in the template folder as Qute templates until a Java file is opened (I'm not sure if this is handled by vscode-quarkus or quarkus-ls)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked pull request discussion and trace where qute-ls assumes the template folder location, including the Java-file CodeLens path and template recognition reported for vscode-quarkus. Compare this with configurable resource directories in Eclipse, Maven, and Gradle projects; done means those features work when the resources directory is moved.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.