nixd/Controller: allow setting initial configuration via CLI (#579)

Add a CLI flag `-config` used to set initial configuration. For editor
clients which does not support workspace configuration, the flag could
be used as a fallback.

nixd/include/nixd/CommandLine/Configuration.h

@@ -0,0 +1,13 @@
+/// \file
+/// \brief Allow default configuration being passed via CLI
+
+#include "nixd/Controller/Configuration.h"
+
+#include <exception>
+
+namespace nixd {
+
+/// \brief Parse the CLI flag and initialize the config nixd::DefaultConfig
+nixd::Configuration parseCLIConfig();
+
+} // namespace nixd

nixd/include/nixd/Support/Exception.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include <llvm/Support/Error.h>
+
+#include <exception>
+
+namespace nixd {
+
+class LLVMErrorException : public std::exception {
+  llvm::Error E;
+
+public:
+  LLVMErrorException(llvm::Error E) : E(std::move(E)) {}
+
+  llvm::Error takeError() { return std::move(E); }
+};
+
+} // namespace nixd

nixd/include/nixd/Support/JSON.h

@@ -0,0 +1,38 @@
+#include "Exception.h"
+
+#include <llvm/ADT/StringRef.h>
+#include <llvm/Support/JSON.h>
+
+#include <exception>
+
+namespace nixd {
+
+class JSONParseException : public LLVMErrorException {
+public:
+  JSONParseException(llvm::Error E) : LLVMErrorException(std::move(E)) {}
+
+  [[nodiscard]] const char *what() const noexcept override {
+    return "JSON result cannot be parsed";
+  }
+};
+
+class JSONSchemaException : public LLVMErrorException {
+public:
+  JSONSchemaException(llvm::Error E) : LLVMErrorException(std::move(E)) {}
+
+  [[nodiscard]] const char *what() const noexcept override {
+    return "JSON schema mismatch";
+  }
+};
+
+llvm::json::Value parse(llvm::StringRef JSON);
+
+template <class T> T fromJSON(const llvm::json::Value &V) {
+  llvm::json::Path::Root R;
+  T Result;
+  if (!fromJSON(V, Result, R))
+    throw JSONSchemaException(R.getError());
+  return Result;
+}
+
+} // namespace nixd

nixd/lib/CommandLine/Configuration.cpp

@@ -0,0 +1,32 @@
+/// \file
+/// \brief This file implements CLI initialized configuration.
+
+#include "nixd/CommandLine/Configuration.h"
+#include "nixd/CommandLine/Options.h"
+#include "nixd/Controller/Configuration.h"
+#include "nixd/Support/JSON.h"
+
+#include "lspserver/Logger.h"
+
+#include <llvm/Support/CommandLine.h>
+#include <llvm/Support/JSON.h>
+
+#include <string>
+
+using namespace nixd;
+using namespace llvm::cl;
+
+namespace {
+
+opt<std::string> DefaultConfigJSON{"config",
+                                   desc("JSON-encoded initial configuration"),
+                                   init(""), cat(NixdCategory)};
+
+} // namespace
+
+Configuration nixd::parseCLIConfig() {
+  if (DefaultConfigJSON.empty())
+    return {};
+
+  return nixd::fromJSON<Configuration>(nixd::parse(DefaultConfigJSON));
+}

nixd/lib/Controller/LifeTime.cpp

@@ -5,9 +5,11 @@
 
 #include "nixd-config.h"
 
+#include "nixd/CommandLine/Configuration.h"
 #include "nixd/CommandLine/Options.h"
 #include "nixd/Controller/Controller.h"
 #include "nixd/Eval/Launch.h"
+#include "nixd/Support/Exception.h"
 
 #include "lspserver/Protocol.h"
 
@@ -183,6 +185,13 @@ void Controller::
       evalExprWithProgress(*Client, getDefaultNixOSOptionsExpr(),
                            "nixos options");
   }
+  try {
+    Config = parseCLIConfig();
+  } catch (LLVMErrorException &Err) {
+    lspserver::elog("parse CLI config error: {0}, {1}", Err.what(),
+                    Err.takeError());
+    std::exit(-1);
+  }
   fetchConfig();
 }
 

nixd/lib/Support/JSON.cpp

@@ -0,0 +1,10 @@
+#include "nixd/Support/JSON.h"
+
+#include <llvm/ADT/StringRef.h>
+
+llvm::json::Value nixd::parse(llvm::StringRef JSON) {
+  llvm::Expected<llvm::json::Value> E = llvm::json::parse(JSON);
+  if (!E)
+    throw JSONParseException(E.takeError());
+  return *E;
+}

nixd/lib/meson.build

@@ -4,6 +4,7 @@ libnixd_deps = [ nixd_lsp_server, nixf, llvm, nixt ]
 
 libnixd_lib = library(
     'nixd',
+    'CommandLine/Configuration.cpp',
     'CommandLine/Options.cpp',
     'Controller/AST.cpp',
     'Controller/CodeAction.cpp',
@@ -33,6 +34,7 @@ libnixd_lib = library(
     'Support/AutoCloseFD.cpp',
     'Support/AutoRemoveShm.cpp',
     'Support/ForkPiped.cpp',
+    'Support/JSON.cpp',
     'Support/StreamProc.cpp',
     dependencies: libnixd_deps,
     include_directories: libnixd_include,

nixd/tools/nixd/test/format/format.md

@@ -0,0 +1,62 @@
+# RUN: nixd --lit-test -config='{ "formatting": { "command": ["%S/nixfmt"] } }' < %s | FileCheck %s
+
+<-- initialize(0)
+
+```json
+{
+   "jsonrpc":"2.0",
+   "id":0,
+   "method":"initialize",
+   "params":{
+      "processId":123,
+      "rootPath":"",
+      "capabilities":{
+      },
+      "trace":"off"
+   }
+}
+```
+
+```json
+{
+   "jsonrpc":"2.0",
+   "method":"textDocument/didOpen",
+   "params":{
+      "textDocument":{
+         "uri":"file:///format.nix",
+         "languageId":"nix",
+         "version":1,
+         "text":"{ stdenv,\npkgs}: \n let x=1; in { y = x; }"
+      }
+   }
+}
+```
+
+<-- textDocument/formatting
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 2,
+    "method": "textDocument/formatting",
+    "params": {
+        "textDocument": {
+            "uri": "file:///format.nix"
+        },
+        "options": {
+            "tabSize": 2,
+            "insertSpaces": true,
+            "trimTrailingWhitespace": true,
+            "insertFinalNewline": true
+        }
+    }
+}
+```
+
+```
+CHECK: "newText": "Hello\n",
+```
+
+```json
+{"jsonrpc":"2.0","method":"exit"}
+```

nixd/tools/nixd/test/format/nixfmt

@@ -0,0 +1,2 @@
+#!/bin/sh
+echo "Hello"