Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Aug 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions nixd/include/nixd/CommandLine/Configuration.h
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions nixd/include/nixd/Support/Exception.h
Original file line number Diff line number Diff line change
@@ -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
38 changes: 38 additions & 0 deletions nixd/include/nixd/Support/JSON.h
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions nixd/lib/CommandLine/Configuration.cpp
Original file line number Diff line number Diff line change
@@ -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));
}
9 changes: 9 additions & 0 deletions nixd/lib/Controller/LifeTime.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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();
}

Expand Down
10 changes: 10 additions & 0 deletions nixd/lib/Support/JSON.cpp
Original file line number Diff line number Diff line change
@@ -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;
}
2 changes: 2 additions & 0 deletions nixd/lib/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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,
Expand Down
62 changes: 62 additions & 0 deletions nixd/tools/nixd/test/format/format.md
Original file line number Diff line number Diff line change
@@ -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"}
```
2 changes: 2 additions & 0 deletions nixd/tools/nixd/test/format/nixfmt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/sh
echo "Hello"
Loading