42-header.nvim's Introduction

🛸 42 Header

This plugin is whole re-write of 42header in Lua.

✨ Features

Command: Stdheader
Auto update on save (optional)
Supports commentstring
Supports Git

🚀 Showcase

🎈 Setup

📦 Packer.nvim

use {
  "Diogo-ss/42-header.nvim",
  cmd = { "Stdheader" },
  config = function()
    require "42header"setup {
      default_map = true, -- Default mapping <F1> in normal mode.
      auto_update = true, -- Update header when saving.
      user = "username", -- Your user.
      mail = "[email protected]", -- Your mail.
    -- add other options.
    }
  end,
}

💤 Lazy.nvim

{
  "Diogo-ss/42-header.nvim",
  cmd = { "Stdheader" },
  keys = { "<F1>" },
  opts = {
    default_map = true, -- Default mapping <F1> in normal mode.
    auto_update = true, -- Update header when saving.
    user = "username", -- Your user.
    mail = "[email protected]", -- Your mail.
    -- add other options.
  },
  config = function(_, opts)
    require("42header").setup(opts)
  end,
}

⚙ Options

{
  ---Max header size (not recommended change).
  --length = 80,
  ---Header margin (not recommended change).
  --margin = 5,
  ---Activate default mapping (e.g. F1).
  default_map = true,
  ---Enable auto-update of headers.
  auto_update = true,
  ---Default user.name.
  user = "username",
  ---Default user.email.
  mail = "[email protected]",
  ---ASCII art.
  --asciiart = { "---", "---", ... },
  ---Git config.
  git = {
    ---Enable Git support.
    enabled = false,
    ---PATH to the Git binary.
    bin = "git",
    ---Use global user.name, otherwise use local user.name.
    user_global = true,
    ---Use global user.email, otherwise use local user.email.
    email_global = true,
  },
}

🌐 User and Mail

user and mail can be defined using global variables.

vim.g.user = "username"
vim.g.mail = "[email protected]"

NOTE: The order of priority: global variables > git config (if support enabled) > user config.

42-header.nvim's People

Contributors

Stargazers

Watchers

42-header.nvim's Issues

Instalação no Astrovim

Hey Diogo, tentei instalar através do instalador lazy.nvim sem sucesso, uso com o Astrovim no MacOS. Pode me ajudar?

Add a option to search for user and email in ~/.gitconfig

First of all thanks a lot for writing this very useful extension for us nvim users.

My suggestion is basically this : have a option that will make the header email and user be based on the info of the gitconfig, if it's a repo the file being edited is currently in.

I'm pretty sure this is not as straightforward as i make it sound, and would love to help you with this if you need any help.