Merge 852c862f05 into 57b5585372

this is pretty much WIP and contains a bunch of bugs that I haven't tackled yet.

.github/README.md

@@ -1,10 +1,9 @@
 <div align="center">
     <img src="assets/nvf-logo-work.svg" alt="nvf Logo"  width="200">
-    <h1 ❄️  nvf</h1>
 </div>
-
+<h1 align="center">❄️  nvf</h1>
 <div align="center">
-  <p>
+<p>
     <a href="https://github.com/NotAShelf/nvf/releases/latest">
       <img alt="Latest release" src="https://img.shields.io/github/v/release/NotAShelf/nvf?style=for-the-badge&logo=nixos&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />
     </a>
@@ -23,8 +22,7 @@
     <a href="https://github.com/NotAShelf/nvf">
       <img alt="Repo Size" src="https://img.shields.io/github/repo-size/NotAShelf/nvf?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
     </a>
-  </p>
-</div>
+</p>
 
 <p align="center">
     <img src="https://stars.medv.io/NotAShelf/nvf.svg", title="stars"/>
@@ -38,18 +36,19 @@
     Nix code.
   </a>
 </div>
+<br/>
+
+> [!WARNING]  
+> Main branch is only updated for small, non-breaking changes. For the latest version of neovim-flake, please see
+> [the list of branches](https://github.com/NotAShelf/neovim-flake/branches) or
+> [open pull requests](https://github.com/NotAShelf/neovim-flake/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
+> neovim-flake, at the time, is still being actively developed - and will continue to be so for the foreseeable
+> future.
 
 ---
 
 <div align="center"><p>
 
-[Get Started]: #get-started
-[Documentation]: #documentation
-[Help]: #help
-[Contribute]: #contributing
-[FAQ]: #faq
-[Credits]: #credits
-
 **[<kbd> <br> Get Started <br> </kbd>][Get Started]**
 **[<kbd> <br> Documentation <br> </kbd>][Documentation]**
 **[<kbd> <br> Help <br> </kbd>][Help]**
@@ -59,6 +58,13 @@
 
 </p></div>
 
+[Get Started]: #get-started
+[Documentation]: #documentation
+[Help]: #help
+[Contribute]: #contributing
+[FAQ]: #faq
+[Credits]: #credits
+
 ---
 
 ## Get Started
@@ -107,15 +113,13 @@ featured configuration with `nix` language support by running:
 nix run github:notashelf/nvf#nix
 ```
 
-[Issues]: https://github.com/NotAShelf/nvf/issues
-
-Please create an issue on the [issue tracker](issues) if you find
+Please create an issue on the [issue tracker](../../../issues) if you find
 the documentation lacking or confusing. I also appreciate any contributions
 to the documentation.
 
 ## Help
 
-You can create an issue on the [issue tracker](issues) to ask questions
+You can create an issue on the [issue tracker](../../../issues) to ask questions
 or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue
 tracker for now.
 
@@ -124,7 +128,7 @@ tracker for now.
 I am always looking for new ways to help improve this flake. If you would like
 to contribute, please read the [contributing guide](CONTRIBUTING.md) before
 submitting a pull request. You can also create an issue on the
-[issue tracker](issues) before submitting a pull request if you would
+[issue tracker](../../../issues) before submitting a pull request if you would
 like to discuss a feature or bug fix.
 
 ## FAQ
@@ -133,7 +137,8 @@ like to discuss a feature or bug fix.
 <br/>
 **A**: Maybe! It is not one of our goals to support each and every Neovim
 plugin, however, I am always open to new modules and plugin setup additions
-to **nvf**. Use the [appropritate issue template](issues/new/choose) and I will
+to **nvf**. Use the [appropritate issue
+template](https://github.com/NotAShelf/nvf/issues/new/choose) and I will
 consider a module addition.
 
 **Q**: A plugin I need is not available in **nvf**. What to do?
@@ -142,15 +147,6 @@ consider a module addition.
 plugin configurations! Please see the documentation on how you may do
 this.
 
-**Q**: Main branch is awfully silent, is the project dead?
-<br/>
-**A**: No! Sometimes we branch out (e.g. v0.6) to avoid breaking userspace
-and work in a separate branch until we make sure the new additions are
-implemented in the most comfortable way available to the end user. If you have
-not noticed any activity on the main branch, consider taking a look at the [list
-of branches](https://github.com/NotAShelf/nvf/branches=) or the [list of open
-pull requests](https://github.com/NotAShelf/nvf)
-
 ## Credits
 
 ### Contributors
@@ -184,7 +180,7 @@ recommend checking their work out.
 
 Following the [original neovim-flake](https://github.com/jordanisaacs/neovim-flake)
 **nvf** has been made available under the **MIT License**. However, all assets
-and documentation are published under the [CC BY License].
+are published under the [CC BY License].
 
 ---
 

.github/workflows/check-docs.yml

@@ -48,4 +48,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: "${{ matrix.package }}"
-          path: result/share/doc/nvf
+          path: result/share/doc/neovim-flake/

.github/workflows/docker.yml

@@ -0,0 +1,50 @@
+name: "Publish Docker Image"
+on:
+  workflow_dispatch:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build-docker-image:
+    name: "Build Docker Image"
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+      - name: Magic Nix Cache
+        uses: DeterminateSystems/magic-nix-cache-action@main
+
+      - name: Build Docker Image
+        run: nix build .#docker-nix --print-build-logs
+
+      - name: Load & Tag Built Docker Image
+        run: |
+          docker load -i result &&
+          docker tag neovim-flake:latest notashelf/neovim-flake:latest
+
+      - name: Log into DockerHub
+        uses: docker/login-action@master
+        with:
+          username: notashelf
+          password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+
+      - name: Push to DockerHub
+        run: docker push notashelf/neovim-flake:latest
+
+      - name: Log into ghcr
+        uses: docker/login-action@master
+        with:
+          registry: "ghcr.io"
+          username: "${{ github.actor }}"
+          password: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Publish Docker Image (Github Packages)
+        run: docker push notashelf/neovim-flake:latest

.github/workflows/manual.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Build
         run: |
           nix build '.#docs'
-          cp -r result/share/doc/nvf public
+          cp -r result/share/doc/neovim-flake public
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4

modules/plugins/treesitter/config.nix

@@ -6,6 +6,7 @@
 }: let
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.lists) optional optionals;
+  inherit (lib.trivial) boolToString;
   inherit (lib.nvim.binds) mkSetBinding addDescriptionsToMappings;
   inherit (lib.nvim.lua) toLuaObject;
   inherit (lib.nvim.dag) entryBefore entryAfter;

modules/plugins/treesitter/treesitter.nix

@@ -97,7 +97,7 @@ in {
         example = literalMD ''
           ```lua
           -- Disable slow treesitter highlight for large files
-          function(lang, buf)
+          disable = function(lang, buf)
             local max_filesize = 1000 * 1024 -- 1MB
             local ok, stats = pcall(vim.loop.fs_stat, vim.api.nvim_buf_get_name(buf))
             if ok and stats and stats.size > max_filesize then