Merge branch 'atom-tree-sitter'

Author: fwcd

BUILDING.md

@@ -35,10 +35,14 @@ Run `./gradlew :editors:vscode:packageExtension` from the repository's top-level
 ## Atom plugin
 
 ### Development/Running
-To install the Atom plugin, run `./gradlew :editors:atom:link`.
+To build and link the Atom plugin into your local packages folder, run:
+
+>`./gradlew :editors:atom:apmLink`
 
 That's it! To use the extension, just reload your Atom window.
 
+> Note that you might have to manually run `apm rebuild` and `apm link` in `editors/atom` if `apm` could not be found on your `PATH` or you are using Windows.
+
 ## Gradle Tasks
 This paragraph assumes that you are familiar with Gradle's [task system](https://docs.gradle.org/current/userguide/build_lifecycle.html). In short: Every task describes an atomic piece of work and may depend on other tasks. Task dependencies will automatically be executed. The following subsections describe the available tasks for each module of this project.
 
@@ -72,4 +76,5 @@ This paragraph assumes that you are familiar with Gradle's [task system](https:/
 | ---- | ------- | ----------- |
 | Prepare | `./gradlew :editors:atom:prepare` | Copies the packaged language server into the extension's directory. |
 | Install | `./gradlew :editors:atom:install` | Installs the npm dependencies of the extension. |
-| Link | `./gradlew :editors:atom:link` | Links the extension into your local Atom package directory. |
+| APM Rebuild | `./gradlew :editors:atom:apmRebuild` | Rebuilds the extension's native modules using Atom's Node version. |
+| APM Link | `./gradlew :editors:atom:apmLink` | Links the extension into your local Atom package directory. |

TROUBLESHOOTING.md

@@ -1,6 +1,14 @@
 # Troubleshooting
 
-## The tests fail with `java.lang.NoSuchMethodError`
+## Atom: Failed to load `ide-kotlin` package grammar
+
+### A dynamic link library (DLL) initialization routine failed / The module was compiled against a different Node.js version using `NODE_MODULE_VERSION` X, but requires `NODE_MODULE_VERSION` Y
+
+Run `./gradlew :editors:atom:apmRebuild` (or inside `editors/atom`: `apm rebuild`).
+
+See also [this issue](https://github.com/tree-sitter/tree-sitter/issues/377) and [the Electron docs](https://electronjs.org/docs/tutorial/using-native-node-modules) on how to rebuild.
+
+## Language Server: The tests fail with `java.lang.NoSuchMethodError`
 * After updating the Kotlin version, there may be multiple copies of the compiler plugin in `lib-kotlin`, for example:
 
 ```
@@ -16,7 +24,7 @@ lib-kotlin
 * If that still does not work, delete the entire `lib-kotlin` folder
     * Gradle will automatically re-download the necessary files once the project is built again
 
-## Running `npm run compile` or `vsce package` fails
+## VSCode: Running `npm run compile` or `vsce package` fails
 If you get the error
 
 ```

editors/atom/build.gradle

@@ -2,12 +2,18 @@ plugins {
     id 'com.github.node-gradle.node' version '2.0.0'
 }
 
-/** Prepares the grammars for packaging. */
-task copyGrammars(type: Sync) {
+/** Prepares the TextMate grammar for packaging. */
+task copyTextMateGrammar(type: Copy) {
     from "$rootDir/grammars/textmate/Kotlin.tmLanguage.json"
     into file('grammars')
 }
 
+/** Prepares the Tree-Sitter grammar for packaging. */
+task copyTreeSitterGrammar(type: Copy) {
+    from "$rootDir/grammars/tree-sitter/tree-sitter-kotlin.cson"
+    into file('grammars')
+}
+
 /** Prepares the language server binaries for packaging. */
 task copyLanguageServer(type: Sync) {
     dependsOn ':server:installDist'
@@ -16,20 +22,30 @@ task copyLanguageServer(type: Sync) {
 }
 
 /** Prepares resources used by the extension. */
-task prepare { dependsOn copyGrammars, copyLanguageServer }
+task prepare { dependsOn copyTextMateGrammar, copyTreeSitterGrammar, copyLanguageServer }
 
 npmInstall { dependsOn prepare }
 
 task install { dependsOn npmInstall }
 
 task build { dependsOn install }
 
+/**
+ * Rebuilds the extension's native modules (the
+ * Tree-Sitter parser) using Atom's node version.
+ */
+task apmRebuild(type: Exec) {
+	dependsOn install
+	workingDir projectDir
+	commandLine 'apm', 'rebuild'
+}
+
 /**
  * Links the extension into your local Atom
  * package directory.
  */
-task link(type: Exec) {
-    dependsOn install
+task apmLink(type: Exec) {
+    dependsOn apmRebuild
     workingDir projectDir
     commandLine 'apm', 'link'
 }

editors/atom/lib/main.js

@@ -15,8 +15,7 @@ class KotlinLanguageClient extends AutoLanguageClient {
     getServerName() { return "KotlinLanguageServer"; }
 
     startServerProcess(projectPath) {
-        // TODO: Windows-support
-        const serverPath = path.join(__dirname, "..", "install", "bin", "kotlin-language-server");
+        const serverPath = path.join(__dirname, "..", "install", "bin", this.correctScriptName("kotlin-language-server"));
         const process = cp.spawn(serverPath);
         process.on("close", () => {
             if (!process.killed) {
@@ -28,6 +27,10 @@ class KotlinLanguageClient extends AutoLanguageClient {
         return process;
     }
 
+    correctScriptName(name) {
+        return name + ((process.platform === "win32") ? ".bat" : "");
+    }
+
     preInitialization(connection) {
         this.updateStatusMessage("Activating KLS...");
     }

editors/atom/package-lock.json

@@ -4,16 +4,21 @@
     "version": "0.2.4",
     "description": "Smart code completion, linting and more for Kotlin",
     "keywords": [],
-    "repository": "https://github.com/fwcd/KotlinLanguageServer",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/fwcd/kotlin-language-server.git"
+    },
     "license": "MIT",
     "engines": {
-        "atom": ">=1.0.0 <2.0.0"
+        "atom": "*",
+        "node": "*"
     },
     "enhancedScopes": [
         "source.kotlin"
     ],
     "dependencies": {
-        "atom-languageclient": "^0.9.9"
+        "atom-languageclient": "^0.9.9",
+        "tree-sitter-kotlin": "^0.2.3"
     },
     "consumedServices": {
         "linter-indie": {

editors/atom/package.json

@@ -5,7 +5,7 @@
     "icon": "resources/Icon128.png",
     "repository": {
         "type": "git",
-        "url": "https://github.com/fwcd/KotlinLanguageServer.git"
+        "url": "https://github.com/fwcd/kotlin-language-server.git"
     },
     "version": "0.2.4",
     "preview": true,

editors/vscode/package.json

@@ -0,0 +1,2 @@
+# Grammars
+Grammar files that are used by the editor extensions.

grammars/README.md

@@ -232,7 +232,7 @@
 			]
 		},
 		"prefix-modifiers": {
-			"match": "\\b(abstract|final|enum|open|annotation|sealed|data|override|final|abstract|lateinit|private|protected|public|internal|inner|companion|noinline|crossinline|vararg|reified|tailrec|operator|infix|inline|external|const|suspend)\\b",
+			"match": "\\b(abstract|final|enum|open|annotation|sealed|data|override|final|lateinit|private|protected|public|internal|inner|companion|noinline|crossinline|vararg|reified|tailrec|operator|infix|inline|external|const|suspend)\\b",
 			"name": "storage.modifier.other.kotlin"
 		},
 		"postfix-modifiers": {

grammars/textmate/Kotlin.tmLanguage.json

@@ -0,0 +1,2 @@
+# TextMate-Grammar
+A Kotlin grammar that is shared between the VSCode- and the Atom-extension.