feat: initial push with a fully separated and organized user configuration for AstroNvim v3

Author: mehalter

.stylua.toml

@@ -0,0 +1,7 @@
+column_width = 120
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 2
+quote_style = "AutoPreferDouble"
+call_parentheses = "None"
+collapse_simple_statement = "Always"

astronvim_theme/colors.lua

@@ -0,0 +1,5 @@
+-- Modify the color palette for the default theme
+return {
+  fg = "#abb2bf",
+  bg = "#1e222a",
+}

astronvim_theme/highlights.lua

@@ -0,0 +1,11 @@
+local C = require "astronvim_theme.colors"
+-- modify the astronvim colors of the astronvim colorscheme directly when it's created
+return {
+  Normal = { fg = C.fg, bg = C.bg },
+
+  -- customize styles of highlight groups
+  -- DiagnosticError = { italic = true },
+  -- DiagnosticHint = { italic = true },
+  -- DiagnosticInfo = { italic = true },
+  -- DiagnosticWarn = { italic = true },
+}

astronvim_theme/plugins.lua

@@ -0,0 +1,22 @@
+-- enable or disable highlighting for extra plugins in the astronvim theme
+return {
+  aerial = true,
+  beacon = false,
+  bufferline = false,
+  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,
+}

colorscheme.lua

@@ -0,0 +1,2 @@
+-- Set colorscheme to use
+return "astronvim"

diagnostics.lua

@@ -0,0 +1,5 @@
+-- Diagnostics configuration (for vim.diagnostics.config({...})) when diagnostics are on
+return {
+  virtual_text = true,
+  underline = true,
+}

heirline/attributes.lua

@@ -0,0 +1,5 @@
+-- Customize attributes of highlighting in Heirline components
+return {
+  -- styling choices for each heirline element, check possible attributes with `:h attr-list`
+  git_branch = { bold = true }, -- bold the git branch statusline component
+}

heirline/colors.lua

@@ -0,0 +1,5 @@
+-- Customize colors for each element each element has a `_fg` and a `_bg`
+return function(colors)
+  colors.git_branch_fg = astronvim.get_hlgroup "Conditional"
+  return colors
+end

heirline/icon_highlights.lua

@@ -0,0 +1,9 @@
+-- Customize if icons should be highlighted
+return {
+  breadcrumbs = false, -- LSP symbols in the breadcrumbs
+  file_icon = {
+    winbar = false, -- Filetype icon in the winbar inactive windows
+    statusline = true, -- Filetype icon in the statusline
+    tabline = true, -- Filetype icon in the tabline
+  },
+}

heirline/separators.lua

@@ -0,0 +1,5 @@
+-- Customize different separators between sections
+return {
+  breadcrumbs = " > ",
+  tab = { "", "" },
+}

highlights/duskfox.lua

@@ -0,0 +1,3 @@
+return { -- a table of overrides/changes to the duskfox theme
+  Normal = { bg = "#000000" },
+}

highlights/init.lua

@@ -0,0 +1,3 @@
+return { -- this table overrides highlights in all themes
+  -- Normal = { bg = "#000000" },
+}

lazy.lua

@@ -0,0 +1,10 @@
+-- Configure require("lazy").setup() options
+return {
+  defaults = { lazy = true },
+  performance = {
+    rtp = {
+      -- customize default disabled vim plugins
+      disabled_plugins = { "tohtml", "gzip", "matchit", "zipPlugin", "netrwPlugin", "tarPlugin", "matchparen" },
+    },
+  },
+}

lsp/config/yamlls.lua

@@ -0,0 +1,12 @@
+-- example for addings schemas to yamlls
+return { -- 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}",
+      },
+    },
+  },
+}

lsp/formatting.lua

@@ -0,0 +1,20 @@
+-- customize lsp formatting options
+return {
+  -- 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
+}

lsp/mappings.lua

@@ -0,0 +1,6 @@
+-- easily add or disable built in mappings added during LSP attaching
+return {
+  n = {
+    -- ["<leader>lf"] = false -- disable formatting keymap
+  },
+}

lsp/mason.lua

@@ -0,0 +1,26 @@
+-- customize mason plugins
+return {
+  -- use mason-lspconfig to configure LSP installations
+  {
+    "williamboman/mason-lspconfig.nvim",
+    -- overrides `require("mason-lspconfig").setup(...)`
+    opts = {
+      -- ensure_installed = { "sumneko_lua" },
+    },
+  },
+  -- use mason-null-ls to configure Formatters/Linter installation for null-ls sources
+  {
+    "jay-babu/mason-null-ls.nvim",
+    -- overrides `require("mason-null-ls").setup(...)`
+    opts = {
+      -- ensure_installed = { "prettier", "stylua" },
+    },
+  },
+  {
+    "jay-babu/mason-nvim-dap.nvim",
+    -- overrides `require("mason-nvim-dap").setup(...)`
+    opts = {
+      -- ensure_installed = { "python" },
+    },
+  },
+}

lsp/servers.lua

@@ -0,0 +1,4 @@
+-- enable servers that you already have installed without mason
+return {
+  -- "pyright"
+}

lsp/setup_handlers.lua

@@ -0,0 +1,10 @@
+-- override the LSP setup handler function based on server name
+return {
+  -- first function changes the default setup handler
+  function(server, opts) require("lspconfig")[server].setup(opts) end,
+  -- keys for a specific server name will be used for that LSP
+  sumneko_lua = function(server, opts)
+    -- custom sumneko_lua setup handler
+    require("lspconfig")["sumneko_lua"].setup(opts)
+  end,
+}

mappings.lua

@@ -0,0 +1,25 @@
+-- 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.)
+return {
+  -- 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" },
+    -- tables with the `name` key will be registered with which-key if it's installed
+    -- this is useful for naming menus
+    ["<leader>b"] = { name = "Buffers" },
+    -- quick save
+    -- ["<C-s>"] = { ":w!<cr>", desc = "Save File" },  -- change description but the same command
+  },
+  t = {
+    -- setting a mapping to false will disable it
+    -- ["<esc>"] = false,
+  },
+}

options.lua

@@ -0,0 +1,21 @@
+-- set vim options here (vim.<first_key>.<second_key> = value)
+return {
+  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
+  },
+}

plugins/alpha.lua

@@ -0,0 +1,21 @@
+-- customize alpha options
+return {
+  "goolord/alpha-nvim",
+  opts = function(_, opts)
+    -- customize the dashboard header
+    opts.section.header.val = {
+      " █████  ███████ ████████ ██████   ██████",
+      "██   ██ ██         ██    ██   ██ ██    ██",
+      "███████ ███████    ██    ██████  ██    ██",
+      "██   ██      ██    ██    ██   ██ ██    ██",
+      "██   ██ ███████    ██    ██   ██  ██████",
+      " ",
+      "    ███    ██ ██    ██ ██ ███    ███",
+      "    ████   ██ ██    ██ ██ ████  ████",
+      "    ██ ██  ██ ██    ██ ██ ██ ████ ██",
+      "    ██  ██ ██  ██  ██  ██ ██  ██  ██",
+      "    ██   ████   ████   ██ ██      ██",
+    }
+    return opts
+  end,
+}

plugins/core.lua

@@ -0,0 +1,56 @@
+return {
+  -- You can disable default plugins as follows:
+  -- { "max397574/better-escape.nvim", enabled = false },
+  --
+  -- You can also easily customize additional setup of plugins that is outside of the plugin's setup call
+  -- {
+  --   "L3MON4D3/LuaSnip",
+  --   config = function(plugin, opts)
+  --     plugin.default_config(opts) -- include the default astronvim config that calls the setup call
+  --     -- add more custom luasnip configuration such as filetype extend or custom snippets
+  --     local luasnip = require "luasnip"
+  --     luasnip.filetype_extend("javascript", { "javascriptreact" })
+  --   end,
+  -- },
+  -- {
+  --   "windwp/nvim-autopairs",
+  --   config = function(plugin, opts)
+  --     plugin.default_config(opts) -- include the default astronvim config that calls the setup call
+  --     -- add more custom autopairs configuration such as custom rules
+  --     local npairs = require "nvim-autopairs"
+  --     local Rule = require "nvim-autopairs.rule"
+  --     local cond = require "nvim-autopairs.conds"
+  --     npairs.add_rules(
+  --       {
+  --         Rule("$", "$", { "tex", "latex" })
+  --           -- don't add a pair if the next character is %
+  --           :with_pair(cond.not_after_regex "%%")
+  --           -- don't add a pair if  the previous character is xxx
+  --           :with_pair(
+  --             cond.not_before_regex("xxx", 3)
+  --           )
+  --           -- don't move right when repeat character
+  --           :with_move(cond.none())
+  --           -- don't delete if the next character is xx
+  --           :with_del(cond.not_after_regex "xx")
+  --           -- disable adding a newline when you press <cr>
+  --           :with_cr(cond.none()),
+  --       },
+  --       -- disable for .vim files, but it work for another filetypes
+  --       Rule("a", "a", "-vim")
+  --     )
+  --   end,
+  -- },
+  -- By adding to the which-key config and using our helper function you can add more which-key registered bindings
+  -- {
+  --   "folke/which-key.nvim",
+  --   config = function(plugin, opts)
+  --     plugin.default_config(opts)
+  --     -- Add bindings which show up as group name
+  --     local wk = require "which-key"
+  --     wk.register({
+  --       b = { name = "Buffer" },
+  --     }, { mode = "n", prefix = "<leader>" })
+  --   end,
+  -- },
+}

plugins/null-ls.lua

@@ -0,0 +1,17 @@
+return {
+  "jose-elias-alvarez/null-ls.nvim",
+  opts = function(_, 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
+    config.sources = {
+      -- Set a formatter
+      -- null_ls.builtins.formatting.stylua,
+      -- null_ls.builtins.formatting.prettier,
+    }
+    return config -- return final config table
+  end,
+}

plugins/treesitter.lua

@@ -0,0 +1,6 @@
+return {
+  "nvim-treesitter/nvim-treesitter",
+  opts = {
+    -- ensure_installed = { "lua" },
+  },
+}

plugins/user.lua

@@ -0,0 +1,12 @@
+return {
+  -- You can also add new plugins here as well:
+  -- Add plugins, the lazy syntax
+  -- "andweeb/presence.nvim",
+  -- {
+  --   "ray-x/lsp_signature.nvim",
+  --   event = "BufRead",
+  --   config = function()
+  --     require("lsp_signature").setup()
+  --   end,
+  -- },
+}

polish.lua

@@ -0,0 +1,17 @@
+-- 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
+return function()
+  -- Set up custom filetypes
+  -- vim.filetype.add {
+  --   extension = {
+  --     foo = "fooscript",
+  --   },
+  --   filename = {
+  --     ["Foofile"] = "fooscript",
+  --   },
+  --   pattern = {
+  --     ["~/%.config/foo/.*"] = "fooscript",
+  --   },
+  -- }
+end

updater.lua

@@ -0,0 +1,17 @@
+-- Configure AstroNvim updates
+return {
+  remote = "origin", -- remote to use
+  channel = "stable", -- "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_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
+  -- },
+}