From 0416b67e15858c3b8a591def4f47fca572adbe24 Mon Sep 17 00:00:00 2001 From: Micah Halter Date: Fri, 10 Mar 2023 08:17:27 -0500 Subject: [PATCH] chore: add single file user configuration example --- .github/README.md | 36 +++++ .stylua.toml | 7 + init.lua | 374 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 417 insertions(+) create mode 100644 .github/README.md create mode 100644 .stylua.toml create mode 100644 init.lua diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..e6c589a --- /dev/null +++ b/.github/README.md @@ -0,0 +1,36 @@ +# AstroNvim User Configuration Example + +A user configuration template for [AstroNvim](https://github.com/AstroNvim/AstroNvim) + +## 🛠️ Installation + +#### Make a backup of your current nvim and shared folder + +```shell +mv ~/.config/nvim ~/.config/nvim.bak +mv ~/.local/share/nvim ~/.local/share/nvim.bak +``` + +#### Clone AstroNvim + +```shell +git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim +``` + +#### Create a new user repository from this template + +Press the "Use this template" button above to create a new repository to store your user configuration. + +You can also just clone this repository directly if you do not want to track your user configuration in GitHub. + +#### Clone the repository + +```shell +git clone https://github.com// ~/.config/nvim/lua/user +``` + +#### Start Neovim + +```shell +nvim +``` diff --git a/.stylua.toml b/.stylua.toml new file mode 100644 index 0000000..bfcffff --- /dev/null +++ b/.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" diff --git a/init.lua b/init.lua new file mode 100644 index 0000000..a0603d0 --- /dev/null +++ b/init.lua @@ -0,0 +1,374 @@ +-- 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 = "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 + -- }, + }, + + -- Set colorscheme to use + colorscheme = "astrodark", + + -- 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.. = 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_mode = 3, -- set the visibility of diagnostics in the UI (0=off, 1=only show in status line, 2=virtual text off, 3=all on) + 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 + }, + }, + -- 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, + + -- Diagnostics configuration (for vim.diagnostics.config({...})) when diagnostics are on + diagnostics = { + 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 + -- "lua_ls", + }, + 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 = { + -- ["lf"] = false -- disable formatting keymap + }, + }, + -- add to the global LSP on_attach function + -- on_attach = function(client, bufnr) + -- end, + + -- override the LSP setup handler function based on server name + -- setup_handlers = { + -- -- 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 + -- lua_ls = function(server, opts) + -- -- custom lua_ls setup handler + -- require("lspconfig")["lua_ls"].setup(opts) + -- end, + -- }, + + -- Add overrides for LSP server settings, the keys are the name of the server + config = { + -- 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" + ["bb"] = { "tabnew", desc = "New tab" }, + ["bc"] = { "BufferLinePickClose", desc = "Pick to close" }, + ["bj"] = { "BufferLinePick", desc = "Pick to jump" }, + ["bt"] = { "BufferLineSortByTabs", 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 + ["b"] = { name = "Buffers" }, + -- quick save + -- [""] = { ":w!", desc = "Save File" }, -- change description but the same command + }, + t = { + -- setting a mapping to false will disable it + -- [""] = false, + }, + }, + + -- Configure require("lazy").setup() options + lazy = { + defaults = { lazy = true }, + performance = { + rtp = { + -- customize default disabled vim plugins + disabled_plugins = { + "tohtml", + "gzip", + "matchit", + "zipPlugin", + "netrwPlugin", + "tarPlugin", + "matchparen", + }, + }, + }, + }, + + -- Configure plugins + plugins = { + -- 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) + -- require "plugins.configs.luasnip"(plugin, 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) + -- require "plugins.configs.nvim-autopairs"(plugin, 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 + -- :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) + -- require "plugins.configs.which-key"(plugin, opts) + -- -- Add bindings which show up as group name + -- local wk = require "which-key" + -- wk.register({ + -- b = { name = "Buffer" }, + -- }, { mode = "n", prefix = "" }) + -- end, + -- }, + + -- 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, + -- }, + + -- Plugin entries can also be used to override the default options for plugins as well + { + "goolord/alpha-nvim", + opts = function(_, opts) + -- customize the dashboard header + opts.section.header.val = { + " █████ ███████ ████████ ██████ ██████", + "██ ██ ██ ██ ██ ██ ██ ██", + "███████ ███████ ██ ██████ ██ ██", + "██ ██ ██ ██ ██ ██ ██ ██", + "██ ██ ███████ ██ ██ ██ ██████", + " ", + " ███  ██ ██  ██ ██ ███  ███", + " ████  ██ ██  ██ ██ ████  ████", + " ██ ██  ██ ██  ██ ██ ██ ████ ██", + " ██  ██ ██  ██  ██  ██ ██  ██  ██", + " ██   ████   ████   ██ ██      ██", + } + return opts + end, + }, + { + "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, + }, + { + "nvim-treesitter/nvim-treesitter", + opts = { + -- ensure_installed = { "lua" }, + }, + }, + -- use mason-lspconfig to configure LSP installations + { + "williamboman/mason-lspconfig.nvim", + -- overrides `require("mason-lspconfig").setup(...)` + opts = { + -- ensure_installed = { "lua_ls" }, + }, + }, + -- 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" }, + }, + }, + -- Add the community repository of plugin specifications + "AstroNvim/astrocommunity", + -- example of imporing a plugin, comment out to use it or add your own + -- available plugins can be found at https://github.com/AstroNvim/astrocommunity + + -- { import = "astrocommunity.colorscheme.catppuccin" }, + -- { import = "astrocommunity.completion.copilot-lua-cmp" }, + }, + + -- Customize Heirline options + heirline = { + -- -- Customize different separators between sections + -- separators = { + -- breadcrumbs = " > ", + -- tab = { "", "" }, + -- }, + -- -- Customize colors for each element each element has a `_fg` and a `_bg` + -- colors = function(colors) + -- colors.git_branch_fg = require("astronvim.utils").get_hlgroup "Conditional" + -- return colors + -- end, + -- -- Customize attributes of highlighting in Heirline components + -- attributes = { + -- -- styling choices for each heirline element, check possible attributes with `:h attr-list` + -- git_branch = { bold = true }, -- bold the git branch statusline component + -- }, + -- -- Customize if icons should be highlighted + -- icon_highlights = { + -- 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 + -- }, + -- }, + }, + + -- 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 up custom filetypes + -- vim.filetype.add { + -- extension = { + -- foo = "fooscript", + -- }, + -- filename = { + -- ["Foofile"] = "fooscript", + -- }, + -- pattern = { + -- ["~/%.config/foo/.*"] = "fooscript", + -- }, + -- } + end, +} + +return config