diff --git a/README.md b/README.md
index bbcb34456..0d3c88371 100644
--- a/README.md
+++ b/README.md
@@ -6,87 +6,26 @@
-# WIP Note 🚧
-
-`nixd-next` is still WIP! Please see https://github.com/nix-community/nixd/issues/283 for the migration plan.
-
-[Released versions](https://github.com/nix-community/nixd/releases/) contain stable nixd code. If you encountered any problem with this nightly version, please use to our released version in nixpkgs.
-
-The following description is suitable for stable releases, but outdated for `nixd-next` (i.e. this version).
-
## About
-This is a Nix language server that directly uses (i.e., is linked with) the official Nix library (https://github.com/NixOS/nix).
+This is a feature-rich nix language server interoperating with C++ nix.
Some notable features provided by linking with the Nix library include:
- Nixpkgs option support, for all option system (NixOS/home-manager/flake-parts).
-- Diagnostics and evaluation that produce identical results as the real Nix command.
+- Nixpkgs package complete, lazily evaluated.
- Shared eval caches (flake, file) with your system's Nix.
-- Native support for cross-file analysis (goto definition to locations in nixpkgs).
-- Precise Nix language support. We do not maintain "yet another parser & evaluator".
-- Support for built-ins, including Nix plugins.
-
-
-## Features Preview
-
-
-Home-manager options auto-completion & goto declaration
-
-
-
-See how to configure option system: https://github.com/nix-community/nixd/blob/main/nixd/docs/user-guide.md#options
-
-Write a package using nixd
-
-
-
-Native cross-file analysis
-
-
-
-We support goto-definition on nix derivations!
-Just `Ctrl + click` to see where is a package defined.
-
-
-
-And also for nix lambda:
-
-
-
-See how to configure the evaluator for cross-file analysis: https://github.com/nix-community/nixd/blob/main/nixd/docs/user-guide.md#evaluation
-
-Handle evaluations exactly same as nix evaluator
-
-
-
-Support *all* builtins
-
-
-
-And diagnostic:
-
-
+- Support for cross-file analysis (goto definition to locations in nixpkgs).
-
NixOS Configuration
@@ -43,7 +42,7 @@ nix profile install github:nixos/nixpkgs#nixd
-And our flake.nix provides a package named `nixd`, and an overlay to nixpkgs that add the `nixd` package.
+And our flake.nix provides a package named `nixd` with "unstable" experience.
Note that please do NOT override nixpkgs revision for nixd inputs.
The source code have tested on specific version on NixOS/nix, which may not work at your version.
@@ -65,186 +64,63 @@ nix build -L .#
### Configuration
-- [Configuration Examples](/nixd/docs/examples)
-
We support LSP standard `workspace/configuration` for server configurations.
-Configuration overview:
-
-```jsonc
-{
- // The evaluation section, provide auto completion for dynamic bindings.
- "eval": {
- "target": {
- // Accept args as "nix eval"
- "args": [],
- // "nix eval"
- "installable": ""
- },
- // Extra depth for evaluation
- "depth": 0,
- // The number of workers for evaluation task.
- "workers": 3
- },
- "formatting": {
- // Which command you would like to do formatting
- "command": "nixpkgs-fmt"
- },
- // Tell the language server your desired option set, for completion
- // This is lazily evaluated.
- "options": {
- // Enable option completion task.
- // If you are writing a package, disable this
- "enable": true,
- "target": {
- // Accept args as "nix eval"
- "args": [],
- // "nix eval"
- "installable": ""
- }
- }
-}
-```
+### Default configuration
-Note: we support a configuration file named `.nixd.json` at your workspace directory.
-This is a feature requested by nvim users.
+Most important part of package/options features is the path of "nixpkgs".
+By default, this is search via standard nix search path.
+That is, find nixpkgs via ``.
-Typically, you can write a nix file, and evaluate the result into `.nixd.json`, because json does not support comments:
+For nix-channels users: nixos option & package features shall work out of box, without any extra effort.
+For nix-flake users: (suggestion) you can set $NIX_PATH env to your flake input. e.g.
```nix
-# .nixd.nix
+{ inputs, ... }:
{
- eval = {
- # Example target for writing a package.
- target = {
- args = [ "--expr" "with import { }; callPackage ./somePackage.nix { }" ];
- installable = "";
- };
- # Force thunks
- depth = 10;
- };
- formatting.command = "nixpkgs-fmt";
- options = {
- enable = true;
- target = {
- args = [ ];
- # Example installable for flake-parts, nixos, and home-manager
-
- # flake-parts
- installable = "/flakeref#debug.options";
-
- # nixOS configuration
- installable = "/flakeref#nixosConfigurations..options";
-
- # home-manager configuration
- installable = "/flakeref#homeConfigurations..options";
- };
- };
-}
-
-```
-
-```console
-nix eval --json --file .nixd.nix > .nixd.json
-```
-
-`.nixd.json`, the configuration of `nixd`, supports [json schema](https://json-schema.org/).
-So if your editor supports
-[LSP](https://microsoft.github.io/language-server-protocol/implementors/servers/),
-you can get completions, diagnostics and more[^json-schema]:
-
-
-
-
-
-[^json-schema]: These pictures were captured in [neovim](https://neovim.org/)
-with the plugin [coc-json](https://github.com/neoclide/coc-json).
-
-#### Evaluation
-
-##### Target
-
-Unlike any other nix lsp implementation, you may need to explicitly specify a `installable` in your workspace.
-The language server will consider the `installable` is your desired "object file", and it is the cross-file analysis pivot.
-For example, here is a nix pacakge:
-
-```nix
-{ stdenv
-, lib
-}:
-
-stdenv.mkDerivation {
- pname = "...";
- version = "...";
+ # NixOS configuration.
+ nix.nixPath = [ "nixpkgs=${inputs.nixpkgs}" ];
}
```
-From a language perspective, the lambda expression only accepts one argument and returns an AttrSet, without any special properties of a "package".
-So how do we know what argument it will accept?
-
-For nixd, you can write a project-specific *installable* that will be evaluated.
-e.g.
-
-```sh
-nix eval --expr "with import { }; callPackage ./some-package.nix { }"
-```
-
-We accept the same argument as `nix eval`, and perform evaluation for language analysis.
-
-
-```jsonc
-{
- "eval": {
- "target": {
- // Same as:
- // nix eval --expr "..."
- "args": [
- "--expr",
- "with import { }; callPackage ./some-package.nix { } "
- ],
- // AttrPath
- "installable": ""
- }
- }
-}
-```
+### The configuration
-This is much similar to `compile_commands.json` in C/C++ world.
-
-Here is the demo video that I used the above installable in my workspace:
-
-
-
-##### Depth
-
-Nix evaluator will be lazily peform evaluation on your specified task[^nix-evaluation-peformance].
-
-[^nix-evaluation-peformance]: https://wiki.nixos.org/wiki/Nix_Evaluation_Performance
-
-As for language service, we have an custom extension to nix evaluator that allows you to force thunks being evaluated in a desired depth.
+Configuration overview:
```jsonc
{
- "eval": {
- "depth": 5
- }
-}
-```
-
-##### Workers
-
-Nixd evals your project concurrently.
-You can specify how many workers will be used for language tasks, e.g. parsing & evaluation.
+ "nixpkgs": {
+ // For flake.
+ // "expr": "import (builtins.getFlake \"/home/lyc/workspace/CS/OS/NixOS/flakes\").inputs.nixpkgs { } "
+
+ // This expression will be interpreted as "nixpkgs" toplevel
+ // Nixd provides package, lib completion/information from it.
+ ///
+ // Resouces Usage: Entries are lazily evaluated, entire nixpkgs takes 200~300MB for just "names".
+ /// Package documentation, versions, are evaluated by-need.
+ "expr": "import { }"
+ },
+ "formatting": {
+ // Which command you would like to do formatting
+ "command": [ "nixpkgs-fmt" ]
+ },
+ // Tell the language server your desired option set, for completion
+ // This is lazily evaluated.
+ "options": { // Map of eval information
+ // If this is ommited, default search path () will be used.
+ "nixos": { // This name "nixos" could be arbitary.
+ // The expression to eval, intepret it as option declarations.
+ "expr": "(builtins.getFlake \"/home/lyc/flakes\").nixosConfigurations.adrastea.options"
+ },
-```jsonc
-{
- "eval": {
- "workers": 5
+ // By default there is no home-manager options completion, thus you can add this entry.
+ "home-manager": {
+ "expr": "(builtins.getFlake \"/home/lyc/flakes\").homeConfigurations.\"lyc@adrastea\".options"
}
+ }
}
```
-The default value is `std::thread::hardware_concurrency()`.
#### Format
@@ -254,7 +130,7 @@ To configure which command will be used for formatting, you can change the "form
{
"formatting": {
// The external command to be invoked for formatting
- "command": ""
+ "command": [ "some-command" ]
}
}
```
@@ -280,53 +156,21 @@ In our option system, you need to specify which option set you'd like to use.
```jsonc
{
- "options": {
- // Disable it if you are not writting modules.
- "enable": true,
- "target": {
- "args": [],
- // Example of NixOS options.
- "installable": "#nixosConfigurations..options"
+ // Tell the language server your desired option set, for completion
+ // This is lazily evaluated.
+ "options": { // Map of eval information
+ // If this is ommited, default search path () will be used.
+ "nixos": { // This name "nixos" could be arbitary.
+ // The expression to eval, intepret it as option declarations.
+ "expr": "(builtins.getFlake \"/home/lyc/flakes\").nixosConfigurations.adrastea.options"
+ },
+
+ // By default there is no home-manager options completion, thus you can add this entry.
+ "home-manager": {
+ "expr": "(builtins.getFlake \"/home/lyc/flakes\").homeConfigurations.\"lyc@adrastea\".options"
}
}
}
```
-Options auto completion
-
-**Home-manager Options**
-
-
-
-**NixOS Options**
-
-
-
-
-