Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add experimental LSP in order to support Declarative Gradle's DCL files #1320

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

hegyibalint
Copy link
Contributor

Context

Declarative Gradle introduces a new file format dcl.
As this file is based on our DCL language, we need extra tooling to support it.

Currently, we are developing an LSP to handle the file, and this PR introduces a new plugin using this server.

README.md Outdated
Comment on lines 5 to 21
> [!IMPORTANT]
> This is a forked repository that is adding [Declarative Gradle](https://declarative.gradle.org/) support to normal Buildship.
> The following instructions will help you to get started.

### Setup: update site-based installation

> [!TIP]
> This installation method is preferred if you don't want to develop the plugins.

1. Open the "Help > Install New Software..." dialog
2. In the "Work with:" field, paste the following link: https://hegyibalint.github.io/buildship/
3. Under "Buildship Extras - Incubating" there should be a new option: _"Buildship - Gradle Declarative editor support"_
4. Select the option and proceed with the installation
5. After installation, go to the "Settings > Gradle > Experimental features" menu, and select the `lsp-all.jar` file (the file is the result of `shadowJar` assembled by [declarative-lsp](https://github.com/gradle/declarative-lsp), see that repository for further instructions)

The installation can be kept up-to-date, just go to "Help > Check for Updates".
If there is a new snapshot version of the plugin, the dialog will offer the new version.
Copy link
Contributor Author

@hegyibalint hegyibalint Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ This needs to go, I will need to move this.
@donat WDYT, where could we put this so users trying out the feature could discover these instructions?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just add a line here and reference a dedicated document in the docs directory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to docs/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed a single-line TIP admonition about where to find the docs

@hegyibalint hegyibalint marked this pull request as ready for review October 30, 2024 09:03
@donat donat self-requested a review October 30, 2024 10:03
Copy link
Contributor

@donat donat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good!
Please make sure that you use the user/email that you specified when you signed the Eclipse Contributor Agreement. See the GH validation failure for details.

image

Comment on lines 20 to 21
Our main flagship project showcasing the capabilities is the [unified-prototype](https://github.com/gradle/declarative-gradle/tree/main/unified-prototype).
This project is importable by Buildship (even without the declarative support). The project needs the latest
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The unified-prototype folder in there is not the flagship project showcasing declarative. It contains some supporting plugins and builds that are ~ integration tests for it.

Please point to https://declarative.gradle.org/docs/getting-started/samples/ instead

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL

@hegyibalint
Copy link
Contributor Author

I've rebased and reauthored my commit, but still something doesn't add up

@hegyibalint hegyibalint force-pushed the master branch 3 times, most recently from 1cbc741 to 5a17976 Compare November 4, 2024 08:27
@donat donat merged commit f9f91a7 into eclipse-buildship:master Nov 4, 2024
4 checks passed
@donat
Copy link
Contributor

donat commented Nov 4, 2024

@hegyibalint Thank you for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants