https://github.com/CreativeCodeCat/header.nvim
https://github.com/CreativeCodeCat/header.nvim
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/CreativeCodeCat/header.nvim
- Owner: CreativeCodeCat
- License: mit
- Created: 2022-08-15T15:40:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T08:03:41.000Z (9 months ago)
- Last Synced: 2025-05-03T22:57:16.838Z (8 months ago)
- Language: Lua
- Size: 19.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# header.nvim
The header plugin written in Lua aims to quickly generate readable headers for several programming languages.
Additionally, it also automatically updates the last edited time.
## Installation
Just install using your package manager of choice:
```lua
use 'CreativeCodeCat/header.nvim'
```
## Setup
```lua
local header = require('header')
header.setup({
user = 'Example',
mail = 'example@email.com',
-- You can also extend filetypes, e.g:
ft = {
lua = {
start_comment = "--",
end_comment = "--",
fill_comment = "-",
}
}
})
```
## Supported Filetypes by Default
* `c` for C files
* `cpp` for C++ and header files
* `python` for python files
* `lua` for lua files
* `make` for Makefiles
* `vim` for vimscript files
## Mappings
header.nvim does not provide default mappings, but you can map a to the command `StrHeader`.
Although this plugins does not provide mappings, it sets up `autocmd` to update the header.