diff --git a/.github/workflows/luarocks-scm.yml b/.github/workflows/luarocks-scm.yml index 4509c73..260bd72 100644 --- a/.github/workflows/luarocks-scm.yml +++ b/.github/workflows/luarocks-scm.yml @@ -18,7 +18,10 @@ jobs: with: version: scm summary: Show diagnostics that are not visible in current view - # detailed_description: | + detailed_description: | + sense.nvim shows diagnostics that are not visible in current view with their distance. + Allows you to quickly navigate to off-screen diagnostics with relative-line-number motions. + Don't miss the diagnostics ever again! dependencies: | luautf8 test_dependencies: | diff --git a/.github/workflows/luarocks.yml b/.github/workflows/luarocks.yml index 05301d5..4e1dd44 100644 --- a/.github/workflows/luarocks.yml +++ b/.github/workflows/luarocks.yml @@ -20,7 +20,10 @@ jobs: LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }} with: summary: Show diagnostics that are not visible in current view - # detailed_description: | + detailed_description: | + sense.nvim shows diagnostics that are not visible in current view with their distance. + Allows you to quickly navigate to off-screen diagnostics with relative-line-number motions. + Don't miss the diagnostics ever again! dependencies: | luautf8 test_dependencies: | diff --git a/README.md b/README.md index 33fa6a3..5928bb2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # 🧘 sense.nvim -Show diagnostics that are not visible in current view +sense.nvim shows diagnostics that are not visible in current view with their distance.\ +Allows you to quickly navigate to off-screen diagnostics with relative-line-number motions.\ +Don't miss the diagnostics ever again! + + ## Requirements - Neovim >= 0.10.2 +- rockspec support enabled in your Neovim plugin manager (See [Installation](#installation)) ## Installation @@ -75,10 +80,26 @@ local default_config = { ## Contributing -test drive plugin with nix: +Contributions are always welcome! + +> [!IMPORTANT] +> +> sense.nvim uses [semantic commits](https://www.conventionalcommits.org/en/v1.0.0/) that adhere to +> semantic versioning and these help with automatic releases, please use this type of convention +> when submitting changes to the project. + +You can test drive the plugin with nix: -```sh -nix run .#neovim-drive +```console +nix run .#neovim-with-sense +``` + +### Dev Environment + +You can enter devshell as nix shell. + +```console +nix develop ``` [^1]: https://lazy.folke.io/configuration diff --git a/flake.nix b/flake.nix index 50991ed..33b4da6 100644 --- a/flake.nix +++ b/flake.nix @@ -51,7 +51,7 @@ inherit (pkgs) docgen - neovim-test-drive + neovim-with-sense ; }; @@ -66,7 +66,6 @@ stylua docgen sync-readme - neovim-nightly (pkgs.lua5_1.withPackages (ps: with ps; [luarocks luacheck])) ]; }; diff --git a/nix/plugin-overlay.nix b/nix/plugin-overlay.nix index 721b20d..74910e6 100644 --- a/nix/plugin-overlay.nix +++ b/nix/plugin-overlay.nix @@ -35,7 +35,7 @@ in { vimPlugins = prev.vimPlugins // { sense-nvim = sense-nvim-dev; }; - neovim-test-drive = let + neovim-with-sense = let neovimConfig = final.neovimUtils.makeNeovimConfig { viAlias = false; vimAlias = false; diff --git a/sense.nvim-scm-1.rockspec b/sense.nvim-scm-1.rockspec index d15e4ff..d8d595c 100644 --- a/sense.nvim-scm-1.rockspec +++ b/sense.nvim-scm-1.rockspec @@ -21,5 +21,6 @@ build = { type = "builtin", copy_directories = { "plugin", + "doc", } }