zoriya/auto-save.nvim
1
0
Fork 0
mirror of https://github.com/zoriya/auto-save.nvim.git synced 2026-05-28 17:04:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

finished readme

Browse Source
This commit is contained in:
kdav5758
2021-07-01 21:38:44 -05:00
parent 9c49e293c5
commit 0781634b4f
1 changed files with 224 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+224
View File
@@ -37,4 +37,228 @@
/></a>
</p>
<kbd><img src ="https://raw.githubusercontent.com/Pocco81/AutoSave.nvim/dev/resources/demo.gif"></kbd>
<p align="center">
Demo
</p><hr>
# TL;DR
<div style="text-align: justify">
AutoSave.nvim is a NeoVim plugin written in Lua that aims to provide the simple functionality of automatically saving your work whenever you make changes to it. You can filter under which conditions which files are saved and when the auto-save functionality should triggered (events). To get started simply install the plugin with your favorite plugin manager!
</div>
# 🌲 Table of Contents
* [Features](#-features)
* [Notices](#-notices)
* [Installation](#-installation)
* [Prerequisites](#prerequisites)
* [Adding the plugin](#adding-the-plugin)
* [Setup Configuration](#setup-configuration)
* [For init.lua](#for-initlua)
* [For init.vim](#for-initvim)
* [Updating](#updating)
* [Usage (commands)](#-usage-commands)
* [Default](#default)
* [Configuration](#-configuration)
* [General](#general)
* [Contribute](#-contribute)
* [Inspirations](#-inspirations)
* [License](#-license)
* [FAQ](#-faq)
* [To-Do](#-to-do)
# 🎁 Features
- Highlight visual selection in any given *pre-defined* color.
- Remove highlighting from lines in visual selection.
- Users can set up foreground and background of any color.
- Has a "smart" option to set foreground based on background.
- Users can add any amount of colors.
- Produce a *verbose* output for debugging (optional).
# 📺 Notices
Checkout the [CHANGELOG.md](https://github.com/Pocco81/AutoSave.nvim/blob/main/CHANGELOG.md) file for more information on the notices below:
- **26-05-21**: Fixed bug that prevented adding new colors and added option to remove all highlighting from the current buffer
- **25-05-21**: Just released!
# 📦 Installation
## Prerequisites
- [NeoVim nightly](https://github.com/neovim/neovim/releases/tag/nightly) (>=v0.5.0)
- A nice color scheme to complement your experience ;)
## Adding the plugin
You can use your favorite plugin manager for this. Here are some examples with the most popular ones:
### Vim-plug
```lua
Plug 'Pocco81/AutoSave.nvim'
```
### Packer.nvim
```lua
use "Pocco81/AutoSave.nvim"
```
### Vundle
```lua
Plugin 'Pocco81/AutoSave.nvim'
```
### NeoBundle
```lua
NeoBundleFetch 'Pocco81/AutoSave.nvim'
```
## Setup (configuration)
As it's stated in the TL;DR, there are already some sane defaults that you may like, however you can change them to match your taste. These are the defaults:
```lua
enabled = true,
execution_message = "AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"),
events = {"InsertLeave", "TextChanged"},
conditions = {
exists = true,
filetype_is_not = {},
modifiable = true,
},
write_all_buffers = false,
on_off_commands = false,
clean_command_line_interval = 0
```
The way you setup the settings on your config varies on whether you are using vimL for this or Lua.
<details>
<summary>For init.lua</summary>
<p>
```lua
local autosave = require("autosave")
autosave.setup(
{
enabled = true,
execution_message = "AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"),
events = {"InsertLeave", "TextChanged"},
conditions = {
exists = true,
filetype_is_not = {},
modifiable = true
},
write_all_buffers = true,
on_off_commands = true,
clean_command_line_interval = 2500
}
)
```
<br />
</details>
<details>
<summary>For init.vim</summary>
<p>
```lua
lua << EOF
local autosave = require("autosave")
autosave.setup(
{
enabled = true,
execution_message = "AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"),
events = {"InsertLeave", "TextChanged"},
conditions = {
exists = true,
filetype_is_not = {},
modifiable = true
},
write_all_buffers = true,
on_off_commands = true,
clean_command_line_interval = 2500
}
)
EOF
```
<br />
</details>
For instructions on how to configure the plugin, check out the [configuration](#configuration) section.
## Updating
This depends on your plugin manager. If, for example, you are using Packer.nvim, you can update it with this command:
```lua
:PackerUpdate
```
# 🤖 Usage (commands)
All the commands follow the *camel casing* naming convention and have the `AS` prefix so that it's easy to remember that they are part of this plugin. These are all of them:
## Default
+ `:ASToggle`: toggles AutoSave.nvim on and off.
## Extra
+ `:ASOn`: toggles AutoSave.nvim on.
+ `:ASOff`: toggles AutoSave.nvim off.
# 🐬 Configuration
Although settings already have self-explanatory names, here is where you can find info about each one of them and their classifications!
## General
- `verbosity`: (Integer) if greater that zero, enables verbose output (print what it does when you execute any of the two command).
+ `enabled:`: (Boolean) if true, enables AutoSave.nvim at startup (Note: this is not for loading the plugin it self but rather the "auto-save" functionality. This is like running `:ASOn`).
+ `execution_message`: (String) message to be displayed when saving [a] file[s].
+ `events`: (Table): events that will trigger the plugin.
+ `write_all_buffers`: (Boolean) if true, writes to all modifiable buffers that meet the `conditions`.
+ `on_off_commands`: (Boolean) if true, enables extra commands for toggling the plugin on and off (`:ASOn` and `:ASOff`).
+ `clean_command_line_interval` (Integer) if greater than 0, cleans the command line after *x* amount of milliseconds after printing the `execution_message`.
## Conditions
These are the conditions that every file must meet so that it can be saved. If every file to be auto-saved doesn't meet all of the conditions it won't be saved.
+ `exists`: (Boolean) if true, enables this condition. If the file doesn't exist it won't save it (e.g. if you `nvim stuff.txt` and don't save the file then this condition won't be met)
+ `modifiable`: (Boolean) if true, enables this condition. If the file isn't modifiable, then this condition isn't met.
+ `filetype_is_not`: (Table, Strings) if there is one or more filetypes (should be strings) in the table, it enables this condition. Use this to exclude filetypes that you don't want to automatically save.
# 🙋 FAQ
- Q: ***"How can I view the doc from NeoVim?"***
- A: Use `:help AutoSave.nvim`
# 🫂 Contribute
Pull Requests are welcomed as long as they are properly justified and there are no conflicts. If your PR has something to do with the README or in general related with the documentation, I'll gladly merge it! Also, when writing code for the project **you must** use the [.editorconfig](https://github.com/Pocco81/AutoSave.nvim/blob/main/.editorconfig) file on your editor so as to "maintain consistent coding styles". For instructions on how to use this file refer to [EditorConfig's website](https://editorconfig.org/).
# 💭 Inspirations
The following projects inspired the creation of AutoSave.nvim. If possible, go check them out to see why they are so amazing :]
- [907th/vim-auto-save](https://github.com/907th/vim-auto-save): Automatically save changes to disk in Vim.
# 📜 License
AutoSave.nvim is released under the GPL v3.0 license. It grants open-source permissions for users including:
- The right to download and run the software freely
- The right to make changes to the software as desired
- The right to redistribute copies of the software
- The right to modify and distribute copies of new versions of the software
For more convoluted language, see the [LICENSE file](https://github.com/Pocco81/AutoSave.nvim/blob/main/LICENSE.md).
# 📋 TO-DO
**High Priority**
- Store and Restore highlights on a per-file basis
**Low Priority**
- Add tab completion to get more than 10 numbers.
<hr>
<p align="center">
Enjoy!
</p>