Merge pull request #32 from alexheretic/master

Enhance debugging

Author: mehcode

README.md

@@ -38,6 +38,14 @@ When set you'll be able to see, and remove, this from the package settings. Afte
 
 ![](https://image.ibb.co/jsR65w/rls_Command_Override_Info.png)
 
+## Debugging
+If stuff isn't working you can try **enabling logging** to debug:
+  * Open the atom console _(ctrl-shift-i)_
+  * Enter `atom.config.set('core.debugLSP', true)`
+  * Reload atom _(ctrl-shift-F5)_
+
+This will spit out language server message logging into the atom console. Check if requests/responses are being sent or are incorrect. It will also include any Rls stderr messages (as warnings) which may point to Rls bugs.
+
 ## License
 
 MIT License. See the [license](LICENSE) for more details.

lib/index.js

@@ -168,6 +168,24 @@ function serverEnv(toolchain) {
   return env
 }
 
+/**
+ * Logs stderr if `core.debugLSP` is enabled
+ * TODO should be handled upstream, see https://github.com/atom/atom-languageclient/issues/157
+ * @param {process} process
+ * @return {process}
+ */
+function logStdErr(process) {
+  if (atom.config.get('core.debugLSP')) {
+    process.stderr.on('data', chunk => {
+      chunk.toString()
+        .split('\n')
+        .filter(l => l)
+        .forEach(line => console.warn('Rls-stderr', line))
+    })
+  }
+  return process
+}
+
 /**
  * Check for and install Rls
  * @param [busySignalService]
@@ -320,16 +338,18 @@ class RustLanguageClient extends AutoLanguageClient {
         atom.notifications.addInfo(`Using rls command \`${cmdOverride}\``)
         this._warnedAboutRlsCommandOverride = true
       }
-      return cp.spawn(cmdOverride, {
+      return logStdErr(cp.spawn(cmdOverride, {
         env: serverEnv(),
         shell: true
-      })
+      }))
     }
 
     return checkToolchain(this.busySignalService)
       .then(toolchain => checkRls(this.busySignalService).then(() => toolchain))
       .then(toolchain => {
-        return cp.spawn("rustup", ["run", configToolchain(), "rls"], { env: serverEnv(toolchain) })
+        return logStdErr(cp.spawn("rustup", ["run", configToolchain(), "rls"], {
+          env: serverEnv(toolchain)
+        }))
       })
   }
 }

package-lock.json

@@ -18,7 +18,7 @@
     "atom": ">=1.21.0"
   },
   "dependencies": {
-    "atom-languageclient": "^0.7.0",
+    "atom-languageclient": "^0.7.2",
     "atom-package-deps": "^4.6.0",
     "toml": "^2.3.3",
     "underscore-plus": "^1.6.6"