tiyn/tidy.nvim
1
0
Fork 0
mirror of https://github.com/tiyn/tidy.nvim.git synced 2025-10-31 03:01:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: change config to opts in example lazy.nvim cfg

Browse Source 
Closes #15
This commit is contained in:
jmp
2023-10-22 12:16:40 -07:00
committed by GitHub
parent 86eab24e80
commit f8bfd7b799
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -5,17 +5,18 @@
![tidy-demo](https://github.com/mcauley-penney/tidy.nvim/assets/59481467/f3807c69-2b36-4a14-b83a-dd0f2829e096) ![tidy-demo](https://github.com/mcauley-penney/tidy.nvim/assets/59481467/f3807c69-2b36-4a14-b83a-dd0f2829e096)
## Features ## Features
- Remove white space at the end of every line on save - Remove white space at the end of every line on save
- Remove empty lines at the end of the buffer on save - Remove empty lines at the end of the buffer on save
## Requirements ## Requirements
- Neovim >= 0.9.0 - Neovim >= 0.9.0
It may (should) work on lower versions, but is tested and updated using nightly. It may (should) work on lower versions, but is tested and updated using nightly.
## Installation ## Installation
Your installation configuration will depend on your plugin manager. Below is the basic installation (using default options) for lazy.nvim. Your installation configuration will depend on your plugin manager. Below is the basic installation (using default options) for lazy.nvim.
```lua ```lua
@@ -25,8 +26,8 @@ Your installation configuration will depend on your plugin manager. Below is the
} }
``` ```
## Configuration ## Configuration
tidy.nvim comes with the following options and their default settings: tidy.nvim comes with the following options and their default settings:
```lua ```lua
@@ -35,13 +36,12 @@ tidy.nvim comes with the following options and their default settings:
} }
``` ```
A more full example configuration for lazy.nvim would be: A more full example configuration for lazy.nvim would be:
```lua ```lua
{ {
"mcauley-penney/tidy.nvim", "mcauley-penney/tidy.nvim",
config = { opts = {
filetype_exclude = { "markdown", "diff" } filetype_exclude = { "markdown", "diff" }
}, },
init = function() init = function()
@@ -50,16 +50,16 @@ A more full example configuration for lazy.nvim would be:
} }
``` ```
## Usage ## Usage
tidy.nvim comes with the following functions: tidy.nvim comes with the following functions:
| Lua | Description | | Lua | Description |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------- | -------------------------------------------------- |
| `require("tidy").toggle()` | Turn tidy.nvim off for the current buffer a plugin | | `require("tidy").toggle()` | Turn tidy.nvim off for the current buffer a plugin |
## About and Credits ## 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. 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) - [Vim Tips Wiki entry for removing unwanted spaces](https://vim.fandom.com/wiki/Remove_unwanted_spaces#Automatically_removing_all_trailing_whitespace)
@@ -67,5 +67,5 @@ I originally wrote this as a wrapper around a couple of vim regex commands used
- `ib.`, the author of [this Stack Overflow answer](https://stackoverflow.com/a/7501902) - `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) - [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` in [gpanders/editorconfig.nvim](https://github.com/gpanders/editorconfig.nvim) for exposing me to the `keepjumps`
and `keeppatterns` modifiers and `keeppatterns` modifiers