mirror of
				https://github.com/tiyn/tidy.nvim.git
				synced 2025-10-31 03:01:22 +01:00 
			
		
		
		
	
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							| @@ -5,17 +5,18 @@ | ||||
|  | ||||
|  | ||||
| ## Features | ||||
|  | ||||
| - Remove white space at the end of every line on save | ||||
| - Remove empty lines at the end of the buffer on save | ||||
|  | ||||
|  | ||||
| ## Requirements | ||||
|  | ||||
| - Neovim >= 0.9.0 | ||||
|  | ||||
| It may (should) work on lower versions, but is tested and updated using nightly. | ||||
|  | ||||
|  | ||||
| ## Installation | ||||
|  | ||||
| Your installation configuration will depend on your plugin manager. Below is the basic installation (using default options) for lazy.nvim. | ||||
|  | ||||
| ```lua | ||||
| @@ -25,8 +26,8 @@ Your installation configuration will depend on your plugin manager. Below is the | ||||
| } | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ## Configuration | ||||
|  | ||||
| tidy.nvim comes with the following options and their default settings: | ||||
|  | ||||
| ```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: | ||||
|  | ||||
| ```lua | ||||
| { | ||||
|     "mcauley-penney/tidy.nvim", | ||||
|     config = { | ||||
|     opts = { | ||||
|         filetype_exclude = { "markdown", "diff" } | ||||
|     }, | ||||
|     init = function() | ||||
| @@ -50,16 +50,16 @@ A more full example configuration for lazy.nvim would be: | ||||
| } | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ## Usage | ||||
|  | ||||
| tidy.nvim comes with the following functions: | ||||
|  | ||||
| | Lua                        | Description                                        | | ||||
| | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | ||||
| | -------------------------- | -------------------------------------------------- | | ||||
| | `require("tidy").toggle()` | Turn tidy.nvim off for the current buffer a plugin | | ||||
|  | ||||
|  | ||||
| ## 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) | ||||
| @@ -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) | ||||
|  | ||||
| - [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 | ||||
|   in [gpanders/editorconfig.nvim](https://github.com/gpanders/editorconfig.nvim) for exposing me to the `keepjumps` | ||||
|   and `keeppatterns` modifiers  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user