Checker Framework Language Server Downloader

Overview

This downloader can be used by other plugins that wish to use the Checker Framework Language Server and the Checker Framework to download the latest versions of them, so the actual plugins for editors/IDEs can focus more on editor-specific functions.

Command-line Arguments

Note: when setting the organization/repo of the Checker Framework Language Server, it is required that the targeted repository makes releases containing the distribution zip file of the Checker Framework and a jar file of the CF Language Server.

Required: dest

This is the path to where downloaded files will be stored.

Optional: checkerframework_org

This specifies from which GitHub organization to download the Checker Framework. The default is eisop.

Optional: checkerframework_repo

This specifies from which GitHub repository under checkerframework_org to download the Checker Framework. The default is checker-framework.

Combined with checkerframework_org, the default Checker Framework is eisop/checker-framework.

Optional: languageserver_org

This specifies from which GitHub organization to download the CF Language Server. The default is eisopux.

Optional: languageserver_repo

This specifies from which GitHub repository under languageserver_org to download the CF Language Server. The default is checker-framework-languageserver.

Combined with languageserver_org, the default CF Language Server is eisopux/checker-framework-languageserver.

Example

Download the default Checker Framework and CF Language Server:

java \
    -jar checker-framework-languageserver-downloader.jar \
    -dest /some/env/

Download the typetools version of the Checker Framework and the default CF Language Server:

java \
    -jar checker-framework-languageserver-downloader.jar \
    -dest /some/env/ \
    -checkerframework_org typetools

Development notes

Run

./gradlew assemble

to build build/libs/checker-framework-languageserver-downloader-all.jar.

To format the source code, run $ ./gradlew spotlessApply.

When adding a new downloader for some new dependency, please inherit BaseDownloader and overwrite methods that you wish to change. We assume that the dependency can be downloaded as a release asset from GitHub, and by default the first file will be downloaded.

After this, add arguments to DownloaderMain, and instantiate/call your new class there.

Expected Output

The expected output for the server downloader is: Got language server: {absolute_path}

The expected output for the framework downloader is: Got Checker Framework: {absolute_path}