Compare commits
24 Commits
fc34e7ffb9
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 1e761356fe | |||
| c777ce8d74 | |||
| 3eb2ce870d | |||
| 286c9c8953 | |||
| ccf1054eee | |||
| 5e8c8e7af2 | |||
| d43365ca73 | |||
| ed557e6819 | |||
| 627027dd8a | |||
| 85c5782bc3 | |||
| f03d942a91 | |||
| af683e7c4e | |||
| 69bcb280b3 | |||
| 9c64b69498 | |||
| 7cd84ab8d3 | |||
| ccca420391 | |||
| b506c69df8 | |||
| 056e677599 | |||
| 5f0eabf629 | |||
| 3adc822ccf | |||
| a7a6e907ec | |||
| 9b20b6703e | |||
| fe6230225e | |||
| 7a4be838d4 |
34
README.md
34
README.md
@@ -1,6 +1,6 @@
|
||||
# Mzansi Vim: The No-Fuss Neovim Kickstart 🇿🇦
|
||||
|
||||
<img src='assets/demo.png' height='300' alt='MzansiVim Dashboard'>
|
||||
<img src='assets/MzansiVim.png' height='300' alt='MzansiVim Dashboard'>
|
||||
|
||||
A pre-configured, performance-oriented Neovim setup designed to get you from zero to coding in minutes. Built for local developers who want a powerful IDE experience without the manual overhead of a 500-line `init.lua`.
|
||||
|
||||
@@ -18,19 +18,7 @@ A pre-configured, performance-oriented Neovim setup designed to get you from zer
|
||||
|
||||
The **Leader Key** is set to `Space`.
|
||||
|
||||
**Note:** Dashboard keybindings are active only on the startup screen and do not require the leader key prefix.
|
||||
|
||||
### Dashboard
|
||||
| Action | Keybinding | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **File Explorer** | `cd` | Open Netrw directly from the dashboard. |
|
||||
| **Find Files** | `ff` | Fuzzy find files via Telescope. |
|
||||
| **Live Grep** | `fg` | Search across all files via Telescope. |
|
||||
| **Harpoon Menu** | `e` | Open the Harpoon quick menu. |
|
||||
| **Harpoon Search** | `fl` | Search Harpoon marks via Telescope. |
|
||||
| **Lazy Manager** | `z` | Open the Lazy plugin manager. |
|
||||
| **Help Tags** | `fh` | Search Neovim help tags via Telescope. |
|
||||
| **Quit** | `q` | Quit Neovim. |
|
||||
**Note:** Dashboard keybindings are active only on the dashboard screen and do not require the leader key prefix.
|
||||
|
||||
### Dashboard
|
||||
| Action | Keybinding | Description |
|
||||
@@ -48,6 +36,7 @@ The **Leader Key** is set to `Space`.
|
||||
### Navigation & Searching
|
||||
| Action | Keybinding | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **Dashboard** | `<leader>;` | Open the MzansiVim Dasboard. |
|
||||
| **File Explorer** | `<leader>cd` | Open the built-in Netrw explorer. |
|
||||
| **Find Files** | `<leader>ff` | Fuzzy find files in your project. |
|
||||
| **Live Grep** | `<leader>fg` | Search for specific text across all files. |
|
||||
@@ -67,7 +56,7 @@ The **Leader Key** is set to `Space`.
|
||||
| **Hover Docs** | `K` | Display documentation for the symbol under cursor. |
|
||||
| **Go to Definition**| `gd` | Jump to the source code of a function/variable. |
|
||||
| **Code Actions** | `<leader>ca` | Show available fixes or refactors. |
|
||||
| **Align File** | `<leader>rn` | Auto align file. |
|
||||
| **Align File** | `<leader>af` | Auto align file. |
|
||||
| **References** | `gr` | List all places where a symbol is used. |
|
||||
| **Rename** | `<leader>rn` | Rename all occurrences of the symbol. |
|
||||
|
||||
@@ -77,8 +66,8 @@ The **Leader Key** is set to `Space`.
|
||||
| **Show Error** | `<leader>e` | Open a floating window with the full error under cursor. |
|
||||
| **Next Error** | `]d` | Jump to the next diagnostic in the file. |
|
||||
| **Previous Error** | `[d` | Jump to the previous diagnostic in the file. |
|
||||
| **Quickfix List** | `<leader>q` | Load all diagnostics into the quickfix list. |
|
||||
| **Close Quickfix** | `:q <Enter>` | Close the quickfix window. |
|
||||
| **Error List** | `<leader>el` | Load all diagnostics into the quickfix list. |
|
||||
| **Close Quickfix** | `:q <Enter>` | Close the quickfix window while active. |
|
||||
|
||||
### Window Management
|
||||
| Action | Keybinding | Description |
|
||||
@@ -107,9 +96,9 @@ To ensure all plugins (LSP, Tree-sitter, and Telescope) function correctly, plea
|
||||
|
||||
* **Neovim** (v0.10+ recommended)
|
||||
* **Git** (For cloning the repo and managing plugins)
|
||||
* **Tree-sitter & Tree-sitter-cli** (For syntax highlighting)
|
||||
* **Tree-sitter-cli** (For syntax highlighting)
|
||||
* **Ripgrep** (Required for Telescope live grep)
|
||||
* **Node.js & npm** (Required for various LSP servers like `html` and `eslint`)
|
||||
* **Node & NPM** (Required for various LSP servers like `html` and `eslint`)
|
||||
* **Go** (Required for certain internal tools)
|
||||
|
||||
For the best results, we recommend you install and use the Ghostty terminal with the following configuration:
|
||||
@@ -129,13 +118,14 @@ Depending on whether you have an existing setup, follow the appropriate step bel
|
||||
**For a Fresh Install:**
|
||||
If you have never configured Neovim, create the configuration folder:
|
||||
```bash
|
||||
mkdir -p ~/.config/nvim
|
||||
mkdir ~/.config/nvim
|
||||
```
|
||||
|
||||
**For an Existing Setup:**
|
||||
If you have never configured Neovim, create the configuration folder:
|
||||
If you have configured Neovim already, create a backup folder:
|
||||
```bash
|
||||
mv ~/.config/nvim ~/.config/nvim.bak
|
||||
mkdir ~/.config/nvim
|
||||
```
|
||||
|
||||
#### 2. Clone the Repository
|
||||
@@ -143,7 +133,7 @@ Clone the Mzansi Vim configuration into your config folder:
|
||||
|
||||
```bash
|
||||
cd ~/.config/nvim
|
||||
git clone https://git.mzansi-innovation-hub.co.za/yaso_meth/mzansi_vim.git
|
||||
git clone https://git.mzansi-innovation-hub.co.za/yaso_meth/mzansi_vim.git .
|
||||
```
|
||||
|
||||
#### 3. Initialize
|
||||
|
||||
BIN
assets/.DS_Store
vendored
Normal file
BIN
assets/.DS_Store
vendored
Normal file
Binary file not shown.
BIN
assets/MzansiVim.png
Normal file
BIN
assets/MzansiVim.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 786 KiB |
BIN
assets/demo.png
BIN
assets/demo.png
Binary file not shown.
|
Before Width: | Height: | Size: 682 KiB |
@@ -11,11 +11,13 @@
|
||||
"harpoon": { "branch": "harpoon2", "commit": "87b1a3506211538f460786c23f98ec63ad9af4e5" },
|
||||
"lazy.nvim": { "branch": "main", "commit": "306a05526ada86a7b30af95c5cc81ffba93fef97" },
|
||||
"lualine.nvim": { "branch": "master", "commit": "47f91c416daef12db467145e16bed5bbfe00add8" },
|
||||
"mason-lspconfig.nvim": { "branch": "main", "commit": "a676ab7282da8d651e175118bcf54483ca11e46d" },
|
||||
"mason-lspconfig.nvim": { "branch": "main", "commit": "a979821a975897b88493843301950c456a725982" },
|
||||
"mason.nvim": { "branch": "main", "commit": "44d1e90e1f66e077268191e3ee9d2ac97cc18e65" },
|
||||
"mini.ai": { "branch": "main", "commit": "bfb26d9072670c3aaefab0f53024b2f3729c8083" },
|
||||
"nvim-autopairs": { "branch": "master", "commit": "59bce2eef357189c3305e25bc6dd2d138c1683f5" },
|
||||
"nvim-cmp": { "branch": "main", "commit": "da88697d7f45d16852c6b2769dc52387d1ddc45f" },
|
||||
"nvim-lspconfig": { "branch": "master", "commit": "dc2f86d2b66a6e01a98c37cdadd3be3e90f8ab9a" },
|
||||
"nvim-treesitter": { "branch": "main", "commit": "2cc172c28e5550e00e6beead4599b1469469c1c7" },
|
||||
"nvim-lspconfig": { "branch": "master", "commit": "841c6d4139aedb8a3f2baf30cef5327371385b93" },
|
||||
"nvim-treesitter": { "branch": "main", "commit": "53f6ce29df5841ce26e5a9f06fb371088b8d8031" },
|
||||
"nvim-web-devicons": { "branch": "master", "commit": "d7462543c9e366c0d196c7f67a945eaaf5d99414" },
|
||||
"plenary.nvim": { "branch": "master", "commit": "b9fd5226c2f76c951fc8ed5923d85e4de065e509" },
|
||||
"telescope-fzf-native.nvim": { "branch": "main", "commit": "6fea601bd2b694c6f2ae08a6c6fab14930c60e2c" },
|
||||
|
||||
@@ -11,7 +11,7 @@ return {
|
||||
╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═══╝╚══════╝╚═╝ ╚═══╝ ╚═╝╚═╝ ╚═╝
|
||||
]]
|
||||
|
||||
logo = string.rep("\n", 8) .. logo .. "\n\n"
|
||||
logo = string.rep("\n", 3) .. logo .. "\n\n"
|
||||
|
||||
local opts = {
|
||||
theme = "doom",
|
||||
@@ -22,13 +22,18 @@ return {
|
||||
{ icon = " ", desc = " File Explorer ", key = "cd", action = "Explore" },
|
||||
{ icon = " ", desc = " Find Files ", key = "ff", action = "Telescope find_files" },
|
||||
{ icon = " ", desc = " Live Grep ", key = "fg", action = "Telescope live_grep" },
|
||||
{ icon = " ", desc = " Harpoon Menu ", key = "e", action = function()
|
||||
{
|
||||
icon = " ",
|
||||
desc = " Harpoon Menu ",
|
||||
key = "e",
|
||||
action = function()
|
||||
local harpoon = require("harpoon")
|
||||
harpoon.ui:toggle_quick_menu(harpoon:list())
|
||||
end},
|
||||
end
|
||||
},
|
||||
{ icon = " ", desc = " Harpoon Search ", key = "fl", action = "Telescope harpoon marks" },
|
||||
{ icon = " ", desc = " Lazy Manager ", key = "z", action = "Lazy" },
|
||||
{ icon = " ", desc = " Help Tags ", key = "fh", action = "Telescope help_tags" },
|
||||
{ icon = " ", desc = " Help Tags ", key = "fh", action = "Telescope help_tags" },
|
||||
{ icon = " ", desc = " Quit ", key = "q", action = "qa" },
|
||||
},
|
||||
-- footer = { vim.fn.strftime("%Y-%m-%d %H:%M:%S") .. " • Mzansi Vim Kickstart" },
|
||||
|
||||
@@ -75,7 +75,7 @@ return {
|
||||
vim.keymap.set("n", "<leader>e", vim.diagnostic.open_float, opts) -- show error under cursor
|
||||
vim.keymap.set("n", "[d", vim.diagnostic.goto_prev, opts) -- jump to previous error
|
||||
vim.keymap.set("n", "]d", vim.diagnostic.goto_next, opts) -- jump to next error
|
||||
vim.keymap.set("n", "<leader>q", vim.diagnostic.setloclist, opts) -- all errors in quickfix list
|
||||
vim.keymap.set("n", "<leader>el", vim.diagnostic.setloclist, opts) -- all errors in quickfix list
|
||||
vim.keymap.set("n", "<leader>af", vim.lsp.buf.format, { desc = "Format file" }) -- manual format
|
||||
|
||||
-- Format on save
|
||||
@@ -132,6 +132,13 @@ return {
|
||||
["<C-f>"] = cmp.mapping.scroll_docs(4),
|
||||
["<C-Space>"] = cmp.mapping.complete(),
|
||||
["<CR>"] = cmp.mapping.confirm({ select = true }),
|
||||
["<Tab>"] = cmp.mapping(function(fallback) -- add this
|
||||
if cmp.visible() then
|
||||
cmp.confirm({ select = true })
|
||||
else
|
||||
fallback()
|
||||
end
|
||||
end, { "i", "s" }),
|
||||
}),
|
||||
sources = cmp.config.sources({
|
||||
{ name = "nvim_lsp" },
|
||||
|
||||
9
lua/plugins/mini-ai.lua
Normal file
9
lua/plugins/mini-ai.lua
Normal file
@@ -0,0 +1,9 @@
|
||||
return {
|
||||
"echasnovski/mini.ai",
|
||||
version = "*",
|
||||
config = function()
|
||||
require("mini.ai").setup({
|
||||
search_method = "next",
|
||||
})
|
||||
end,
|
||||
}
|
||||
@@ -11,4 +11,10 @@ return {
|
||||
vim.keymap.set("v", "<C-/>", "gc", { remap = true, desc = "Toggle comment" })
|
||||
end,
|
||||
},
|
||||
{
|
||||
'windwp/nvim-autopairs',
|
||||
event = "InsertEnter",
|
||||
config = true
|
||||
},
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user