diff --git a/docs/default.nix b/docs/default.nix index 2a5142c..a597fb2 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -2,6 +2,7 @@ pkgs, lib ? import ../lib/stdlib-extended.nix pkgs.lib, nmdSrc, + ... }: let nmd = import nmdSrc { inherit lib; @@ -29,6 +30,8 @@ ]; }; + dontCheckDefinitions = {_module.check = false;}; + githubDeclaration = user: repo: subpath: let urlRef = "main"; in { @@ -36,96 +39,100 @@ name = "<${repo}/${subpath}>"; }; - dontCheckDefinitions = {_module.check = false;}; - nvimPath = toString ./..; buildOptionsDocs = args @ { modules, - includeModuleSystemsOptions ? true, + includeModuleSystemOptions ? true, ... }: let - options = (lib.evalModules {inherit modules;}).options; + inherit ((lib.evalModules {inherit modules;})) options; in - pkgs.buildPackages.nixosOptionsDoc - ({ + pkgs.buildPackages.nixosOptionsDoc ({ options = - if includeModuleSystemsOptions + if includeModuleSystemOptions then options - else builtins.removeAttrs (options ["_module"]); + else builtins.removeAttrs options ["_module"]; transformOptions = opt: opt // { - # Clean up declaration sites to not refer to local source tree - declarations = - map - (decl: - if lib.hasPrefix nvimPath (toString decl) - then - githubDeclaration "notashelf" "neovim-flake" - (lib.removePrefix "/" (lib.removePrefix nvimPath (toString decl))) - else decl) - opt.declarations; + # Clean up declaration sites to not refer to the Home Manager + # source tree. + declarations = map (decl: + if lib.hasPrefix nvimPath (toString decl) + then + githubDeclaration "notashelf" "neovim-flake" + (lib.removePrefix "/" (lib.removePrefix nvimPath (toString decl))) + else if decl == "lib/modules.nix" + then + # TODO: handle this in a better way (may require upstream + # changes to nixpkgs) + githubDeclaration "NixOS" "nixpkgs" decl + else decl) + opt.declarations; }; } - // builtins.removeAttrs args ["modules" "includeModuleSystemsOptions"]); + // builtins.removeAttrs args ["modules" "includeModuleSystemOptions"]); nvimModuleDocs = buildOptionsDocs { modules = - import ../modules/modules.nix - { - inherit pkgs lib; + import ../modules/modules.nix { + inherit lib pkgs; check = false; } ++ [scrubbedPkgsModule]; variablelistId = "neovim-flake-options"; }; - docs = nmd.buildDocBookDocs { - pathName = "neovim-flake"; - projectName = "neovim-flake"; - modulesDocs = [ - { - docBook = pkgs.linkFarm "nvim-module-docs-for-nmd" { - "nmd-result/neovim-flake-options.xml" = nvimModuleDocs.optionsDocBook; - }; - } - ]; - documentsDirectory = ./.; - documentType = "book"; - chunkToc = '' - - - - - - - - - - - - ''; - }; -in { - options.json = - pkgs.runCommand "options.json" - # TODO: Use `nvimOptionsDoc.optionsJSON` directly once upstream - # `nixosOptionsDoc` is more customizable - { - meta.description = "List of neovim-flake options in JSON format"; + release-config = builtins.fromJSON (builtins.readFile ../release.json); + revision = "release-${release-config.release}"; + # Generate the `man home-configuration.nix` package + nvf-configuration-manual = + pkgs.runCommand "neovim-flake-reference-manpage" { + nativeBuildInputs = [pkgs.buildPackages.installShellFiles pkgs.nixos-render-docs]; + allowedReferences = ["out"]; } '' - mkdir -p $out/{share/doc,nix-support} - cp -a ${nvimModuleDocs.optionsJSON}/share/doc/nixos $out/share/doc/neovim-flake - substitute \ - ${nvimModuleDocs.optionsJSON}/nix-support/hydra-build-products \ - $out/nix-support/hydra-build-products \ - --replace \ - '${nvimModuleDocs.optionsJSON}/share/doc/nixos' \ - "$out/share/doc/neovim-flake" + # Generate manpages. + mkdir -p $out/share/man/man5 + mkdir -p $out/share/man/man1 + nixos-render-docs -j $NIX_BUILD_CORES options manpage \ + --revision ${revision} \ + ${nvimModuleDocs.optionsJSON}/share/doc/nixos/options.json \ + $out/share/man/man5/neovim-flake.5 + cp ${./neovim-flake.1} $out/share/man/man1/neovim-flake.1 ''; + # Generate the HTML manual pages + neovim-flake-manual = pkgs.callPackage ./manual.nix { + inherit revision; + outputPath = "share/doc/neovim-flake"; + nmd = nmdSrc; + options = { + neovim-flake = nvimModuleDocs.optionsJSON; + }; + }; + html = neovim-flake-manual; + htmlOpenTool = pkgs.callPackage ./html-open-tool.nix {} {inherit html;}; +in { + inherit nmdSrc; - inherit (docs) manPages; + options = { + # TODO: Use `hmOptionsDocs.optionsJSON` directly once upstream + # `nixosOptionsDoc` is more customizable. + json = + pkgs.runCommand "options.json" { + meta.description = "List of Home Manager options in JSON format"; + } '' + mkdir -p $out/{share/doc,nix-support} + cp -a ${nvimModuleDocs.optionsJSON}/share/doc/nixos $out/share/doc/neovim-flake + substitute \ + ${nvimModuleDocs.optionsJSON}/nix-support/hydra-build-products \ + $out/nix-support/hydra-build-products \ + --replace \ + '${nvimModuleDocs.optionsJSON}/share/doc/nixos' \ + "$out/share/doc/neovim-flake" + ''; + }; - manual = {inherit (docs) html htmlOpenTool;}; + manPages = nvf-configuration-manual; + manual = {inherit html htmlOpenTool;}; } diff --git a/docs/footer.5 b/docs/footer.5 new file mode 100644 index 0000000..f2c7cfd --- /dev/null +++ b/docs/footer.5 @@ -0,0 +1,3 @@ +.SH "AUTHORS" +.PP +neovim-flake contributors diff --git a/docs/header.5 b/docs/header.5 new file mode 100644 index 0000000..e3307ed --- /dev/null +++ b/docs/header.5 @@ -0,0 +1,14 @@ +.TH "neovim-flake" "5" "01/01/1980" "neovim-flake" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" enable line breaks after slashes +.cflags 4 / +.SH "NAME" +neovim-flake configuration specification +.SH "OPTIONS" +.PP +You can use the following options in +home\-configuration\&.nix: +.PP diff --git a/docs/highlight-style.css b/docs/highlight-style.css new file mode 100644 index 0000000..d5fbcef --- /dev/null +++ b/docs/highlight-style.css @@ -0,0 +1,8 @@ +pre { + padding: 0; +} + +pre code.hljs { + border: none; + margin: 0; +} diff --git a/docs/html-open-tool.nix b/docs/html-open-tool.nix new file mode 100644 index 0000000..0eeb9fe --- /dev/null +++ b/docs/html-open-tool.nix @@ -0,0 +1,43 @@ +{ + writeShellScriptBin, + makeDesktopItem, + symlinkJoin, +}: { + html, + pathName ? "neovim-flake", + projectName ? pathName, + name ? "${pathName}-help", +}: let + helpScript = writeShellScriptBin name '' + set -euo pipefail + + if [[ ! -v BROWSER || -z $BROWSER ]]; then + for candidate in xdg-open open w3m; do + BROWSER="$(type -P $candidate || true)" + if [[ -x $BROWSER ]]; then + break; + fi + done + fi + + if [[ ! -v BROWSER || -z $BROWSER ]]; then + echo "$0: unable to start a web browser; please set \$BROWSER" + exit 1 + else + exec "$BROWSER" "${html}/share/doc/${pathName}/index.xhtml" + fi + ''; + + desktopItem = makeDesktopItem { + name = "${pathName}-manual"; + desktopName = "${projectName} Manual"; + genericName = "View ${projectName} documentation in a web browser"; + icon = "nix-snowflake"; + exec = "${helpScript}/bin/${name}"; + categories = ["System"]; + }; +in + symlinkJoin { + inherit name; + paths = [helpScript desktopItem]; + } diff --git a/docs/man-configuration.xml b/docs/man-configuration.xml deleted file mode 100644 index e0c870f..0000000 --- a/docs/man-configuration.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - neovim-flake configuration - 5 - neovim-flake - - - - neovim configuration - neovim-flake configuration specification - - - Description - - Custom configuration is done with the neovim-flake.lib.neovimConfiguration if home-manager module is not in use. - It takes in the configuration as a module. - - - neovim-flake.lib.neovimConfiguration { - inherit pkgs; - modules = [{config = xxx;}]; - }; - - - The output of the configuration function is an attrset. - - - In case of the home-manager module, all options will be available under programs.neovim-flake once the module has - been imported from the flake inputs. - - - { - options = "The options that were available to configure"; - config = "The outputted configuration"; - pkgs = "The package set used to evaluate the module"; - neovim = "The built neovim package"; - } - - - - - Options - - You can use the following options in your neovim configuration. - - - - diff --git a/docs/man-pages.xml b/docs/man-pages.xml deleted file mode 100644 index 2526aea..0000000 --- a/docs/man-pages.xml +++ /dev/null @@ -1,13 +0,0 @@ - - neovim-flake Reference Pages - - neovim-flake contributors - - 2023 - neovim-flake contributors - - - - diff --git a/docs/manual.nix b/docs/manual.nix new file mode 100644 index 0000000..76adfd4 --- /dev/null +++ b/docs/manual.nix @@ -0,0 +1,64 @@ +{ + stdenv, + lib, + documentation-highlighter, + nmd, + revision, + outputPath ? "share/doc/neovim-flake", + options, + nixos-render-docs, +}: +stdenv.mkDerivation { + name = "neovim-flake-manual"; + + nativeBuildInputs = [nixos-render-docs]; + + src = ./manual; + + buildPhase = '' + mkdir -p out/media + + mkdir -p out/highlightjs + cp -t out/highlightjs \ + ${documentation-highlighter}/highlight.pack.js \ + ${documentation-highlighter}/LICENSE \ + ${documentation-highlighter}/mono-blue.css \ + ${documentation-highlighter}/loader.js + + substituteInPlace ./options.md \ + --replace \ + '@OPTIONS_JSON@' \ + ${options.neovim-flake}/share/doc/nixos/options.json + + substituteInPlace ./manual.md \ + --replace \ + '@VERSION@' \ + ${revision} + + cp ${nmd}/static/style.css out/style.css + cp -t out/highlightjs ${nmd}/static/highlightjs/tomorrow-night.min.css + cp ${./highlight-style.css} out/highlightjs/highlight-style.css + + nixos-render-docs manual html \ + --manpage-urls ./manpage-urls.json \ + --revision ${lib.trivial.revisionWithDefault revision} \ + --stylesheet style.css \ + --stylesheet highlightjs/tomorrow-night.min.css \ + --stylesheet highlightjs/highlight-style.css \ + --script highlightjs/highlight.pack.js \ + --script highlightjs/loader.js \ + --toc-depth 1 \ + --section-toc-depth 1 \ + manual.md \ + out/index.xhtml + ''; + + installPhase = '' + dest="$out/${outputPath}" + mkdir -p "$(dirname "$dest")" + mv out "$dest" + + mkdir -p $out/nix-support/ + echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products + ''; +} diff --git a/docs/manual.xml b/docs/manual.xml deleted file mode 100644 index 6cdbb7a..0000000 --- a/docs/manual.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - neovim-flake Manual - - - Preface - - If you believe your problem is caused by a bug in neovim-flake then please consider reporting it over - the neovim-flake issue tracker. - Bugfixes, feature additions and upstream changes are welcome over - the neovim-flake pull requests tab. - - - - - - - - - - - - Configuration Options - - - - diff --git a/docs/manual/custom-configs.adoc b/docs/manual/custom-configs.md similarity index 91% rename from docs/manual/custom-configs.adoc rename to docs/manual/custom-configs.md index 5d8cd75..d2b3dc5 100644 --- a/docs/manual/custom-configs.adoc +++ b/docs/manual/custom-configs.md @@ -1,23 +1,20 @@ -[[ch-custom-configuration]] -== Custom Configuration +# Custom Configuration {#ch-custom-configuration} Custom configuration is done with the `neovimConfiguration` while using the flake as a standalone package. It takes in the configuration as a module. The output of the configuration function is an attrset. -[source,nix] ----- +```nix { options = "The options that were available to configure"; config = "The outputted configuration"; pkgs = "The package set used to evaluate the module"; neovim = "The built neovim package"; } ----- +``` The following is an example of a barebones vim configuration with the default theme enabled. -[source,nix] ----- +```nix { inputs.neovim-flake = { url = "github:notashelf/neovim-flake"; @@ -59,10 +56,8 @@ The following is an example of a barebones vim configuration with the default th }; }; } ----- +``` Your built neovim configuration can be exposed as a flake output, or be added to your system packages to make it available across your system. You may also consider passing the flake output to home-manager to make it available -to a specific user *without* using the home-manager module. - - +to a specific user _without_ using the home-manager module. diff --git a/docs/manual/custom-package.adoc b/docs/manual/custom-package.md similarity index 87% rename from docs/manual/custom-package.adoc rename to docs/manual/custom-package.md index 64c043c..8fc0048 100644 --- a/docs/manual/custom-package.adoc +++ b/docs/manual/custom-package.md @@ -1,14 +1,12 @@ -[[ch-custom-package]] -== Custom Neovim Package +# Custom Neovim Package {#ch-custom-package} As of v0.5, you may now specify the neovim package that will be wrapped with your configuration. This is done with the `vim.package` option. -[source,nix] ----- +```nix {inputs, pkgs, ...}: { # using the neovim-nightly overlay config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim; } ----- +``` The neovim-nightly-overlay always exposes an unwrapped package. If using a different source, you are highly recommended to get an "unwrapped" version of the neovim package,similar to `neovim-unwrapped` in nixpkgs. diff --git a/docs/manual/custom-plugins.adoc b/docs/manual/custom-plugins.adoc deleted file mode 100644 index e53f193..0000000 --- a/docs/manual/custom-plugins.adoc +++ /dev/null @@ -1,74 +0,0 @@ -[[ch-custom-plugins]] -== Custom Plugins - -You can use custom plugins, before they are implemented in the flake. -To add a plugin, you need to add it to your config's `config.vim.startPlugins` array. - -[[sec-new-method]] -=== New Method -As of version 0.5, we have a more extensive API for configuring plugins, under `vim.extraPlugins`. - -Instead of using DAGs exposed by the library, you may use the extra plugin module as follows: - -[source,nix] ----- -{ - config.vim.extraPlugins = with pkgs.vimPlugins; { - aerial = { - package = aerial-nvim; - setup = '' - require('aerial').setup { - -- some lua configuration here - } - ''; - }; - - harpoon = { - package = harpoon; - setup = "require('harpoon').setup {}"; - after = ["aerial"]; - }; - }; -} ----- - -[[sec-old-method]] -=== Old Method -Users who have not yet updated to 0.5, or prefer a more hands-on approach may use the old method where the load order -of the plugins is determined by DAGs. - -[source,nix] ----- -{ - # fetch plugin source from GitHub and add it to startPlugins - config.vim.startPlugins = [ - (pkgs.fetchFromGitHub { - owner = "FrenzyExists"; - repo = "aquarium-vim"; - rev = "d09b1feda1148797aa5ff0dbca8d8e3256d028d5"; - sha256 = "CtyEhCcGxxok6xFQ09feWpdEBIYHH+GIFVOaNZx10Bs="; - }) - ]; -} ----- - -However, just making the plugin available might not be enough. In that case, you can write custom vimscript -or lua config, using `config.vim.configRC` or `config.vim.luaConfigRC` respectively. -These options are attribute sets, and you need to give the configuration you're adding some name, like this: - -[source,nix] ----- -{ - # this will create an "aquarium" section in your init.vim with the contents of your custom config - # which will be *appended* to the rest of your configuration, inside your init.vim - config.vim.configRC.aquarium = "colorscheme aquiarum"; -} ----- - -Note: If your configuration needs to be put in a specific place in the config, you can use functions from -`inputs.neovim-flake.lib.nvim.dag` to order it. -Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix to find out more about -the DAG system. - -Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue -with your findings so that we can make it available for everyone easily. diff --git a/docs/manual/custom-plugins.md b/docs/manual/custom-plugins.md new file mode 100644 index 0000000..e377918 --- /dev/null +++ b/docs/manual/custom-plugins.md @@ -0,0 +1,10 @@ +# Custom Plugins {#ch-custom-plugins} + +You can use custom plugins, before they are implemented in the flake. +To add a plugin, you need to add it to your config's `config.vim.startPlugins` array. + +```{=include=} sections +custom-plugins/new-method.md +custom-plugins/old-method.md +custom-plugins/configuring.md +``` diff --git a/docs/manual/custom-plugins/configuring.md b/docs/manual/custom-plugins/configuring.md new file mode 100644 index 0000000..2217ce8 --- /dev/null +++ b/docs/manual/custom-plugins/configuring.md @@ -0,0 +1,23 @@ +# Configuring {#configuring-plugins} + +Just making the plugin to your neovim configuration available might not always be enough. +In that case, you can write custom vimscript or lua config, using `config.vim.configRC` or `config.vim.luaConfigRC` +respectively. These options are attribute sets, and you need to give the configuration you're adding some name, like this: + +```nix +{ + # this will create an "aquarium" section in your init.vim with the contents of your custom config + # which will be *appended* to the rest of your configuration, inside your init.vim + config.vim.configRC.aquarium = "colorscheme aquiarum"; +} +``` + +:::{.note} +If your configuration needs to be put in a specific place in the config, you can use functions from +`inputs.neovim-flake.lib.nvim.dag` to order it. +Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix to find out more about +the DAG system. +::: + +Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue +with your findings so that we can make it available for everyone easily. diff --git a/docs/manual/custom-plugins/new-method.md b/docs/manual/custom-plugins/new-method.md new file mode 100644 index 0000000..66523fd --- /dev/null +++ b/docs/manual/custom-plugins/new-method.md @@ -0,0 +1,26 @@ +# New Method {#sec-new-method} + +As of version 0.5, we have a more extensive API for configuring plugins, under `vim.extraPlugins`. + +Instead of using DAGs exposed by the library, you may use the extra plugin module as follows: + +```nix +{ + config.vim.extraPlugins = with pkgs.vimPlugins; { + aerial = { + package = aerial-nvim; + setup = '' + require('aerial').setup { + -- some lua configuration here + } + ''; + }; + + harpoon = { + package = harpoon; + setup = "require('harpoon').setup {}"; + after = ["aerial"]; + }; + }; +} +``` diff --git a/docs/manual/custom-plugins/old-method.md b/docs/manual/custom-plugins/old-method.md new file mode 100644 index 0000000..0984338 --- /dev/null +++ b/docs/manual/custom-plugins/old-method.md @@ -0,0 +1,18 @@ +# Old Method {#sec-old-method} + +Users who have not yet updated to 0.5, or prefer a more hands-on approach may use the old method where the load order +of the plugins is determined by DAGs. + +```nix +{ + # fetch plugin source from GitHub and add it to startPlugins + config.vim.startPlugins = [ + (pkgs.fetchFromGitHub { + owner = "FrenzyExists"; + repo = "aquarium-vim"; + rev = "d09b1feda1148797aa5ff0dbca8d8e3256d028d5"; + sha256 = "CtyEhCcGxxok6xFQ09feWpdEBIYHH+GIFVOaNZx10Bs="; + }) + ]; +} +``` diff --git a/docs/manual/default-configs.adoc b/docs/manual/default-configs.adoc deleted file mode 100644 index 981d859..0000000 --- a/docs/manual/default-configs.adoc +++ /dev/null @@ -1,36 +0,0 @@ -[[ch-default-configs]] -== Default Configs - -While you can configure neovim-flake yourself using the builder, here are a few default configurations you can use. - -[[sec-default-tidal]] -=== Tidal Cycles - -[source,console] -$ nix run github:notashelf/neovim-flake#tidal file.tidal - -Utilizing https://github.com/tidalcycles/vim-tidal[vim-tidal] and mitchmindtree's fantastic https://github.com/mitchmindtree/tidalcycles.nix[tidalcycles.nix] start playing with tidal cycles in a single command. - -In your tidal file, type a cycle e.g. `d1 $ s "drum"` and then press _ctrl+enter_. Super collider with superdirt, and a modified GHCI with tidal will start up and begin playing. Note, you need jack enabled on your system. If you are using pipewire, its as easy as setting `services.pipewire.jack.enable = true`. - - -[[sec-default-nix]] -=== Nix - -[source,console] -$ nix run github:notashelf/neovim-flake#nix test.nix - -Enables all the of neovim plugins, with language support for specifically Nix. This lets you see what a fully configured neovim setup looks like without downloading a whole bunch of language servers and associated tools. - -[[sec-default-maximal]] -=== Maximal - -[source,console] -$ nix shell github:notashelf/neovim-flake#maximal test.nix - -It is the same fully configured neovim as with the <> config, but with every supported language enabled. - -[NOTE] -==== -Running the maximal config will download *a lot* of packages as it is downloading language servers, formatters, and more. -==== diff --git a/docs/manual/default-configs.md b/docs/manual/default-configs.md new file mode 100644 index 0000000..fff6a19 --- /dev/null +++ b/docs/manual/default-configs.md @@ -0,0 +1,10 @@ +# Default Configs {#ch-default-configs} + +While you can configure neovim-flake yourself using the builder, you can also use the pre-built configs that are available. +Here are a few default configurations you can use. + +```{=include=} sections +default-configs/maximal.md +default-configs/nix.md +default-configs/tidal.md +``` diff --git a/docs/manual/default-configs/maximal.md b/docs/manual/default-configs/maximal.md new file mode 100644 index 0000000..58256eb --- /dev/null +++ b/docs/manual/default-configs/maximal.md @@ -0,0 +1,11 @@ +# Maximal {#sec-default-maximal} + +```bash +$ nix shell github:notashelf/neovim-flake#maximal test.nix +``` + +It is the same fully configured neovim as with the [Nix](#sec-default-nix) config, but with every supported language enabled. + +::: note +Running the maximal config will download _a lot_ of packages as it is downloading language servers, formatters, and more. +::: diff --git a/docs/manual/default-configs/nix.md b/docs/manual/default-configs/nix.md new file mode 100644 index 0000000..6afe386 --- /dev/null +++ b/docs/manual/default-configs/nix.md @@ -0,0 +1,7 @@ +# Nix {#sec-default-nix} + +```bash +$ nix run github:notashelf/neovim-flake#nix test.nix +``` + +Enables all the of neovim plugins, with language support for specifically Nix. This lets you see what a fully configured neovim setup looks like without downloading a whole bunch of language servers and associated tools. diff --git a/docs/manual/default-configs/tidal.md b/docs/manual/default-configs/tidal.md new file mode 100644 index 0000000..f931fd3 --- /dev/null +++ b/docs/manual/default-configs/tidal.md @@ -0,0 +1,12 @@ +# Tidal Cycles {#sec-default-tidal} + +```bash +$ nix run github:notashelf/neovim-flake#tidal file.tidal +``` + +Utilizing [vim-tidal](https://github.com/tidalcycles/vim-tidal) and mitchmindtree's fantastic +[tidalcycles.nix](https://github.com/mitchmindtree/tidalcycles.nix) start playing with tidal cycles in a single command. + +In your tidal file, type a cycle e.g. `d1 $ s "drum"` and then press _ctrl+enter_. Super collider with superdirt, and a +modified GHCI with tidal will start up and begin playing. Note, you need jack enabled on your system. If you are using +pipewire, its as easy as setting `services.pipewire.jack.enable = true` in your configuration. diff --git a/docs/manual/hacking.adoc b/docs/manual/hacking.adoc deleted file mode 100644 index 51995b8..0000000 --- a/docs/manual/hacking.adoc +++ /dev/null @@ -1,412 +0,0 @@ -[[ch-hacking]] -== Hacking neovim-flake - -neovim-flake is designed for developers as much as it is for the end user. I would like any potential contributor -to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides -(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates -into neovim-flake's development without leaving question marks in your head. - -:fork-a-repo: https://help.github.com/articles/fork-a-repo/ -:open-issues: https://github.com/notashelf/neovim-flake/issues -:new-issue: https://github.com/notashelf/neovim-flake/issues/new -:seven-rules: https://cbea.ms/git-commit/#seven-rules -:example-commit-message: https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef - -This section is mainly directed towards those who wish to contribute code into neovim-flake. If you wish to instead -report a bug or discuss a potential feature implementation, first look among the already {open-issues}[open issues] and -if no matching issue exists you may open a {new-issue}[new issue] and describe your problem/request. While creating an -issue, please try to include as much information as you can, ideally also include relevant context in which an issue -occurs or a feature should be implemented. - -[[sec-contrib-getting-started]] -=== Getting started - -You naturally would like to start by forking the repository. If you are new to git, have a look at GitHub's -{fork-a-repo}[Fork a repo guide] for instructions on how you can do this. Once you have a fork of neovim-flake -you should create a branch starting at the most recent `main` branch. -Give your branch a reasonably descriptive name, suffixed by its type - i.e `feature/debugger` or `fix/pesky-bug`. - -Implement your changes and commit them to the newly created branch and when you are happy with the result and positive -that it fulfills <>. Once you are confident everything is in order, push the branch to GitHub and -{create-a-pull-request}[create a pull request], following the template that you will be prompted to fill. - -[[sec-guidelines]] -=== Guidelines -:assertions: https://nixos.org/manual/nixos/stable/index.html#sec-assertions -:discussions-tab: https://github.com/NotAShelf/neovim-flake/discussions - -If your contribution tightly follows the guidelines, then there is a good chance it will be merged without too much -trouble. Some of the guidelines will be strictly enforced, others will remain as gentle nudges towards the correct -direction. As we have no automated system enforcing those guidelines, please try to double check your changes before -making your pull request in order to avoid "faulty" code slipping by. - -If you are uncertain how these rules affect the change you would like to make then feel free to start a -discussion in the {discussions-tab}[discussions tab] ideally (but not necessarily) before you start developing. - -[[sec-documentation]] -==== Add adequate documentation -:nixpkgs-markdown: https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup -:docbook: https://tdg.docbook.org/ -:asciidoc: https://asciidoc.org/ - -Most, if not all, changes warrant changes to the documentation. Module options should be documented with -{nixpkgs-markdown}[Nixpkgs-flavoured Markdown], albeit with exceptions. -neovim-flake is itself documented using a combination of {docbook}[DocBook] and {asciidoc}[AsciiDoc] conventions. - -The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake -(such as this page) can be generated and opened by typing the following in a shell within a clone of the -neovim-flake Git repository: - -[source,console] ----- -$ nix build .#docs-html -$ xdg-open ./result/share/doc/neovim-flake/index.html ----- - -[[sec-guidelines-code-style]] -==== Format your code - -Make sure your code is formatted as described in <>. To maintain consistency throughout the project -you are encouraged to browse through existing code and adopt its style also in new code. - -[[sec-guidelines-commit-message-style]] -==== Format your commit messages - -Similar to <> we encourage a consistent commit message format as described -in <>. - -[[sec-commit-style]] -==== Commits - -The commits in your pull request should be reasonably self-contained. Which means each and every commit in -a pull request should make sense both on its own and in general context. That is, a second commit should not resolve -an issue that is introduced in an earlier commit. In particular, you will be asked to amend any commit that -introduces syntax errors or similar problems even if they are fixed in a later commit. - -The commit messages should follow the {seven-rules}[seven rules], except for "Capitalize the subject line". -We also ask you to include the affected code component or module in the first line. -A commit message ideally, but not necessarily, follow the given template from home-manager's own documentation - ----- -{component}: {description} - -{long description} ----- - -where `{component}` refers to the code component (or module) your change affects, `{description}` is a very brief -description of your change, and `{long description}` is an optional clarifying description. As a rare exception, if -there is no clear component, or your change affects many components, then the `{component}` part is optional. -See <> for a commit message that fulfills these requirements. - -[[ex-commit-message]] -.Compliant commit message -=============================================================================== -The commit {example-commit-message}[69f8e47e9e74c8d3d060ca22e18246b7f7d988ef] contains the commit message - ----- -starship: allow running in Emacs if vterm is used - -The vterm buffer is backed by libvterm and can handle Starship prompts -without issues. ----- -=============================================================================== - -Long description can be ommitted if the change is too simple to warrant it. A minor fix in spelling or a formatting -change does not warrant long description, however, a module addition or removal does as you would like to provide the -relevant context for your changes. - -Finally, when adding a new module, say `modules/foo.nix`, we use the fixed commit format `foo: add module`. -You can, of course, still include a long description if you wish. - -In case of nested modules, i.e `modules/languages/java.nix` you are recommended to contain the parent as well - for -example `languages/java: some major change`. - - -[[sec-code-style]] -==== Code Style -:alejandra: https://github.com/kamadorueda/alejandra - -**Treewide** -Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module -descriptions and documentation. - -**Nix** -neovim-flake is formatted by the {alejandra}[alejandra] tool and the formatting is checked in the pull -request and push workflows. Run the `nix fmt` command inside the project repository before submitting your -pull request. - -While Alejandra is mostly opinionated on how code looks after formatting, certain changes are done at the -user's discretion based on how the original code was structured. - -Please use one line code for attribute sets that contain only one subset. -For example: - -[source,nix] ----- -# parent modules should always be unfolded -# which means module = { value = ... } instead of module.value = { ... } -module = { - value = mkEnableOption "some description" // { default = true; }; # merges can be done inline where possible - - # same as parent modules, unfold submodules - subModule = { - # this is an option that contains more than one nested value - someOtherValue = mkOption { - type = lib.types.bool; - description = "Some other description" - default = true; - }; - }; -} ----- - -If you move a line down after the merge operator, Alejandra will automatically unfold the whole merged attrset -for you, which we **do not** want. - -[source,nix] ----- -module = { - key = mkEnableOption "some description" // { - default = true; # we want this to be inline - }; - # ... -} ----- - -For lists, it is mostly up to your own discretion how you want to format them, but please try to unfold lists if -they contain multiple items and especially if they are to include comments. - -[source,nix] ----- -# this is ok -acceptableList = [ - item1 # comment - item2 - item3 # some other comment - item4 -]; - -# this is not ok -listToBeAvoided = [item1 item2 /* comment */ item3 item4]; - -# this is ok -singleItemList = [item1]; ----- - -[[sec-testing]] -=== Testing Your Changes - -Once you have made your changes, you will need to test them throughly. If it is a module, add your module option to -`configuration.nix` (located in the root of this project) inside `neovimConfiguration`. Enable it, and then run the -maximal configuration with `nix run .#maximal -Lv` to check for build errors. If neovim opens in the current directory -without any error messages (you can check the output of `:messages` inside neovim to see if there are any errors), then -your changes are good to go. Open your pull request, and it will be reviewed as soon as posssible. - -If it is not a new module, but a change to an existing one, then make sure the module you have changed is enabled in the -maximal configuration by editing `configuration.nix`, and then run it with `nix run .#maximal -Lv`. Same procedure as -adding a new module will apply here. - -[[sec-keybinds]] -=== Keybinds - -As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in -the https://github.com/NotAShelf/neovim-flake/tree/main/lib[extended standard library]. The following section contains -a general overview to how you may utilize said functions. - -[[sec-custom-key-mappings]] -==== Custom Key Mappings Support for a Plugin - -:maps: https://notashelf.github.io/neovim-flake/options.html#opt-vim.maps.command._name_.action - -To set a mapping, you should define it in `vim.maps.<>`. -The available modes are: - -* normal -* insert -* select -* visual -* terminal -* normalVisualOp -* visualOnly -* operator -* insertCommand -* lang -* command - -An example, simple keybinding, can look like this: - -[source,nix] ----- -{ - vim.maps.normal = { - "wq" = { - action = ":wq"; - silent = true; - desc = "Save file and quit"; - }; - }; -} ----- - -There are many settings available in the options. Please refer to the {maps}[documentation] to see a list of them. - -`neovim-flake` provides a list of helper commands, so that you don't have to write the mapping attribute sets every -time: - -* `mkBinding = key: action: desc:` - makes a basic binding, with `silent` set to true. -* `mkExprBinding = key: action: desc:` - makes an expression binding, with `lua`, `silent`, and `expr` set to true. -* `mkLuaBinding = key: action: desc:` - makes an expression binding, with `lua`, and `silent` set to true. - -Note that the Lua in these bindings is actual Lua, not pasted into a `:lua` command. -Therefore, you either pass in a function like `require('someplugin').some_function`, without actually calling it, -or you define your own function, like `function() require('someplugin').some_function() end`. - -Additionally, to not have to repeat the descriptions, there's another utility function with its own set of functions: - -[source,nix] ----- -# Utility function that takes two attrsets: -# { someKey = "some_value" } and -# { someKey = { description = "Some Description"; }; } -# and merges them into -# { someKey = { value = "some_value"; description = "Some Description"; }; } - -addDescriptionsToMappings = actualMappings: mappingDefinitions: ----- - -This function can be used in combination with the same `mkBinding` functions as above, except they only take two -arguments - `binding` and `action`, and have different names: - -* `mkSetBinding = binding: action:` - makes a basic binding, with `silent` set to true. -* `mkSetExprBinding = binding: action:` - makes an expression binding, with `lua`, `silent`, and `expr` set to true. -* `mkSetLuaBinding = binding: action:` - makes an expression binding, with `lua`, and `silent` set to true. - -You can read the source code of some modules to see them in action, but their usage should look something like this: - -[source,nix] ----- -# plugindefinition.nix -{lib, ...}: -with lib; { - options.vim.plugin = { - enable = mkEnableOption "Enable plugin"; - - # Mappings should always be inside an attrset called mappings - mappings = { - # mkMappingOption is a helper function from lib, - # that takes a description (which will also appear in which-key), - # and a default mapping (which can be null) - toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc"; - toggleCurrentBlock = mkMappingOption "Toggle current block comment" "gbc"; - - toggleOpLeaderLine = mkMappingOption "Toggle line comment" "gc"; - toggleOpLeaderBlock = mkMappingOption "Toggle block comment" "gb"; - - toggleSelectedLine = mkMappingOption "Toggle selected comment" "gc"; - toggleSelectedBlock = mkMappingOption "Toggle selected block" "gb"; - }; - }; -} ----- - -[source,nix] ----- -# config.nix -{ - pkgs, - config, - lib, - ... -}: -with lib; -with builtins; let - cfg = config.vim.plugin; - self = import ./plugindefinition.nix {inherit lib;}; - mappingDefinitions = self.options.vim.plugin; - - # addDescriptionsToMappings is a helper function from lib, - # that merges mapping values and their descriptions - # into one nice attribute set - mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions; -in { - config = mkIf (cfg.enable) { - # ... - - vim.maps.normal = mkMerge [ - # mkSetBinding is another helper function from lib, - # that actually adds the mapping with a description. - (mkSetBinding mappings.findFiles " Telescope find_files") - (mkSetBinding mappings.liveGrep " Telescope live_grep") - (mkSetBinding mappings.buffers " Telescope buffers") - (mkSetBinding mappings.helpTags " Telescope help_tags") - (mkSetBinding mappings.open " Telescope") - - (mkSetBinding mappings.gitCommits " Telescope git_commits") - (mkSetBinding mappings.gitBufferCommits " Telescope git_bcommits") - (mkSetBinding mappings.gitBranches " Telescope git_branches") - (mkSetBinding mappings.gitStatus " Telescope git_status") - (mkSetBinding mappings.gitStash " Telescope git_stash") - - (mkIf config.vim.lsp.enable (mkMerge [ - (mkSetBinding mappings.lspDocumentSymbols " Telescope lsp_document_symbols") - (mkSetBinding mappings.lspWorkspaceSymbols " Telescope lsp_workspace_symbols") - - (mkSetBinding mappings.lspReferences " Telescope lsp_references") - (mkSetBinding mappings.lspImplementations " Telescope lsp_implementations") - (mkSetBinding mappings.lspDefinitions " Telescope lsp_definitions") - (mkSetBinding mappings.lspTypeDefinitions " Telescope lsp_type_definitions") - (mkSetBinding mappings.diagnostics " Telescope diagnostics") - ])) - - ( - mkIf config.vim.treesitter.enable - (mkSetBinding mappings.treesitter " Telescope treesitter") - ) - ]; - - # ... - }; -} ----- - -[NOTE] -==== -If you have come across a plugin that has an API that doesn't seem to easily allow custom keybindings, -don't be scared to implement a draft PR. We'll help you get it done. -==== - -[[sec-additional-plugins]] -=== Adding Plugins - -To add a new neovim plugin, first add the source url in the inputs section of `flake.nix` - -[source,nix] ----- -{ - inputs = { - # ... - neodev-nvim = { - url = "github:folke/neodev.nvim"; - flake = false; - }; - }; -} ----- - -Then add the name of the plugin into the `availablePlugins` variable in `lib/types/plugins.nix`: - -[source,nix] ----- -# ... -availablePlugins = [ - # ... - "neodev-nvim" -]; ----- - -You can now reference this plugin using its string name: - -[source,nix] ----- -config.vim.startPlugins = ["neodev-nvim"]; ----- diff --git a/docs/manual/hacking.md b/docs/manual/hacking.md new file mode 100644 index 0000000..b9a223c --- /dev/null +++ b/docs/manual/hacking.md @@ -0,0 +1,21 @@ +# Hacking neovim-flake {#ch-hacking} + +neovim-flake is designed for developers as much as it is for the end user. I would like any potential contributor +to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides +(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates +into neovim-flake's development without leaving question marks in your head. + +This section is mainly directed towards those who wish to contribute code into neovim-flake. If you wish to instead +report a bug or discuss a potential feature implementation, first look among the +already [open issues](https://github.com/notashelf/neovim-flake/issues) and if no matching issue exists you may open +a [new issue](https://github.com/notashelf/neovim-flake/issues/new) and describe your problem/request. While creating an +issue, please try to include as much information as you can, ideally also include relevant context in which an issue +occurs or a feature should be implemented. + +```{=include=} sections +hacking/getting-started.md +hacking/guidelines.md +hacking/testing.md +hacking/keybinds.md +hacking/additional-plugins.md +``` diff --git a/docs/manual/hacking/additional-plugins.md b/docs/manual/hacking/additional-plugins.md new file mode 100644 index 0000000..c70727d --- /dev/null +++ b/docs/manual/hacking/additional-plugins.md @@ -0,0 +1,33 @@ +# Adding Plugins {#sec-additional-plugins} + +To add a new neovim plugin, first add the source url in the inputs section of `flake.nix` + +```nix + +{ + inputs = { + # ... + neodev-nvim = { + url = "github:folke/neodev.nvim"; + flake = false; + }; + # ... + }; +} +``` + +Then add the name of the plugin into the `availablePlugins` variable in `lib/types/plugins.nix`: + +```nix +# ... +availablePlugins = [ + # ... + "neodev-nvim" +]; +``` + +You can now reference this plugin using its string name: + +```nix +config.vim.startPlugins = ["neodev-nvim"]; +``` diff --git a/docs/manual/hacking/getting-started.md b/docs/manual/hacking/getting-started.md new file mode 100644 index 0000000..8d16681 --- /dev/null +++ b/docs/manual/hacking/getting-started.md @@ -0,0 +1,10 @@ +# Getting Started {#sec-contrib-getting-started} + +You naturally would like to start by forking the repository. If you are new to git, have a look at GitHub's +[Fork a repo guide](https://help.github.com/articles/fork-a-repo/) for instructions on how you can do this. Once you have a fork of neovim-flake +you should create a branch starting at the most recent `main` branch. +Give your branch a reasonably descriptive name, suffixed by its type - i.e `feature/debugger` or `fix/pesky-bug`. + +Implement your changes and commit them to the newly created branch and when you are happy with the result and positive +that it fulfills [Guidelines](#sec-guidelines). Once you are confident everything is in order, push the branch to GitHub and +[create a pull request](https://help.github.com/articles/creating-a-pull-request), following the template that you will be prompted to fill. diff --git a/docs/manual/hacking/guidelines.md b/docs/manual/hacking/guidelines.md new file mode 100644 index 0000000..49f35c8 --- /dev/null +++ b/docs/manual/hacking/guidelines.md @@ -0,0 +1,155 @@ +# Guidelines {#sec-guidelines} + +If your contribution tightly follows the guidelines, then there is a good chance it will be merged without too much +trouble. Some of the guidelines will be strictly enforced, others will remain as gentle nudges towards the correct +direction. As we have no automated system enforcing those guidelines, please try to double check your changes before +making your pull request in order to avoid "faulty" code slipping by. + +If you are uncertain how these rules affect the change you would like to make then feel free to start a +discussion in the [discussions tab](https://github.com/NotAShelf/neovim-flake/discussions) ideally (but not necessarily) +before you start developing. + +## Adding Documentation {#sec-guidelines-documentation} + +Most, if not all, changes warrant changes to the documentation. Module options should be documented with +[Nixpkgs-flavoured Markdown](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup), albeit with exceptions. + +:::{.note} +As of v0.6, neovim-flake is itself documented using full markdown in both module options and the manual. +::: + +The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake +(such as this page) can be generated and opened by typing the following in a shell within a clone of the +neovim-flake Git repository: + +```console +$ nix build .#docs-html +$ xdg-open $PWD/result/share/doc/neovim-flake/index.html +``` + +## Formatting Code {#sec-guidelines-formatting} + +Make sure your code is formatted as described in [code-style section](#sec-guidelines-code-style). To maintain consistency throughout +the project you are encouraged to browse through existing code and adopt its style also in new code. + +## Formatting Commits {#sec-guidelines-commit-message-style} + +Similar to [code style guidelines](#sec-guidelines-code-style) we encourage a consistent commit message format as described +in [commit style guidelines](#sec-guidelines-commit-style). + +## Commit Style {#sec-guidelines-commit-style} + +The commits in your pull request should be reasonably self-contained. Which means each and every commit in +a pull request should make sense both on its own and in general context. That is, a second commit should not resolve +an issue that is introduced in an earlier commit. In particular, you will be asked to amend any commit that +introduces syntax errors or similar problems even if they are fixed in a later commit. + +The commit messages should follow the {seven-rules}[seven rules], except for "Capitalize the subject line". +We also ask you to include the affected code component or module in the first line. +A commit message ideally, but not necessarily, follow the given template from home-manager's own documentation + +``` + {component}: {description} + + {long description} +``` + +where `{component}` refers to the code component (or module) your change affects, `{description}` is a very brief +description of your change, and `{long description}` is an optional clarifying description. As a rare exception, if +there is no clear component, or your change affects many components, then the `{component}` part is optional. +See <> for a commit message that fulfills these requirements. + +## Example Commit {#sec-guidelines-ex-commit-message} + +The commit {example-commit-message}[69f8e47e9e74c8d3d060ca22e18246b7f7d988ef] contains the commit message + +``` + +starship: allow running in Emacs if vterm is used + +The vterm buffer is backed by libvterm and can handle Starship prompts +without issues. + +``` + +Long description can be ommitted if the change is too simple to warrant it. A minor fix in spelling or a formatting +change does not warrant long description, however, a module addition or removal does as you would like to provide the +relevant context for your changes. + +Finally, when adding a new module, say `modules/foo.nix`, we use the fixed commit format `foo: add module`. +You can, of course, still include a long description if you wish. + +In case of nested modules, i.e `modules/languages/java.nix` you are recommended to contain the parent as well - for +example `languages/java: some major change`. + +## Code Style {#sec-guidelines-code-style} + +**Treewide** +Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module +descriptions and documentation. + +**Nix** +neovim-flake is formatted by the [alejandra](https://github.com/kamadorueda/alejandra) tool and the formatting is checked in the pull +request and push workflows. Run the `nix fmt` command inside the project repository before submitting your +pull request. + +While Alejandra is mostly opinionated on how code looks after formatting, certain changes are done at the +user's discretion based on how the original code was structured. + +Please use one line code for attribute sets that contain only one subset. +For example: + +```nix +# parent modules should always be unfolded +# which means module = { value = ... } instead of module.value = { ... } +module = { + value = mkEnableOption "some description" // { default = true; }; # merges can be done inline where possible + + # same as parent modules, unfold submodules + subModule = { + # this is an option that contains more than one nested value + someOtherValue = mkOption { + type = lib.types.bool; + description = "Some other description"; + default = true; + }; + }; +} +``` + +If you move a line down after the merge operator, Alejandra will automatically unfold the whole merged attrset +for you, which we **do not** want. + +```nix +module = { + key = mkEnableOption "some description" // { + default = true; # we want this to be inline + }; # ... +} +``` + +For lists, it is mostly up to your own discretion how you want to format them, but please try to unfold lists if +they contain multiple items and especially if they are to include comments. + +```nix + +# this is ok + +acceptableList = [ + item1 # comment + item2 + item3 # some other comment + item4 +]; + +# this is not ok +listToBeAvoided = [item1 item2 /* comment */ item3 item4]; + +# this is ok +acceptableList = [item1]; + +# this is not ok +listToBeAvoided = [ + item1 +]; +``` diff --git a/docs/manual/hacking/keybinds.md b/docs/manual/hacking/keybinds.md new file mode 100644 index 0000000..f6c5947 --- /dev/null +++ b/docs/manual/hacking/keybinds.md @@ -0,0 +1,166 @@ +# Keybinds {#sec-keybinds} + +As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in +the https://github.com/NotAShelf/neovim-flake/tree/main/lib[extended standard library]. The following section contains +a general overview to how you may utilize said functions. + +## Custom Key Mappings Support for a Plugin {#sec-custom-key-mappings} + +:maps: https://notashelf.github.io/neovim-flake/options.html#opt-vim.maps.command._name_.action + +To set a mapping, you should define it in `vim.maps.<>`. +The available modes are: + +- normal +- insert +- select +- visual +- terminal +- normalVisualOp +- visualOnly +- operator +- insertCommand +- lang +- command + +An example, simple keybinding, can look like this: + +```nix +{ + vim.maps.normal = { + "wq" = { + action = ":wq"; + silent = true; + desc = "Save file and quit"; + }; + }; +} +``` + +There are many settings available in the options. Please refer to the {maps}[documentation] to see a list of them. + +`neovim-flake` provides a list of helper commands, so that you don't have to write the mapping attribute sets every +time: + +- `mkBinding = key: action: desc:` - makes a basic binding, with `silent` set to true. +- `mkExprBinding = key: action: desc:` - makes an expression binding, with `lua`, `silent`, and `expr` set to true. +- `mkLuaBinding = key: action: desc:` - makes an expression binding, with `lua`, and `silent` set to true. + +Note that the Lua in these bindings is actual Lua, not pasted into a `:lua` command. +Therefore, you either pass in a function like `require('someplugin').some_function`, without actually calling it, +or you define your own function, like `function() require('someplugin').some_function() end`. + +Additionally, to not have to repeat the descriptions, there's another utility function with its own set of functions: + +Utility function that takes two attrsets: + +- `{ someKey = "some_value" }` +- `{ someKey = { description = "Some Description"; }; }` + +and merges them into `{ someKey = { value = "some_value"; description = "Some Description"; }; }` + +``` +addDescriptionsToMappings = actualMappings: mappingDefinitions: +``` + +This function can be used in combination with the same `mkBinding` functions as above, except they only take two +arguments - `binding` and `action`, and have different names: + +- `mkSetBinding = binding: action:` - makes a basic binding, with `silent` set to true. +- `mkSetExprBinding = binding: action:` - makes an expression binding, with `lua`, `silent`, and `expr` set to true. +- `mkSetLuaBinding = binding: action:` - makes an expression binding, with `lua`, and `silent` set to true. + +You can read the source code of some modules to see them in action, but their usage should look something like this: + +```nix + +# plugindefinition.nix +{lib, ...}: with lib; { + options.vim.plugin = { + enable = mkEnableOption "Enable plugin"; + + # Mappings should always be inside an attrset called mappings + mappings = { + # mkMappingOption is a helper function from lib, + # that takes a description (which will also appear in which-key), + # and a default mapping (which can be null) + toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc"; + toggleCurrentBlock = mkMappingOption "Toggle current block comment" "gbc"; + + toggleOpLeaderLine = mkMappingOption "Toggle line comment" "gc"; + toggleOpLeaderBlock = mkMappingOption "Toggle block comment" "gb"; + + toggleSelectedLine = mkMappingOption "Toggle selected comment" "gc"; + toggleSelectedBlock = mkMappingOption "Toggle selected block" "gb"; + }; + + }; +} + +``` + +```nix + +# config.nix +{ + pkgs, + config, + lib, + ... +}: + with lib; + with builtins; let + cfg = config.vim.plugin; + self = import ./plugindefinition.nix {inherit lib;}; + mappingDefinitions = self.options.vim.plugin; + + # addDescriptionsToMappings is a helper function from lib, + # that merges mapping values and their descriptions + # into one nice attribute set + mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions; +in { + config = mkIf (cfg.enable) { + # ... + vim.maps.normal = mkMerge [ + # mkSetBinding is another helper function from lib, + # that actually adds the mapping with a description. + (mkSetBinding mappings.findFiles " Telescope find_files") + (mkSetBinding mappings.liveGrep " Telescope live_grep") + (mkSetBinding mappings.buffers " Telescope buffers") + (mkSetBinding mappings.helpTags " Telescope help_tags") + (mkSetBinding mappings.open " Telescope") + + (mkSetBinding mappings.gitCommits " Telescope git_commits") + (mkSetBinding mappings.gitBufferCommits " Telescope git_bcommits") + (mkSetBinding mappings.gitBranches " Telescope git_branches") + (mkSetBinding mappings.gitStatus " Telescope git_status") + (mkSetBinding mappings.gitStash " Telescope git_stash") + + (mkIf config.vim.lsp.enable (mkMerge [ + (mkSetBinding mappings.lspDocumentSymbols " Telescope lsp_document_symbols") + (mkSetBinding mappings.lspWorkspaceSymbols " Telescope lsp_workspace_symbols") + + (mkSetBinding mappings.lspReferences " Telescope lsp_references") + (mkSetBinding mappings.lspImplementations " Telescope lsp_implementations") + (mkSetBinding mappings.lspDefinitions " Telescope lsp_definitions") + (mkSetBinding mappings.lspTypeDefinitions " Telescope lsp_type_definitions") + (mkSetBinding mappings.diagnostics " Telescope diagnostics") + ])) + + ( + mkIf config.vim.treesitter.enable + (mkSetBinding mappings.treesitter " Telescope treesitter") + ) + ]; + # ... + }; +} + +``` + +:::{.note} + +If you have come across a plugin that has an API that doesn't seem to easily allow custom keybindings, +don't be scared to implement a draft PR. We'll help you get it done. + +::: diff --git a/docs/manual/hacking/testing.md b/docs/manual/hacking/testing.md new file mode 100644 index 0000000..2568ceb --- /dev/null +++ b/docs/manual/hacking/testing.md @@ -0,0 +1,11 @@ +# Testing Changes {#sec-testing-changes} + +Once you have made your changes, you will need to test them throughly. If it is a module, add your module option to +`configuration.nix` (located in the root of this project) inside `neovimConfiguration`. Enable it, and then run the +maximal configuration with `nix run .#maximal -Lv` to check for build errors. If neovim opens in the current directory +without any error messages (you can check the output of `:messages` inside neovim to see if there are any errors), then +your changes are good to go. Open your pull request, and it will be reviewed as soon as posssible. + +If it is not a new module, but a change to an existing one, then make sure the module you have changed is enabled in the +maximal configuration by editing `configuration.nix`, and then run it with `nix run .#maximal -Lv`. Same procedure as +adding a new module will apply here. diff --git a/docs/manual/home-manager.adoc b/docs/manual/home-manager.md similarity index 89% rename from docs/manual/home-manager.adoc rename to docs/manual/home-manager.md index b48f262..63c88ff 100644 --- a/docs/manual/home-manager.adoc +++ b/docs/manual/home-manager.md @@ -1,13 +1,11 @@ -[[ch-hm-module]] -== Home Manager +# Home Manager {#ch-hm-module} The Home Manager module allows us to customize the different `vim` options from inside the home-manager configuration and it is the preferred way of configuring neovim-flake, both on NixOS and non-NixOS systems. To use it, we first add the input flake. -[source,nix] ----- +```nix { neovim-flake = { url = github:notashelf/neovim-flake; @@ -17,22 +15,20 @@ To use it, we first add the input flake. # i.e inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- obsidian nvim needs to be in your inputs }; } ----- +``` Followed by importing the home-manager module somewhere in your configuration. -[source,nix] ----- +```nix { # assuming neovim-flake is in your inputs and inputs is in the argset imports = [ inputs.neovim-flake.homeManagerModules.default ]; } ----- +``` An example installation for standalone home-manager would look like this: -[source,nix] ----- +```nix { inputs = { nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; @@ -52,14 +48,12 @@ An example installation for standalone home-manager would look like this: }; }; } ----- +``` Once the module is imported, we will be able to define the following options (and much more) from inside the home-manager configuration. -[source,nix] ----- -{ +```nix{ programs.neovim-flake = { enable = true; @@ -74,12 +68,8 @@ home-manager configuration. }; }; } ----- - -[NOTE] -==== -You may find all avaliable options in the https://notashelf.github.io/neovim-flake/options[appendix] -==== - - +``` +:::{.note} +You may find all avaliable options in the [appendix](https://notashelf.github.io/neovim-flake/options) +::: diff --git a/docs/manual/languages.adoc b/docs/manual/languages.adoc deleted file mode 100644 index 8a981dc..0000000 --- a/docs/manual/languages.adoc +++ /dev/null @@ -1,40 +0,0 @@ -[[ch-languages]] -== Language Support - -Language specific support means there is a combination of language specific plugins, `treesitter` support, `nvim-lspconfig` language servers, and `null-ls` integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the `vim.languages` attribute. See the configuration docs for details. - -* Rust: <> -* Nix: <> -* SQL: <> -* C/C++: <> -* Typescript/Javascript: <> -* Python: <>: -* Zig: <> -* Markdown: <> -* HTML: <> -* SQL: <> -* Dart: <> -* Go: <> -* Lua: <> -* PHP: <> - -Adding support for more languages, and improving support for existing ones are great places -where you can contribute with a PR. - -=== LSP Custom Packages/Command - -In any of the `opt.languages..lsp.package` options you can provide your own LSP package, or provide -the command to launch the language server, as a list of strings. - -You can use this to skip automatic installation of a language server, and instead -use the one found in your `$PATH` during runtime, for example: - -[source,nix] ----- -vim.languages.java = { - lsp = { - enable = true; - package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"]; - }; -} ----- diff --git a/docs/manual/languages.md b/docs/manual/languages.md new file mode 100644 index 0000000..1508318 --- /dev/null +++ b/docs/manual/languages.md @@ -0,0 +1,24 @@ +# Language Support {#ch-languages} + +Language specific support means there is a combination of language specific plugins, `treesitter` support, `nvim-lspconfig` language servers, and `null-ls` integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the `vim.languages` attribute. See the configuration docs for details. + +- Rust: [vim.languages.rust.enable](#opt-vim.languages.rust.enable) +- Nix: [vim.languages.nix.enable](#opt-vim.languages.nix.enable) +- SQL: [vim.languages.sql.enable](#opt-vim.languages.sql.enable) +- C/C++: [vim.languages.clang.enable](#opt-vim.languages.clang.enable) +- Typescript/Javascript: [vim.languages.ts.enable](#opt-vim.languages.ts.enable) +- Python: [vim.languages.python.enable](#opt-vim.languages.python.enable): +- Zig: [vim.languages.zig.enable](#opt-vim.languages.zig.enable) +- Markdown: [vim.languages.markdown.enable](#opt-vim.languages.markdown.enable) +- HTML: [vim.languages.html.enable](#opt-vim.languages.html.enable) +- Dart: [vim.languages.dart.enable](#opt-vim.languages.dart.enable) +- Go: [vim.languages.go.enable](#opt-vim.languages.go.enable) +- Lua: [vim.languages.lua.enable](#opt-vim.languages.lua.enable) +- PHP: [vim.languages.php.enable](#opt-vim.languages.php.enable) + +Adding support for more languages, and improving support for existing ones are great places +where you can contribute with a PR. + +```{=include=} sections +languages/lsp.md +``` diff --git a/docs/manual/languages/lsp.md b/docs/manual/languages/lsp.md new file mode 100644 index 0000000..8d72f11 --- /dev/null +++ b/docs/manual/languages/lsp.md @@ -0,0 +1,16 @@ +# LSP Custom Packages/Command {#sec-languages-custom-lsp-packages} + +In any of the `opt.languages..lsp.package` options you can provide your own LSP package, or provide +the command to launch the language server, as a list of strings. + +You can use this to skip automatic installation of a language server, and instead +use the one found in your `$PATH` during runtime, for example: + +```nix +vim.languages.java = { + lsp = { + enable = true; + package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"]; + }; +} +``` diff --git a/docs/manual/manpage-urls.json b/docs/manual/manpage-urls.json new file mode 100644 index 0000000..fba2bdd --- /dev/null +++ b/docs/manual/manpage-urls.json @@ -0,0 +1,3 @@ +{ + "nix.conf(5)": "https://nixos.org/manual/nix/stable/command-ref/conf-file.html" +} diff --git a/docs/manual/manual.md b/docs/manual/manual.md new file mode 100644 index 0000000..e026824 --- /dev/null +++ b/docs/manual/manual.md @@ -0,0 +1,22 @@ +# neovim-flake-manual {#neovim-flake-manual} + +## Version @VERSION@ + +```{=include=} preface +preface.md +try-it-out.md +``` + +```{=include=} parts +custom-configs.md +custom-package.md +custom-plugins.md +default-configs.md +home-manager.md +languages.md +hacking.md +``` + +```{=include=} appendix html:into-file=//options.html +options.md +``` diff --git a/docs/manual/options.md b/docs/manual/options.md new file mode 100644 index 0000000..6bd41f9 --- /dev/null +++ b/docs/manual/options.md @@ -0,0 +1,7 @@ +# Neovim Flake Configuration Options {#ch-options} + +```{=include=} options +id-prefix: opt- +list-id: neovim-flake-options +source: @OPTIONS_JSON@ +``` diff --git a/docs/manual/preface.md b/docs/manual/preface.md new file mode 100644 index 0000000..9aa02ea --- /dev/null +++ b/docs/manual/preface.md @@ -0,0 +1,6 @@ +# Preface {#sec-preface} + +If you noticed a bug caused by neovim-flake then please consider reporting it over +[the neovim-flake issue tracker](https://github.com/notashelf/neovim-flake/issues). +Bugfixes, feature additions and upstreamed changes are welcome over +[the neovim-flake pull requests tab](https://github.com/notashelf/neovim-flake/pulls). diff --git a/docs/manual/try-it-out.adoc b/docs/manual/try-it-out.md similarity index 76% rename from docs/manual/try-it-out.adoc rename to docs/manual/try-it-out.md index f186de1..8b17005 100644 --- a/docs/manual/try-it-out.adoc +++ b/docs/manual/try-it-out.md @@ -1,53 +1,47 @@ -[[ch-try-it-out]] -== Try it out +# Try it out {#ch-try-it-out} Thanks to the portability of Nix, you can try out neovim-flake without actually installing it to your machine. Below are the commands you may run to try out different configurations provided by this flake. As of v0.5, three configurations are provided: -* Nix -* Tidal -* Maximal +- Nix +- Tidal +- Maximal You may try out any of the provided configurations using the `nix run` command on a system where Nix is installed. -[source,console] ----- +```console $ cachix use neovim-flake # Optional: it'll save you CPU resources and time $ nix run github:notashelf/neovim-flake#nix # will run the default minimal configuration ----- +``` Do keep in mind that this is **susceptible to garbage collection** meaning it will be removed from your Nix store once you garbage collect. If you wish to install neovim-flake, please take a look at -<> or <> sections for installation +[custom-configuration](#ch-custom-configuration) or [home-manager](#ch-hm-module) sections for installation instructions. -[[sec-using-prebuild-configs]] -=== Using Prebuilt Configs +## Using Prebuilt Configs {#sec-using-prebuild-configs} -[source,console] ----- +```console $ nix run github:notashelf/neovim-flake#nix $ nix run github:notashelf/neovim-flake#tidal $ nix run github:notashelf/neovim-flake#maximal ----- +``` +### Available Configs {#sec-available-configs} -[[sec-available-configs]] -=== Available Configs - -==== Nix +#### Nix {#sec-configs-nix} `Nix` configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins. By running `nix run .`, which is the default package, you will build Neovim with this config. -==== Tidal +#### Tidal {#sec-configs-tidal} Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration. -==== Maximal +#### Maximal {#sec-configs-maximal} `Maximal` is the ultimate configuration that will enable support for more commonly used language as well as additional complementary plugins. Keep in mind, however, that this will pull a lot of dependencies. -You are *strongly* recommended to use the binary cache if you would like to try the Maximal configuration. +You are _strongly_ recommended to use the binary cache if you would like to try the Maximal configuration. diff --git a/docs/neovim-flake.1 b/docs/neovim-flake.1 new file mode 100644 index 0000000..54aab90 --- /dev/null +++ b/docs/neovim-flake.1 @@ -0,0 +1,29 @@ +.Dd January 1, 1980 +.Dt neovim-flake 1 +.Os neovim-flake +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" enable line breaks after slashes +.cflags 4 / +.Sh NAME +.Nm neovim-flake +.Nd a extensible and distro-agonistic Neovim configuration wrapper in Nix +. +.Sh BUGS +.Pp +Please report any bugs on the +\m[blue]\fBproject issue tracker\fR\m[]\&. + +.Sh AUTHOR +.Pp +\fBneovim-flake contributors\fR +.RS 4 +Author. +.RE + +.Sh COPYRIGHT +.br +Copyright \(co 2017\(en2022 neovim-flake contributors +.br diff --git a/flake.lock b/flake.lock index b90a3cb..4410222 100644 --- a/flake.lock +++ b/flake.lock @@ -3,11 +3,11 @@ "alpha-nvim": { "flake": false, "locked": { - "lastModified": 1689470865, - "narHash": "sha256-wgjYus4XlJ0GoQWTo5gf7yyKYhseOXKOqUXEiwXpEJQ=", + "lastModified": 1701205026, + "narHash": "sha256-R0Sjkhzn1Rueptcxnu69UataPWAnZnbwqRXoEHIivo4=", "owner": "goolord", "repo": "alpha-nvim", - "rev": "e4fc5e29b731bdf55d204c5c6a11dc3be70f3b65", + "rev": "29074eeb869a6cbac9ce1fbbd04f5f5940311b32", "type": "github" }, "original": { @@ -35,11 +35,11 @@ "catppuccin": { "flake": false, "locked": { - "lastModified": 1700667946, - "narHash": "sha256-TBOaD7A8/c/sg78C1hUpPDuIrrQkSUQR1KgHiDb6jxs=", + "lastModified": 1703191933, + "narHash": "sha256-ENqPmCpQYTaMTa7dpnqzuzU3F0czSCg9HQ1ktz9lxdw=", "owner": "catppuccin", "repo": "nvim", - "rev": "a2107df4379d66e72a36a89792603151cebec1bf", + "rev": "4fbab1f01488718c3d54034a473d0346346b90e3", "type": "github" }, "original": { @@ -51,11 +51,11 @@ "ccc": { "flake": false, "locked": { - "lastModified": 1686587775, - "narHash": "sha256-T1ryyTdbU/335MpD184PSnBLgj4S2Kzf9hZnwc9to+I=", + "lastModified": 1702716924, + "narHash": "sha256-nWe7uYWPZ1LjQRVynYnPomb4EFfyh919Jsh07UPSdvg=", "owner": "uga-rosa", "repo": "ccc.nvim", - "rev": "4a0ddaf787cc82796e84ab8a7f70d086f250aeb6", + "rev": "ec6e23fd2c0bf4ffcf71c1271acdcee6e2c6f49c", "type": "github" }, "original": { @@ -67,11 +67,11 @@ "cellular-automaton": { "flake": false, "locked": { - "lastModified": 1674679594, - "narHash": "sha256-h4KQCf8+GbxWSyZzDny07YFZm7j+aSSfm51lsaK0Ers=", + "lastModified": 1693589931, + "narHash": "sha256-szbd6m7hH7NFI0UzjWF83xkpSJeUWCbn9c+O8F8S/Fg=", "owner": "Eandrju", "repo": "cellular-automaton.nvim", - "rev": "679943b8e1e5ef79aaeeaf4b00782c52eb4e928f", + "rev": "b7d056dab963b5d3f2c560d92937cb51db61cb5b", "type": "github" }, "original": { @@ -131,11 +131,11 @@ "cmp-nvim-lsp": { "flake": false, "locked": { - "lastModified": 1687494203, - "narHash": "sha256-mU0soCz79erJXMMqD/FyrJZ0mu2n6fE0deymPzQlxts=", + "lastModified": 1702205473, + "narHash": "sha256-/0sh9vJBD9pUuD7q3tNSQ1YLvxFMNykdg5eG+LjZAA8=", "owner": "hrsh7th", "repo": "cmp-nvim-lsp", - "rev": "44b16d11215dce86f253ce0c30949813c0a90765", + "rev": "5af77f54de1b16c34b23cba810150689a3a90312", "type": "github" }, "original": { @@ -163,11 +163,11 @@ "cmp-treesitter": { "flake": false, "locked": { - "lastModified": 1680745848, - "narHash": "sha256-WOcg6w4M20gpMCZjZ3DpPIA55SGLjV75fhckefiVfU0=", + "lastModified": 1702163214, + "narHash": "sha256-K7F9iqmB13ONenwsbaND8F4010MvHQXp7DxMFfcsZ4A=", "owner": "ray-x", "repo": "cmp-treesitter", - "rev": "389eadd48c27aa6dc0e6b992644704f026802a2e", + "rev": "13e4ef8f4dd5639fca2eb9150e68f47639a9b37d", "type": "github" }, "original": { @@ -195,11 +195,11 @@ "codewindow-nvim": { "flake": false, "locked": { - "lastModified": 1690128662, - "narHash": "sha256-7ntC06PhxfuKnGyXpiW4juP3fWR97DH3Gygwvscv3OY=", + "lastModified": 1695487629, + "narHash": "sha256-/u2Zjbd9m3/iJU3I3HzFzXWxuvoycwJoIq7UFeHNtKM=", "owner": "gorbit99", "repo": "codewindow.nvim", - "rev": "11fb5520898d22a563fe6a124a61c0d2887f3d3f", + "rev": "8c8f5ff66e123491c946c04848d744fcdc7cac6c", "type": "github" }, "original": { @@ -211,11 +211,11 @@ "comment-nvim": { "flake": false, "locked": { - "lastModified": 1686546603, - "narHash": "sha256-XM9yhp+SGxfAOdN/eDunzM0TMoCJhVth3wpFKNCGf3g=", + "lastModified": 1691409559, + "narHash": "sha256-+dF1ZombrlO6nQggufSb0igXW5zwU++o0W/5ZA07cdc=", "owner": "numToStr", "repo": "Comment.nvim", - "rev": "176e85eeb63f1a5970d6b88f1725039d85ca0055", + "rev": "0236521ea582747b58869cb72f70ccfa967d2e89", "type": "github" }, "original": { @@ -227,11 +227,11 @@ "copilot-cmp": { "flake": false, "locked": { - "lastModified": 1683831407, - "narHash": "sha256-+MzEGnhlrYRvAfskOwmw69OC1CsPXt7s3z+xPe9XPqs=", + "lastModified": 1694286652, + "narHash": "sha256-srgNohm/aJpswNJ5+T7p+zi9Jinp9e5FA8/wdk6VRiY=", "owner": "zbirenbaum", "repo": "copilot-cmp", - "rev": "c2cdb3c0f5078b0619055af192295830a7987790", + "rev": "72fbaa03695779f8349be3ac54fa8bd77eed3ee3", "type": "github" }, "original": { @@ -243,11 +243,11 @@ "copilot-lua": { "flake": false, "locked": { - "lastModified": 1688190439, - "narHash": "sha256-lD9FdbKKZ6d/BjIfqp0Ust2hqSYNLpCFWxuaKUO9qLs=", + "lastModified": 1702668818, + "narHash": "sha256-eeSjcnveoqsod9b0WfT4P5u6yoytnA118buMJCkWSLk=", "owner": "zbirenbaum", "repo": "copilot.lua", - "rev": "e48bd7020a98be217d85c006a298656294fd6210", + "rev": "dcaaed5b58e6c2d395bca18d25d34e6384856722", "type": "github" }, "original": { @@ -259,11 +259,11 @@ "crates-nvim": { "flake": false, "locked": { - "lastModified": 1688295570, - "narHash": "sha256-ah+fTmzkZn+xuL3sG2RxlCtDiFsRv3SY1iJzYKMIaMg=", + "lastModified": 1703082380, + "narHash": "sha256-pXkzxP/yf+4hLr553pXIW9mJ3u2xb61nHXqhja6JmbY=", "owner": "Saecki", "repo": "crates.nvim", - "rev": "4ce7c51b881e58f1e2f8f437f30e4e583cbac319", + "rev": "81c6325b7f8875857ec09e5d24f3b6d7986f29e2", "type": "github" }, "original": { @@ -275,11 +275,11 @@ "dashboard-nvim": { "flake": false, "locked": { - "lastModified": 1690351087, - "narHash": "sha256-aVMugjgA9lnORUVDBpa8G800Ev86htP4hDGrBq6Sw6s=", + "lastModified": 1699578883, + "narHash": "sha256-LNjYIRL5xZyLgFkoTu3K5USOfk1mtaXe5RhKBAbzYRw=", "owner": "glepnir", "repo": "dashboard-nvim", - "rev": "c17d3210b3dec8798b4fc82a11c542989251f85d", + "rev": "63df28409d940f9cac0a925df09d3dc369db9841", "type": "github" }, "original": { @@ -291,11 +291,11 @@ "diffview-nvim": { "flake": false, "locked": { - "lastModified": 1689788060, - "narHash": "sha256-0tsgwI/qZm8Gj3NyN9CA+YHf3qim7vGXI+vbEcFBKbQ=", + "lastModified": 1700506468, + "narHash": "sha256-3EdnBUka9Rh5Brl6TWpN6GlD9z32mmY3Ip+wyiKob/8=", "owner": "sindrets", "repo": "diffview.nvim", - "rev": "e91110d2a7f8e2f667666aba6ea089ff823f8748", + "rev": "3dc498c9777fe79156f3d32dddd483b8b3dbd95f", "type": "github" }, "original": { @@ -307,11 +307,11 @@ "dirt-samples-src": { "flake": false, "locked": { - "lastModified": 1588278411, - "narHash": "sha256-h8vQxRym6QzNLOTZU7A43VCHuG0H77l+BFwXnC0L1CE=", + "lastModified": 1667426233, + "narHash": "sha256-Zl2bi9QofcrhU63eMtg+R6lhV9ExQS/0XNTJ+oq65Uo=", "owner": "tidalcycles", "repo": "dirt-samples", - "rev": "66d432418c9a7d82cf049d9246adfa62f46df2a6", + "rev": "92f2145e661b397e62ca0ff3965819e7c7db0dad", "type": "github" }, "original": { @@ -324,11 +324,11 @@ "dracula": { "flake": false, "locked": { - "lastModified": 1690594744, - "narHash": "sha256-gblqxRTphGBpEOx57/4oU/B50O0OguIm1bFtd4LXuQ4=", + "lastModified": 1702658179, + "narHash": "sha256-lM+d5S73XDTOJ2FUxgWdWzTPbtZzRE7iJ2m9r92cIqg=", "owner": "Mofiqul", "repo": "dracula.nvim", - "rev": "9fe831e685a76e1a1898a694623b33247c4d036c", + "rev": "cadf9a1d873d67a92a76b258715cad91f0c1dbb9", "type": "github" }, "original": { @@ -340,11 +340,11 @@ "dressing-nvim": { "flake": false, "locked": { - "lastModified": 1690648598, - "narHash": "sha256-hndRErSXhX1BHM90nuhiZkgHwkclLEMv5vtF+GDzUP4=", + "lastModified": 1701415471, + "narHash": "sha256-yza3h2IwgWppKmHLhguWfp1bZO0m94x3+G4lF/dVQ74=", "owner": "stevearc", "repo": "dressing.nvim", - "rev": "829bc80400651aea31b03d8fc9a99135512fe67a", + "rev": "8b7ae53d7f04f33be3439a441db8071c96092d19", "type": "github" }, "original": { @@ -356,11 +356,11 @@ "elixir-ls": { "flake": false, "locked": { - "lastModified": 1690526097, - "narHash": "sha256-lR1xsOJhz0W/Z3E2EUWujpUvpgUkLLDr0E6Ao31zi8s=", + "lastModified": 1703238342, + "narHash": "sha256-tiBTcetY31gbg+8+orWs1SPcWPKG1tv/nkZpYDmt/Ns=", "owner": "elixir-lsp", "repo": "elixir-ls", - "rev": "216ff0e2969c2bbe45d324c4d6a5f08e6b681f5e", + "rev": "ad3473c6ce388c1e6dcb042aea55205e0dc99616", "type": "github" }, "original": { @@ -372,11 +372,11 @@ "elixir-tools": { "flake": false, "locked": { - "lastModified": 1690555653, - "narHash": "sha256-7wDEChXTUGp8ONT6jufIJp05vawzo4AXg35ELNLvysA=", + "lastModified": 1699924210, + "narHash": "sha256-KyOqvh1eXbgp9+uNkyPhtUfUPZeCP6cqknxjEyXdFmY=", "owner": "elixir-tools", "repo": "elixir-tools.nvim", - "rev": "883933b57c9150c71ad2b99a4080685d83e095b8", + "rev": "8f573b0b089567aa9c544b029000c97e715e5f58", "type": "github" }, "original": { @@ -388,11 +388,11 @@ "fidget-nvim": { "flake": false, "locked": { - "lastModified": 1686378433, - "narHash": "sha256-N3O/AvsD6Ckd62kDEN4z/K5A3SZNR15DnQeZhH6/Rr0=", + "lastModified": 1699509702, + "narHash": "sha256-8Gl2Ck4YJGReSEq1Xeh1dpdRq4eImmrxvIHrfxdem3Q=", "owner": "j-hui", "repo": "fidget.nvim", - "rev": "90c22e47be057562ee9566bad313ad42d622c1d3", + "rev": "2f7c08f45639a64a5c0abcf67321d52c3f499ae6", "type": "github" }, "original": { @@ -423,11 +423,11 @@ "nixpkgs-lib": "nixpkgs-lib" }, "locked": { - "lastModified": 1698882062, - "narHash": "sha256-HkhafUayIqxXyHH1X8d9RDl1M2CkFgZLjKD3MzabiEo=", + "lastModified": 1701473968, + "narHash": "sha256-YcVE5emp1qQ8ieHUnxt1wCZCC3ZfAS+SRRWZ2TMda7E=", "owner": "hercules-ci", "repo": "flake-parts", - "rev": "8c9fa2545007b49a5db5f650ae91f227672c3877", + "rev": "34fed993f1674c8d06d58b37ce1e0fe5eebcb9f5", "type": "github" }, "original": { @@ -441,11 +441,11 @@ "systems": "systems" }, "locked": { - "lastModified": 1694529238, - "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", + "lastModified": 1701680307, + "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", "owner": "numtide", "repo": "flake-utils", - "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", + "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", "type": "github" }, "original": { @@ -472,11 +472,11 @@ "flutter-tools": { "flake": false, "locked": { - "lastModified": 1690188839, - "narHash": "sha256-h8s5g6KU7dMesDqiwzv2MmUGk6jlU5lBnuVA3LaoI1g=", + "lastModified": 1702990002, + "narHash": "sha256-V2BbQ5LT+yuSInRLtZuYRPPIKSHLDz5MiOeq+s+3z7E=", "owner": "akinsho", "repo": "flutter-tools.nvim", - "rev": "561d85b16d8ca2938820a9c26b2fe74096d89c81", + "rev": "7cb01c52ac9ece55118be71e0f7457783d5522a4", "type": "github" }, "original": { @@ -488,11 +488,11 @@ "gesture-nvim": { "flake": false, "locked": { - "lastModified": 1687655077, - "narHash": "sha256-ps/dAKIga2ZVunwj+KU/Iej4PGZbBvm5ZzcK30EiKMc=", + "lastModified": 1696828351, + "narHash": "sha256-+wEbR7GsTD+1sXFCB7StWRaNosnCoxi2DYjSvNl5V4A=", "owner": "notomo", "repo": "gesture.nvim", - "rev": "aa273e7982943ac6ccf6b864f3fd40ad287a9fe2", + "rev": "ebcbe7c6bdd21ac6d7a73f4164cbbba9cfd3247d", "type": "github" }, "original": { @@ -504,11 +504,11 @@ "gitsigns-nvim": { "flake": false, "locked": { - "lastModified": 1690463120, - "narHash": "sha256-kraK0GP5aLGbh1eVZCm41D6BztjFxthSXGnE5CxhrZs=", + "lastModified": 1702378585, + "narHash": "sha256-lzL+1OOS0bpMeB9SCkc147/OdweI206r0yPFBmhsN1g=", "owner": "lewis6991", "repo": "gitsigns.nvim", - "rev": "5d73da785a3c05fd63ac31769079db05169a6ec7", + "rev": "d195f0c35ced5174d3ecce1c4c8ebb3b5bc23fa9", "type": "github" }, "original": { @@ -520,11 +520,11 @@ "glow-nvim": { "flake": false, "locked": { - "lastModified": 1690579937, - "narHash": "sha256-ZDlQfSJHq9CbOpTDgmIoMq4gDzHxoUslFfN5XKtrDtM=", + "lastModified": 1693233815, + "narHash": "sha256-vdlwkIK2EkFviJmSiOqPWvc15xqJ9F2gHCC4ObJ5Qjk=", "owner": "ellisonleao", "repo": "glow.nvim", - "rev": "8942dfb05794f436af4fbc90a34393f1fd36f361", + "rev": "5b38fb7b6e806cac62707a4aba8c10c5f14d5bb5", "type": "github" }, "original": { @@ -552,11 +552,11 @@ "hop-nvim": { "flake": false, "locked": { - "lastModified": 1684332066, - "narHash": "sha256-xdjFbdp0+S3pVdwcOFmad8PMUU033WeDzswOSdxSQjg=", + "lastModified": 1694283445, + "narHash": "sha256-SnuFeD/lrMxKtpBRPgIwdG0kVF7BWe02PiV7URVDASI=", "owner": "phaazon", "repo": "hop.nvim", - "rev": "03f0434869f1f38868618198b5f4f2ab6d39aef2", + "rev": "1a1eceafe54b5081eae4cb91c723abd1d450f34b", "type": "github" }, "original": { @@ -584,11 +584,11 @@ "indent-blankline": { "flake": false, "locked": { - "lastModified": 1697081010, - "narHash": "sha256-e8gn4pJYALaQ6sGA66SFf8p6VLJBPxT/BimQhOd5eBs=", + "lastModified": 1703209316, + "narHash": "sha256-aD7JPV/fcwEVErFoATRYPcUswiTp20I2OjRWYiq/SoA=", "owner": "lukas-reineke", "repo": "indent-blankline.nvim", - "rev": "0fe34b4c1b926e106d105d3ae88ef6cbf6743572", + "rev": "3084950d1b66426d207064a509477cbfa96362c6", "type": "github" }, "original": { @@ -600,11 +600,11 @@ "kommentary": { "flake": false, "locked": { - "lastModified": 1672983049, - "narHash": "sha256-N4n5tjNB1yX/QxH+t5aG0VxNwZhUJejv0b5V62WEKDU=", + "lastModified": 1701264889, + "narHash": "sha256-lpa3o42jieVKqs+ZCU8HBqWsoqoc53JKMmCNmIJ0rH0=", "owner": "b3nj5m1n", "repo": "kommentary", - "rev": "3a80117148c6798972bb69414423311ab151d368", + "rev": "d5a111a3bc4109a8f913a5863c9092b3b3801482", "type": "github" }, "original": { @@ -616,11 +616,11 @@ "leap-nvim": { "flake": false, "locked": { - "lastModified": 1690120911, - "narHash": "sha256-9GFZ5CuR92kFGwh/ouqSSp14eOLZLpzpoFTEuYL7biQ=", + "lastModified": 1703147489, + "narHash": "sha256-Q9ghtomDLM+eHTwXx2WMeQoE5NTRt+8u7IK9IoXAiA4=", "owner": "ggandor", "repo": "leap.nvim", - "rev": "5efe985cf68fac3b6a6dfe7a75fbfaca8db2af9c", + "rev": "b20691cc8824826571e5298d1402730bb9c721d2", "type": "github" }, "original": { @@ -632,11 +632,11 @@ "lsp-lines": { "flake": false, "locked": { - "lastModified": 1684163755, - "narHash": "sha256-Zhf2xitLWtE+dWqhvWtLM1K1WdtBvkqqoRLSYIO42oY=", + "lastModified": 1698584731, + "narHash": "sha256-3DWM2mTnm6b7J4cYUwCKBGHkXw/dQDO0ZTJXkTl06aE=", "owner": "~whynothugo", "repo": "lsp_lines.nvim", - "rev": "f53af96d4789eef39a082dbcce078d2bfc384ece", + "rev": "cf2306dd332e34a3e91075b40bdd4f6db824b2ee", "type": "sourcehut" }, "original": { @@ -648,11 +648,11 @@ "lsp-signature": { "flake": false, "locked": { - "lastModified": 1690267930, - "narHash": "sha256-qvcs0KuO2/NdtiTZIxJ2vrwV0I5PjzjMvoAePPasaJM=", + "lastModified": 1701211782, + "narHash": "sha256-4GcTfu7MRpZUi5dqewaddSvaOezRl9ROKrR7wnnLnKE=", "owner": "ray-x", "repo": "lsp_signature.nvim", - "rev": "58d4e810801da74c29313da86075d6aea537501f", + "rev": "fed2c8389c148ff1dfdcdca63c2b48d08a50dea0", "type": "github" }, "original": { @@ -696,11 +696,11 @@ "lualine": { "flake": false, "locked": { - "lastModified": 1683213422, - "narHash": "sha256-ltHE8UIquGo07BSlFGM1l3wmTNN43i8kx6QY7Fj2CNo=", + "lastModified": 1697772980, + "narHash": "sha256-jV+6mV0dyuhiHGei1UqE2r2GoiKJLtdZI2AMNexbi7E=", "owner": "hoob3rt", "repo": "lualine.nvim", - "rev": "05d78e9fd0cdfb4545974a5aa14b1be95a86e9c9", + "rev": "2248ef254d0a1488a72041cfb45ca9caada6d994", "type": "github" }, "original": { @@ -728,11 +728,11 @@ "minimap-vim": { "flake": false, "locked": { - "lastModified": 1690301768, - "narHash": "sha256-yRWZH9caSxrWjUXlM84fU90tZjNfX97m0m491ZsIHxA=", + "lastModified": 1696276849, + "narHash": "sha256-bPW/wDCvItpl0VIQCgz5AEYfx1aAnIMhB1S/tJN5/80=", "owner": "wfxr", "repo": "minimap.vim", - "rev": "74573b63b9ef0583262b6bf6ef209eb7f3b06b94", + "rev": "701f4cf4b60a3e1685d2da484282f3a3d8bf9db6", "type": "github" }, "original": { @@ -744,11 +744,11 @@ "modes-nvim": { "flake": false, "locked": { - "lastModified": 1682778003, - "narHash": "sha256-qrGgraBdAvIc6AXqMMWESlOV29lM5zC1du1r5L2kpQQ=", + "lastModified": 1702245923, + "narHash": "sha256-Kd2hf5obrPvCVLtRcFjLd75byyrB2o3uYCSEMW6IeCc=", "owner": "mvllow", "repo": "modes.nvim", - "rev": "4d97a51ebbdb649b85f6d79da0009fddd7081a6b", + "rev": "4035a46aaabe43faf1b54740575af9dd5bb03809", "type": "github" }, "original": { @@ -781,11 +781,11 @@ "neodev-nvim": { "flake": false, "locked": { - "lastModified": 1695449121, - "narHash": "sha256-WisbNLKEz0IgO7gLDA2quNzK69hJaHzmvWkZSUPQb6k=", + "lastModified": 1703225156, + "narHash": "sha256-+Sz4utV0JFmn1ZA+Xqq/0KW2oIUpr8gNdJhSPA2Yj/k=", "owner": "folke", "repo": "neodev.nvim", - "rev": "c8e126393a34939fb448d48eeddb510971739e3a", + "rev": "0afdcb703f265c3079a47857bda01e3ccf884558", "type": "github" }, "original": { @@ -805,11 +805,11 @@ "rust-overlay": "rust-overlay" }, "locked": { - "lastModified": 1699423608, - "narHash": "sha256-WEVUgivm5DCziwZqiXRPeoD3FQTXW38ExKrZjvMveqE=", + "lastModified": 1701225372, + "narHash": "sha256-QSiFeEmTzAIIiCtUaMesu7wi7bvfHuFzPMQpOKMt4Lo=", "owner": "oxalica", "repo": "nil", - "rev": "5607d429016d6f9a72843b07127fad23ea9d661f", + "rev": "0031eb4343fd4672742fd6ff839da9b4f5120646", "type": "github" }, "original": { @@ -820,11 +820,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1700794826, - "narHash": "sha256-RyJTnTNKhO0yqRpDISk03I/4A67/dp96YRxc86YOPgU=", + "lastModified": 1703013332, + "narHash": "sha256-+tFNwMvlXLbJZXiMHqYq77z/RfmpfpiI3yjL6o/Zo9M=", "owner": "nixos", "repo": "nixpkgs", - "rev": "5a09cb4b393d58f9ed0d9ca1555016a8543c2ac8", + "rev": "54aac082a4d9bb5bbc5c4e899603abfb76a3f6d6", "type": "github" }, "original": { @@ -837,11 +837,11 @@ "nixpkgs-lib": { "locked": { "dir": "lib", - "lastModified": 1698611440, - "narHash": "sha256-jPjHjrerhYDy3q9+s5EAsuhyhuknNfowY6yt6pjn9pc=", + "lastModified": 1701253981, + "narHash": "sha256-ztaDIyZ7HrTAfEEUt9AtTDNoCYxUdSd6NrRHaYOIxtk=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "0cbe9f69c234a7700596e943bfae7ef27a31b735", + "rev": "e92039b55bcd58469325ded85d4f58dd5a4eaf58", "type": "github" }, "original": { @@ -870,11 +870,11 @@ }, "nixpkgs_3": { "locked": { - "lastModified": 1655400192, - "narHash": "sha256-49OBVVRgb9H/PSmNT9W61+NRdDbuSJVuDDflwXlaUKU=", + "lastModified": 1693844670, + "narHash": "sha256-t69F2nBB8DNQUWHD809oJZJVE+23XBrth4QZuVd6IE0=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "3d7435c638baffaa826b85459df0fff47f12317d", + "rev": "3c15feef7770eb5500a4b8792623e2d6f598c9c1", "type": "github" }, "original": { @@ -886,16 +886,16 @@ }, "nixpkgs_4": { "locked": { - "lastModified": 1689088367, - "narHash": "sha256-Y2tl2TlKCWEHrOeM9ivjCLlRAKH3qoPUE/emhZECU14=", + "lastModified": 1702350026, + "narHash": "sha256-A+GNZFZdfl4JdDphYKBJ5Ef1HOiFsP18vQe9mqjmUis=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "5c9ddb86679c400d6b7360797b8a22167c2053f8", + "rev": "9463103069725474698139ab10f17a9d125da859", "type": "github" }, "original": { "owner": "NixOS", - "ref": "release-23.05", + "ref": "nixos-23.05", "repo": "nixpkgs", "type": "github" } @@ -903,27 +903,27 @@ "nmd": { "flake": false, "locked": { - "lastModified": 1696846470, - "narHash": "sha256-S/6s3nRcg+xZfsO7aLe01W+EMAKFVyieHa4eFvOKOLk=", - "owner": "horriblename", + "lastModified": 1701431551, + "narHash": "sha256-5HPHG1u3koaWHG/TXHl5/YxYPYOuKc58104btrD8ypE=", + "owner": "~rycee", "repo": "nmd", - "rev": "bcf805ce85b9e938f7e027b3311137ffbd995794", - "type": "github" + "rev": "f18defadcc25e69e95b04493ee02682005472255", + "type": "sourcehut" }, "original": { - "owner": "horriblename", + "owner": "~rycee", "repo": "nmd", - "type": "github" + "type": "sourcehut" } }, "noice-nvim": { "flake": false, "locked": { - "lastModified": 1690306450, - "narHash": "sha256-Zca6meJkfF4fl17Y+6s77GYrqnhkkzIYW73vAhKg7e4=", + "lastModified": 1698229631, + "narHash": "sha256-7lgJK5pkMqwIXNeBDsz4B8UAKnkpUvDrHdeG/aSFRzM=", "owner": "folke", "repo": "noice.nvim", - "rev": "894db25ec726d32047799d4d0a982b701bec453b", + "rev": "92433164e2f7118d4122c7674c3834d9511722ba", "type": "github" }, "original": { @@ -935,11 +935,11 @@ "none-ls": { "flake": false, "locked": { - "lastModified": 1697600654, - "narHash": "sha256-dDMZEgT5uG31bEsLiX9r6MJlOJUdQyeTPJAeRcY2z7s=", + "lastModified": 1703042394, + "narHash": "sha256-dQP/rrIM4QbDI/r4dtxlT5FmsdE8ak9mwr/jF6MVXTw=", "owner": "nvimtools", "repo": "none-ls.nvim", - "rev": "dc9b7e28f5573a1a2225ffb33893d23d3e052ed6", + "rev": "bbd8c0c2b8a47ff2e0a97868afdf3fc640f1ad1e", "type": "github" }, "original": { @@ -951,11 +951,11 @@ "nui-nvim": { "flake": false, "locked": { - "lastModified": 1689828309, - "narHash": "sha256-nSUs9zAX7hQ3PuFrH4zQblMfTY6ALDNggmqaQnkbR5E=", + "lastModified": 1701845751, + "narHash": "sha256-LPNDj2VuFlLdRGZlMgspMTPsnygO/Slw9NpPUqjHqc4=", "owner": "MunifTanjim", "repo": "nui.nvim", - "rev": "9e3916e784660f55f47daa6f26053ad044db5d6a", + "rev": "c9b4de623d19a85b353ff70d2ae9c77143abe69c", "type": "github" }, "original": { @@ -967,11 +967,11 @@ "nvim-autopairs": { "flake": false, "locked": { - "lastModified": 1689332359, - "narHash": "sha256-bu+WpW5Wfk3pS74mzVvehl7dVMHgrttmV4ZSlfwbai4=", + "lastModified": 1703044435, + "narHash": "sha256-H4wCE3snCBQVkiA4+r5VaUrd4bWOhF1lwafngGThm/c=", "owner": "windwp", "repo": "nvim-autopairs", - "rev": "ae5b41ce880a6d850055e262d6dfebd362bb276e", + "rev": "9fd41181693dd4106b3e414a822bb6569924de81", "type": "github" }, "original": { @@ -983,11 +983,11 @@ "nvim-bufferline-lua": { "flake": false, "locked": { - "lastModified": 1690184232, - "narHash": "sha256-MiQsYeLgADCaUf1x88q/7gO17F992HMlt1pu9dYEmp0=", + "lastModified": 1702475933, + "narHash": "sha256-xguFDEZVEVbIjdd0XnvRBjgB20Ym2ci1F+zw5jcVThk=", "owner": "akinsho", "repo": "nvim-bufferline.lua", - "rev": "99f0932365b34e22549ff58e1bea388465d15e99", + "rev": "e48ce1805697e4bb97bc171c081e849a65859244", "type": "github" }, "original": { @@ -999,11 +999,11 @@ "nvim-cmp": { "flake": false, "locked": { - "lastModified": 1688965049, - "narHash": "sha256-Hq6YUfMQo1rHoay3/NieGCne7U/f06GwUPhN2HO0PdQ=", + "lastModified": 1702541213, + "narHash": "sha256-BtAYRYn6m788zAq/mNnbAzAxp1TGf9QkRE0hSOp9sdc=", "owner": "hrsh7th", "repo": "nvim-cmp", - "rev": "c4e491a87eeacf0408902c32f031d802c7eafce8", + "rev": "538e37ba87284942c1d76ed38dd497e54e65b891", "type": "github" }, "original": { @@ -1015,11 +1015,11 @@ "nvim-code-action-menu": { "flake": false, "locked": { - "lastModified": 1671523188, - "narHash": "sha256-7szx+Me6WhrANbmfQ6C6gfSVB2owd02b3iZYhz7K6wY=", + "lastModified": 1702287297, + "narHash": "sha256-pY+aP9iBuJhvDZzVEsOHZmnfaq3vUP7TfKEEQrj+Mo8=", "owner": "weilbith", "repo": "nvim-code-action-menu", - "rev": "e4399dbaf6eabff998d3d5f1cbcd8d9933710027", + "rev": "8c7672a4b04d3cc4edd2c484d05b660a9cb34a1b", "type": "github" }, "original": { @@ -1079,11 +1079,11 @@ "nvim-dap": { "flake": false, "locked": { - "lastModified": 1690444190, - "narHash": "sha256-OSJA+K8eGj87RWo2tE0kT6bAItGkMMtuR0HB8WEXZ4k=", + "lastModified": 1703096477, + "narHash": "sha256-UM4BIO/5m5wJGo08Ovguya0RB5T7tYPQ4dH/pVDKun0=", "owner": "mfussenegger", "repo": "nvim-dap", - "rev": "2f28ea843bcdb378b171a66ddcd568516e431d55", + "rev": "f0dca670fa059eb89dda8869a6310c804241345c", "type": "github" }, "original": { @@ -1095,11 +1095,11 @@ "nvim-dap-ui": { "flake": false, "locked": { - "lastModified": 1689371609, - "narHash": "sha256-z6TFe7+r/g2tfgdXr6PCPri5lSboi66zZmsdyWTI1BM=", + "lastModified": 1694342930, + "narHash": "sha256-IdWPzLpNH0fkubELr2uTI7UnB0Yaf/zCkF8WUWBtyaM=", "owner": "rcarriga", "repo": "nvim-dap-ui", - "rev": "85b16ac2309d85c88577cd8ee1733ce52be8227e", + "rev": "34160a7ce6072ef332f350ae1d4a6a501daf0159", "type": "github" }, "original": { @@ -1111,11 +1111,11 @@ "nvim-docs-view": { "flake": false, "locked": { - "lastModified": 1697737319, - "narHash": "sha256-EmQbnleqxE+VHO5bMI9U/gMpwbJbPdNhrEWE7357MCE=", + "lastModified": 1703078963, + "narHash": "sha256-FkDXHUEAfoMgvq6Gv8cd/nTnwYCZqLk1Ob0jCQ+nSfg=", "owner": "amrbashir", "repo": "nvim-docs-view", - "rev": "74a5e989e3fdcfd9418bb9dfec0ace308e00a5a0", + "rev": "17ff4b73e838b15e791940f745b69e28ec5967d7", "type": "github" }, "original": { @@ -1143,11 +1143,11 @@ "nvim-lspconfig": { "flake": false, "locked": { - "lastModified": 1690356683, - "narHash": "sha256-Ama9nLC/T1wJWal6bKvgY0ywUUiJ5VLuIxoY1xbJKtY=", + "lastModified": 1703214333, + "narHash": "sha256-wTQJAwNKlWWPLPu5qhS6TlHSBJBbYTkmHP/7aP9BLnE=", "owner": "neovim", "repo": "nvim-lspconfig", - "rev": "b6091272422bb0fbd729f7f5d17a56d37499c54f", + "rev": "9099871a7c7e1c16122e00d70208a2cd02078d80", "type": "github" }, "original": { @@ -1159,11 +1159,11 @@ "nvim-navbuddy": { "flake": false, "locked": { - "lastModified": 1688569844, - "narHash": "sha256-011RT/wnQdBR1vMrXFwxbicBAgdcd4eQYPbok/o3CIE=", + "lastModified": 1694669446, + "narHash": "sha256-zy1Tq8M5UITNAwtAlFYaUFlHnIZ5LWD9ZLaZcy7ulQ8=", "owner": "SmiteshP", "repo": "nvim-navbuddy", - "rev": "244a4cded6f2b568403684131d148048efe4e8af", + "rev": "f137a3466a6cd1965cdcc5398daff54e66eebbe5", "type": "github" }, "original": { @@ -1175,11 +1175,11 @@ "nvim-navic": { "flake": false, "locked": { - "lastModified": 1689944100, - "narHash": "sha256-M7BT1C9xHyLgr22JI3b+wyD+bYs6FgKc6PIqMrXnNr4=", + "lastModified": 1701345631, + "narHash": "sha256-0p5n/V8Jlj9XyxV/fuMwsbQ7oV5m9H2GqZZEA/njxCQ=", "owner": "SmiteshP", "repo": "nvim-navic", - "rev": "9c89730da6a05acfeb6a197e212dfadf5aa60ca0", + "rev": "8649f694d3e76ee10c19255dece6411c29206a54", "type": "github" }, "original": { @@ -1191,11 +1191,11 @@ "nvim-neoclip": { "flake": false, "locked": { - "lastModified": 1684196333, - "narHash": "sha256-96AwMgyC7PTDEPS5tXwDT3WfK8jJJuIYGE+q+j6U5Uc=", + "lastModified": 1701664728, + "narHash": "sha256-QtqLKdrDGzIiSEo3DZtv0C7wx3KlrcyePoIYdvH6vpk=", "owner": "AckslD", "repo": "nvim-neoclip.lua", - "rev": "4e406ae0f759262518731538f2585abb9d269bac", + "rev": "798cd0592a81c185465db3a091a0ff8a21af60fd", "type": "github" }, "original": { @@ -1207,11 +1207,11 @@ "nvim-notify": { "flake": false, "locked": { - "lastModified": 1685978736, - "narHash": "sha256-Rr2tzuEr06M9ZbvQbC07qcxkyjFJFYdABwRpYelKBFI=", + "lastModified": 1703160424, + "narHash": "sha256-EvzxvwFfme2t/3efpQDsdEdF3G0GzEJThr1hSWFqURs=", "owner": "rcarriga", "repo": "nvim-notify", - "rev": "ea9c8ce7a37f2238f934e087c255758659948e0f", + "rev": "ba1f59dccc584dddd138da870d0ee99b3f04ce54", "type": "github" }, "original": { @@ -1223,11 +1223,11 @@ "nvim-session-manager": { "flake": false, "locked": { - "lastModified": 1689976511, - "narHash": "sha256-04GL+0JdtD2hEOSrRJUh3Wdpoy2igjHt95Nf3WioFU4=", + "lastModified": 1696875507, + "narHash": "sha256-WOJQ6RIibOby+Pmzr6kQxcT2NCGrq1roWkh4QKJECks=", "owner": "Shatur", "repo": "neovim-session-manager", - "rev": "4883372b1ef2bdcf4cbdac44c98d68c216914462", + "rev": "68dde355a4304d83b40cf073f53915604bdd8e70", "type": "github" }, "original": { @@ -1239,11 +1239,11 @@ "nvim-surround": { "flake": false, "locked": { - "lastModified": 1685464327, - "narHash": "sha256-r3D5WTqEnIL1T3p7cmkRmBY8qgwFFJptM7BKNNsCT8k=", + "lastModified": 1701725242, + "narHash": "sha256-ph4obOW+l+TGZp6B4R4ZZtjiFMKWKFKigV3aLLPhbGs=", "owner": "kylechui", "repo": "nvim-surround", - "rev": "10b20ca7d9da1ac8df8339e140ffef94f9ab3b18", + "rev": "633a0ab03159569a66b65671b0ffb1a6aed6cf18", "type": "github" }, "original": { @@ -1255,11 +1255,11 @@ "nvim-tree-lua": { "flake": false, "locked": { - "lastModified": 1690616703, - "narHash": "sha256-kTbYvT21wLfiwEpQAgGZtep2GP4F9e7e6XGVpr4D1hY=", + "lastModified": 1702981741, + "narHash": "sha256-u4JjV0Qwr5ESQ54Ae6SDotCeOil6+2iGC/Uwu0D+Yis=", "owner": "nvim-tree", "repo": "nvim-tree.lua", - "rev": "4bd30f0137e44dcf3e74cc1164efb568f78f2b02", + "rev": "50f30bcd8c62ac4a83d133d738f268279f2c2ce2", "type": "github" }, "original": { @@ -1271,11 +1271,11 @@ "nvim-treesitter-context": { "flake": false, "locked": { - "lastModified": 1689239188, - "narHash": "sha256-AJamiDezFK7l0bqb/VFm+pzBKugQNCmQ6JAWKmjH76g=", + "lastModified": 1702723034, + "narHash": "sha256-10sOLaW9+L2dXOe6c1T6+vpv6z9SUfLdB/Fo6ZN0oTI=", "owner": "nvim-treesitter", "repo": "nvim-treesitter-context", - "rev": "6f8f788738b968f24a108ee599c5be0031f94f06", + "rev": "c9f2b429a1d63023f7a33b5404616f4cd2a109c5", "type": "github" }, "original": { @@ -1287,11 +1287,11 @@ "nvim-ts-autotag": { "flake": false, "locked": { - "lastModified": 1686883732, - "narHash": "sha256-4qTtXYA5HyG1sADV0wsiccO/G89qEoYPmlg8tTx7h8g=", + "lastModified": 1702195293, + "narHash": "sha256-O10jzgh4aznTQ1EIEL8OGBsgjN9arsM6XZC2FBKevS4=", "owner": "windwp", "repo": "nvim-ts-autotag", - "rev": "6be1192965df35f94b8ea6d323354f7dc7a557e4", + "rev": "8515e48a277a2f4947d91004d9aa92c29fdc5e18", "type": "github" }, "original": { @@ -1303,11 +1303,11 @@ "nvim-web-devicons": { "flake": false, "locked": { - "lastModified": 1689474464, - "narHash": "sha256-FtEJBhqvs+c/Rvy4qXf3iyoMTTKrDBvQw5g63n4KEYo=", + "lastModified": 1703166652, + "narHash": "sha256-bkD4fxHS8Ti+1Vz/o0qbiFqnEfb05Bqo2cCIdpsoK2E=", "owner": "nvim-tree", "repo": "nvim-web-devicons", - "rev": "efbfed0567ef4bfac3ce630524a0f6c8451c5534", + "rev": "aff5f50b34754335a312c9b3dc5b245f605ce437", "type": "github" }, "original": { @@ -1319,11 +1319,11 @@ "obsidian-nvim": { "flake": false, "locked": { - "lastModified": 1690662423, - "narHash": "sha256-qemlp11QSp4BnWadN3+3ndv47e+1yS+w91GumbzQric=", + "lastModified": 1703107752, + "narHash": "sha256-qV2gfNU7Du0JsM3CwaoW/w+JZ5N4JCGfEGr/tC3TVwM=", "owner": "epwalsh", "repo": "obsidian.nvim", - "rev": "f81ddfa56b87fda158d3a56625a8040a7cf23fef", + "rev": "430bee736fc48170362f38ba1217596d241abdaa", "type": "github" }, "original": { @@ -1335,11 +1335,11 @@ "onedark": { "flake": false, "locked": { - "lastModified": 1689269544, - "narHash": "sha256-HfyYEppo9NFswYlPKnHNOZO5eiTQSORQhWAkzCmM2m4=", + "lastModified": 1701844102, + "narHash": "sha256-UtC8OJw62xYkAyTcwIEbg0tBWttaXeGhFw7Ux8Yu5/0=", "owner": "navarasu", "repo": "onedark.nvim", - "rev": "cae5fdf035ee92c407a29ee2ccfcff503d2be7f1", + "rev": "c5476a091b0f1b4e853db91c91ff941f848a1cdd", "type": "github" }, "original": { @@ -1351,11 +1351,11 @@ "orgmode-nvim": { "flake": false, "locked": { - "lastModified": 1690291768, - "narHash": "sha256-jc89zEAtHBh8785gNW/UZ9jkgTee/XYMm4+jyW7G2Oo=", + "lastModified": 1701697142, + "narHash": "sha256-knx//3KV0S0piPyXn7uKvQc/q/DFaBL3MdOPWffVrjE=", "owner": "nvim-orgmode", "repo": "orgmode", - "rev": "6b6eb8eabbed4d95568fd1f5374a3dff7ed51a3b", + "rev": "92bfc3fb7ee845d9e58326b0b69f3ed89e84253f", "type": "github" }, "original": { @@ -1384,11 +1384,11 @@ "plenary-nvim": { "flake": false, "locked": { - "lastModified": 1689589150, - "narHash": "sha256-oRtNcURQzrIRS3D88tWAl3HuFHxVJr8m/zzL7xoa/II=", + "lastModified": 1701343040, + "narHash": "sha256-f8YVaXMG0ZyW6iotAgnftaYULnL69UPolRad6RTG27g=", "owner": "nvim-lua", "repo": "plenary.nvim", - "rev": "267282a9ce242bbb0c5dc31445b6d353bed978bb", + "rev": "55d9fe89e33efd26f532ef20223e5f9430c8b0c0", "type": "github" }, "original": { @@ -1432,11 +1432,11 @@ "registers": { "flake": false, "locked": { - "lastModified": 1680595111, - "narHash": "sha256-MeBlcF5LLk6bhIofYuG+0Z2xwc0BVqP85yNCvjH66fw=", + "lastModified": 1696789791, + "narHash": "sha256-X7paip2MIQ9BXOuKHTuX976Hd9PGuUUH9cMmxIDv4kU=", "owner": "tversteeg", "repo": "registers.nvim", - "rev": "2ab8372bb837f05fae6b43091f10a0b725d113ca", + "rev": "7a16c6e6fe96f3c9c8bb55b95047d745dd34ca4d", "type": "github" }, "original": { @@ -1631,11 +1631,11 @@ "smartcolumn": { "flake": false, "locked": { - "lastModified": 1679417638, - "narHash": "sha256-DjPWBOLbzdfOQAx+6xgV1CD5NKuP1N6An2lmHNHd39Q=", + "lastModified": 1703065201, + "narHash": "sha256-M/qYdwYlZ1li7BnIc85lhLkAY+NMUuXn6qm7EN6hzsM=", "owner": "m4xshen", "repo": "smartcolumn.nvim", - "rev": "0c572e3eae48874f25b74394a486f38cadb5c958", + "rev": "8cbf75c26e9f9248704a662564f30cc2d7de7f34", "type": "github" }, "original": { @@ -1707,6 +1707,21 @@ "type": "github" } }, + "systems_3": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + }, "tabular": { "flake": false, "locked": { @@ -1726,11 +1741,11 @@ "telescope": { "flake": false, "locked": { - "lastModified": 1690663693, - "narHash": "sha256-okyOr5t0e+oV3mY7Yq1ad/7f6qEEDS/ZQrqJcjktYRI=", + "lastModified": 1703030316, + "narHash": "sha256-HwQP5Zxx2bKaPnuPiRfgwCxyUX+OyfVosvvKcgvZYZM=", "owner": "nvim-telescope", "repo": "telescope.nvim", - "rev": "b6fccfb0f7589a87587875206786daccba62acc3", + "rev": "f336f8cfab38a82f9f00df380d28f0c2a572f862", "type": "github" }, "original": { @@ -1767,11 +1782,11 @@ "vowel-src": "vowel-src" }, "locked": { - "lastModified": 1664760044, - "narHash": "sha256-e5LGk/tDnphory1mYhADgPnVtShofY2w/3xY09jEE2A=", + "lastModified": 1694087816, + "narHash": "sha256-GMV5ONQhLwa6xRYhZkmwc2W2jbjAfHfB/OR9vR0+PFA=", "owner": "mitchmindtree", "repo": "tidalcycles.nix", - "rev": "3f3a820cd43709077d15a24fa6062de7d623a6bf", + "rev": "1b1c4df5303e07930d23e8361ab8253ebec0c7bb", "type": "github" }, "original": { @@ -1783,11 +1798,11 @@ "todo-comments": { "flake": false, "locked": { - "lastModified": 1690569591, - "narHash": "sha256-Qm8AJ8omU5eCfjLt91DVxLS0R3QHbfW55ZTegB1JvWI=", + "lastModified": 1698270703, + "narHash": "sha256-Z041A05I2zESNV+aSghtnijEUeDqPjLQxiOcCVVOwfE=", "owner": "folke", "repo": "todo-comments.nvim", - "rev": "3094ead8edfa9040de2421deddec55d3762f64d1", + "rev": "4a6737a8d70fe1ac55c64dfa47fcb189ca431872", "type": "github" }, "original": { @@ -1799,11 +1814,11 @@ "toggleterm-nvim": { "flake": false, "locked": { - "lastModified": 1689602083, - "narHash": "sha256-/sUulN93nRHa3Je+tXr8/i1cgCrd/wtrvMPkjG5Ofzs=", + "lastModified": 1702454846, + "narHash": "sha256-hfsBRQ+0d3fAZGWE5Dh/OEdAJfqb3Wuf3IGVI4y2+yI=", "owner": "akinsho", "repo": "toggleterm.nvim", - "rev": "00c13dccc78c09fa5da4c5edda990a363e75035e", + "rev": "91be5f327e42aa016da13b277540de8dba0b14e3", "type": "github" }, "original": { @@ -1815,11 +1830,11 @@ "tokyonight": { "flake": false, "locked": { - "lastModified": 1689285710, - "narHash": "sha256-x26qLaZzg7sJIc1d/5Q/DJ/YvRSc3s87PwPHTPTl+Xk=", + "lastModified": 1698229236, + "narHash": "sha256-axjZVZOI+WIv85FfMG+lxftDKlDIw/HzQKyJVFkL33M=", "owner": "folke", "repo": "tokyonight.nvim", - "rev": "1ee11019f8a81dac989ae1db1a013e3d582e2033", + "rev": "f247ee700b569ed43f39320413a13ba9b0aef0db", "type": "github" }, "original": { @@ -1831,11 +1846,11 @@ "trouble": { "flake": false, "locked": { - "lastModified": 1690614197, - "narHash": "sha256-Ee0AM8S/A8DU0hyOnZoKC1hkW0fvk0A+c3WGvPqmKcU=", + "lastModified": 1697626811, + "narHash": "sha256-8nLghiueYOtWY7OGVxow9A2G/5lgt+Kt5D8q1xeJvVg=", "owner": "folke", "repo": "trouble.nvim", - "rev": "40aad004f53ae1d1ba91bcc5c29d59f07c5f01d3", + "rev": "f1168feada93c0154ede4d1fe9183bf69bac54ea", "type": "github" }, "original": { @@ -1860,12 +1875,15 @@ } }, "utils_2": { + "inputs": { + "systems": "systems_3" + }, "locked": { - "lastModified": 1653893745, - "narHash": "sha256-0jntwV3Z8//YwuOjzhV2sgJJPt+HY6KhU7VZUL0fKZQ=", + "lastModified": 1692799911, + "narHash": "sha256-3eihraek4qL744EvQXsK1Ha6C3CR7nnT8X2qWap4RNk=", "owner": "numtide", "repo": "flake-utils", - "rev": "1ed9fb1935d260de5fe1c2f7ee0ebaae17ed2fa1", + "rev": "f9e7cf818399d17d347f847525c5a5a8032e4e44", "type": "github" }, "original": { @@ -1877,11 +1895,11 @@ "vim-dirtytalk": { "flake": false, "locked": { - "lastModified": 1690722430, - "narHash": "sha256-kjyLwkAk6mqK7u4+zAr+Yh+zbSiukNKtXwb7t39LUco=", + "lastModified": 1697142601, + "narHash": "sha256-ezbcgCvOXhPSpsOZpCI2QIaFFaRGZAFbuAluMvB7Jjk=", "owner": "psliwka", "repo": "vim-dirtytalk", - "rev": "a49251dce1852875951d95f7013979ece5caebf0", + "rev": "f5b0d51a7d822177814e7edc116ca484f852665f", "type": "github" }, "original": { @@ -1893,11 +1911,11 @@ "vim-illuminate": { "flake": false, "locked": { - "lastModified": 1679187974, - "narHash": "sha256-8dL3cBjQ2iY4D4gTxKVVmOGhxcSSRuDBvmEwwFIbWsQ=", + "lastModified": 1696601720, + "narHash": "sha256-KdF52Ho4c8VKt3qBgBIxYnDK8upXqlUj+YnL2IaJdHQ=", "owner": "RRethy", "repo": "vim-illuminate", - "rev": "a2907275a6899c570d16e95b9db5fd921c167502", + "rev": "3bd2ab64b5d63b29e05691e624927e5ebbf0fb86", "type": "github" }, "original": { @@ -1909,11 +1927,11 @@ "vim-markdown": { "flake": false, "locked": { - "lastModified": 1680951012, - "narHash": "sha256-B00rad/Bbp+kJBN/fYliOaGiUe0AfBng6gs/fVBve9A=", + "lastModified": 1698870120, + "narHash": "sha256-d3GDuMlnhweAajSc284wWN/h0teu5uFG6NQTWa+dcxo=", "owner": "preservim", "repo": "vim-markdown", - "rev": "cc82d88e2a791f54d2b6e2b26e41f743351ac947", + "rev": "46add6c3017d3e4035dc10ffa9cb54221d8dfe1a", "type": "github" }, "original": { @@ -1941,11 +1959,11 @@ "vim-startify": { "flake": false, "locked": { - "lastModified": 1620487920, - "narHash": "sha256-//3bzFTe1WKqvQ3uYrDbk5Zu5BKq2hXQGeBhmhKIHvk=", + "lastModified": 1695213983, + "narHash": "sha256-W5N/Dqxf9hSXEEJsrEkXInFwBXNBJe9Dzx9TVS12mPk=", "owner": "mhinz", "repo": "vim-startify", - "rev": "81e36c352a8deea54df5ec1e2f4348685569bed2", + "rev": "4e089dffdad46f3f5593f34362d530e8fe823dcf", "type": "github" }, "original": { @@ -1973,11 +1991,11 @@ "vim-vsnip": { "flake": false, "locked": { - "lastModified": 1678609126, - "narHash": "sha256-ehPnvGle7YrECn76YlSY/2V7Zeq56JGlmZPlwgz2FdE=", + "lastModified": 1699776303, + "narHash": "sha256-r5XxpKJ2vj6IG/y7RIRXasaT1j+XLuq3Il07HadsSoE=", "owner": "hrsh7th", "repo": "vim-vsnip", - "rev": "7753ba9c10429c29d25abfd11b4c60b76718c438", + "rev": "8eebdf6ab4a880d845893f210fd20516d2e2384f", "type": "github" }, "original": { @@ -2006,11 +2024,11 @@ "which-key": { "flake": false, "locked": { - "lastModified": 1690570286, - "narHash": "sha256-B1+EHd2eH/EbD5Kip9PfhdPyyGfIkD6rsx0Z3rXvb5w=", + "lastModified": 1697801635, + "narHash": "sha256-uvghPj/teWrRMm09Gh8iQ/LV2nYJw0lmoiZK6L4+1cY=", "owner": "folke", "repo": "which-key.nvim", - "rev": "7ccf476ebe0445a741b64e36c78a682c1c6118b7", + "rev": "4433e5ec9a507e5097571ed55c02ea9658fb268a", "type": "github" }, "original": { @@ -2026,11 +2044,11 @@ "nixpkgs": "nixpkgs_4" }, "locked": { - "lastModified": 1690718829, - "narHash": "sha256-GN19SrCqWxIJN+rnbv+pIkF/yynh6FG2y7jY6PZRiYw=", + "lastModified": 1703204565, + "narHash": "sha256-A2Wpu3z6cj/zV+QzQ11Zzt3nAtqat0Qo2lPX8qsB3Wk=", "owner": "mitchellh", "repo": "zig-overlay", - "rev": "92e485cc7887f57be4d2921ed077f467912b7d33", + "rev": "b7a0aa41fb33514bc216e2f4a106eeac8dee6775", "type": "github" }, "original": { diff --git a/flake.nix b/flake.nix index 25ce941..5b7caab 100644 --- a/flake.nix +++ b/flake.nix @@ -63,7 +63,7 @@ # For generating documentation website nmd = { - url = "github:horriblename/nmd"; + url = "sourcehut:~rycee/nmd"; flake = false; }; diff --git a/release.json b/release.json new file mode 100644 index 0000000..031d214 --- /dev/null +++ b/release.json @@ -0,0 +1,4 @@ +{ + "release": "v0.6", + "isReleaseBranch": false +}