https://github.com/mcauley-penney/tidy.nvim

A small Neovim plugin to remove trailing whitespace and empty lines at end of file on every save
https://github.com/mcauley-penney/tidy.nvim

Last synced: 14 days ago
JSON representation

A small Neovim plugin to remove trailing whitespace and empty lines at end of file on every save

• Host: GitHub
• URL: https://github.com/mcauley-penney/tidy.nvim
• Owner: mcauley-penney
• Created: 2021-10-26T03:57:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T16:52:23.000Z (18 days ago)
• Last Synced: 2024-10-22T05:38:32.432Z (18 days ago)
• Language: Lua
• Homepage:
• Size: 45.9 KB
• Stars: 109
• Watchers: 1
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-neovim - mcauley-penney/tidy.nvim - Clear trailing whitespace and empty lines at end of file on every save. (Formatting / Comment)

README

        
# tidy.nvim 🧹

**tidy.nvim** removes trailing white space and empty lines at EOF on save.

![tidy](https://github.com/mcauley-penney/tidy.nvim/assets/59481467/0c9c43c8-891a-40d4-9d54-b4bd5010be86)

## Requirements

- Neovim >= 0.9.0

It may work on lower versions, but is tested and updated using nightly.

## Installation

Most basic configuration using lazy.nvim:

```lua

{

    "mcauley-penney/tidy.nvim",

    config = true,

}

```

A more full example configuration for lazy.nvim would be:

```lua

{

    "mcauley-penney/tidy.nvim",

    opts = {

        enabled_on_save = false

        filetype_exclude = { "markdown", "diff" }

    },

    init = function()

        vim.keymap.set('n', "tt", require("tidy").toggle, {})

        vim.keymap.set('n', "tr", require("tidy").run, {})

    end

}

```

## Configuration

tidy.nvim comes with the following options and their default settings:

```lua

{

  enabled_on_save = true

  filetype_exclude = {}  -- Tidy will not be enabled for any filetype, e.g. "markdown", in this table

}

```

tidy.nvim also comes with the following functions, which may be mapped:

| Lua                        | Description                                                      |

| -------------------------- | ---------------------------------------------------------------- |

| `require("tidy").toggle()` | Turn tidy.nvim off for the current buffer                        |

| `require("tidy").run()`    | Run the formatting functionality of tidy.nvim off without saving |

```lua

init = function()

     vim.keymap.set('n', "tt", require("tidy").toggle, {})

     vim.keymap.set('n', "tr", require("tidy").run, {})

end

```

## About and Credits

I originally wrote this as a wrapper around a couple of vim regex commands used for formatting files before I began using formatters. These commands are not mine, please see the sources below. Even with real formatters in my setup now, I still like and use this because I like these specific formats to be applied to every buffer and don't want to have a formatting tool installed for them.

- [Vim Tips Wiki entry for removing unwanted spaces](https://vim.fandom.com/wiki/Remove_unwanted_spaces#Automatically_removing_all_trailing_whitespace)

- `ib.`, the author of [this Stack Overflow answer](https://stackoverflow.com/a/7501902)

- [This line](https://github.com/gpanders/editorconfig.nvim/blob/ae3586771996b2fb1662eb0c17f5d1f4f5759bb7/lua/editorconfig.lua#L180)

  in [gpanders/editorconfig.nvim](https://github.com/gpanders/editorconfig.nvim) for exposing me to the `keepjumps`

  and `keeppatterns` modifiers