From f25098e3ce02275a704abd80439c5f00795ba1b6 Mon Sep 17 00:00:00 2001 From: Frothy <76622149+FrothyMarrow@users.noreply.github.com> Date: Sat, 22 Jul 2023 16:05:08 -0400 Subject: [PATCH 1/6] fix: update bufferline from v3.0.1 branch to main --- flake.lock | 7 +++---- flake.nix | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/flake.lock b/flake.lock index 69727ee..cbd1ec7 100644 --- a/flake.lock +++ b/flake.lock @@ -919,16 +919,15 @@ "nvim-bufferline-lua": { "flake": false, "locked": { - "lastModified": 1666171880, - "narHash": "sha256-hueIGT7KOhca0kP0M1nUYzBrzMz+DpuZSOt5iyuEa40=", + "lastModified": 1689661992, + "narHash": "sha256-0BJXUDGeUhPALEnPgO4ix+GgI/3P/Foiqi0tf2mgUXg=", "owner": "akinsho", "repo": "nvim-bufferline.lua", - "rev": "e70be6232f632d16d2412b1faf85554285036278", + "rev": "d24378edc14a675c820a303b4512af3bbc5761e9", "type": "github" }, "original": { "owner": "akinsho", - "ref": "v3.0.1", "repo": "nvim-bufferline.lua", "type": "github" } diff --git a/flake.nix b/flake.nix index 67d3825..44af3f5 100644 --- a/flake.nix +++ b/flake.nix @@ -181,7 +181,7 @@ # Tablines nvim-bufferline-lua = { - url = "github:akinsho/nvim-bufferline.lua?ref=v3.0.1"; + url = "github:akinsho/nvim-bufferline.lua"; flake = false; }; From 48219eba744d4bb6361b3115737fa9e1327e3e25 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 24 Jul 2023 08:18:19 +0300 Subject: [PATCH 2/6] docs: wording --- .github/CONTRIBUTING.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 19f0287..10371c9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -30,22 +30,21 @@ Here are the overall boundaries I would like you to follow while contributing to #### Documentation -If you are making a pull request to add a - +If you are making a pull request to add a #### Style **Nix** -We use Alejandra for formatting nix code, which can be invoked directly with `nix fmt` in the repository. +We use Alejandra for formatting nix code, which can be invoked directly by running `nix fmt` in the repository. While Alejandra is mostly opinionated on how code looks after formatting, certain formattings are done at the user's discretion. Please use one line code for attribute sets that contain only one subset. For example: -```nix +```nix # parent modules should always be unfolded -module = { +module = { value = mkEnableOption "some description" // { default = true; }; # same as parent modules, unfold submodules subModule = { @@ -65,15 +64,16 @@ If you move a line down after the merge operator, Alejandra will automatically u module = { key = mkEnableOption "some description" // { default = true; # we want this to be inline - }; + }; # ... } ``` For lists, it's up mostly to your discretion but please try to avoid unfolded lists if there is only one item in the list. + ```nix -# ok +# ok acceptableList = [ item1 item2 @@ -85,10 +85,11 @@ acceptableList = [ listToBeAvoided = [item1 item2 item3 item4]; ``` -*This will be moved elsewhere, disregard unless you are adding a new plugin with keybinds* +_This will be moved elsewhere, disregard unless you are adding a new plugin with keybinds_ + #### Keybinds -##### Custom key mappings support for a plugin +##### Custom key mappings support for a plugin To add custom keymappings to a plugin, a couple of helper functions are available in the project. @@ -237,5 +238,3 @@ in { ``` 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. - - From e719eb11760debeba813bdf78bf210c83e47fe2b Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 24 Jul 2023 08:18:49 +0300 Subject: [PATCH 3/6] docs: fix typo in issue search URL --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 14e8cbe..c9270b2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -7,7 +7,7 @@ body: id: no-duplicate-issues attributes: label: "⚠️ Please verify that this bug has NOT been reported before." - description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake4/issues?q=)" + description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake/issues?q=)" options: - label: "I checked all existing issues and didn't find a similar issue" required: true From aaf57d02e75091f9d6ccb951fdc07831171f8e2a Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 24 Jul 2023 08:19:08 +0300 Subject: [PATCH 4/6] docs: cleanup --- .../pull_request_template.md | 5 +- docs/home-manager.adoc | 77 ------------------- 2 files changed, 2 insertions(+), 80 deletions(-) delete mode 100644 docs/home-manager.adoc diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index c50c5aa..ca65c8b 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -18,11 +18,10 @@ Please delete any options that are not relevant. ## Checklist -Please try to check at least a majority of the checklist before opening your pull request. PRs -Exceptions to this will be reviewed on a case by case basis. +Please try to check at least a majority of the checklist before opening your pull request. Exceptions to this will be reviewed on a case by case basis. - [ ] My code follows the style and contributing guidelines of this project. -- [ ] I ran Alejandra to format my code. +- [ ] I ran Alejandra to format my code (`nix fmt`). - [ ] I have performed a self-review of my own code and tested it. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] My changes generate no new warnings. diff --git a/docs/home-manager.adoc b/docs/home-manager.adoc deleted file mode 100644 index f238092..0000000 --- a/docs/home-manager.adoc +++ /dev/null @@ -1,77 +0,0 @@ -[[ch-hm-module]] -== Home Manager - -The Home Manager module allows us to customize the different `vim` options. To use it, we first add the input flake. - -[source,nix] ----- -{ - neovim-flake = { - url = github:notashelf/neovim-flake; - # you can override input nixpkgs - inputs.nixpkgs.follows = "nixpkgs"; - }; -} ----- - -Followed by importing the HM module. - -[source,nix] ----- -{ - imports = [ neovim-flake.homeManagerModules.default ]; -} ----- - -Then we should be able to use the given module. E.g. - -[source,nix] ----- -{ - programs.neovim-flake = { - - enable = true; - # your settings need to go into the settings attrset - settings = { - vim.viAlias = false; - vim.vimAlias = true; - vim.lsp = { - enable = true; - }; - }; - }; -} ----- - -=== Custom vim plugins - -It's possible to add custom vim plugins by using the startPlugins and lua DAG settings. First we install the plugin by adding it to startPlugins. This example uses nvim-surround, but the process will be similar for other plugins as well. - -[source,nix] ----- -{ - programs.neovim-flake = { - enable = true; - settings = { - vim.startPlugins = [ pkgs.vimPlugins.nvim-surround ]; - }; - }; -} ----- - -Then we continue by requiring the plugin in lua using DAG settings. Please note that you're able to name this setting to however you want, the name will add a `--SECTION ` in the init.vim, under which it will be initialized. - -[source,nix] ----- -{ - programs.neovim-flake = { - enable = true; - settings = { - vim.startPlugins = [ pkgs.vimPlugins.nvim-surround ]; - luaConfigRC.nvim-surround = nvim-flake.lib.nvim.dag.entryAnywhere '' # nvim-flake is a reference to the flake. Please change this accordingly to your config. - require("nvim-surround").setup() - ''; - }; - }; -} ----- \ No newline at end of file From 19f7c6732fb04e38250fefd4ed4ab13cd201c02a Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 24 Jul 2023 08:19:27 +0300 Subject: [PATCH 5/6] CI: clean up workflows --- .github/workflows/cachix.yml | 14 +++++++------- .github/workflows/check.yml | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/cachix.yml b/.github/workflows/cachix.yml index 536061a..ee1327d 100644 --- a/.github/workflows/cachix.yml +++ b/.github/workflows/cachix.yml @@ -11,15 +11,15 @@ on: - .gitignore jobs: - cahix: - runs-on: ubuntu-latest + cachix: + wruns-on: ubuntu-latest strategy: matrix: package: - - default - - nix - - tidal - - maximal + - default + - nix + - tidal + - maximal steps: - uses: easimon/maximize-build-space@v6 with: @@ -30,7 +30,7 @@ jobs: - uses: actions/checkout@v3 - uses: cachix/install-nix-action@v20 with: - extra_nix_config: | + extra_nix_config: | access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} auto-optimise-store = true experimental-features = nix-command flakes diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 91bbb8f..c6d46d6 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -20,10 +20,11 @@ jobs: extra_nix_config: | access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} - run: nix flake check + format-with-alejandra: name: Formatting via Alejandra runs-on: ubuntu-latest - steps: + steps: - uses: actions/checkout@v3 - uses: cachix/install-nix-action@v20 with: @@ -32,4 +33,3 @@ jobs: auto-optimise-store = true experimental-features = nix-command flakes - run: nix run nixpkgs#alejandra -- -c . - From 5d5aec5b8a48327f528ee791b3c646ab2f40345f Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 24 Jul 2023 08:21:54 +0300 Subject: [PATCH 6/6] docs: add @FrothyMarrow to credits --- .github/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index 0020b1b..e7dcdb3 100644 --- a/.github/README.md +++ b/.github/README.md @@ -52,7 +52,7 @@

-[Get Started]: #try-it-out +[Get Started]: #get-started [Documentation]: #documentation [Help]: #help [Contribute]: #contributing @@ -144,8 +144,8 @@ Special thanks to - [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to work - [@n3oney](https://github.com/n3oney) - For making custom keybinds finally possible - [@horriblename](https://github.com/horriblename) - For actively implementing planned features and quality of life updates -- [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to work - [@Yavko](https://github.com/Yavko) - For the amazing neovim-flake logo +- [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I could not and everyone who has submitted issues or pull requests!