Initial commit

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,11 @@
+name: Bug Report
+description: Report a problem with pick-lsp-formatter
+labels: [bug]
+body:
+  - type: textarea
+    attributes:
+      label: "Description"
+      description: "Describe the problem you are reporting."
+      placeholder: "A clear and concise description of the bug"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Question
+    url: https://github.com/fmbarina/pick-lsp-formatter.nvim/discussions/new?category=q-a
+    about: Usage questions and support requests are answered in the discussions tab

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Felipe Barina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,137 @@
+# plf.nvim
+
+**pick-lsp-formatter** is a plugin to choose a language server to format with.
+
+TODO: put a video of me using it here.
+
+## ✨ Features
+
+- 📝 Lets you pick a single language server when formatting
+- 💾 Remembers per filetype choices between sessions, which can be saved:
+  - per working directory
+  - per project
+
+By default, [`vim.buf.lsp.format()`](https://neovim.io/doc/user/lsp.html#vim.lsp.buf.format()) will format the buffer will all attached language servers capable of it, which is less than ideal. It *does* let you filter which language servers to use, but doing that every time isn't very nice. This is the issue this plugin aims to alleviate.
+
+It exists because I wanted to format lua using stylua, so I installed efm. I soon realized I didn't want *every* lua file formatted with stylua. Later, I even thought to stop using stylua at all—editorconfig is right there! Alas, pick-lsp-formatter already existed by then, so stylua gets another chance... in select environments.
+
+Anyways, hear me out... [efm](https://github.com/mattn/efm-langserver) + [configs](https://github.com/creativenull/efmls-configs-nvim) = good stuff.
+
+## 📦 Installation
+
+For the "I know what I'm doing" users:
+- `fmbarina/pick-lsp-formatter.nvim`
+- `require('plf').setup(opts)` if you need.
+- Install [telescope](https://github.com/nvim-telescope/telescope.nvim) or [dressing](https://github.com/stevearc/dressing.nvim) (or both) for a better picker.
+
+<details>
+<summary>For lazy.nvim users</summary>
+
+  Add the following to your plugin list, your settings go in opts.
+
+  ```lua
+  {
+    'fmbarina/pick-lsp-formatter.nvim',
+    dependencies = {
+      'stevearc/dressing.nvim',        -- Optional, better picker
+      'nvim-telescope/telescope.nvim', -- Optional, better picker
+    },
+    main = 'plf',
+    lazy = true,
+    opts = {},
+  }
+  ```
+</details>
+
+<details>
+<summary>For packer.nvim users</summary>
+
+  Installation:
+
+  ```lua
+  use({
+    'fmbarina/pick-lsp-formatter.nvim',
+    requires = {
+      'stevearc/dressing.nvim',        -- Optional, better picker
+      'nvim-telescope/telescope.nvim', -- Optional, better picker
+    }
+  })
+  ```
+
+  Setup:
+
+  ```lua
+  require('plf').setup()
+  ```
+
+  Your settings can be passed through the setup function.
+</details>
+
+Again, if you want a better picker (default kinda sucks), you only need to install one of the dependencies, but having both installed will work, too.
+
+## 💻️ Usage
+
+At least for now, pick-lsp-formatter won't create any commands, and it'll likely never create any keybindings.
+
+**Recommendation:** anywhere you `vim.lsp.buf.format()`'ed, use `require('plf').format()` instead. That's it.
+
+<details>
+<summary>Example: my (simplified) lsp config</summary>
+
+  ```lua
+  lsp.on_attach(function(client, bufnr)
+    -- Stuff...
+    vim.keymap.set('n', '<leader>lf', function()
+      -- vim.lsp.buf.format(opts) -- We take this out
+      require('plf').format(opts) -- And put this in
+    end, { buffer = bufnr, desc = 'LSP format buffer' })
+    -- More stuff...
+  end)
+  ```
+</details>
+
+### API
+
+pick-lsp-formatter exposes a simple API to:
+
+- Automatically format with previously chosen server, or open picker to choose one.
+- Open picker with formatting capable servers and format buffer with chosen server.
+- Format with a specific server (*very* simple wrapper around `vim.lsp.buf.format`)
+
+For now, you can see these near the end of `lua/plf/init.lua`, but I'll document them properly soon™.
+
+## 🔧 Configuration
+
+The settings table (`opts`) may define the following fields.
+
+| Setting       | Type                                 | Description                                                                  |
+|---------------|--------------------------------------|------------------------------------------------------------------------------|
+| data_dir      | `string`                             | Path to store plugin data in.                                                |
+| when_unset    | `string`: `pick` or `fun(): boolean` | What to do when no server has been set as the formatter yet. See note below. |
+| set_on_pick   | `boolean`                            | Whether to remember chosen server for this filetype. Note: see Scope below.  |
+| find_project  | `boolean`                            | Whether to save chosen servers for entire current project.                   |
+| find_patterns | `string[]`                           | Patterns to look for that define the root of a projet.                       |
+| exclude_lsp   | `string[]`                           | Names of servers to never use for formatting.                                |
+
+Note that `when_unset` can be a function. When this is the case, it must return `true` to open picker or `false` to format normally.
+
+And "format normally" here meanss calling `vim.lsp.buf.format` as you would without this plugin.
+
+### Scope
+
+By default (when `find_project == false`) plf will save your choices for the current working directory. This may not be the best choice if your working directory rarely coincides with the root of projects you're working on. Worst case? You'll need pick servers again.
+
+If you would like to save your choices for the current project instead, use `find_project == true`. It'll then search upwards for files or directories in `find_patterns` and once it finds one, it will save your choices for that directory. It also falls back to the cwd if the root can't be found.
+
+### Default settings
+
+The plugin comes with the following defaults:
+
+```lua
+data_dir = vim.fn.expand(vim.fn.stdpath('state') .. '/picklspfmt/'),
+when_unset = 'pick',
+set_on_pick = true,
+find_project = false,
+find_patterns = { '.git/' },
+exclude_lsp = {},
+```

lua/plf/config.lua

@@ -0,0 +1,18 @@
+local M = {}
+
+local defaults = {
+  data_dir = vim.fn.expand(vim.fn.stdpath('state') .. '/picklspfmt/'),
+  when_unset = 'pick', -- nil, 'pick', fun()->bool
+  set_on_pick = true,
+  find_project = false,
+  find_patterns = { '.git/' },
+  exclude_lsp = {},
+}
+
+M.opts = {}
+
+function M.build(opts)
+  M.opts = vim.tbl_extend('force', {}, defaults, opts)
+end
+
+return M