chore(build): auto-generate vimdoc

Author: github-actions[bot]

doc/elixir-tools.nvim.txt

@@ -0,0 +1,290 @@
+*elixir-tools.nvim.txt*        For NVIM v0.8.0        Last change: 2023 May 09
+
+==============================================================================
+Table of Contents                        *elixir-tools.nvim-table-of-contents*
+
+1. Overview                                       |elixir-tools.nvim-overview|
+  - Features                             |elixir-tools.nvim-overview-features|
+2. Install                                         |elixir-tools.nvim-install|
+  - lazy.nvim                            |elixir-tools.nvim-install-lazy.nvim|
+  - packer.nvim                        |elixir-tools.nvim-install-packer.nvim|
+3. Getting Started                         |elixir-tools.nvim-getting-started|
+  - Minimal Setup            |elixir-tools.nvim-getting-started-minimal-setup|
+  - Advanced Setup          |elixir-tools.nvim-getting-started-advanced-setup|
+4. Features                                       |elixir-tools.nvim-features|
+  - ElixirLS                             |elixir-tools.nvim-features-elixirls|
+  - credo-language-server   |elixir-tools.nvim-features-credo-language-server|
+  - Mix                                       |elixir-tools.nvim-features-mix|
+  - Projectionist                   |elixir-tools.nvim-features-projectionist|
+
+==============================================================================
+1. Overview                                       *elixir-tools.nvim-overview*
+
+<https://discord.gg/6XdGnxVA2A>
+
+`elixir-tools.nvim` provides a nice experience for writing Elixir applications
+with Neovim <https://github.com/neovim/neovim>.
+
+
+  Note: This plugin does not provide autocompletion, I recommend using nvim-cmp
+  <https://github.com/hrsh7th/nvim-cmp>.
+
+  Note: This plugin does not provide syntax highlighting, I recommend using
+  nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter>.
+
+FEATURES                                 *elixir-tools.nvim-overview-features*
+
+
+- ElixirLS <https://github.com/elixir-lsp/elixir-ls> installation and configuration (uses the Neovim built-in LSP client)
+- credo-language-server <https://github.com/elixir-tools/credo-language-server> integration.
+- `:Mix` command with autocomplete
+- vim-projectionist <https://github.com/tpope/vim-projectionist> support
+
+
+==============================================================================
+2. Install                                         *elixir-tools.nvim-install*
+
+Requires 0.8
+
+
+LAZY.NVIM                                *elixir-tools.nvim-install-lazy.nvim*
+
+>lua
+    {
+      "elixir-tools/elixir-tools.nvim",
+      event = { "BufReadPre", "BufNewFile" },
+      config = function()
+        local elixir = require("elixir")
+        local elixirls = require("elixir.elixirls")
+    
+        elixir.setup {
+          credo = {},
+          elixirls = {
+            enabled = true,
+            settings = elixirls.settings {
+              dialyzerEnabled = false,
+              enableTestLenses = false,
+            },
+            on_attach = function(client, bufnr)
+              vim.keymap.set("n", "<space>fp", ":ElixirFromPipe<cr>", { buffer = true, noremap = true })
+              vim.keymap.set("n", "<space>tp", ":ElixirToPipe<cr>", { buffer = true, noremap = true })
+              vim.keymap.set("v", "<space>em", ":ElixirExpandMacro<cr>", { buffer = true, noremap = true })
+            end,
+          }
+        }
+      end,
+      dependencies = {
+        "nvim-lua/plenary.nvim",
+      },
+    }
+<
+
+
+PACKER.NVIM                            *elixir-tools.nvim-install-packer.nvim*
+
+>lua
+    use({ "elixir-tools/elixir-tools.nvim", requires = { "nvim-lua/plenary.nvim" }})
+<
+
+
+==============================================================================
+3. Getting Started                         *elixir-tools.nvim-getting-started*
+
+
+MINIMAL SETUP                *elixir-tools.nvim-getting-started-minimal-setup*
+
+The minimal setup will configure both ElixirLS and credo-language-server.
+
+>lua
+    require("elixir").setup()
+<
+
+ElixirLS and credo-language-server can be disabled by setting the `enabled`
+flag in the respective options table.
+
+>lua
+    require("elixir").setup({
+      credo = {enable = false},
+      elixirls = {enable = false},
+    })
+<
+
+
+ADVANCED SETUP              *elixir-tools.nvim-getting-started-advanced-setup*
+
+While the plugin works with a minimal setup, it is much more useful if you add
+some personal configuration.
+
+Note: For ElixirLS, not specifying the `repo`, `branch`, or `tag` options will
+default to the latest release.
+
+>lua
+    local elixir = require("elixir")
+    local elixirls = require("elixir.elixirls")
+    
+    elixir.setup {
+      credo = {
+        port = 9000, -- connect via TCP with the given port. mutually exclusive with `cmd`
+        cmd = "path/to/credo-language-server", -- path to the executable. mutually exclusive with `port`
+        on_attach = function(client, bufnr)
+          -- custom keybinds
+        end
+      },
+      elixirls = {
+        -- specify a repository and branch
+        repo = "mhanberg/elixir-ls", -- defaults to elixir-lsp/elixir-ls
+        branch = "mh/all-workspace-symbols", -- defaults to nil, just checkouts out the default branch, mutually exclusive with the `tag` option
+        tag = "v0.13.0", -- defaults to nil, mutually exclusive with the `branch` option
+    
+        -- alternatively, point to an existing elixir-ls installation (optional)
+        -- not currently supported by elixirls, but can be a table if you wish to pass other args `{"path/to/elixirls", "--foo"}`
+        cmd = "/usr/local/bin/elixir-ls.sh",
+    
+        -- default settings, use the `settings` function to override settings
+        settings = elixirls.settings {
+          dialyzerEnabled = true,
+          fetchDeps = false,
+          enableTestLenses = false,
+          suggestSpecs = false,
+        },
+        on_attach = function(client, bufnr)
+          vim.keymap.set("n", "<space>fp", ":ElixirFromPipe<cr>", { buffer = true, noremap = true })
+          vim.keymap.set("n", "<space>tp", ":ElixirToPipe<cr>", { buffer = true, noremap = true })
+          vim.keymap.set("v", "<space>em", ":ElixirExpandMacro<cr>", { buffer = true, noremap = true })
+        end
+      }
+    }
+<
+
+
+==============================================================================
+4. Features                                       *elixir-tools.nvim-features*
+
+
+ELIXIRLS                                 *elixir-tools.nvim-features-elixirls*
+
+
+AUTOMATIC INSTALLATION ~
+
+When a compatible installation of ELixirLS is not found, you will be prompted
+to install it. The plugin will download the source code to the `.elixir_ls`
+directory and compile it using the Elixir and OTP versions used by your current
+project.
+
+Caveat: This assumes you are developing your project locally (outside of
+something like Docker) and they will be available.
+
+Caveat: This currently downloads the language server into the `.elixir_ls`
+directory in your repository, but it does install it into `~/.cache` and will
+re-use it when needed.
+
+
+ROOT PATH DETECTION ~
+
+`elixir-tools.nvim` should be able to properly set the root directory for
+umbrella and non-umbrella apps. The nvim-lspconfig project’s root detection
+doesn’t properly account for umbrella projects.
+
+
+RUN TESTS ~
+
+ElixirLS provides a codelens to identify and run your tests. If you configure
+`enableTestLenses = true` in the settings table, you will see the codelens as
+virtual text in your editor and can run them with `vim.lsp.codelens.run()`.
+
+
+COMMANDS ~
+
+
+                                         *elixir-tools.nvim-:ElixirFromPipe*
+
+
+:ElixirFromPipe                        Convert pipe operator to nested expressions.
+
+
+                                           *elixir-tools.nvim-:ElixirToPipe*
+
+
+:ElixirToPipe                          Convert nested expressions to the pipe operator.
+
+
+
+
+                                      *elixir-tools.nvim-:ElixirExpandMacro*
+
+
+:[range]ElixirExpandMacro              For the given [range], expand any macros and display it in a floating window.
+
+
+
+
+                                          *elixir-tools.nvim-:ElixirRestart*
+
+
+:ElixirRestart                         Restart ElixirLS, you must then reconnect your buffer with `:edit`.
+
+
+                                      *elixir-tools.nvim-:ElixirOutputPanel*
+
+
+:ElixirOutputPanel                     Open the output panel that displays logs and compiler information from the server.
+
+
+
+>lua
+    require("elixir").open_output_panel()
+    require("elixir").open_output_panel({ window = "split" })
+    require("elixir").open_output_panel({ window = "vsplit" })
+    require("elixir").open_output_panel({ window = "float" })
+<
+
+
+CREDO-LANGUAGE-SERVER       *elixir-tools.nvim-features-credo-language-server*
+
+
+  Note: The credo-language-server integration utilizes `Mix.install/2`, so you
+  must be running Elixir >= 1.12
+
+- Uses your project’s Credo version.
+- Full project diagnostics
+- Code Actions
+
+
+MIX                                           *elixir-tools.nvim-features-mix*
+
+You can run any `mix` command in your project, complete with… autocomplete!
+
+
+                                                    *elixir-tools.nvim-:Mix*
+
+
+:Mix {args}                            Run any mix command.
+
+
+
+
+PROJECTIONIST                       *elixir-tools.nvim-features-projectionist*
+
+vim-projectionist <https://github.com/tpope/vim-projectionist> definitions are
+provided for:
+
+
+- Elixir files
+- Phoenix Views
+- Phoenix Controllers
+- Phoenix Channels
+- Wallaby/Hound Feature tests
+
+==============================================================================
+5. Links                                             *elixir-tools.nvim-links*
+
+1. *Discord*: https://img.shields.io/badge/Discord-5865F3?style=flat&logo=discord&logoColor=white&link=https://discord.gg/nNDMwTJ8
+2. *auto-install-elixirls*: https://user-images.githubusercontent.com/5523984/160333851-94d448d9-5c80-458c-aa0d-4c81528dde8f.gif
+3. *elixir-test-lens*: https://user-images.githubusercontent.com/5523984/159722637-ef1586d5-9d47-4e1a-b68b-6a90ad744098.gif
+4. *manipulate_pipes*: https://user-images.githubusercontent.com/5523984/160508641-cedb6ebf-3ec4-4229-9708-aa360b15a2d5.gif
+5. *expand_macro*: https://user-images.githubusercontent.com/5523984/162372669-4782baba-1889-4145-8a4f-e3bf13a6450d.gif
+6. *elixir-nvim-mix-demo*: https://user-images.githubusercontent.com/5523984/181859468-19d47a55-3f63-4af5-8698-4b5dd3459141.gif
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl: