mirror of
https://github.com/zoriya/auto-save.nvim.git
synced 2025-12-06 06:36:11 +00:00
ci: add vimdoc auto-generation workflow (#23)
vimdoc should update on every commit to `main`. This way the "Last change" info in vimdoc actually shows when the code was last changed even if the source file for help didn't change.
Other notable changes:
- Made README.md panvimdoc compatible
- Got rid of `<details>` and `<summary>` tags in installation instructions
- Made title, description and badges markdown only features (not included in vimdoc)
- Tweaked README.md appearance
- Raised all heading levels by one
- Updated description
- Added license badge
- Removed customisations from badges
- Left style as For the Badge though
- Added initial vimdoc, locally generated with panvimdoc
Closes #10.
This commit is contained in:
okuuva
GitHub
24
.github/workflows/docs.yml
vendored
Normal file
24
.github/workflows/docs.yml
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
docs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: kdheepak/panvimdoc@v3
|
||||
with:
|
||||
vimdoc: auto-save.nvim
|
||||
version: "Neovim >= 0.8.0"
|
||||
demojify: true
|
||||
treesitter: true
|
||||
shiftheadinglevelby: -1
|
||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
||||
with:
|
||||
branch: ${{ github.head_ref }}
|
||||
commit_message: "chore(doc): auto-generate vimdoc"
|
||||
commit_user_name: "github-actions[bot]"
|
||||
commit_user_email: "github-actions[bot]@users.noreply.github.com"
|
||||
commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
|
||||
55
README.md
55
README.md
@@ -1,21 +1,31 @@
|
||||
<!-- panvimdoc-ignore-start -->
|
||||
<p align="center">
|
||||
<h2 align="center">🧶 auto-save.nvim</h2>
|
||||
<h1 align="center">🧶 auto-save.nvim</h1>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
Automatically save your changes in NeoVim
|
||||
<b>auto-save.nvim</b> is a lua plugin for automatically saving your changed buffers in Neovim<br>
|
||||
Forked from <a href="https://github.com/Pocco81/auto-save.nvim">auto-save.nvim</a> as active development has stopped
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/okuuva/auto-save.nvim/stargazers">
|
||||
<img alt="Stars" src="https://img.shields.io/github/stars/okuuva/auto-save.nvim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41"></a>
|
||||
<img alt="Stars" src="https://img.shields.io/github/stars/okuuva/auto-save.nvim?style=for-the-badge">
|
||||
</a>
|
||||
<a href="https://github.com/okuuva/auto-save.nvim/issues">
|
||||
<img alt="Issues" src="https://img.shields.io/github/issues/okuuva/auto-save.nvim?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41"></a>
|
||||
<img alt="Issues" src="https://img.shields.io/github/issues/okuuva/auto-save.nvim?style=for-the-badge">
|
||||
</a>
|
||||
<a href="https://github.com/okuuva/auto-save.nvim/blob/main/LICENSE">
|
||||
<img alt="License" src="https://img.shields.io/github/license/okuuva/auto-save.nvim?style=for-the-badge">
|
||||
</a>
|
||||
<a href="https://github.com/okuuva/auto-save.nvim">
|
||||
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/okuuva/auto-save.nvim?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41"/></a>
|
||||
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/okuuva/auto-save.nvim?style=for-the-badge"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
### 📋 Features
|
||||
<!-- panvimdoc-ignore-end -->
|
||||
|
||||
## 📋 Features
|
||||
|
||||
- automatically save your changes so the world doesn't collapse
|
||||
- highly customizable:
|
||||
@@ -26,16 +36,15 @@
|
||||
- multiple callbacks
|
||||
- automatically clean the message area
|
||||
|
||||
### 📚 Requirements
|
||||
## 📚 Requirements
|
||||
|
||||
- Neovim >= 0.5.0
|
||||
- Neovim >= 0.8.0
|
||||
|
||||
### 📦 Installation
|
||||
## 📦 Installation
|
||||
|
||||
Install the plugin with your favourite package manager:
|
||||
|
||||
<details>
|
||||
<summary><a href="https://github.com/folke/lazy.nvim">Lazy.nvim</a></summary>
|
||||
### [Lazy.nvim]("https://github.com/folke/lazy.nvim")
|
||||
|
||||
```lua
|
||||
{
|
||||
@@ -49,10 +58,7 @@ Install the plugin with your favourite package manager:
|
||||
},
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><a href="https://github.com/wbthomason/packer.nvim">Packer.nvim</a></summary>
|
||||
### [Packer.nvim]("https://github.com/wbthomason/packer.nvim")
|
||||
|
||||
```lua
|
||||
use({
|
||||
@@ -66,10 +72,7 @@ use({
|
||||
})
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><a href="https://github.com/junegunn/vim-plug">vim-plug</a></summary>
|
||||
### [vim-plug]("https://github.com/junegunn/vim-plug")
|
||||
|
||||
```vim
|
||||
Plug 'okuuva/auto-save.nvim'
|
||||
@@ -83,7 +86,7 @@ EOF
|
||||
|
||||
</details>
|
||||
|
||||
### ⚙️ Configuration
|
||||
## ⚙️ Configuration
|
||||
|
||||
**auto-save** comes with the following defaults:
|
||||
|
||||
@@ -118,10 +121,12 @@ EOF
|
||||
}
|
||||
```
|
||||
|
||||
#### Condition
|
||||
### Condition
|
||||
|
||||
The condition field of the configuration allows the user to exclude **auto-save** from saving specific buffers.
|
||||
|
||||
Here is an example using a helper function from `auto-save.utils.data` that disables auto-save for specified file types:
|
||||
|
||||
```lua
|
||||
{
|
||||
condition = function(buf)
|
||||
@@ -138,6 +143,7 @@ Here is an example using a helper function from `auto-save.utils.data` that disa
|
||||
```
|
||||
|
||||
You may also exclude `special-buffers` see (`:h buftype` and `:h special-buffers`):
|
||||
|
||||
```lua
|
||||
{
|
||||
condition = function(buf)
|
||||
@@ -154,7 +160,7 @@ You may also exclude `special-buffers` see (`:h buftype` and `:h special-buffers
|
||||
|
||||
Buffers that are `nomodifiable` are not saved by default.
|
||||
|
||||
### 🪴 Usage
|
||||
## 🚀 Usage
|
||||
|
||||
Besides running auto-save at startup (if you have `enabled = true` in your config), you may as well:
|
||||
|
||||
@@ -179,14 +185,13 @@ or as part of the `lazy.nvim` plugin spec:
|
||||
|
||||
```
|
||||
|
||||
|
||||
### 🤝 Contributing
|
||||
## 🤝 Contributing
|
||||
|
||||
- All pull requests are welcome.
|
||||
- If you encounter bugs please open an issue.
|
||||
- Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) when commiting.
|
||||
- See [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional) for more details.
|
||||
|
||||
### 👋 Acknowledgements
|
||||
## 👋 Acknowledgements
|
||||
|
||||
This plugin wouldn't exist without [Pocco81](https://github.com/Pocco81)'s work on the [original](https://github.com/Pocco81/auto-save.nvim).
|
||||
|
||||
219
doc/auto-save.nvim.txt
Normal file
219
doc/auto-save.nvim.txt
Normal file
@@ -0,0 +1,219 @@
|
||||
*auto-save.nvim.txt* Last change: 2023 April 30
|
||||
|
||||
==============================================================================
|
||||
Table of Contents *auto-save.nvim-table-of-contents*
|
||||
|
||||
1. Features |auto-save.nvim-features|
|
||||
2. Requirements |auto-save.nvim-requirements|
|
||||
3. Installation |auto-save.nvim-installation|
|
||||
- Lazy.nvim |auto-save.nvim-installation-lazy.nvim|
|
||||
- Packer.nvim |auto-save.nvim-installation-packer.nvim|
|
||||
- vim-plug |auto-save.nvim-installation-vim-plug|
|
||||
4. Configuration |auto-save.nvim-configuration|
|
||||
- Condition |auto-save.nvim-configuration-condition|
|
||||
5. Usage |auto-save.nvim-usage|
|
||||
6. Contributing |auto-save.nvim-contributing|
|
||||
7. Acknowledgements |auto-save.nvim-acknowledgements|
|
||||
|
||||
==============================================================================
|
||||
1. Features *auto-save.nvim-features*
|
||||
|
||||
|
||||
- automatically save your changes so the world doesn’t collapse
|
||||
- highly customizable:
|
||||
- conditionals to assert whether to save or not
|
||||
- execution message (it can be dimmed and personalized)
|
||||
- events that trigger auto-save
|
||||
- debounce the save with a delay
|
||||
- multiple callbacks
|
||||
- automatically clean the message area
|
||||
|
||||
|
||||
==============================================================================
|
||||
2. Requirements *auto-save.nvim-requirements*
|
||||
|
||||
|
||||
- Neovim >= 0.8.0
|
||||
|
||||
|
||||
==============================================================================
|
||||
3. Installation *auto-save.nvim-installation*
|
||||
|
||||
Install the plugin with your favourite package manager:
|
||||
|
||||
|
||||
LAZY.NVIM *auto-save.nvim-installation-lazy.nvim*
|
||||
|
||||
>lua
|
||||
{
|
||||
"okuuva/auto-save.nvim",
|
||||
cmd = "ASToggle", -- optional for lazy loading on command
|
||||
event = { "InsertLeave", "TextChanged" } -- optional for lazy loading on trigger events
|
||||
opts = {
|
||||
-- your config goes here
|
||||
-- or just leave it empty :)
|
||||
},
|
||||
},
|
||||
<
|
||||
|
||||
|
||||
PACKER.NVIM *auto-save.nvim-installation-packer.nvim*
|
||||
|
||||
>lua
|
||||
use({
|
||||
"okuuva/auto-save.nvim",
|
||||
config = function()
|
||||
require("auto-save").setup {
|
||||
-- your config goes here
|
||||
-- or just leave it empty :)
|
||||
}
|
||||
end,
|
||||
})
|
||||
<
|
||||
|
||||
|
||||
VIM-PLUG *auto-save.nvim-installation-vim-plug*
|
||||
|
||||
>vim
|
||||
Plug 'okuuva/auto-save.nvim'
|
||||
lua << EOF
|
||||
require("auto-save").setup {
|
||||
-- your config goes here
|
||||
-- or just leave it empty :)
|
||||
}
|
||||
EOF
|
||||
<
|
||||
|
||||
|
||||
==============================================================================
|
||||
4. Configuration *auto-save.nvim-configuration*
|
||||
|
||||
**auto-save** comes with the following defaults:
|
||||
|
||||
>lua
|
||||
{
|
||||
enabled = true, -- start auto-save when the plugin is loaded (i.e. when your package manager loads it)
|
||||
execution_message = {
|
||||
enabled = true,
|
||||
message = function() -- message to print on save
|
||||
return ("AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"))
|
||||
end,
|
||||
dim = 0.18, -- dim the color of `message`
|
||||
cleaning_interval = 1250, -- (milliseconds) automatically clean MsgArea after displaying `message`. See :h MsgArea
|
||||
},
|
||||
trigger_events = { -- See :h events
|
||||
immediate_save = { "BufLeave", "FocusLost" }, -- vim events that trigger an immediate save
|
||||
defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`)
|
||||
cancel_defered_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save
|
||||
},
|
||||
-- function that takes the buffer handle and determines whether to save the current buffer or not
|
||||
-- return true: if buffer is ok to be saved
|
||||
-- return false: if it's not ok to be saved
|
||||
-- if set to `nil` then no specific condition is applied
|
||||
condition = nil,
|
||||
write_all_buffers = false, -- write all buffers when the current one meets `condition`
|
||||
debounce_delay = 1000, -- delay after which a pending save is executed
|
||||
callbacks = { -- functions to be executed at different intervals
|
||||
before_saving = nil, -- ran before doing the actual save
|
||||
},
|
||||
-- log debug messages to 'auto-save.log' file in neovim cache directory, set to `true` to enable
|
||||
debug = false,
|
||||
}
|
||||
<
|
||||
|
||||
|
||||
CONDITION *auto-save.nvim-configuration-condition*
|
||||
|
||||
The condition field of the configuration allows the user to exclude
|
||||
**auto-save** from saving specific buffers.
|
||||
|
||||
Here is an example using a helper function from `auto-save.utils.data` that
|
||||
disables auto-save for specified file types:
|
||||
|
||||
>lua
|
||||
{
|
||||
condition = function(buf)
|
||||
local fn = vim.fn
|
||||
local utils = require("auto-save.utils.data")
|
||||
|
||||
-- don't save for `sql` file types
|
||||
if utils.not_in(fn.getbufvar(buf, "&filetype"), {'sql'}) then
|
||||
return true
|
||||
end
|
||||
return false
|
||||
end
|
||||
}
|
||||
<
|
||||
|
||||
You may also exclude `special-buffers` see (`:h buftype` and `:h
|
||||
special-buffers`):
|
||||
|
||||
>lua
|
||||
{
|
||||
condition = function(buf)
|
||||
local fn = vim.fn
|
||||
|
||||
-- don't save for special-buffers
|
||||
if fn.getbufvar(buf, "&buftype") ~= '' then
|
||||
return false
|
||||
end
|
||||
return true
|
||||
end
|
||||
}
|
||||
<
|
||||
|
||||
Buffers that are `nomodifiable` are not saved by default.
|
||||
|
||||
|
||||
==============================================================================
|
||||
5. Usage *auto-save.nvim-usage*
|
||||
|
||||
Besides running auto-save at startup (if you have `enabled = true` in your
|
||||
config), you may as well:
|
||||
|
||||
|
||||
- `ASToggle`toggle auto-save
|
||||
|
||||
You may want to set up a key mapping for toggling:
|
||||
|
||||
>lua
|
||||
vim.api.nvim_set_keymap("n", "<leader>n", ":ASToggle<CR>", {})
|
||||
<
|
||||
|
||||
or as part of the `lazy.nvim` plugin spec:
|
||||
|
||||
>lua
|
||||
{
|
||||
"okuuva/auto-save.nvim",
|
||||
keys = {
|
||||
{ "<leader>n", ":ASToggle<CR>", desc = "Toggle auto-save" },
|
||||
},
|
||||
...
|
||||
},
|
||||
<
|
||||
|
||||
|
||||
==============================================================================
|
||||
6. Contributing *auto-save.nvim-contributing*
|
||||
|
||||
|
||||
- All pull requests are welcome.
|
||||
- If you encounter bugs please open an issue.
|
||||
- Please use Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/> when commiting.
|
||||
- See @commitlint/config-conventional <https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional> for more details.
|
||||
|
||||
|
||||
==============================================================================
|
||||
7. Acknowledgements *auto-save.nvim-acknowledgements*
|
||||
|
||||
This plugin wouldn’t exist without Pocco81 <https://github.com/Pocco81>’s
|
||||
work on the original <https://github.com/Pocco81/auto-save.nvim>.
|
||||
|
||||
==============================================================================
|
||||
8. Links *auto-save.nvim-links*
|
||||
|
||||
1. *@commitlint/config-conventional*:
|
||||
|
||||
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
Reference in New Issue
Block a user