My neovim init.lua configuration

init.lua

--              AstroNvim Configuration Table
-- All configuration changes should go inside of the table below

-- You can think of a Lua "table" as a dictionary like data structure the
-- normal format is "key = value". These also handle array like data structures
-- where a value with no key simply has an implicit numeric key
local config = {
  -- Configure AstroNvim updates
  updater = {
    remote = "origin", -- remote to use
    channel = "nightly", -- "stable" or "nightly"
    version = "latest", -- "latest", tag name, or regex search like "v1.*" to only do updates before v2 (STABLE ONLY)
    branch = "main", -- branch name (NIGHTLY ONLY)
    commit = nil, -- commit hash (NIGHTLY ONLY)
    pin_plugins = nil, -- nil, true, false (nil will pin plugins on stable only)
    skip_prompts = false, -- skip prompts about breaking changes
    show_changelog = true, -- show the changelog after performing an update
    auto_reload = true, -- automatically reload and sync packer after a successful update
    auto_quit = false, -- automatically quit the current session after a successful update
    -- remotes = { -- easily add new remotes to track
    --   ["remote_name"] = "https://remote_url.come/repo.git", -- full remote url
    --   ["remote2"] = "github_user/repo", -- GitHub user/repo shortcut,
    --   ["remote3"] = "github_user", -- GitHub user assume AstroNvim fork
    -- },
  },
  -- Set colorscheme to use
  colorscheme = "default_theme",
  -- Add highlight groups in any theme
  highlights = {
    -- init = { -- this table overrides highlights in all themes
    --   Normal = { bg = "#000000" },
    -- }
    -- duskfox = { -- a table of overrides/changes to the duskfox theme
    --   Normal = { bg = "#000000" },
    -- },
  },
  -- set vim options here (vim.<first_key>.<second_key> = value)
  options = {
    opt = {
      -- set to true or false etc.
      relativenumber = true, -- sets vim.opt.relativenumber
      number = true, -- sets vim.opt.number
      spell = false, -- sets vim.opt.spell
      signcolumn = "auto", -- sets vim.opt.signcolumn to auto
      wrap = false, -- sets vim.opt.wrap
    },
    g = {
      mapleader = " ", -- sets vim.g.mapleader
      autoformat_enabled = true, -- enable or disable auto formatting at start (lsp.formatting.format_on_save must be enabled)
      cmp_enabled = true, -- enable completion at start
      autopairs_enabled = true, -- enable autopairs at start
      diagnostics_enabled = true, -- enable diagnostics at start
      status_diagnostics_enabled = true, -- enable diagnostics in statusline
      icons_enabled = true, -- disable icons in the UI (disable if no nerd font is available, requires :PackerSync after changing)
      ui_notifications_enabled = true, -- disable notifications when toggling UI elements

      -- https://github.com/alvan/vim-closetag
      closetag_filenames = "*.html,*.html.erb",
      closetag_filetypes = "html,eruby",
    },
  },
  -- If you need more control, you can use the function()...end notation
  -- options = function(local_vim)
  --   local_vim.opt.relativenumber = true
  --   local_vim.g.mapleader = " "
  --   local_vim.opt.whichwrap = vim.opt.whichwrap - { 'b', 's' } -- removing option from list
  --   local_vim.opt.shortmess = vim.opt.shortmess + { I = true } -- add to option list
  --
  --   return local_vim
  -- end,

  -- Set dashboard header
  header = {
    " █████  ███████ ████████ ██████   ██████",
    "██   ██ ██         ██    ██   ██ ██    ██",
    "███████ ███████    ██    ██████  ██    ██",
    "██   ██      ██    ██    ██   ██ ██    ██",
    "██   ██ ███████    ██    ██   ██  ██████",
    " ",
    "    ███    ██ ██    ██ ██ ███    ███",
    "    ████   ██ ██    ██ ██ ████  ████",
    "    ██ ██  ██ ██    ██ ██ ██ ████ ██",
    "    ██  ██ ██  ██  ██  ██ ██  ██  ██",
    "    ██   ████   ████   ██ ██      ██",
  },
  -- Default theme configuration
  default_theme = {
    -- Modify the color palette for the default theme
    colors = {
      fg = "#abb2bf",
      bg = "#1e222a",
    },
    highlights = function(hl) -- or a function that returns a new table of colors to set
      local C = require("default_theme.colors")

      hl.Normal = { fg = C.fg, bg = C.bg }

      -- New approach instead of diagnostic_style
      hl.DiagnosticError.italic = true
      hl.DiagnosticHint.italic = true
      hl.DiagnosticInfo.italic = true
      hl.DiagnosticWarn.italic = true

      return hl
    end,
    -- enable or disable highlighting for extra plugins
    plugins = {
      aerial = true,
      beacon = false,
      bufferline = true,
      cmp = true,
      dashboard = true,
      highlighturl = true,
      hop = false,
      indent_blankline = true,
      lightspeed = false,
      ["neo-tree"] = true,
      notify = true,
      ["nvim-tree"] = false,
      ["nvim-web-devicons"] = true,
      rainbow = true,
      symbols_outline = false,
      telescope = true,
      treesitter = true,
      vimwiki = false,
      ["which-key"] = true, -- <space> shows a small help window
    },
  },
  -- Diagnostics configuration (for vim.diagnostics.config({...})) when diagnostics are on
  diagnostics = {
    virtual_text = true,
    underline = true,
  },
  -- Extend LSP configuration
  lsp = {
    -- enable servers that you already have installed without mason
    servers = {
      -- "pyright"
    },
    formatting = {
      -- control auto formatting on save
      format_on_save = {
        enabled = true, -- enable or disable format on save globally
        allow_filetypes = { -- enable format on save for specified filetypes only
          -- "go",
        },
        ignore_filetypes = { -- disable format on save for specified filetypes
          -- "python",
        },
      },
      disabled = { -- disable formatting capabilities for the listed language servers
        -- "sumneko_lua",
      },
      timeout_ms = 1000, -- default format timeout
      -- filter = function(client) -- fully override the default formatting function
      --   return true
      -- end
    },
    -- easily add or disable built in mappings added during LSP attaching
    mappings = {
      n = {
        -- ["<leader>lf"] = false -- disable formatting keymap
      },
    },
    -- add to the global LSP on_attach function
    -- on_attach = function(client, bufnr)
    -- end,

    -- override the mason server-registration function
    -- server_registration = function(server, opts)
    --   require("lspconfig")[server].setup(opts)
    -- end,

    -- Add overrides for LSP server settings, the keys are the name of the server
    ["server-settings"] = {
      -- example for addings schemas to yamlls
      -- yamlls = { -- override table for require("lspconfig").yamlls.setup({...})
      --   settings = {
      --     yaml = {
      --       schemas = {
      --         ["http://json.schemastore.org/github-workflow"] = ".github/workflows/*.{yml,yaml}",
      --         ["http://json.schemastore.org/github-action"] = ".github/action.{yml,yaml}",
      --         ["http://json.schemastore.org/ansible-stable-2.9"] = "roles/tasks/*.{yml,yaml}",
      --       },
      --     },
      --   },
      -- },
    },
  },
  -- Mapping data with "desc" stored directly by vim.keymap.set().
  --
  -- Please use this mappings table to set keyboard mapping since this is the
  -- lower level configuration and more robust one. (which-key will
  -- automatically pick-up stored data by this setting.)
  mappings = {
    -- first key is the mode
    n = {
      -- second key is the lefthand side of the map
      -- mappings seen under group name "Buffer"
      ["<leader>bb"] = { "<cmd>tabnew<cr>", desc = "New tab" },
      ["<leader>bc"] = { "<cmd>BufferLinePickClose<cr>", desc = "Pick to close" },
      ["<leader>bj"] = { "<cmd>BufferLinePick<cr>", desc = "Pick to jump" },
      ["<leader>bt"] = { "<cmd>BufferLineSortByTabs<cr>", desc = "Sort by tabs" },
      -- quick save
      -- ["<C-s>"] = { ":w!<cr>", desc = "Save File" },  -- change description but the same command
      ["q"] = "<Nop>", -- Disable the "recording" mode
      -- Map <Enter> in normal mode to insert a newline character and keep the cursor in normal mode
      ["<CR>"] = { ':call append(".", "")<Bar>normal! j0<CR>', noremap = true, silent = true },
      -- Yank all lines in file
      ["<leader>co"] = {
        [[:%y+<CR>:silent !echo "Yanked " . line('$') . " lines to clipboard"<CR>]],
        noremap = true,
        silent = true,
      },
      -- Highlight all file (like ctrl A)
      ["<leader>vv"] = { [[ggVG]], noremap = true, silent = true },
      -- Ctrl A + paste
      ["<leader>pp"] = { [[ggVGp]], noremap = true, silent = true },
      -- Copy current file path
      ["<leader>cd"] = { [[:let @+=expand('%')<CR>]], noremap = true, silent = true },
      -- Copy current file name with extension
      ["<leader>cf"] = { [[:let @+=expand('%:t')<CR>]], noremap = true, silent = true },
      -- Copy current file path with line number
      ["<leader>cl"] = { [[:let @+=expand('%') . ':' . line('.')<CR>]], noremap = true, silent = true },
      -- Open a file in the same dir as the open buffer
      [",e"] = { [[:e <C-R>=expand("%:h") . "/" <CR>]] },
      -- Split open a file in the same dir as the open buffer
      [",v"] = { [[:vs <C-R>=expand("%:h") . "/" <CR>]] },

      -- ["weizheheng/ror.nvim"]
      -- https://github.com/weizheheng/ror.nvim/blob/main/lua/ror/commands.lua
      ["<leader>lc"] = {
        function()
          require("ror.commands").list_commands()
        end,
        desc = "Show a list of available ror.nvim commands to run",
      },
      ["<leader>tt"] = {
        function()
          require("ror.test").run()
        end,
        desc = "Test current file",
      },
      ["<leader>nn"] = {
        function()
          require("ror.test").run("Line")
        end,
        desc = "Test current line",
      },
      ["<leader>ll"] = {
        function()
          require("ror.test").clear()
        end,
        desc = "Clear test results",
      },
      ["<leader>tm"] = {
        function()
          require("ror.test").attach_terminal()
        end,
        desc = "Toggle test terminal",
      },
    },
    t = {
      -- setting a mapping to false will disable it
      -- ["<esc>"] = false,
    },
  },
  -- Configure plugins
  plugins = {
    init = {
      -- You can disable default plugins as follows:
      -- ["goolord/alpha-nvim"] = { disable = true },

      -- You can also add new plugins here as well:
      -- Add plugins, the packer syntax without the "use"
      -- { "andweeb/presence.nvim" },
      -- {
      --   "ray-x/lsp_signature.nvim",
      --   event = "BufRead",
      --   config = function() require("lsp_signature").setup() end,
      -- },

      -- We also support a key value style plugin definition similar to NvChad:
      -- ["ray-x/lsp_signature.nvim"] = {
      --   event = "BufRead",
      --   config = function()
      --     require("lsp_signature").setup()
      --   end,
      -- },

      -- Ruby / Rails
      ["tpope/vim-rails"] = { ft = { "ruby", "eruby" } },
      ["tpope/vim-bundler"] = {},
      ["weizheheng/ror.nvim"] = {
        enabled = true,
        config = function()
          require("ror").setup({})
        end,
      },

      -- General nvim plugins
      ["kylechui/nvim-surround"] = {},
      ["wakatime/vim-wakatime"] = {
        opt = true,
        setup = function()
          table.insert(astronvim.file_plugins, "vim-wakatime")
        end,
      },
      -- Multiple cursors
      ["mg979/vim-visual-multi"] = { branch = "master" },

      ["AndrewRadev/splitjoin.vim"] = {},
      ["alvan/vim-closetag"] = {},

      ["mattn/emmet-vim"] = {},

      ["gpanders/editorconfig.nvim"] = {},
      ["RRethy/nvim-treesitter-endwise"] = { after = "nvim-treesitter" },
      ["wesleimp/stylua.nvim"] = {
        requires = {
          "nvim-lua/plenary.nvim",
        },
      },
      ["mfussenegger/nvim-lint"] = {
        config = function()
          require("lint").linters_by_ft = {
            ruby = { "ruby" },
          }
        end,
      },
      ["Pocco81/auto-save.nvim"] = {},
      -- Motions to jump anywhere real quick
      ["phaazon/hop.nvim"] = {
        branch = "v2", -- optional but strongly recommended
        config = function()
          -- you can configure Hop the way you like here; see :h hop-config
          require("hop").setup({ keys = "etovxqpdygfblzhckisuran" })
        end,
      },
    },
    -- All other entries override the require("<key>").setup({...}) call for default plugins
    ["null-ls"] = function(config) -- overrides `require("null-ls").setup(config)`
      -- config variable is the default configuration table for the setup function call
      local null_ls = require("null-ls")

      -- Check supported formatters and linters
      -- https://github.com/jose-elias-alvarez/null-ls.nvim/tree/main/lua/null-ls/builtins/formatting
      -- https://github.com/jose-elias-alvarez/null-ls.nvim/tree/main/lua/null-ls/builtins/diagnostics
      -- https://github.com/jose-elias-alvarez/null-ls.nvim/blob/main/doc/BUILTINS.md
      config.sources = {
        -- Linters
        -- Static checker for GitHub Actions workflow files
        null_ls.builtins.diagnostics.actionlint,
        -- Ruby
        -- null_ls.builtins.diagnostics.standardrb,
        -- Not sure if it works, but this will be cool
        -- null_ls.builtins.diagnostics.standardrb.with {
        -- command = "bundle",
        -- args = vim.list_extend({ "exec", "standardrb" }, null_ls.builtins.diagnostics.standardrb._opts.args),
        -- },
        -- If you use Rubocop
        null_ls.builtins.diagnostics.rubocop,
        -- Lint ERB or HTML files
        null_ls.builtins.diagnostics.erb_lint,
        null_ls.builtins.diagnostics.haml_lint,
        -- Lint JS files
        null_ls.builtins.diagnostics.eslint_d,
        -- SQL
        null_ls.builtins.diagnostics.sqlfluff,
        -- It's in the name
        null_ls.builtins.diagnostics.jsonlint,
        null_ls.builtins.diagnostics.markdownlint,
        null_ls.builtins.diagnostics.yamllint,

        -- Formatters
        -- Lua
        null_ls.builtins.formatting.stylua,
        -- Ruby
        null_ls.builtins.formatting.erb_lint,
        -- null_ls.builtins.formatting.standardrb,
        -- If you use rubocop
        null_ls.builtins.formatting.rubocop,
        -- JS
        null_ls.builtins.formatting.eslint_d,
        -- null_ls.builtins.formatting.prettier,
        -- Postgres
        null_ls.builtins.formatting.pg_format,
        -- It's in the name
        null_ls.builtins.formatting.markdownlint,
        null_ls.builtins.formatting.nginx_beautifier,

        -- null_ls.builtins.formatting.rubocop.with {
        --   command = "bundle",
        --   args = vim.list_extend({ "exec", "rubocop" }, null_ls.builtins.formatting.rubocop._opts.args),
        -- },
      }

      -- set up null-ls's on_attach function
      -- NOTE: You can remove this on attach function to disable format on save
      config.on_attach = function(client)
        if client.server_capabilities.document_formatting then
          vim.api.nvim_create_autocmd("BufWritePre", {
            desc = "Auto format before save",
            pattern = "<buffer>",
            callback = vim.lsp.buf.formatting_sync,
          })
        end
      end
      return config -- return final config table
    end,
    treesitter = { -- overrides `require("treesitter").setup(...)`
      ensure_installed = { "lua" },
      rainbow = {
        enable = false,
      },
      endwise = {
        enable = true,
      },
      highlight = {
        disable = { "ruby", "eruby" },
        -- additional_vim_regex_highlighting = true,
      },
    },
    -- use mason-lspconfig to configure LSP installations
    ["mason-lspconfig"] = { -- overrides `require("mason-lspconfig").setup(...)`
      -- ensure_installed = { "sumneko_lua" },
    },
    -- use mason-null-ls to configure Formatters/Linter installation for null-ls sources
    ["mason-null-ls"] = { -- overrides `require("mason-null-ls").setup(...)`
      -- ensure_installed = { "prettier", "stylua" },
    },
    ["neo-tree"] = {
      filesystem = {
        filtered_items = {
          visible = true,
          hide_dotfiles = false,
          hide_gitignored = true,
        },
      },
    },
  },
  -- LuaSnip Options
  luasnip = {
    -- Extend filetypes
    filetype_extend = {
      -- javascript = { "javascriptreact" },
    },
    -- Configure luasnip loaders (vscode, lua, and/or snipmate)
    vscode = {
      -- Add paths for including more VS Code style snippets in luasnip
      paths = {},
    },
  },
  -- CMP Source Priorities
  -- modify here the priorities of default cmp sources
  -- higher value == higher priority
  -- The value can also be set to a boolean for disabling default sources:
  -- false == disabled
  -- true == 1000
  cmp = {
    source_priority = {
      nvim_lsp = 1000,
      luasnip = 750,
      buffer = 500,
      path = 250,
    },
  },
  -- Modify which-key registration (Use this with mappings table in the above.)
  ["which-key"] = {
    -- Add bindings which show up as group name
    register = {
      -- first key is the mode, n == normal mode
      n = {
        -- second key is the prefix, <leader> prefixes
        ["<leader>"] = {
          -- third key is the key to bring up next level and its displayed
          -- group name in which-key top level menu
          ["b"] = { name = "Buffer" },
        },
      },
    },
  },
  -- This function is run last and is a good place to configuring
  -- augroups/autocommands and custom filetypes also this just pure lua so
  -- anything that doesn't fit in the normal config locations above can go here
  polish = function()
    -- Set key binding
    -- Set autocommands
    --
    -- vim.filetype.add {
    --   extension = {
    --     foo = "fooscript",
    --   },
    --   filename = {
    --     ["Foofile"] = "fooscript",
    --   },
    --   pattern = {
    --     ["~/%.config/foo/.*"] = "fooscript",
    --   },
    -- }
    --
    -- vim.cmd "hi! link rubyTSSymbol rubySymbol"
    -- vim.cmd "hi! link rubyTSString rubyString"

    vim.api.nvim_create_augroup("packer_conf", { clear = true })
    vim.api.nvim_create_autocmd("BufWritePost", {
      desc = "Sync packer after modifying plugins.lua",
      group = "packer_conf",
      pattern = "plugins.lua",
      command = "source <afile> | PackerSync",
    })

    vim.api.nvim_create_augroup("highlight_yank", { clear = true })
    vim.api.nvim_create_autocmd("TextYankPost", {
      desc = "Highlight line on yank",
      group = "highlight_yank",
      pattern = "*",
      callback = function()
        vim.highlight.on_yank({ higroup = "Visual", timeout = 200 })
      end,
    })

    vim.api.nvim_create_autocmd("BufWritePost", {
      callback = function()
        require("lint").try_lint()
      end,
    })

    -- Set up custom filetypes
    vim.filetype.add({
      extension = {
        jbuilder = "ruby",
        ["html.erb"] = "eruby",
      },
      filename = {
        ["Gemfile.lock"] = "ruby",
        ["Capfile"] = "ruby",
        ["Guardfile"] = "ruby",
        ["Vagrantfile"] = "ruby",
      },
    })
  end,
}

return config