https://github.com/creativecodecat/header.nvim

https://github.com/creativecodecat/header.nvim

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/creativecodecat/header.nvim
• Owner: CreativeCodeCat
• License: mit
• Created: 2022-08-15T15:40:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-16T14:46:59.000Z (over 2 years ago)
• Last Synced: 2025-01-08T05:16:29.820Z (7 days ago)
• Language: Lua
• Size: 14.6 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 'The-Repo-Club/header.nvim'

```

## Setup

```lua

local header = require('header')

header.setup({

	user = 'Example',

	mail = '[email protected]',

	-- 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.