feat(nix): upgrade to 24.05, switch to fish + jeezyvim

.github/workflows/build.yml

@@ -1,11 +1,13 @@
-name: 'build'
+name: "build"
 
 on:
   push:
-    branches: 
+    branches:
       - master
       - feature/*
       - hotfix/*
+    tags:
+      - nixos-wsl-starter-*
   pull_request: {}
   workflow_call: {}
 
@@ -21,7 +23,7 @@ jobs:
 
       - uses: cachix/install-nix-action@6a9a9e84a173d90b3ffb42c5ddaf9ea033fad011
         with:
-          extra_nix_config: 'access-tokens = github.com=${{ github.token }}'
+          extra_nix_config: "access-tokens = github.com=${{ github.token }}"
 
       - name: Build tarball
         run: |
@@ -31,5 +33,10 @@ jobs:
       - name: Upload tarball
         uses: actions/upload-artifact@v3
         with:
-          name: nixos-wsl-starter
+          name: nixos-wsl.tar.gz
           path: nixos-wsl.tar.gz
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: nixos-wsl.tar.gz

README.md

@@ -1,7 +1,8 @@
 # nixos-wsl-starter
 
 This repository is intended to be a sane, batteries-included starter template
-for running a LunarVim-powered NixOS development environment on WSL.
+for running a [JeezyVim](https://github.com/LGUG2Z/JeezyVim)-powered NixOS
+development environment on WSL.
 
 If you don't want to dig into NixOS too much right now, the only file you need
 to concern yourself with is [home.nix](home.nix). This is where you can add and
@@ -13,7 +14,7 @@ in other package managers.
 
 `unstable-packages` is for packages that you want to always keep at the latest
 released versions, and `stable-packages` is for packages that you want to track
-with the current release of NixOS (currently 23.11).
+with the current release of NixOS (currently 24.05).
 
 If you want to update the versions of the available `unstable-packages`, run
 `nix flake update` to pull the latest version of the Nixpkgs repository and
@@ -33,106 +34,123 @@ This starter is a lightly-opinionated take on a productive terminal-driven
 development environment based on my own preferences. However, it is trivial to
 customize to your liking both by removing and adding tools that you prefer.
 
-* The default editor is `lvim`
-* `win32yank` is used to ensure perfect bi-directional copying and pasting to
+- The default editor is [JeezyVim](https://github.com/LGUG2Z/JeezyVim)
+- `win32yank` is used to ensure perfect bi-directional copying and pasting to
   and from Windows GUI applications and LunarVim running in WSL
-* The default shell is `zsh`
-* Native `docker` (ie. Linux, not Windows) is enabled by default
-* The prompt is [Starship](https://starship.rs/)
-* [`fzf`](https://github.com/junegunn/fzf),
+- The default shell is `fish`
+- Native `docker` (ie. Linux, not Windows) is enabled by default
+- The prompt is [Starship](https://starship.rs/)
+- [`fzf`](https://github.com/junegunn/fzf),
   [`lsd`](https://github.com/lsd-rs/lsd),
   [`zoxide`](https://github.com/ajeetdsouza/zoxide), and
-  [`broot`](https://github.com/Canop/broot) are integrated into `zsh` by
+  [`broot`](https://github.com/Canop/broot) are integrated into `fish` by
   default
-    * These can all be disabled easily by setting `enable = false` in
-      [home.nix](home.nix), or just removing the lines all together
-* [`direnv`](https://github.com/direnv/direnv) is integrated into `zsh` by
+  - These can all be disabled easily by setting `enable = false` in
+    [home.nix](home.nix), or just removing the lines all together
+- [`direnv`](https://github.com/direnv/direnv) is integrated into `fish` by
   default
-* `git` config is generated in [home.nix](home.nix) with options provided to
+- `git` config is generated in [home.nix](home.nix) with options provided to
   enable private HTTPS clones with secret tokens
-* `zsh` config is generated in [home.nix](home.nix) and includes git aliases,
-  useful WSL aliases, and
-  [sensible`$WORDCHARS`](https://lgug2z.com/articles/sensible-wordchars-for-most-developers/)
+- `fish` config is generated in [home.nix](home.nix) and includes git aliases,
+  useful WSL aliases
+
+### win32yank
+
+There have been some recent changes in WSL2 that make running `win32yank`
+within WSL2 very slow. You should install this on Windows by running `scoop
+install win32yank` or compiling it from source, and then adding it to your `$PATH`:
+
+```nix
+{
+    programs.fish = {
+      interactiveShellInit = ''
+        fish_add_path --append /mnt/c/Users/<Your Windows Username>/scoop/apps/win32yank/0.1.1
+      '';
+    };
+}
+```
 
 ## Quickstart
 
 [![Watch the walkthrough video](https://img.youtube.com/vi/UmRXXYxq8k4/hqdefault.jpg)](https://www.youtube.com/watch?v=UmRXXYxq8k4)
 
-* Get the [latest NixOS-WSL
-  installer](https://github.com/nix-community/NixOS-WSL)
-* Install it (tweak the command to your desired paths):
+- Get the [latest
+  release](https://github.com/LGUG2Z/nixos-wsl-starter/releases) and unzip it
+- Install it (tweak the command to your desired paths):
+
 ```powershell
 wsl --import NixOS .\NixOS\ .\nixos-wsl.tar.gz --version 2
-
 ```
 
-* Enter the distro:
+- Enter the distro:
+
 ```powershell
 wsl -d NixOS
 ```
 
-* Set up a channel:
-```bash
-sudo nix-channel --add https://nixos.org/channels/nixos-23.11 nixos
-sudo nix-channel --update
-```
+- Get a copy of this repo (you'll probably want to fork it eventually):
 
-* Get a copy of this repo (you'll probably want to fork it eventually):
 ```bash
-nix-shell -p git neovim
+nix-shell -p git
 git clone https://github.com/LGUG2Z/nixos-wsl-starter.git /tmp/configuration
 cd /tmp/configuration
 ```
 
-* Change the username to your desired username in `flake.nix` with `nvim` (or whichever editor you prefer)
-* Apply the configuration
+- Change the username to your desired username in `flake.nix` with `nvim` (or
+  whichever editor you prefer)
+- Install `win32yank` with `scoop` and add it to your `$PATH` in NixOS
+- Apply the configuration and shutdown the WSL2 VM
+
 ```bash
-sudo nixos-rebuild switch --flake /tmp/configuration
+sudo nixos-rebuild switch --flake /tmp/configuration && sudo shutdown -h now
 ```
 
-* Restart and reconnect to the current WSL shell
+- Reconnect to the WSL2 VM
+
 ```bash
-wsl -t NixOS
 wsl -d NixOS
 ```
 
-* `cd ~` and then `pwd` should now show `/home/<YOUR_USERNAME>`
-* Move the configuration to your new home directory 
+- `cd ~` and then `pwd` should now show `/home/<YOUR_USERNAME>`
+- Move the configuration to your new home directory
+
 ```bash
 mv /tmp/configuration ~/configuration
 ```
 
-* Go through all the `FIXME:` notices in `~/configuration` and make changes
+- Go through all the `FIXME:` notices in `~/configuration` and make changes
   wherever you want
-* Apply the configuration
+- Apply the configuration
+
 ```bash
 sudo nixos-rebuild switch --flake ~/configuration
 ```
 
-Note: If developing in Rust, you'll still be managing your toolchains and components like `rust-analyzer` with `rustup`!
+Note: If developing in Rust, you'll still be managing your toolchains and
+components like `rust-analyzer` with `rustup`!
 
 ## Project Layout
 
 In order to keep the template as approachable as possible for new NixOS users,
 this project uses a flat layout without any nesting or modularization.
 
-* `flake.nix` is where dependencies are specified
-    * `nixpkgs` is the current release of NixOS
-    * `nixpkgs-unstable` is the current trunk branch of NixOS (ie. all the
-      latest packages)
-    * `home-manager` is used to manage everything related to your home
-      directory (dotfiles etc.)
-    * `nur` is the community-maintained [Nix User
-      Repositories](https://nur.nix-community.org/) for packages that may not
-      be available in the NixOS repository
-    * `nixos-wsl` exposes important WSL-specific configuration options
-    * `nix-index-database` tells you how to install a package when you run a
-      command which requires a binary not in the `$PATH`
-* `wsl.nix` is where the VM is configured
-    * The hostname is set here
-    * The default shell is set here
-    * User groups are set here
-    * WSL configuration options are set here
-    * NixOS options are set here
-* `home.nix` is where packages, dotfiles, terminal tools, environment variables
+- `flake.nix` is where dependencies are specified
+  - `nixpkgs` is the current release of NixOS
+  - `nixpkgs-unstable` is the current trunk branch of NixOS (ie. all the
+    latest packages)
+  - `home-manager` is used to manage everything related to your home
+    directory (dotfiles etc.)
+  - `nur` is the community-maintained [Nix User
+    Repositories](https://nur.nix-community.org/) for packages that may not
+    be available in the NixOS repository
+  - `nixos-wsl` exposes important WSL-specific configuration options
+  - `nix-index-database` tells you how to install a package when you run a
+    command which requires a binary not in the `$PATH`
+- `wsl.nix` is where the VM is configured
+  - The hostname is set here
+  - The default shell is set here
+  - User groups are set here
+  - WSL configuration options are set here
+  - NixOS options are set here
+- `home.nix` is where packages, dotfiles, terminal tools, environment variables
   and aliases are configured