v1 release

Author: Casey Fryer

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Jordan
+Copyright (c) 2023 Casey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,86 @@
 # neovim-flake
 
-![ci-badge](https://img.shields.io/static/v1?label=Built%20with&message=Garnix&color=blue&style=flat&logo=nixos&link=https://garnix.io&labelColor=111212)
+Nix flake for [neovim](https://neovim.io/) that closely follows the [LazyVim](https://www.lazyvim.org) configuration.
 
-Nix flake for [neovim](https://neovim.io/) with configuration options highly focused on Scala 3.
-
-![screenshot-1](./docs/screenshot-1.png)
-
-![screenshot-2](./docs/screenshot-2.png)
+It is usable as a nixpkgs overlay, a home-manager module, or as a stand-alone nix flake.
+This is a bit of an experiment as a personal project. I am unlikely to fix any issues, beyond ones that affect me personally.
 
+![screenshot-1](./screenshot_1.png)
 ## Documentation
+### try it out
+```
+nix run github:cwfryer/neovim-flake .#default
+```
+By default, this includes all the LazyVim keybinds, autocmds, and settings.
+It also includes LSP support for Lua, Nix, and Rust (via [rust-tools](https://github.com/simrat39/rust-tools.nvim)).
+### nixpkgs overlay
+This flake outputs an overlay that replaces the nix-community/neovim-nightly-overlay with this neovim package.
+To use it in your flake config:
+```
+{
+  inputs = {
+    #... other inputs here...
+    neovim-nightly = {
+      url = "github:nix-community/neovim-nightly-overlay";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    neovim-flake = {
+        url = github:cwfryer/neovim-flake;
+        inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+  outputs = {
+    nixosConfigurations = {
+      "<your_hostname"> = nixpkgs.lib.nixosSystem {
+        nixpkgs = {
+          overlays = [
+            inputs.neovim-flake.overlays.default
+            #... your other overlays ...
+          ];
+        };
+        #... more nix config ...
+        environment.systemPackages = with pkgs; [
+          #... your packages ...
+          neovim-nightly
+        ];
+      }
+    };
+  };
+}
+```
+You can also overlay nixpkgs in your home-manager configuration. It works basically the same as above. But... you should just the home-manager module below.
 
-- [https://gvolpe.com/neovim-flake](https://gvolpe.com/neovim-flake).
-
+### home-manager module (recommended)
+The best option is to use the home-manager module.
+Add the input flake:
+```
+{
+  neovim-flake = {
+    url = github:gvolpe/neovim-flake;
+    inputs.nixpkgs.follows = "nixpkgs";
+  };
+}
+```
+Import the home-manager module:
+```
+{
+  imports = [ neovim-flake.nixosModules."<your_system>".hm ];
+}
+```
+Add the module to your home-manager config:
+```
+{
+  programs.neovim-ide = {
+    enable = true;
+    settings = {
+      #... your options ...
+    };
+  }
+}
+```
 ## Credits
+Mostly based on Gabriel Volpe's [neovim-flake](https://github.com/gvolpe/neovim-flake).
+Which was based on Jordan Isaacs' [neovim-flake](https://github.com/jordanisaacs/neovim-flake), which was based on Wil Taylor's [neovim-flake](https://github.com/wiltaylor/neovim-flake).
 
-Originally based on Jordan Isaacs' [neovim-flake](https://github.com/jordanisaacs/neovim-flake).
+All 3 of these are great references to see how to use a flake to build your flavor of Neovim.
+The vim configuration is largely based on the oustanding [LazyVim](https://www.lazyvim.org).

flake.lock

@@ -9,11 +9,6 @@
     neovim-nightly-overlay.url = "github:nix-community/neovim-nightly-overlay";
     neovim-nightly-overlay.inputs.nixpkgs.follows = "nixpkgs";
 
-    tree-sitter = {
-      url = github:tree-sitter/tree-sitter;
-      flake = false;
-    };
-
     #-------------------------------------
     # Coding Plugins
     #-------------------------------------
@@ -177,14 +172,18 @@
       url = github:simrat39/rust-tools.nvim;
       flake = false;
     };
+    inc-rename = {
+      url = github:smjonas/inc-rename.nvim;
+      flake = false;
+    };
 
     #-------------------------------------
     # Treesitter Plugins
     #-------------------------------------
-    nvim-treesitter = {
-			url = github:nvim-treesitter/nvim-treesitter;
-			flake = false;
-		};
+		/* nvim-treesitter = { */
+		/* 	url = github:nvim-treesitter/nvim-treesitter; */
+		/* 	flake = false; */
+		/* }; */
     nvim-treesitter-textobjects = {
 			url = github:nvim-treesitter/nvim-treesitter-textobjects;
 			flake = false;

flake.nix

@@ -8,15 +8,7 @@ with builtins;
 let
   inherit (prev.vimUtils) buildVimPluginFrom2Nix;
 
-  ts = prev.tree-sitter.override {
-    # extraGrammars = {
-    #   tree-sitter-scala = final.tree-sitter-scala-master;
-    #   tree-sitter-tsx = final.tree-sitter-tsx-master;
-    #   tree-sitter-typescript = final.tree-sitter-tsx-master;
-    # };
-  };
-
-  treesitterGrammars = ts.withPlugins (p: [
+  treeSitterPlug = pkgs.vimPlugins.nvim-treesitter.withPlugins (p: [
     p.tree-sitter-c
     p.tree-sitter-nix
     p.tree-sitter-python
@@ -33,26 +25,22 @@ let
     p.tree-sitter-graphql
     p.tree-sitter-json
     p.tree-sitter-go
+    p.tree-sitter-lua
+    p.tree-sitter-markdown-inline
+    p.tree-sitter-bash
+    p.tree-sitter-regex
+    p.tree-sitter-vim
   ]);
 
-  tsPostPatchHook = ''
-    rm -r parser
-    ln -s ${treesitterGrammars} parser
-  '';
-
   buildPlug = name:
     buildVimPluginFrom2Nix {
       pname = name;
       version = "master";
       src = builtins.getAttr name inputs;
-      postPatch = ''
-        ${writeIf (name == "nvim-treesitter") tsPostPatchHook}
-      '';
     };
 
   vimPlugins = {
-    inherit (pkgs.vimPlugins) nerdcommenter;
-    # inherit vim-scala3;
+    inherit treeSitterPlug;
   };
 in
 {

lib/buildPlugin.nix

@@ -9,7 +9,7 @@ with lib; {
   meta.maintainers = [ maintainers.cfryer ];
 
   options.programs.neovim-ide = {
-    enable = mkEnableOption "NeoVim with LSP enabled for Haskell, Rust and more.";
+    enable = mkEnableOption "NeoVim with LazyVim config recreated in nix";
 
     settings = mkOption {
       type = types.attrsOf types.anything;