Merge branch 'main' of github.com:fwcd/kotlin-language-server into dependency-caching

Author: daplf

.github/workflows/build.yml

@@ -1,11 +1,18 @@
 name: Build
-on: [ push, pull_request ]
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
         java: [ '11', '17' ]
     steps:
       - uses: actions/checkout@v3
@@ -14,6 +21,9 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: ${{ matrix.java }}
-      - uses: gradle/gradle-build-action@v2
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
       - name: Build
-        run: ./gradlew :server:build :shared:build
+        run: ./gradlew :server:build :shared:build -PjavaVersion=${{ matrix.java }}
+      - name: Detekt
+        run: ./gradlew detekt

.github/workflows/deploy.yml

@@ -15,7 +15,8 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: '11'
-      - uses: gradle/gradle-build-action@v2
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
       - name: Build distribution
         run: ./gradlew :server:distZip :grammars:distZip
       - name: Create release

.vscode/launch.json

@@ -30,6 +30,15 @@
             "request": "attach",
             "hostName": "localhost",
             "port": 5005
+        },
+        {
+            "type": "extensionHost",
+            "name": "Run Grammar Dev Extension",
+            "request": "launch",
+            "args": [
+                "--disable-extension=fwcd.kotlin",
+                "--extensionDevelopmentPath=${workspaceFolder}/grammars/vscode-grammar-dev"
+            ]
         }
     ]
 }

CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to the language server will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [1.3.1]
+- Add support for run/debug code lenses
+- Add definition lookup support for JDT symbols
+- Add quick fix for implementing abstract functions
+- Add experimental JDT.LS integration
+
 ## [1.3.0]
 - Bump to Kotlin 1.6
 - Support JDK 17

EDITORS.md

@@ -9,7 +9,27 @@ See [atom-ide-kotlin](https://github.com/fwcd/atom-ide-kotlin).
 ## Emacs
 _using [`lsp-mode`](https://github.com/emacs-lsp/lsp-mode)_
 
-Add the language server executable to your `PATH`.
+There are two ways of setting up the language server with `lsp-mode`:
+- Add the language server executable to your `PATH`. This is useful for development and for always using the latest version from the `main`-branch.
+- Let `lsp-mode` download the server for you (`kotlin-ls`). This will use [the latest release](https://github.com/fwcd/kotlin-language-server/releases/latest).
+
+
+### Run/debug code lenses
+If you use [dap-mode](https://github.com/emacs-lsp/dap-mode), you can set `(setq lsp-kotlin-debug-adapter-enabled t)` to enable the debug adapter. You will need to have [Kotlin Debug Adapter](https://github.com/fwcd/kotlin-debug-adapter) on your system. A simple configuration of `dap-mode` for Kotlin may look like:
+```emacs-lisp
+(require 'dap-kotlin)
+(setq lsp-kotlin-debug-adapter-enabled t)
+;; replace the path below to the path to your Kotlin Debug Adapter
+(setq lsp-kotlin-debug-adapter-path "/path/to/kotlin-debug-adapter")
+```
+
+Then you can activate `lsp-kotlin-lens-mode` to see the Run/Debug code lenses at your main-functions.
+
+
+### Override members (e.g, toString and equals)
+The language server provides a custom protocol extension for finding overridable members of a class (variables and methods). `lsp-mode` provides a function that uses this called `lsp-kotlin-implement-member`. You can run it while hovering a class name, and you will get a menu with all available overridable members. (protip: Bind this function to a key!). If you have [Helm](https://github.com/emacs-helm/helm) or [Ivy](https://github.com/abo-abo/swiper) installed, one of them will be utilized. 
+
+
 
 ## Vim
 _using [`LanguageClient-neovim`](https://github.com/autozimu/LanguageClient-neovim)_
@@ -42,6 +62,25 @@ Add the following to your coc-settings.json file:
 Note that you may need to substitute `kotlin-language-server` with `kotlin-language-server.bat` on Windows.\
 You should also note, that you need a syntax highlighter like [udalov/kotlin-vim](https://github.com/udalov/kotlin-vim) or [sheerun/vim-polyglot](https://github.com/sheerun/vim-polyglot) to work well with coc.
 
+## Neovim
+
+Using Neovim's [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig), register
+the language server using the following.
+
+```lua
+require'lspconfig'.kotlin_language_server.setup{}
+```
+
+If desired, you can also pass in your own defined options to the setup function.
+
+```lua
+require'lspconfig'.kotlin_language_server.setup{
+    on_attach = on_attach,
+    flags = lsp_flags,
+    capabilities = capabilities,
+}
+```
+
 ## Other Editors
 Install a [Language Server Protocol client](https://microsoft.github.io/language-server-protocol/implementors/tools/) for your tool. Then invoke the language server executable in a client-specific way.
 

README.md

@@ -15,11 +15,16 @@ Any editor conforming to LSP is supported, including [VSCode](https://github.com
 
 * See [BUILDING.md](BUILDING.md) for build instructions
 * See [Editor Integration](EDITORS.md) for editor-specific instructions
+* See [Troubleshooting](TROUBLESHOOTING.md) for tips on troubleshooting errors
 * See [Roadmap](https://github.com/fwcd/kotlin-language-server/projects/1) for features, planned additions, bugfixes and changes
 * See [Kotlin Quick Start](https://github.com/fwcd/kotlin-quick-start) for a sample project
 * See [Kotlin Debug Adapter](https://github.com/fwcd/kotlin-debug-adapter) for debugging support on JVM
 * See [tree-sitter-kotlin](https://github.com/fwcd/tree-sitter-kotlin) for an experimental [Tree-Sitter](https://tree-sitter.github.io/tree-sitter/) grammar
 
+## Packaging
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/kotlin-language-server.svg)](https://repology.org/project/kotlin-language-server/versions)
+
 ## This repository needs your help!
 
 [The original author](https://github.com/georgewfraser) created this project while he was considering using Kotlin in his work. He ended up deciding not to and is not really using Kotlin these days though this is a pretty fully-functional language server that just needs someone to use it every day for a while and iron out the last few pesky bugs.
@@ -103,6 +108,7 @@ The Kotlin language server supports some non-standard requests through LSP. See
 ### Global symbols
 ![Global symbols](images/GlobalSymbols.png)
 
+
 ## Authors
 * [georgewfraser](https://github.com/georgewfraser)
 * [fwcd](https://github.com/fwcd)

TROUBLESHOOTING.md

@@ -32,3 +32,13 @@ error TS6059: File '.../KotlinLanguageServer/bin/vscode-extension-src/...' is no
 ```
 
 delete the `bin` folder in the repository directory.
+
+
+## java.lang.OutOfMemoryError when running language server
+The language server is currently a memory hog, mostly due to its use of an in-memory database for symbols (ALL symbols from dependencies etc.!). This makes it not work well for machines with little RAM. If you experience out of memory issues, and still have lots of RAM, the default heap space might be too low. You might want to try tweaking the maximum heap space setting by setting `-Xmx8g` (which sets the heap size to 8GB. Change the number to your needs). This can be done by setting the `JAVA_OPTS` environment variable. 
+
+
+In [the VSCode extension](https://github.com/fwcd/vscode-kotlin), this is in the extension settings in the setting `Kotlin > Java: Opts`. 
+
+
+If you use Emacs, you can try the `setenv` function to set environment variables. Example: `(setenv "JAVA_OPTS" "-Xmx8g")`.

build.gradle

@@ -0,0 +1,57 @@
+import io.gitlab.arturbosch.detekt.Detekt
+import io.gitlab.arturbosch.detekt.DetektCreateBaselineTask
+
+plugins {
+    kotlin("jvm")
+    `maven-publish`
+    id("io.gitlab.arturbosch.detekt") version "1.22.0"
+}
+
+repositories {
+    mavenCentral()
+}
+
+
+detekt {
+    allRules = false // activate all available (even unstable) rules.
+    buildUponDefaultConfig = true // preconfigure defaults
+    parallel = true
+    config = files("$rootDir/detekt.yml")
+    baseline = file("$rootDir/detekt_baseline.xml")
+    source = files(projectDir)
+}
+
+// Registers a baseline for Detekt.
+//
+// The way it works is that you set create "baseline" for Detekt
+// by running this task. It will then creatae a detekt-baseline.xml which
+// contains a list of current issues found within the project.
+// Then every time you run the "detekt" task it will only report errors
+// that are not in the baseline config.
+//
+// We should routinely run this task and commit the baseline file as we
+// fix detekt issues so that we can prevent regressions.
+tasks.register<DetektCreateBaselineTask>("createDetektBaseline") {
+    description = "Overrides current baseline."
+    buildUponDefaultConfig.set(true)
+    ignoreFailures.set(true)
+    parallel.set(true)
+    setSource(files(projectDir))
+    config.setFrom(files("$rootDir/detekt.yml"))
+    baseline.set(file("$rootDir/detekt_baseline.xml"))
+    include("**/*.kt")
+    include("**/*.kts")
+    exclude("shared/build/**/*.*")
+    exclude("server/build/**/*.*")
+    exclude("gradle/plugins/build/**/*.*")
+}
+
+tasks.withType<Detekt>().configureEach {
+    jvmTarget = JavaVersion.VERSION_11.toString()
+    reports {
+        html.required.set(true)
+        md.required.set(true)
+    }
+}
+
+tasks.check.get().dependsOn(tasks.detekt)

build.gradle.kts

@@ -0,0 +1,3 @@
+config:
+  validation: true # verifies that this config file is valid
+  warningsAsErrors: false