├── img ├── checkhealth.png ├── screenshot1.png └── screenshot2.png ├── ftplugin └── lua.lua ├── lua ├── configs │ ├── impatient.lua │ ├── colorschemes.lua │ ├── treesitter.lua │ ├── commentary.lua │ ├── gitsigns.lua │ ├── colorizer.lua │ ├── telescope.lua │ ├── toggleterm.lua │ ├── neoscroll.lua │ ├── nvimtree.lua │ ├── completion.lua │ ├── alpha.lua │ └── statusline.lua ├── utils │ └── utils.lua └── core │ ├── plugins.lua │ ├── keymaps.lua │ └── options.lua ├── .gitignore ├── init.lua ├── README.md └── LICENSE /img/checkhealth.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elairavi/luavim/HEAD/img/checkhealth.png -------------------------------------------------------------------------------- /img/screenshot1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elairavi/luavim/HEAD/img/screenshot1.png -------------------------------------------------------------------------------- /img/screenshot2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elairavi/luavim/HEAD/img/screenshot2.png -------------------------------------------------------------------------------- /ftplugin/lua.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[--------------------------------------]]-- 3 | -- lua.lua - Init file of LuaVim -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[--------------------------------------]]-- 7 | 8 | -- Fixing 'gf' command for lua files 9 | vim.opt_local.suffixesadd:prepend('.lua') 10 | vim.opt_local.suffixesadd:prepend('init.lua') 11 | vim.opt_local.path:prepend(vim.fn.stdpath('config')..'/lua') 12 | -------------------------------------------------------------------------------- /lua/configs/impatient.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[---------------------------------------]]-- 3 | -- impatient - improve startup time -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------]]-- 7 | 8 | -- Load impatient with a protected call 9 | local status_ok, impatient = pcall(require, "impatient") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- View profiling data 15 | impatient.enable_profile() 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Lua sources 2 | luac.out 3 | 4 | # luarocks build files 5 | *.src.rock 6 | *.zip 7 | *.tar.gz 8 | 9 | # Object files 10 | *.o 11 | *.os 12 | *.ko 13 | *.obj 14 | *.elf 15 | 16 | # Precompiled Headers 17 | *.gch 18 | *.pch 19 | 20 | # Libraries 21 | *.lib 22 | *.a 23 | *.la 24 | *.lo 25 | *.def 26 | *.exp 27 | 28 | # Shared objects (inc. Windows DLLs) 29 | *.dll 30 | *.so 31 | *.so.* 32 | *.dylib 33 | 34 | # Executables 35 | *.exe 36 | *.out 37 | *.app 38 | *.i*86 39 | *.x86_64 40 | *.hex 41 | 42 | 43 | plugin/packer_compiled.lua 44 | java-debug/ 45 | vscode-java-test/ 46 | lua-language-server/ 47 | -------------------------------------------------------------------------------- /lua/configs/colorschemes.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[---------------------------------------]]-- 3 | -- colorscheme - nord colorscheme -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------]]-- 7 | 8 | -- Nord colorscheme options 9 | vim.g.nord_contrast = true 10 | vim.g.nord_disable_background = true 11 | vim.g.nord_cursorline_transparent = false 12 | vim.g.nord_borders = false 13 | vim.g.nord_italic = false 14 | 15 | -- Load nord colorscheme with A protected call 16 | local colorscheme = "nord" 17 | local status_ok, _ = pcall(vim.cmd, "colorscheme " .. colorscheme) 18 | if not status_ok then 19 | return 20 | end 21 | -------------------------------------------------------------------------------- /lua/configs/treesitter.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[---------------------------------------]]-- 3 | -- treesitter - syntax highlighting -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------]]-- 7 | 8 | -- Load treesitter with a protected call 9 | local status_ok, nvim_treesitter = pcall(require, 'nvim-treesitter.configs') 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- Treesitter options 15 | nvim_treesitter.setup { 16 | -- A list of parser names, or "all" or just the "maintained" ones 17 | ensure_installed = { 18 | 'bash', 'c', 'lua', 'python' 19 | }, 20 | sync_install = false, 21 | highlight = { 22 | enable = true, -- `false` will disable the whole plugin 23 | }, 24 | } 25 | -------------------------------------------------------------------------------- /lua/configs/commentary.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[---------------------------------------]]-- 3 | -- nvim_comment - comment lines -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------]]-- 7 | 8 | -- Load nvim_comment with a protected call 9 | local status_ok, nvim_comment = pcall(require, "nvim_comment") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- Nvim comment options 15 | nvim_comment.setup { 16 | comment_empty = true, -- Should comment out empty or whitespace only lines 17 | marker_padding = true, -- Linters prefer comment and line to have a space in between markers 18 | create_mappings = true, -- Should key mappings be created 19 | comment_empty_trim_whitespace = true, -- Trim empty comment whitespace 20 | hook = nil -- Hook function to call before commenting takes place 21 | } 22 | -------------------------------------------------------------------------------- /lua/configs/gitsigns.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[-------------------------------------]]-- 3 | -- gitsigns - git for buffers -- 4 | -- Author: elai, ChristianChiarulli -- 5 | -- License: GPLv3 -- 6 | --[[-------------------------------------]]-- 7 | 8 | -- Load gitsigns with a protected call 9 | local status_ok, gitsigns = pcall(require, "gitsigns") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- Gitsigns options 15 | gitsigns.setup { 16 | signs = { 17 | add = { hl = "GitSignsAdd", text = "+", numhl = "GitSignsAddNr", linehl = "GitSignsAddLn" }, 18 | change = { hl = "GitSignsChange", text = "~", numhl = "GitSignsChangeNr", linehl = "GitSignsChangeLn" }, 19 | delete = { hl = "GitSignsDelete", text = "_", numhl = "GitSignsDeleteNr", linehl = "GitSignsDeleteLn" }, 20 | topdelete = { hl = "GitSignsDelete", text = "‾", numhl = "GitSignsDeleteNr", linehl = "GitSignsDeleteLn" }, 21 | changedelete = { hl = "GitSignsChange", text = "▎", numhl = "GitSignsChangeNr", linehl = "GitSignsChangeLn" }, 22 | }, 23 | } 24 | -------------------------------------------------------------------------------- /lua/configs/colorizer.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[------------------------------------]]-- 3 | -- colorizer - colors highlighter -- 4 | -- Author: ChristianChiarulli, elai -- 5 | -- License: GPLv3 -- 6 | --[[------------------------------------]]-- 7 | 8 | -- Load colorizer with a protected call 9 | local status_ok, colorizer = pcall(require, "colorizer") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | colorizer.setup({ "*" }, { 15 | RGB = true; -- #RGB hex codes 16 | RRGGBB = true; -- #RRGGBB hex codes 17 | RRGGBBAA = true; -- #RRGGBBAA hex codes 18 | rgb_fn = true; -- CSS rgb() and rgba() functions 19 | hsl_fn = true; -- CSS hsl() and hsla() functions 20 | names = false; -- "Name" codes like Blue 21 | css = false; -- Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB 22 | css_fn = false; -- Enable all CSS *functions*: rgb_fn, hsl_fn 23 | mode = "background", -- Set the display mode / Available modes: foreground, background, virtualtext 24 | }) 25 | -------------------------------------------------------------------------------- /lua/configs/telescope.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[-------------------------------------]-- 3 | -- telescope - fuzzy finder -- 4 | -- Author: ChristianChiarulli, elai -- 5 | -- License: GPLv3 -- 6 | --[[------------------------------------]]-- 7 | 8 | -- Load telescope with a protected call 9 | local status_ok, telescope = pcall(require, "telescope") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | local actions = require "telescope.actions" 15 | 16 | -- Telescope options 17 | telescope.setup { 18 | defaults = { 19 | 20 | prompt_prefix = " ", 21 | selection_caret = " ", 22 | path_display = { "smart" }, 23 | file_ignore_patterns = { ".git/", "node_modules" }, 24 | 25 | mappings = { 26 | i = { 27 | [""] = actions.close, 28 | [""] = actions.move_selection_next, 29 | [""] = actions.move_selection_previous, 30 | [""] = actions.preview_scrolling_up, 31 | [""] = actions.preview_scrolling_down, 32 | [""] = actions.select_vertical, 33 | [""] = actions.select_horizontal, 34 | }, 35 | }, 36 | }, 37 | } 38 | -------------------------------------------------------------------------------- /lua/configs/toggleterm.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[---------------------------------------]]-- 3 | -- toggleterm - terminal on nvim -- 4 | -- Author: elai, ChristianChiarulli -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------]]-- 7 | 8 | -- Load toggleterm with a protected call 9 | local status_ok, toggleterm = pcall(require, "toggleterm") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- Toggleterm options 15 | toggleterm.setup({ 16 | size = 20, 17 | open_mapping = [[]], 18 | hide_numbers = true, 19 | shade_terminals = true, 20 | shading_factor = 2, 21 | start_in_insert = true, 22 | insert_mappings = true, 23 | persist_size = true, 24 | direction = "float", 25 | close_on_exit = true, 26 | shell = vim.o.shell, 27 | float_opts = { 28 | width = 130, 29 | border = "single", 30 | }, 31 | }) 32 | 33 | function _G.set_terminal_keymaps() 34 | local opts = {noremap = true} 35 | vim.api.nvim_buf_set_keymap(0, 't', '', [[j]], opts) 36 | vim.api.nvim_buf_set_keymap(0, 't', '', [[k]], opts) 37 | end 38 | 39 | vim.cmd('autocmd! TermOpen term://* lua set_terminal_keymaps()') 40 | -------------------------------------------------------------------------------- /init.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[---------------------------------------------]]-- 3 | -- init.lua - Init file of LuaVim -- 4 | -- Author: elai, sergio -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------------]]-- 7 | 8 | local core_modules = { 9 | 10 | ---- Core Settings ---------------------------------- 11 | "core/plugins", -- Plugins + Packer Config 12 | "core/keymaps", -- Custom Keymaps 13 | "core/options", -- General Options 14 | 15 | ---- Plugin Configurations -------------------------- 16 | "configs/impatient", -- Improve Startup Time 17 | "configs/colorschemes", -- All Colorschemes 18 | "configs/treesitter", -- Syntax Highlighting 19 | "configs/completion", -- Auto Completion 20 | "configs/alpha", -- Wellcome Screen 21 | "configs/nvimtree", -- File Explorer 22 | "configs/gitsigns", -- Git Integration 23 | "configs/commentary", -- Easily Comment Lines 24 | "configs/statusline", -- Status Line 25 | "configs/colorizer", -- Colors Highlighter 26 | "configs/neoscroll", -- Smooth Scrolling 27 | "configs/toggleterm", -- Floating Terminal 28 | "configs/telescope", -- Fuzzy finder 29 | 30 | ---- Other Utilities -------------------------------- 31 | "utils/utils", -- Utilities 32 | 33 | } 34 | -- Using pcall we can handle better any loading issues 35 | for _, module in ipairs(core_modules) do 36 | local ok, err = pcall(require, module) 37 | if not ok then 38 | return 39 | end 40 | end 41 | -------------------------------------------------------------------------------- /lua/configs/neoscroll.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[--------------------------------------]]-- 3 | -- neoscroll - smooth scrolling -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[--------------------------------------]]-- 7 | 8 | -- Load neoscroll with a protected call 9 | local status_ok, neoscroll = pcall(require, "neoscroll") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- Neoscroll options 15 | neoscroll.setup { 16 | pre_hook = function(info) if info == "cursorline" then vim.wo.cursorline = false end end, 17 | post_hook = function(info) if info == "cursorline" then vim.wo.cursorline = true end end 18 | } 19 | 20 | -- Custom mappings 21 | local ns = {} 22 | 23 | -- [alt + u for scrolling up] , [alt + d for scrolling down] 24 | ns[''] = {'scroll', {'-vim.api.nvim_win_get_height(0)', 'true', '250'}} 25 | ns[''] = {'scroll', { 'vim.api.nvim_win_get_height(0)', 'true', '250'}} 26 | 27 | -- [ctrl + b for scrolling up] , [ctrl + f for scrolling down] 28 | ns[''] = {'scroll', {'-vim.api.nvim_win_get_height(0)', 'true', '250'}} 29 | ns[''] = {'scroll', { 'vim.api.nvim_win_get_height(0)', 'true', '250'}} 30 | 31 | -- [alt + k for scrolling up] , [alt + j for scrolling down] 32 | ns[''] = {'scroll', {'-vim.wo.scroll', 'false', '150', [['sine']]}} 33 | ns[''] = {'scroll', { 'vim.wo.scroll', 'false', '150', [['sine']]}} 34 | 35 | -- When no easing function is provided the default "quadratic" will be used 36 | ns['zz'] = {'zz', {'200'}} 37 | ns['zb'] = {'zb', {'200'}} 38 | 39 | require('neoscroll.config').set_mappings(ns) 40 | -------------------------------------------------------------------------------- /lua/configs/nvimtree.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[-------------------------------------]]-- 3 | -- nvimtree - file explorer -- 4 | -- Author: ChristianChiarulli, elai -- 5 | -- License: GPLv3 -- 6 | --[[-------------------------------------]]-- 7 | 8 | -- Load nvimtree with protected call 9 | local status_ok, nvim_tree = pcall(require, "nvim-tree") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | local config_status_ok, nvim_tree_config = pcall(require, "nvim-tree.config") 15 | if not config_status_ok then 16 | return 17 | end 18 | 19 | local tree_cb = nvim_tree_config.nvim_tree_callback 20 | 21 | -- Nvimtree options 22 | nvim_tree.setup { 23 | renderer = { 24 | root_folder_modifier = ":t", 25 | icons = { 26 | glyphs = { 27 | default = "", 28 | symlink = "", 29 | folder = { 30 | arrow_open = "", 31 | arrow_closed = "", 32 | default = "", 33 | open = "", 34 | empty = "", 35 | empty_open = "", 36 | symlink = "", 37 | symlink_open = "", 38 | }, 39 | git = { 40 | unstaged = "", 41 | staged = "S", 42 | unmerged = "", 43 | renamed = "➜", 44 | untracked = "U", 45 | deleted = "", 46 | ignored = "◌", 47 | }, 48 | }, 49 | }, 50 | }, 51 | view = { 52 | width = 35, 53 | height = 30, 54 | side = "left", 55 | mappings = { 56 | list = { 57 | { key = { "l", "", "o" }, cb = tree_cb "edit" }, 58 | { key = "h", cb = tree_cb "close_node" }, 59 | { key = "v", cb = tree_cb "vsplit" }, 60 | { key = "H", cb = tree_cb "split" }, 61 | }, 62 | }, 63 | }, 64 | } 65 | -------------------------------------------------------------------------------- /lua/utils/utils.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[-------------------------------------]]-- 3 | -- utils config - other settings -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[-------------------------------------]]-- 7 | 8 | -- Automatically deletes all trailing whitespace and newlines at end of file on save. & reset cursor position 9 | vim.api.nvim_exec([[ 10 | autocmd BufWritePre * let currPos = getpos(".") 11 | autocmd BufWritePre * %s/\s\+$//e 12 | autocmd BufWritePre * %s/\n\+\%$//e 13 | autocmd BufWritePre *.[ch] %s/\%$/\r/e 14 | autocmd BufWritePre * cal cursor(currPos[1], currPos[2]) 15 | ]], false) 16 | 17 | -- Blinking Cursor 18 | vim.cmd [[ 19 | :set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50 20 | \,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor 21 | \,sm:block-blinkwait175-blinkoff150-blinkon175 22 | ]] 23 | 24 | -- Abbreviations 25 | vim.cmd([[ 26 | cnoreabbrev W! w! 27 | cnoreabbrev Q! q! 28 | cnoreabbrev 1! q! 29 | cnoreabbrev Qall! qall! 30 | cnoreabbrev Wq wq 31 | cnoreabbrev Wa wa 32 | cnoreabbrev wQ wq 33 | cnoreabbrev WQ wq 34 | cnoreabbrev W w 35 | cnoreabbrev Q q 36 | cnoreabbrev Qall qall 37 | ]]) 38 | 39 | -- disable builtins plugins 40 | local disabled_built_ins = { 41 | "netrw", 42 | "netrwPlugin", 43 | "netrwSettings", 44 | "netrwFileHandlers", 45 | "gzip", 46 | "zip", 47 | "zipPlugin", 48 | "tar", 49 | "tarPlugin", 50 | "getscript", 51 | "getscriptPlugin", 52 | "vimball", 53 | "vimballPlugin", 54 | "2html_plugin", 55 | "logipat", 56 | "rrhelper", 57 | "spellfile_plugin", 58 | "matchit" 59 | } 60 | 61 | for _, plugin in pairs(disabled_built_ins) do 62 | vim.g["loaded_" .. plugin] = 1 63 | end 64 | 65 | -- Vertically center document when entering insert mode 66 | vim.api.nvim_exec([[ autocmd InsertEnter * norm zz ]], false) 67 | 68 | -- Disable Auto Commenting 69 | vim.cmd [[au BufEnter * set fo-=c fo-=r fo-=o]] 70 | 71 | -- Speed Things Up 72 | vim.cmd [[silent! set updatetime=300 timeout timeoutlen=500 ttimeout ttimeoutlen=50 ttyfast lazyredraw]] 73 | 74 | -- Disbale Word And Line Count 75 | vim.api.nvim_exec([[ autocmd VimEnter * set noru]], false) 76 | 77 | -- Disable Background Color Of The Cursorline 78 | vim.cmd [[hi CursorLine cterm=underline term=underline ctermbg=NONE guibg=NONE]] 79 | 80 | -- Remove These ~ ~ ~ 81 | vim.opt.fillchars:append { eob = " " } 82 | 83 | -- Disbale Status Line 84 | -- vim.api.nvim_exec([[ autocmd VimEnter * set laststatus=1]], false) 85 | -------------------------------------------------------------------------------- /lua/core/plugins.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[--------------------------------------]]-- 3 | -- plugins + packer - configuration -- 4 | -- Author: elai, ChristianChiarulli -- 5 | -- License: GPLv3 -- 6 | --[[--------------------------------------]]-- 7 | 8 | local fn = vim.fn 9 | 10 | -- Automatically install packer 11 | local install_path = fn.stdpath "data" .. "/site/pack/packer/start/packer.nvim" 12 | if fn.empty(fn.glob(install_path)) > 0 then 13 | PACKER_BOOTSTRAP = fn.system { 14 | "git", 15 | "clone", 16 | "--depth", 17 | "1", 18 | "https://github.com/wbthomason/packer.nvim", 19 | install_path, 20 | } 21 | print "Installing packer close and reopen Neovim..." 22 | vim.cmd [[packadd packer.nvim]] 23 | end 24 | 25 | -- Autocommand that reloads neovim whenever you save the plugins.lua file 26 | vim.cmd [[ 27 | augroup packer_user_config 28 | autocmd! 29 | autocmd BufWritePost plugins.lua source | PackerSync 30 | augroup end 31 | ]] 32 | 33 | -- Use a protected call so we don't error out on first use 34 | local status_ok, packer = pcall(require, "packer") 35 | if not status_ok then 36 | return 37 | end 38 | 39 | -- Have packer use a popup window 40 | packer.init { 41 | display = { 42 | open_fn = function() 43 | return require("packer.util").float { border = "rounded" } 44 | end, 45 | }, 46 | } 47 | 48 | -- Install your plugins here 49 | return packer.startup(function(use) 50 | 51 | -- My plugins 52 | -- Git integration for buffers 53 | use { 54 | 'lewis6991/gitsigns.nvim', 55 | event = { "CursorMoved", "CursorMovedI" }, 56 | config = function() 57 | require("gitsigns") 58 | end 59 | } 60 | 61 | use "wbthomason/packer.nvim" -- A use-package inspired plugin manager for Neovim 62 | use "kyazdani42/nvim-web-devicons" -- Lua fork of vim-web-devicons for neovim 63 | use "kyazdani42/nvim-tree.lua" -- A file explorer tree for neovim written in lua 64 | use "nvim-treesitter/nvim-treesitter" -- Treesitter Syntax highlighting and abstraction layer 65 | use "nvim-lualine/lualine.nvim" -- Fast and easy statusline for neovim 66 | use "shaunsingh/nord.nvim" -- Neovim theme based off of the Nord Color Palette 67 | use "goolord/alpha-nvim" -- Lua powered greeter like vim-startify / dashboard-nvim 68 | use "akinsho/nvim-toggleterm.lua" -- Plugin to easily toggle a terminal 69 | use "terrortylor/nvim-comment" -- Comment toggler for Neovim written in Lua 70 | use "norcalli/nvim-colorizer.lua" -- Colors highlighter for neovim 71 | use "hrsh7th/nvim-cmp" -- Completion plugin for neovim coded in Lua 72 | use "hrsh7th/cmp-buffer" -- Nvim-cmp source for buffer words 73 | use "hrsh7th/cmp-path" -- Nvim-cmp source for path 74 | use "L3MON4D3/LuaSnip" -- Snippet Engine for Neovim written in Lua 75 | use "lewis6991/impatient.nvim" -- Speed up loading Lua modules to improve startup time 76 | use "karb94/neoscroll.nvim" -- Smooth scrolling plugin written in lua 77 | use 'nvim-telescope/telescope.nvim' -- Find, filter, preview, pick. all lua, with telescope 78 | use 'nvim-lua/plenary.nvim' -- Plenary, a dependency of telescope 79 | 80 | -- Automatically set up your configuration after cloning packer.nvim 81 | -- Put this at the end after all plugins 82 | if PACKER_BOOTSTRAP then 83 | require("packer").sync() 84 | end 85 | end) 86 | -------------------------------------------------------------------------------- /lua/core/keymaps.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[------------------------------------]]-- 3 | -- keymaps - general mappings -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[------------------------------------]]-- 7 | 8 | -- Shorten function name 9 | local map = vim.keymap.set 10 | local opts = { noremap = true, silent = true } 11 | local term_opts = { silent = true } 12 | 13 | -- Remap space as leader key 14 | map("", "", "", {}) 15 | vim.g.mapleader = " " 16 | vim.g.maplocalleader = " " 17 | 18 | ----------------- 19 | -- Normal Mode -- 20 | ----------------- 21 | -- Mappings for moving through splits 22 | map("n", "", "h", {}) 23 | map("n", "", "j", {}) 24 | map("n", "", "k", {}) 25 | map("n", "", "l", {}) 26 | 27 | -- Resize current buffer by +/- 2 28 | map("n", "", ":vertical resize +2", {}) 29 | map("n", "", ":resize +2", {}) 30 | map("n", "", ":resize -2", {}) 31 | map("n", "", ":vertical resize -2", {}) 32 | 33 | -- Alternate way to save and quit nvim 34 | map("n", "", ":w", {}) -- save file 35 | map("n", "", ":q", {}) -- quit nvim 36 | map("n", "", ":q!", {}) -- quit without saving 37 | 38 | -- Nvim Comment 39 | map("n", "c", ":CommentToggle", {}) -- Comment One Line 40 | map("n", "p", "vip:CommentToggle", {}) -- Comment A Paragraph 41 | map("x", "c", ":'<,'>CommentToggle", {}) -- Comment Multiple Lines In Visual Mode 42 | 43 | -- Don't accidently create macros when trying to quit 44 | map('n', 'Q', 'q', {}) 45 | map('n', 'q', '', {}) 46 | 47 | -- GitSings 48 | map('n', "gp", ":Gitsigns preview_hunk", {}) -- preview_hunk 49 | map('n', "gr", ":Gitsigns reset_buffer", {}) -- reset_buffer 50 | 51 | -- Toggle Alpha Dashboard 52 | map('n', "a", ":set laststatus=3 | :Alpha", {}) 53 | 54 | -- Toggle NvimTree 55 | map("n", "e", ":NvimTreeToggle", {}) 56 | 57 | -- Yank entire line 58 | map("n", "yie", ":%y", {}) 59 | 60 | -- Packer Update 61 | map("n", "u", ":PackerSync", {}) 62 | 63 | -- Telescope Mappings 64 | map("n", "b", "lua require'telescope.builtin'.buffers(require('telescope.themes').get_dropdown({ previewer = false }))", {}) -- preview buffers 65 | map("n", "of", "lua require'telescope.builtin'.oldfiles(require('telescope.themes').get_dropdown({ previewer = false }))", {}) -- old files 66 | map("n", "f", "lua require'telescope.builtin'.find_files(require('telescope.themes').get_dropdown({ previewer = false }))", {}) -- Find files 67 | map("n", "gs", ":Telescope git_status", {}) -- git status 68 | 69 | ----------------- 70 | -- Insert Mode -- 71 | ----------------- 72 | -- Map Escape Key To kj 73 | map ("i", "kj", "", {}) 74 | 75 | -- Fix One [Car] behind 76 | map ("i", "", "`^", {}) 77 | 78 | -- Center screen after search 79 | vim.cmd([[ 80 | nnoremap n nzzzv 81 | nnoremap N Nzzzv 82 | ]]) 83 | 84 | -- Auto Pairs 85 | vim.cmd([[ 86 | inoremap ( () 87 | inoremap [ [] 88 | inoremap { {} 89 | inoremap { {}0 90 | inoremap {; {};0 91 | nnoremap o o^Da 92 | nnoremap O O^Da 93 | inoremap pumvisible() ? "\" : "\" 94 | inoremap " "" 95 | inoremap ' '' 96 | ]]) 97 | 98 | ----------------- 99 | -- Visual Mode -- 100 | ----------------- 101 | -- Move Text Up And Down 102 | vim.cmd([[ 103 | nnoremap :m .+1== 104 | nnoremap :m .-2== 105 | inoremap :m .+1==gi 106 | inoremap :m .-2==gi 107 | vnoremap :m '>+1gv=gv 108 | vnoremap :m '<-2gv=gv 109 | ]]) 110 | -------------------------------------------------------------------------------- /lua/configs/completion.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[--------------------------------------]]-- 3 | -- nvim-cmp - auto complete -- 4 | -- Author: elai, ChristianChiarulli -- 5 | -- License: GPLv3 -- 6 | --[[--------------------------------------]]-- 7 | 8 | -- Load nvim-cmp with a protected call 9 | local cmp_status_ok, cmp = pcall(require, "cmp") 10 | if not cmp_status_ok then 11 | return 12 | end 13 | 14 | -- Load luasnip with a protected call 15 | local snip_status_ok, luasnip = pcall(require, "luasnip") 16 | if not snip_status_ok then 17 | return 18 | end 19 | 20 | require("luasnip/loaders/from_vscode").lazy_load() 21 | 22 | local check_backspace = function() 23 | local col = vim.fn.col "." - 1 24 | return col == 0 or vim.fn.getline("."):sub(col, col):match "%s" 25 | end 26 | 27 | -- Some other good icons   פּ ﯟ   28 | -- Find more here: https://www.nerdfonts.com/cheat-sheet 29 | local kind_icons = { 30 | Text = "", 31 | Method = "m", 32 | Function = "", 33 | Constructor = "", 34 | Field = "", 35 | Variable = "", 36 | Class = "", 37 | Interface = "", 38 | Module = "", 39 | Property = "", 40 | Unit = "", 41 | Value = "", 42 | Enum = "", 43 | Keyword = "", 44 | Snippet = "", 45 | Color = "", 46 | File = "", 47 | Reference = "", 48 | Folder = "", 49 | EnumMember = "", 50 | Constant = "", 51 | Struct = "", 52 | Event = "", 53 | Operator = "", 54 | TypeParameter = "", 55 | } 56 | 57 | -- Nvim-cmp settings 58 | cmp.setup { 59 | snippet = { 60 | expand = function(args) 61 | luasnip.lsp_expand(args.body) 62 | end, 63 | }, 64 | 65 | mapping = { 66 | [""] = cmp.mapping.select_prev_item(), 67 | [""] = cmp.mapping.select_next_item(), 68 | [""] = cmp.mapping(cmp.mapping.scroll_docs(-1), { "i", "c" }), 69 | [""] = cmp.mapping(cmp.mapping.scroll_docs(1), { "i", "c" }), 70 | [""] = cmp.mapping(cmp.mapping.complete(), { "i", "c" }), 71 | [""] = cmp.config.disable, 72 | [""] = cmp.mapping { 73 | i = cmp.mapping.abort(), 74 | c = cmp.mapping.close(), 75 | }, 76 | [""] = cmp.mapping.confirm { select = false }, 77 | [""] = cmp.mapping(function(fallback) 78 | if cmp.visible() then 79 | cmp.select_next_item() 80 | elseif luasnip.expandable() then 81 | luasnip.expand() 82 | elseif luasnip.expand_or_jumpable() then 83 | luasnip.expand_or_jump() 84 | elseif check_backspace() then 85 | fallback() 86 | else 87 | fallback() 88 | end 89 | end, { 90 | "i", 91 | "s", 92 | }), 93 | [""] = cmp.mapping(function(fallback) 94 | if cmp.visible() then 95 | cmp.select_prev_item() 96 | elseif luasnip.jumpable(-1) then 97 | luasnip.jump(-1) 98 | else 99 | fallback() 100 | end 101 | end, { 102 | "i", 103 | "s", 104 | }), 105 | }, 106 | formatting = { 107 | fields = { "kind", "abbr", "menu" }, 108 | format = function(entry, vim_item) 109 | vim_item.kind = string.format("%s", kind_icons[vim_item.kind]) 110 | vim_item.menu = ({ 111 | nvim_lsp = "[LSP]", 112 | luasnip = "[Snippet]", 113 | fuzzy_buffer = "[Buffer]", 114 | path = "[Path]", 115 | })[entry.source.name] 116 | return vim_item 117 | end, 118 | }, 119 | sources = { 120 | { name = "luasnip" }, 121 | { name = "buffer" }, 122 | { name = "path" }, 123 | }, 124 | confirm_opts = { 125 | behavior = cmp.ConfirmBehavior.Replace, 126 | select = false, 127 | }, 128 | experimental = { 129 | ghost_text = true, 130 | native_menu = false, 131 | }, 132 | } 133 | -------------------------------------------------------------------------------- /lua/core/options.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[------------------------------------]]-- 3 | -- options - general settings -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[------------------------------------]]-- 7 | 8 | ---------------------- 9 | -- General settings -- 10 | ---------------------- 11 | local set = vim.opt 12 | set.swapfile = false -- Don't use swapfile 13 | set.updatetime = 0 -- Faster completion 14 | set.encoding="utf-8" -- The encoding displayed 15 | set.fileencoding="utf-8" -- The encoding written to file 16 | set.smartindent = true -- Makes indenting smart 17 | set.iskeyword:append("-") -- Treat dash separated words as a word text object" 18 | set.clipboard = "unnamedplus" -- Copy paste between vim and everything else 19 | set.smarttab = true -- Makes tabbing smarter will realize you have 2 vs 4 20 | set.expandtab = true -- Converts tabs to spaces 21 | set.autoindent = true -- Good auto indent 22 | set.autochdir = true -- Your working directory will always be the same as your working directory 23 | set.incsearch = true -- Sets incremental search 24 | set.mouse = 'a' -- Enable mouse support 25 | set.shell = "/bin/zsh" -- Set your shell to bash or zsh 26 | set.shortmess:append "sI" -- Disable nvim intro 27 | vim.cmd [[set nobackup]] -- Creates a backup file 28 | vim.cmd [[set nowritebackup]] -- Creates a backup file i guess 29 | vim.cmd [[set formatoptions-=cro]] -- Stop newline continution of comments 30 | vim.cmd [[set complete+=kspell]] -- Auto complete with spellcheck 31 | vim.cmd [[set completeopt=menuone,longest]] -- Auto complete menu (It's pretty great) 32 | vim.cmd [[set nocompatible]] -- Disable compatibility to old-time vi 33 | 34 | --------------- 35 | -- Neovim UI -- 36 | --------------- 37 | set.pumheight = 15 -- Makes popup menu smaller 38 | set.ruler = true -- Show the cursor position all the time 39 | set.splitbelow = true -- Horizontal splits will automatically be below 40 | set.splitright = true -- Vertical splits will automatically be to the right 41 | set.conceallevel = 0 -- So that I can see `` in markdown files 42 | set.tabstop = 2 -- Insert 2 spaces for a tab 43 | set.number = true -- Line numbers 44 | set.background = "dark" -- Tell vim what the background color looks like 45 | set.virtualedit = "onemore" -- With This option you can move the cursor one character over the end 46 | set.ignorecase = true -- Ignores case when searching 47 | set.smartcase = true -- Turns on case sensitive search when letters are capitalized 48 | set.termguicolors = true -- Set term gui colors (most terminals support this) 49 | set.laststatus=3 -- Always display the status line 50 | set.title = true -- Show current txt that you editing 51 | set.relativenumber = false -- Vim’s absolute, relative and hybrid line numbers 52 | set.cursorline = true -- Enable highlighting of the current line 53 | set.shiftwidth = 2 -- Change the number of space characters inserted for indentation 54 | set.showtabline = 1 -- Always show tabs 55 | set.cmdheight = 1 -- More space for displaying messages 56 | set.numberwidth = 5 -- Set number column width to 2 {default 4} 57 | set.foldenable = false -- Disable folding text 58 | vim.cmd [[setlocal conceallevel=2]] -- Syntax conceal for markdown 59 | vim.cmd [[set noshowmode]] -- We don't need to see things like -- INSERT -- anymore 60 | vim.cmd [[syntax enable]] -- Enables syntax highlighing 61 | vim.cmd [[set t_Co=256]] -- Support 256 colors 62 | -- vim.cmd "set whichwrap+=<,>,[,],h,l" -- Breaks Space-Time Continuum 63 | -- vim.cmd [[set nowrap]] -- Display long lines as just one line 64 | 65 | ----------------- 66 | -- Memory, CPU -- 67 | ----------------- 68 | set.hidden = true -- Required to keep multiple buffers open multiple buffers 69 | set.timeoutlen = 500 -- By default timeoutlen is 1000 ms 70 | set.lazyredraw = true -- Disable lazyredraw 71 | set.synmaxcol = 240 -- Max column for syntax highlight 72 | set.updatetime = 700 -- ms to wait for trigger an event 73 | -------------------------------------------------------------------------------- /lua/configs/alpha.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[------------------------------]]-- 3 | -- Alpha - welcome screen -- 4 | -- Author: elai -- 5 | -- License: GPLv3 -- 6 | --[[------------------------------]]-- 7 | 8 | -- Load Alpha with a protected call 9 | local status_ok, alpha = pcall(require, "alpha") 10 | if not status_ok then 11 | return 12 | end 13 | 14 | -- Enable Alpha dashboard 15 | local dashboard = require("alpha.themes.dashboard") 16 | 17 | -- Disable the statusline to make the dashboard look clean 18 | vim.cmd [[ au User AlphaReady if winnr('$') == 1 | set laststatus=1 ]] 19 | 20 | -- Custom Footer 21 | dashboard.section.footer.val = { 22 | "Write Programs That Do One Thing And Do It Well.", 23 | } 24 | 25 | -- Custom Section 26 | dashboard.section.buttons.val = { 27 | dashboard.button("n", " Create New file", ":set laststatus=3 | :ene startinsert "), 28 | dashboard.button("r", " Open Recent Files", ":set laststatus=3 | :Telescope oldfiles "), 29 | dashboard.button("v", " Neovim Settings", ":set laststatus=3 | e ~/.config/nvim/init.lua "), 30 | dashboard.button("u", " Update Nvim Plugins", ":PackerSync "), 31 | dashboard.button("q", " Quit Neovim", ":qa"), 32 | } 33 | 34 | -- Luavim Ascii Art 35 | dashboard.section.header.val = { 36 | [[██╗ ██╗ ██╗ █████╗ ██╗ ██╗ ██╗ ███╗ ███╗]], 37 | [[██║ ██║ ██║ ██╔══██╗ ██║ ██║ ██║ ████╗ ████║]], 38 | [[██║ ██║ ██║ ███████║ ██║ ██║ ██║ ██╔████╔██║]], 39 | [[██║ ██║ ██║ ██╔══██║ ╚██╗ ██╔╝ ██║ ██║╚██╔╝██║]], 40 | [[███████╗╚██████╔╝ ██║ ██║ ╚████╔╝ ██║ ██║ ╚═╝ ██║]], 41 | [[╚══════╝ ╚═════╝ ╚═╝ ╚═╝ ╚═══╝ ╚═╝ ╚═╝ ╚═╝]], 42 | } 43 | 44 | -- Layout for luavim ascii art 45 | dashboard.config.layout = { 46 | { type = "padding", val = 6 }, 47 | dashboard.section.header, 48 | { type = "padding", val = 2 }, 49 | dashboard.section.buttons, 50 | { type = "padding", val = 1 }, 51 | dashboard.section.footer, 52 | } 53 | 54 | -- -- Neovim ascii art 55 | -- dashboard.section.header.val = { 56 | -- [[███╗ ██╗ ███████╗ ██████╗ ██╗ ██╗ ██╗ ███╗ ███╗]], 57 | -- [[████╗ ██║ ██╔════╝██╔═══██╗ ██║ ██║ ██║ ████╗ ████║]], 58 | -- [[██╔██╗ ██║ █████╗ ██║ ██║ ██║ ██║ ██║ ██╔████╔██║]], 59 | -- [[██║╚██╗██║ ██╔══╝ ██║ ██║ ╚██╗ ██╔╝ ██║ ██║╚██╔╝██║]], 60 | -- [[██║ ╚████║ ███████╗╚██████╔╝ ╚████╔╝ ██║ ██║ ╚═╝ ██║]], 61 | -- [[╚═╝ ╚═══╝ ╚══════╝ ╚═════╝ ╚═══╝ ╚═╝ ╚═╝ ╚═╝]], 62 | -- } 63 | 64 | -- -- Layout for Neovim ascii art 65 | -- dashboard.config.layout = { 66 | -- { type = "padding", val = 5 }, 67 | -- dashboard.section.header, 68 | -- { type = "padding", val = 2 }, 69 | -- dashboard.section.buttons, 70 | -- { type = "padding", val = 1 }, 71 | -- dashboard.section.footer, 72 | -- } 73 | 74 | -- -- Doom Neovim ascii art 75 | -- dashboard.section.header.val = { 76 | -- [[================= =============== =============== ======== ========]], 77 | -- [[\\ . . . . . . .\\ //. . . . . . .\\ //. . . . . . .\\ \\. . .\\// . . //]], 78 | -- [[||. . ._____. . .|| ||. . ._____. . .|| ||. . ._____. . .|| || . . .\/ . . .||]], 79 | -- [[|| . .|| ||. . || || . .|| ||. . || || . .|| ||. . || ||. . . . . . . ||]], 80 | -- [[||. . || || . .|| ||. . || || . .|| ||. . || || . .|| || . | . . . . .||]], 81 | -- [[|| . .|| ||. _-|| ||-_ .|| ||. . || || . .|| ||. _-|| ||-_.|\ . . . . ||]], 82 | -- [[||. . || ||-' || || `-|| || . .|| ||. . || ||-' || || `|\_ . .|. .||]], 83 | -- [[|| . _|| || || || || ||_ . || || . _|| || || || |\ `-_/| . ||]], 84 | -- [[||_-' || .|/ || || \|. || `-_|| ||_-' || .|/ || || | \ / |-_.||]], 85 | -- [[|| ||_-' || || `-_|| || || ||_-' || || | \ / | `||]], 86 | -- [[|| `' || || `' || || `' || || | \ / | ||]], 87 | -- [[|| .===' `===. .==='.`===. .===' /==. | \/ | ||]], 88 | -- [[|| .==' \_|-_ `===. .===' _|_ `===. .===' _-|/ `== \/ | ||]], 89 | -- [[|| .==' _-' `-_ `=' _-' `-_ `=' _-' `-_ /| \/ | ||]], 90 | -- [[|| .==' _-' '-__\._-' '-_./__-' `' |. /| | ||]], 91 | -- [[||.==' _-' `' | /==.||]], 92 | -- [[==' _-' N E O V I M \/ `==]], 93 | -- [[\ _-' `-_ /]], 94 | -- [[ `'' ``' ]], 95 | -- } 96 | 97 | -- -- Layout for Doom Neovim ascii art 98 | -- dashboard.config.layout = { 99 | -- { type = "padding", val = 3 }, 100 | -- dashboard.section.header, 101 | -- { type = "padding", val = 2 }, 102 | -- dashboard.section.buttons, 103 | -- { type = "padding", val = 1 }, 104 | -- dashboard.section.footer, 105 | -- } 106 | 107 | -- source for ascii art 108 | -- https://textkool.com/en/ascii-art-generator?hl=default&vl=default&font=Red+Phoenix&text=Your+text+here+ 109 | 110 | alpha.setup(dashboard.opts) 111 | -------------------------------------------------------------------------------- /lua/configs/statusline.lua: -------------------------------------------------------------------------------- 1 | 2 | --[[----------------------------------------]-- 3 | -- Lualine - statusline -- 4 | -- Author: elai, shadmansaleh, glepnir -- 5 | -- License: GPLv3 -- 6 | --[[---------------------------------------]]-- 7 | 8 | -- Forked from : https://github.com/nvim-lualine/lualine.nvim/blob/master/examples/evil_lualine.lua 9 | 10 | -- Load lualine with a protected call 11 | local status_ok, lualine = pcall(require, "lualine") 12 | if not status_ok then 13 | return 14 | end 15 | 16 | -- Color table for highlights 17 | local colors = { 18 | bg = '#0c1014', 19 | fg = '#bbc2cf', 20 | yellow = '#ECBE7B', 21 | cyan = '#008080', 22 | darkblue = '#081633', 23 | green = '#B7BD82', 24 | orange = '#8d6141', 25 | violet = '#B294BB', 26 | magenta = '#AE84BB', 27 | blue = '#81A2BE', 28 | red = '#CC8282', 29 | } 30 | 31 | local conditions = { 32 | buffer_not_empty = function() 33 | return vim.fn.empty(vim.fn.expand('%:t')) ~= 1 34 | end, 35 | hide_in_width = function() 36 | return vim.fn.winwidth(0) > 80 37 | end, 38 | check_git_workspace = function() 39 | local filepath = vim.fn.expand('%:p:h') 40 | local gitdir = vim.fn.finddir('.git', filepath .. ';') 41 | return gitdir and #gitdir > 0 and #gitdir < #filepath 42 | end, 43 | } 44 | 45 | -- Config 46 | local config = { 47 | options = { 48 | component_separators = '', 49 | section_separators = '', 50 | theme = { 51 | normal = { c = { fg = colors.fg, bg = colors.bg } }, 52 | inactive = { c = { fg = colors.fg, bg = colors.bg } }, 53 | }, 54 | }, 55 | 56 | -- These are to remove the defaults 57 | sections = { 58 | lualine_a = {}, 59 | lualine_b = {}, 60 | lualine_y = {}, 61 | lualine_z = {}, 62 | lualine_c = {}, 63 | lualine_x = {}, 64 | }, 65 | -- These are to remove the defaults 66 | inactive_sections = { 67 | lualine_a = {}, 68 | lualine_b = {}, 69 | lualine_y = {}, 70 | lualine_z = {}, 71 | lualine_c = {}, 72 | lualine_x = {}, 73 | }, 74 | } 75 | 76 | -- Inserts a component in lualine_c at left section 77 | local function ins_left(component) 78 | table.insert(config.sections.lualine_c, component) 79 | end 80 | 81 | -- Inserts a component in lualine_x ot right section 82 | local function ins_right(component) 83 | table.insert(config.sections.lualine_x, component) 84 | end 85 | 86 | -- Begining Of The StatusLine 87 | ins_left { 88 | function() 89 | return '▎' 90 | end, 91 | color = { fg = colors.blue }, 92 | padding = { left = 0, right = 1 }, 93 | } 94 | 95 | -- Icon for diffrent mode: -- normal -- | -- insert -- | -- visual -- | -- command -- 96 | ins_left { 97 | function() 98 | return '' 99 | end, 100 | color = function() 101 | 102 | -- Auto change color according to neovim's mode 103 | local mode_color = { 104 | n = colors.green, 105 | i = colors.blue, 106 | v = colors.magenta, 107 | [''] = colors.magenta, 108 | V = colors.magenta, 109 | c = colors.red, 110 | no = colors.red, 111 | s = colors.orange, 112 | S = colors.orange, 113 | [''] = colors.orange, 114 | ic = colors.yellow, 115 | R = colors.violet, 116 | Rv = colors.violet, 117 | cv = colors.red, 118 | ce = colors.red, 119 | r = colors.cyan, 120 | rm = colors.cyan, 121 | ['r?'] = colors.cyan, 122 | ['!'] = colors.red, 123 | t = colors.red, 124 | } 125 | return { fg = mode_color[vim.fn.mode()] } 126 | end, 127 | padding = { right = 0 }, 128 | } 129 | 130 | -- File Name 131 | ins_left { 132 | 'filename', 133 | file_status = true, -- Displays file status (readonly status, modified status) 134 | path = 2, -- 0: Just the filename 135 | -- 1: Relative path 136 | -- 2: Absolute path 137 | shorting_target = 0, -- Shortens path to leave 40 spaces in the window 138 | symbols = { 139 | modified = '  ', -- Text to show when the file is modified. 140 | readonly = '  ', -- Text to show when the file is non-modifiable or readonly. 141 | unnamed = '[No Name]', -- Text to show for unnamed buffers. 142 | } 143 | } 144 | 145 | -- Git Diff 146 | local function diff_source() 147 | local gitsigns = vim.b.gitsigns_status_dict 148 | if gitsigns then 149 | return { 150 | added = gitsigns.added, 151 | modified = gitsigns.changed, 152 | removed = gitsigns.removed 153 | } 154 | end 155 | end 156 | 157 | ins_right { 'diff',source = diff_source} 158 | 159 | -- Git Branch 160 | ins_right { 161 | 'branch', 162 | icon = '', 163 | -- icon = '', 164 | -- color = { fg = colors.green }, 165 | } 166 | 167 | -- File Type 168 | ins_right { 169 | 'filetype', 170 | icon_only = true, 171 | padding = { right = 2, left = 1 } 172 | } 173 | 174 | -- File Encoding 175 | ins_right { 176 | 'o:encoding', 177 | cond = conditions.hide_in_width, 178 | padding = { right = 2 }, 179 | -- color = { fg = colors.green, gui = 'bold' }, 180 | -- fmt = string.upper, 181 | } 182 | 183 | -- File Format 184 | ins_right { 185 | 'fileformat', 186 | padding = { right = 2 }, 187 | symbols = { unix = 'unix '}, 188 | -- color = { fg = colors.green, gui = 'bold' }, 189 | -- icons_enabled = false, 190 | } 191 | 192 | -- File Size 193 | ins_right { 194 | 'filesize', 195 | padding = { right = 2 }, 196 | cond = conditions.buffer_not_empty, 197 | } 198 | 199 | -- Text Progress 200 | ins_right { 201 | 'progress', 202 | padding = { right = 1 }, 203 | } 204 | 205 | -- File Location 206 | ins_right { 207 | 'location', 208 | padding = { right = 0 }, 209 | } 210 | 211 | -- Insert mid section. You can make any number of sections in neovim :) 212 | -- For lualine it's any number greater then 2 213 | ins_left { 214 | function() 215 | return '%=' 216 | end, 217 | } 218 | 219 | -- End Of The Status Bar 220 | ins_right { 221 | function() 222 | return '▎' 223 | end, 224 | color = { fg = colors.blue }, 225 | padding = { left = 1, right = 0 }, 226 | } 227 | 228 | -- Now don't forget to initialize lualine 229 | lualine.setup(config) 230 | 231 | -- Set one statusline on all buffers 232 | vim.opt.laststatus = 3 233 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | ![luavim](img/screenshot1.png?raw=true) 3 | ![tree+split](img/screenshot2.png?raw=true) 4 | 5 | ## Description 6 | 7 | * **Luavim** is a simple **neovim** configuration written in **lua**, aiming to provide a **base** config, so users could tweak the defaults, remove the things they don't like, and build their config on top of it. 8 | 9 | ## Table of Contents 10 | 11 | * [Plugins List](#plugins-list) 12 | * [Directory Tree](#directory-tree) 13 | * [Installation](#installation) 14 | * [Configuration Check](#configuration-check) 15 | * [Uninstalation](#uninstalation) 16 | * [Resources](#resources) 17 | 18 | ## Plugins List 19 | 20 | - [packer.nvim](https://github.com/wbthomason/packer.nvim) - A use-package inspired plugin manager for Neovim 21 | - [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Nvim Treesitter configurations and abstraction layer 22 | - [nvim-tree.lua](https://github.com/kyazdani42/nvim-tree.lua) - A file explorer tree for neovim written in lua 23 | - [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) - A blazing fast and easy to configure neovim statusline plugin written in pure lua 24 | - [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) - A Lua fork of vim-devicons 25 | - [nvim-comment](https://github.com/terrortylor/nvim-comment) - A comment toggler for Neovim, written in Lua 26 | - [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) - Git integration for buffers 27 | - [nvim-colorizer.lua](https://github.com/norcalli/nvim-colorizer.lua) - The fastest Neovim colorizer 28 | - [nord.nvim](https://github.com/shaunsingh/nord.nvim) - Neovim theme based off of the Nord Color Palette, written in lua with tree sitter support 29 | - [alpha-nvim](https://github.com/goolord/alpha-nvim) - a lua powered greeter like vim-startify / dashboard-nvim 30 | - [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) - A completion plugin for neovim coded in Lua 31 | - [cmp-buffer](https://github.com/hrsh7th/cmp-buffer) - nvim-cmp source for buffer words 32 | - [cmp-path](https://github.com/hrsh7th/cmp-path) - nvim-cmp source for path 33 | - [LuaSnip](https://github.com/L3MON4D3/LuaSnip) - Snippet Engine for Neovim written in Lua 34 | - [impatient.nvim](https://github.com/lewis6991/impatient.nvim) - Improve startup time for Neovim 35 | - [neoscroll.nvim](https://github.com/karb94/neoscroll.nvim) - Smooth scrolling neovim plugin written in lua 36 | - [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim) - A neovim lua plugin to help easily manage multiple terminal windows 37 | - [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Find, filter, preview, pick. all lua, with telescope 38 | - [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) - All the lua functions I don't want to write twice 39 | 40 | ## Directory Tree 41 | 42 | ``` 43 | ├── ftplugin 44 | │   └── lua.lua 45 | ├── init.lua 46 | └── lua 47 | ├── configs 48 | │   ├── alpha.lua 49 | │   ├── colorizer.lua 50 | │   ├── colorschemes.lua 51 | │   ├── commentary.lua 52 | │   ├── completion.lua 53 | │   ├── gitsigns.lua 54 | │   ├── impatient.lua 55 | │   ├── neoscroll.lua 56 | │   ├── nvimtree.lua 57 | │   ├── statusline.lua 58 | │   ├── telescope.lua 59 | │   ├── toggleterm.lua 60 | │   └── treesitter.lua 61 | ├── core 62 | │   ├── keymaps.lua 63 | │   ├── options.lua 64 | │   └── plugins.lua 65 | └── utils 66 | └── utils.lua 67 | ``` 68 | 69 | ## Installation 70 | 71 | - Install [Neovim v0.7.x](https://github.com/neovim/neovim/releases/latest) 72 | - Install a [nerd font](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts) (for the font in the screenshot, install [JetBrainsMono](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/JetBrainsMono/Ligatures)) 73 | - Follow this [guide](https://youtu.be/fR4ThXzhQYI?t=216) if you don't know how to install patched nerd-fonts 74 | - Make sure you backup your current `nvim` directory 75 | 76 | ```term 77 | mv ~/.config/nvim ~/.config/nvim_backup 78 | mv ~/.local/share/nvim ~/.local/share/nvim_backup 79 | ``` 80 | 81 | - Download `luavim` with `git` and place it into `~/.config/nvim` 82 | 83 | ```term 84 | git clone https://github.com/elairavi/luavim.git ~/.config/nvim 85 | ``` 86 | 87 | - Run `nvim` and wait for the plugins to be installed, when all the plugins are installed close neovim and reopen it 88 | - You will notice treesitter pulling in a bunch of parsers the second time you open Neovim 89 | - Note: checkout this file for some predefined [key-mappings](https://github.com/elairavi/luavim/blob/main/lua/core/keymaps.lua) 90 | 91 | ## Configuration check 92 | 93 | - Open neovim with this flag `nvim +checkhealth` you should not see any errors in the output (except for the one related to Python): 94 | 95 | ![checkhealth](/img/checkhealth.png?raw=true) 96 | 97 | * Note: If you're having a problem or some kinda of an error with a plugin, just run these commands: 98 | ```term 99 | rm -rf ~/.cache/nvim 100 | rm -rf ~/.config/nvim/plugin 101 | rm -rf ~/.local/share/nvim 102 | nvim 103 | ``` 104 | 105 | * If the problem persists open an [issue](https://github.com/elairavi/luavim/issues) and i will do what i can to help. 106 | 107 | ## Uninstalation 108 | 109 | - Note: I suggeste you backup your config first, consider `mv ~/.config/nvim ~/.config/nvim_backup` and then run these commands to uninstall `luavim` 110 | 111 | ```term 112 | rm -rf ~/.config/nvim 113 | rm -rf ~/.local/share/nvim 114 | rm -rf ~/.cache/nvim 115 | ``` 116 | 117 | ## Resources 118 | 119 | #### Neovim lua projects and examples 120 | 121 | - https://github.com/LunarVim/nvim-basic-ide 122 | - https://github.com/brainfucksec/neovim-lua 123 | - https://github.com/siduck76/NvChad 124 | - https://github.com/artart222/CodeArt 125 | - https://github.com/crivotz/nv-ide 126 | 127 | #### Guides and resources 128 | 129 | - https://neovim.io/doc/user/lua.html 130 | - https://github.com/nanotee/nvim-lua-guide 131 | - https://dev.to/vonheikemen/everything-you-need-to-know-to-configure-neovim-using-lua-3h58 132 | - https://www.old.reddit.com/r/neovim/ 133 | 134 | #### Lua resources 135 | 136 | - Lua in Y minutes - https://learnxinyminutes.com/docs/lua/ 137 | - Lua Quick Guide - https://github.com/medwatt/Notes/blob/main/Lua/Lua_Quick_Guide.ipynb 138 | - Lua 5.4 Reference Manual - https://www.lua.org/manual/5.4/ 139 | 140 | ## Special Thanks 141 | 142 | * Thanks to all the authors of the sources mentioned above, And special thanks to [ChristianChiarulli](https://github.com/ChristianChiarulli) and [brainfucksec](https://github.com/brainfucksec) For making this configuration possible. 143 | 144 |
145 | 146 | [![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)](#madewithlua) 147 | 148 |
149 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------