mirror of
https://github.com/dwinkler1/np.git
synced 2026-05-22 13:13:31 -04:00
simplified
This commit is contained in:
parent
5c851aecba
commit
e814d2c04c
3 changed files with 254 additions and 103 deletions
73
templates/ed/README.md
Normal file
73
templates/ed/README.md
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
# Project Editor
|
||||
|
||||
A per-project Neovim wrapper built with [nix-wrapper-modules](https://birdeehub.github.io/nix-wrapper-modules/) and [nvimConfig](https://github.com/dwinkler1/nvimConfig).
|
||||
|
||||
## Setup
|
||||
|
||||
The flake provides two entry points:
|
||||
|
||||
| Command | What you get |
|
||||
|---|---|
|
||||
| `direnv allow` / `nix develop` | **(Recommended)** A shell with `nv` and all enabled language toolchains (R, Python, Julia, Quarto) on `PATH`. |
|
||||
| `nix run` | Launches only the `nv` editor. Language toolchains (R, Python, etc.) are **not** on `PATH`. |
|
||||
|
||||
### With direnv (recommended)
|
||||
|
||||
```bash
|
||||
direnv allow # enter the devShell automatically
|
||||
nv # launch the pre-configured Neovim
|
||||
R # R REPL is available (if enabled in flake.nix)
|
||||
```
|
||||
|
||||
### Without direnv
|
||||
|
||||
```bash
|
||||
nix develop # enter the devShell manually
|
||||
nv # launch Neovim
|
||||
R # R REPL is available (if enabled in flake.nix)
|
||||
```
|
||||
|
||||
> **Why `nix run` only gives the editor:** The flake's `packages.default` is the wrapped Neovim binary. Language toolchains (R, radian, quarto, etc.) live in `devShells.default`. Use `nix develop` (or `direnv allow`) to get the full environment.
|
||||
|
||||
## Configuration
|
||||
|
||||
The `flake.nix` is the single source of truth. Key knobs:
|
||||
|
||||
| Option | What it controls |
|
||||
|---|---|
|
||||
| `cats` | Toggle language support (nix, r, python, julia, etc.) |
|
||||
| `settings.lang_packages.<lang>` | Language-specific packages installed in the wrapper |
|
||||
| `settings.colorscheme` | Neovim colorscheme |
|
||||
| `settings.background` | `"dark"` or `"light"` |
|
||||
| `settings.wrapRc` | When `true`, init.lua is embedded (rebuild to change); when `false`, init.lua is external (reload without rebuild) |
|
||||
| `binName` | The wrapper binary name (`nv` by default) |
|
||||
| `env` | Environment variables set in the wrapper |
|
||||
| `extraPackages` | Extra system packages available in the wrapper's PATH |
|
||||
| `specs.extraLua` | Inject lazy.nvim plugin specs |
|
||||
|
||||
### Adding packages without editing flake.nix
|
||||
|
||||
Create any of these optional files in the project root to add dependencies without modifying `flake.nix`:
|
||||
|
||||
- **`python-packages.nix`** — receives `python3Packages`, return a list of packages:
|
||||
```nix
|
||||
p: with p; [ numpy scipy ]
|
||||
```
|
||||
|
||||
- **`r-packages.nix`** — receives `rpkgs` (includes `rPackages`), return a list:
|
||||
```nix
|
||||
p: with p.rPackages; [ ggplot2 data.table ]
|
||||
```
|
||||
|
||||
- **`julia-packages.nix`** — no arguments, return a list of package name strings:
|
||||
```nix
|
||||
[ "DataFrames" "Plots" ]
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
```bash
|
||||
nix fmt
|
||||
```
|
||||
|
||||
Uses `nixfmt-rfc-style` pinned via the flake's `formatter` output.
|
||||
65
templates/ed/flake.lock
generated
65
templates/ed/flake.lock
generated
|
|
@ -22,11 +22,11 @@
|
|||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1777954456,
|
||||
"narHash": "sha256-hGdgeU2Nk87RAuZyYjyDjFL6LK7dAZN5RE9+hrDTkDU=",
|
||||
"lastModified": 1778869304,
|
||||
"narHash": "sha256-30sZNZoA1cqF5JNO9fVX+wgiQYjB7HJqqJ4ztCDeBZE=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "549bd84d6279f9852cae6225e372cc67fb91a4c1",
|
||||
"rev": "d233902339c02a9c334e7e593de68855ad26c4cb",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -45,20 +45,19 @@
|
|||
"nixpkgs"
|
||||
],
|
||||
"plugins-cmp-pandoc-references": "plugins-cmp-pandoc-references",
|
||||
"plugins-r": [
|
||||
"plugins-r"
|
||||
],
|
||||
"plugins-r": "plugins-r",
|
||||
"r-nvim-nix": "r-nvim-nix",
|
||||
"rixpkgs": [
|
||||
"rixpkgs"
|
||||
],
|
||||
"wrappers": "wrappers"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1778114917,
|
||||
"narHash": "sha256-FB8M8D8YzfSe/oL4l6XGJxErq6nRjWSAeJzNXpk2g0E=",
|
||||
"lastModified": 1779362150,
|
||||
"narHash": "sha256-y3JTpxmNgtEYG1m21Ymvdmrul/WvJzOCX45AlV21aak=",
|
||||
"owner": "dwinkler1",
|
||||
"repo": "nvimConfig",
|
||||
"rev": "4884bf685f157da4f4d60f8e40febeac0b9bf0e9",
|
||||
"rev": "af6d975129768cce36ac4c46198ab2b3ebaafad3",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -86,33 +85,58 @@
|
|||
"plugins-r": {
|
||||
"flake": false,
|
||||
"locked": {
|
||||
"lastModified": 1769881528,
|
||||
"narHash": "sha256-oQSHHu6filJkAyH94yEvyTVuxA+5MU2dMOEAnsIjJKQ=",
|
||||
"lastModified": 1776905071,
|
||||
"narHash": "sha256-dXox6qEs1VDE7vPNDoN8bY4g06uj1IEs6uki72w8lpA=",
|
||||
"owner": "R-nvim",
|
||||
"repo": "R.nvim",
|
||||
"rev": "958b472d763cb258927c7ef69af4fd9945cc5469",
|
||||
"rev": "582f2af11290ac067e49018db38e12a511325556",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "R-nvim",
|
||||
"ref": "v0.99.3",
|
||||
"ref": "v0.99.4",
|
||||
"repo": "R.nvim",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"r-nvim-nix": {
|
||||
"inputs": {
|
||||
"nixpkgs": [
|
||||
"nvimConfig",
|
||||
"rixpkgs"
|
||||
],
|
||||
"rnvimsrc": [
|
||||
"nvimConfig",
|
||||
"plugins-r"
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1778684156,
|
||||
"narHash": "sha256-Z4y1tQfkIsPK4NRxGn668HMDfWxnxNxSJ0CAOOXiIfY=",
|
||||
"owner": "dwinkler1",
|
||||
"repo": "r_nvim_nix",
|
||||
"rev": "2f49dfee27886068e2f49cbd54558ce4cc424c82",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "dwinkler1",
|
||||
"repo": "r_nvim_nix",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"rixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1778115084,
|
||||
"narHash": "sha256-K+Rz+pghAmynE83+e9svnNYsDgPnbEohrcPb6duG5wM=",
|
||||
"lastModified": 1771303851,
|
||||
"narHash": "sha256-tgveHozOJ2D/mi3LxVy/FcmLFDlM5XKZxsNB2XpvzaM=",
|
||||
"owner": "dwinkler1",
|
||||
"repo": "rixpkgs",
|
||||
"rev": "028af91e9161008fce750f3e249afe471a302037",
|
||||
"rev": "af2dd3f7b4b172077747c0869d4e30702fb71b0e",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "dwinkler1",
|
||||
"ref": "nixpkgs",
|
||||
"repo": "rixpkgs",
|
||||
"rev": "af2dd3f7b4b172077747c0869d4e30702fb71b0e",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
|
|
@ -121,7 +145,6 @@
|
|||
"fran": "fran",
|
||||
"nixpkgs": "nixpkgs",
|
||||
"nvimConfig": "nvimConfig",
|
||||
"plugins-r": "plugins-r",
|
||||
"rixpkgs": "rixpkgs"
|
||||
}
|
||||
},
|
||||
|
|
@ -133,11 +156,11 @@
|
|||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1777991014,
|
||||
"narHash": "sha256-0DS24OW9d9iz+w0LCz6KpS2IpE2z2gHxeBdMZg9xpDY=",
|
||||
"lastModified": 1779297405,
|
||||
"narHash": "sha256-VFoBwH7ZjVxCnvZTb5ODRXt70sLtWMxstive0N+RS50=",
|
||||
"owner": "BirdeeHub",
|
||||
"repo": "nix-wrapper-modules",
|
||||
"rev": "dc5184095ad488e937ec308b52c9c0b218959d8b",
|
||||
"rev": "e7ed7a1205945befdf2e0d73ba7df91d935e5af1",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
|
|||
|
|
@ -7,95 +7,107 @@
|
|||
nvimConfig,
|
||||
...
|
||||
} @ inputs: let
|
||||
projectSettings = {pkgs}: {
|
||||
cats = {
|
||||
clickhouse = false;
|
||||
gitPlugins = false;
|
||||
julia = false;
|
||||
lua = false;
|
||||
markdown = false;
|
||||
nix = true;
|
||||
optional = false;
|
||||
python = false;
|
||||
r = true;
|
||||
};
|
||||
|
||||
settings = let
|
||||
# With `replace` packages are replaced otherwise they are merged with base packages
|
||||
replace = pkgs.lib.mkForce;
|
||||
in {
|
||||
lang_packages = {
|
||||
python = replace (
|
||||
(with pkgs.python3Packages; [
|
||||
duckdb
|
||||
polars
|
||||
])
|
||||
++ (
|
||||
if builtins.pathExists ./python-packages.nix
|
||||
# p: with p; [ ... ]
|
||||
then import ./python-packages.nix pkgs.python3Packages
|
||||
else []
|
||||
)
|
||||
);
|
||||
|
||||
r = replace (
|
||||
(with pkgs.rpkgs.rPackages; [
|
||||
fixest
|
||||
# pkgs.extraRPackages.musicMetadata
|
||||
])
|
||||
++ (
|
||||
if builtins.pathExists ./r-packages.nix
|
||||
# p: with p.rPackages; [ ... ]
|
||||
then import ./r-packages.nix pkgs.rpkgs
|
||||
else []
|
||||
)
|
||||
);
|
||||
|
||||
julia = replace ([
|
||||
"StatsBase"
|
||||
]
|
||||
++ (
|
||||
if builtins.pathExists ./julia-packages.nix
|
||||
# [ ... ]
|
||||
then import ./julia-packages.nix
|
||||
else []
|
||||
));
|
||||
};
|
||||
colorscheme = "kanagawa";
|
||||
background = "dark";
|
||||
wrapRc = true;
|
||||
};
|
||||
binName = "vv";
|
||||
|
||||
env = {
|
||||
IS_PROJECT_EDITOR = "1";
|
||||
};
|
||||
|
||||
extraPackages = with pkgs; [
|
||||
cowsay
|
||||
];
|
||||
|
||||
specs.extraLua = let
|
||||
name = builtins.baseNameOf (builtins.toString ./.);
|
||||
in {
|
||||
data = pkgs.vimPlugins.mini-notify;
|
||||
before = ["INIT_MAIN"];
|
||||
config = ''
|
||||
require("mini.notify").setup()
|
||||
vim.notify = MiniNotify.make_notify()
|
||||
vim.notify("Welcome to ${name}!")
|
||||
'';
|
||||
};
|
||||
# ── Shared language support flags ──────────────────────────────
|
||||
# Used by both the neovim wrapper module and the devShell
|
||||
cats = {
|
||||
clickhouse = false;
|
||||
gitPlugins = false;
|
||||
julia = false;
|
||||
lua = false;
|
||||
markdown = false;
|
||||
nix = true;
|
||||
optional = false;
|
||||
python = false;
|
||||
r = false;
|
||||
};
|
||||
|
||||
systems = nixpkgs.lib.systems.flakeExposed;
|
||||
# ── Language package lists ────────────────────────────────────
|
||||
# Shared between wrapper lang_packages and devShell toolchains.
|
||||
# Accept pkgs so they work inside forAllSystems for each system.
|
||||
|
||||
rPackages = pkgs:
|
||||
(with pkgs.rpkgs.rPackages; [
|
||||
fixest
|
||||
# pkgs.extraRPackages.musicMetadata
|
||||
])
|
||||
++ (
|
||||
if builtins.pathExists ./r-packages.nix
|
||||
# p: with p.rPackages; [ ... ]
|
||||
then import ./r-packages.nix pkgs.rpkgs
|
||||
else []
|
||||
);
|
||||
|
||||
pythonPackages = pkgs:
|
||||
(with pkgs.python3Packages; [
|
||||
duckdb
|
||||
polars
|
||||
])
|
||||
++ (
|
||||
if builtins.pathExists ./python-packages.nix
|
||||
# p: with p; [ ... ]
|
||||
then import ./python-packages.nix pkgs.python3Packages
|
||||
else []
|
||||
);
|
||||
|
||||
juliaPackages =
|
||||
["StatsBase"]
|
||||
++ (
|
||||
if builtins.pathExists ./julia-packages.nix
|
||||
# [ ... ]
|
||||
then import ./julia-packages.nix
|
||||
else []
|
||||
);
|
||||
|
||||
systems = ["aarch64-darwin" "x86_64-linux" "aarch64-linux"];
|
||||
forAllSystems = nixpkgs.lib.genAttrs systems;
|
||||
overlays = [inputs.nvimConfig.overlays.dependencies];
|
||||
in {
|
||||
formatter = forAllSystems (system: nixpkgs.legacyPackages.${system}.nixfmt-rfc-style);
|
||||
|
||||
packages = forAllSystems (system: let
|
||||
pkgs = import nixpkgs {inherit system overlays;};
|
||||
pkgs = import nixpkgs {
|
||||
inherit system overlays;
|
||||
config = {allowUnfree = true;};
|
||||
};
|
||||
# Plain attrset — pkgs is captured from the surrounding scope,
|
||||
# so the module system does not need lazy _module.args resolution.
|
||||
projectSettings = {
|
||||
inherit cats;
|
||||
settings = let
|
||||
# With `replace` packages are replaced otherwise they are merged with base packages
|
||||
replace = pkgs.lib.mkForce;
|
||||
in {
|
||||
lang_packages = {
|
||||
python = replace (pythonPackages pkgs);
|
||||
r = replace (rPackages pkgs);
|
||||
julia = replace juliaPackages;
|
||||
};
|
||||
colorscheme = "kanagawa";
|
||||
background = "dark";
|
||||
wrapRc = true;
|
||||
};
|
||||
binName = "nv";
|
||||
|
||||
env = {
|
||||
IS_PROJECT_EDITOR = "1";
|
||||
};
|
||||
|
||||
runtimePkgs = with pkgs; [
|
||||
cowsay
|
||||
];
|
||||
|
||||
specs.extraLua = let
|
||||
name = builtins.baseNameOf (builtins.toString ./.);
|
||||
in {
|
||||
data = pkgs.vimPlugins.mini-notify;
|
||||
before = ["INIT_MAIN"];
|
||||
config = ''
|
||||
require("mini.notify").setup()
|
||||
vim.notify = MiniNotify.make_notify()
|
||||
vim.notify("Welcome to ${name}!")
|
||||
'';
|
||||
};
|
||||
};
|
||||
evalResult = nvimConfig.inputs.wrappers.lib.evalModules {
|
||||
modules = [
|
||||
nvimConfig.wrapperModules.default
|
||||
|
|
@ -103,15 +115,58 @@
|
|||
];
|
||||
};
|
||||
in {
|
||||
default = evalResult.config.wrap { inherit pkgs; };
|
||||
default = evalResult.config.wrap {inherit pkgs;};
|
||||
});
|
||||
|
||||
devShells = forAllSystems (system: let
|
||||
pkgs = import nixpkgs {inherit system overlays;};
|
||||
pkgs = import nixpkgs {
|
||||
inherit system overlays;
|
||||
config = {allowUnfree = true;};
|
||||
};
|
||||
nv = self.packages.${system}.default;
|
||||
in {
|
||||
default = pkgs.mkShell {
|
||||
packages = [nv];
|
||||
packages =
|
||||
[nv]
|
||||
|
||||
# ── R toolchain (R REPL, quarto, LSP, formatter) ─────
|
||||
++ pkgs.lib.optionals cats.r (let
|
||||
r_packages = (pkgs.baseRPackages or []) ++ rPackages pkgs;
|
||||
in [
|
||||
(pkgs.rWrapper.override {packages = r_packages;})
|
||||
pkgs.radianWrapper
|
||||
pkgs.air-formatter
|
||||
pkgs.yaml-language-server
|
||||
pkgs.nvimcom
|
||||
pkgs.rnvimserver
|
||||
])
|
||||
|
||||
# ── Python toolchain (interpreter, LSP, formatter) ────
|
||||
++ pkgs.lib.optionals cats.python [
|
||||
(pkgs.python3.withPackages (ps: pkgs.basePythonPackages ps ++ pythonPackages pkgs))
|
||||
pkgs.nodejs
|
||||
pkgs.ruff
|
||||
pkgs.basedpyright
|
||||
pkgs.uv
|
||||
]
|
||||
|
||||
# ── Julia toolchain ───────────────────────────────────
|
||||
++ pkgs.lib.optionals cats.julia [
|
||||
pkgs.julia-bin.withPackages juliaPackages
|
||||
]
|
||||
|
||||
# ── Markdown toolchain (quarto, zk) ───────────────────
|
||||
++ (let
|
||||
r_packages = (pkgs.baseRPackages or []) ++ rPackages pkgs;
|
||||
quarto =
|
||||
if cats.r
|
||||
then pkgs.quarto.override {extraRPackages = r_packages;}
|
||||
else pkgs.quarto;
|
||||
in pkgs.lib.optionals cats.markdown [
|
||||
pkgs.python313Packages.pylatexenc
|
||||
quarto
|
||||
pkgs.zk
|
||||
]);
|
||||
};
|
||||
});
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue