Minor stylistic changes and updates to README

Author: fwcd

BUILDING.md

@@ -2,6 +2,7 @@
 Contains the commands require to build this project. Note that you might need to use `gradlew` instead of `./gradlew` when running on `cmd.exe`.
 
 ## Setting up the development environment
+* Java should be installed and located under JAVA_HOME or PATH
 
 ### For language server development
 * `./gradlew install`

README.md

@@ -1,35 +1,35 @@
 # kotlin-language-server
 This project implements a [language server](https://microsoft.github.io/language-server-protocol/) using the internal APIs of the [Kotlin compiler](https://github.com/JetBrains/kotlin/tree/master/compiler).
 
-## Contributing
+## Getting Started
 See [BUILDING.md](BUILDING.md) for build instructions.
 
 ## This repository needs your help!
-[The original author](https://github.com/georgewfraser) created this project while he was considering using Kotlin in my 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.
+[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.
 
 There are two hard parts of implementing a language server:
 - Figuring out the dependencies
 - Incrementally re-compiling as the user types
 
-Dependencies are determined by the [findClassPath](https://github.com/georgewfraser/kotlin-language-server/blob/master/src/main/kotlin/org/javacs/kt/classpath/findClassPath.kt) function, which invokes Maven or the Gradle and tells it to output a list of dependencies in a temporary folder. Currently, Maven and Gradle projects are supported.
+Dependencies are determined by the [findClassPath](src/main/kotlin/org/javacs/kt/classpath/findClassPath.kt) function, which invokes Maven or the Gradle and tells it to output a list of dependencies in a temporary folder. Currently, Maven and Gradle projects are supported.
 
-I get incremental compilation at the file-level by keeping the same `KotlinCoreEnvironment` alive between compilations in [Compiler.kt](https://github.com/georgewfraser/kotlin-language-server/blob/master/src/main/kotlin/org/javacs/kt/Compiler.kt). There is a performance benchmark in [OneFilePerformance.java](https://github.com/georgewfraser/kotlin-language-server/blob/master/src/test/java/org/javacs/kt/OneFilePerformance.java) that verifies this works.
+I get incremental compilation at the file-level by keeping the same `KotlinCoreEnvironment` alive between compilations in [Compiler.kt](src/main/kotlin/org/javacs/kt/Compiler.kt). There is a performance benchmark in [OneFilePerformance.java](src/test/java/org/javacs/kt/OneFilePerformance.java) that verifies this works.
 
 Getting incremental compilation at the expression level is a bit more complicated:
-- Fully compile a file and store in [CompiledFile](https://github.com/georgewfraser/kotlin-language-server/blob/master/src/main/kotlin/org/javacs/kt/CompiledFile.kt):
+- Fully compile a file and store in [CompiledFile](src/main/kotlin/org/javacs/kt/CompiledFile.kt):
     - `val content: String` A snapshot of the source code
     - `val parse: KtFil` The parsed AST
     - `val compile: BindingContext` Additional information about the AST from typechecking
 - After the user edits the file:
     - Find the smallest section the encompasses all the user changes
     - Get the `LexicalScope` encompassing this region from the `BindingContext` that was generated by the full-compile
     - Create a fake, in-memory .kt file with just the expression we want to re-compile
-        - [Add space](https://github.com/georgewfraser/kotlin-language-server/blob/master/src/main/kotlin/org/javacs/kt/CompiledFile.kt#L81) at the top of the file so the line numbers match up
+        - [Add space](src/main/kotlin/org/javacs/kt/CompiledFile.kt#L81) at the top of the file so the line numbers match up
     - Re-compile this tiny fake file
 
-The incremental expression compilation logic is all in [CompiledFile.kt](https://github.com/georgewfraser/kotlin-language-server/blob/master/src/main/kotlin/org/javacs/kt/CompiledFile.kt). The Kotlin AST has a built-in repair API, which seems to be how IntelliJ works, but as far as I can tell this API does not work if the surrounding IntelliJ machinery is not present. Hence I created the "fake tiny file" incremental-compilation mechanism, which seems to be quite fast and predictable.
+The incremental expression compilation logic is all in [CompiledFile.kt](src/main/kotlin/org/javacs/kt/CompiledFile.kt). The Kotlin AST has a built-in repair API, which seems to be how IntelliJ works, but as far as I can tell this API does not work if the surrounding IntelliJ machinery is not present. Hence I created the "fake tiny file" incremental-compilation mechanism, which seems to be quite fast and predictable.
 
-There is an extensive suite of behavioral [tests](https://github.com/georgewfraser/kotlin-language-server/tree/master/src/test/kotlin/org/javacs/kt), which are all implemented in terms of the language server protocol, so you should be able to refactor the code any way you like and the tests should still work.
+There is an extensive suite of behavioral [tests](src/test/kotlin/org/javacs/kt), which are all implemented in terms of the language server protocol, so you should be able to refactor the code any way you like and the tests should still work.
 
 ## Features
 
@@ -51,6 +51,6 @@ There is an extensive suite of behavioral [tests](https://github.com/georgewfras
 ### Global symbols
 ![Global symbols](images/GlobalSymbols.png)
 
-## Requirements
-
-## Known Issues
+## Authors
+* [georgewfraser](https://github.com/georgewfraser)
+* [fwcd](https://github.com/fwcd)

TODO.md

@@ -1,7 +1,13 @@
+# TODO
+
 ## Bugs
 
 ## Features
 - Fix-imports-on-save, default to 'on'
   - See https://godoc.org/golang.org/x/tools/cmd/goimports
 - Rename
-- .kts support with eval
+- .kts support with eval
+
+## Requirements
+
+## Known Issues

src/main/kotlin/org/javacs/kt/CompiledFile.kt

@@ -125,15 +125,15 @@ class CompiledFile(
     }
 
     fun describePosition(offset: Int, oldContent: Boolean = false): String {
-        val c = if (oldContent) parse.text else content 
+        val c = if (oldContent) parse.text else content
         val pos = position(c, offset)
         val file = parse.toPath().fileName
 
         return "$file ${pos.line + 1}:${pos.character + 1}"
     }
 
     private fun describeRange(range: TextRange, oldContent: Boolean = false): String {
-        val c = if (oldContent) parse.text else content 
+        val c = if (oldContent) parse.text else content
         val start = position(c, range.startOffset)
         val end = position(c, range.endOffset)
         val file = parse.toPath().fileName