Epitech.nvim

Epitech's neovim plugin

Description

This plugin aims to make epitech's student life easier while using vim
It offers some pretty fine functionality such as embeded coding style reports, headers and so on

The plugin is mainly for 1st year student as upper grade studs doesn't need some of its functionalities but feel free to use it or contribute (: .

Installation

Using packer.nvim

use {'Nero-F/epitech.nvim'}

Using vim-plug

Plug 'Nero-F/epitech.nvim'

Using dein

call dein#add('Nero-F/epitech.nvim')

Configurations

for basic setup with all batteries included:

require("epitechJA").setup()

If using packer.nvim it can be setup directly in the plugin spec:

use {"Nero-F/epitech", config = function() require("epitech").setup() end}

Configuration can be passed to the setup function. Here is an example with most of the default settings:

require("epitech").setup({
  coding_style = {
    -- Default configurations for coding_style goes here
    delivery_dir =  "a folder", -- default: current directory
    reports_dir = "a folder", -- default: current directory
    export_file = "a filename", -- default: "coding-style-reports.log"
  },
})

Disclaimer

This plugin is still under development, I only code it for fun, to practice a little bit of lua and to help my junior students at school.

Contributing

All contributions are welcome! Just open a pull request.