Skip to content

Commit da685b4

Browse files
mhamza15dam9000pjaglomvneogi199rnevius
authored
Modular master (#2)
* Added lua/lazy-bootstrap.lua * Added lua/lazy-plugins.lua * Added lua/options.lua * Added lua/keymaps.lua * Added lua/telescope-setup.lua * Added lua/treesitter-setup.lua * Added lua/lsp-setup.lua * Added lua/cmp-setup.lua * Update README.md - remove single-file * Update README.md - kickstart-modular fork * init.lua: update section comments to match upstream * Run stylua on init.lua * Minor changes to README to reflect the modular repo (nvim-lua#3) * Update README to reflect modular organization - Change install links to this repo instead of nvim-lua/kickstart.nvim - Change “Recommended Steps” repo link to reflect kickstart-modular.nvim.git - Change FAQ re: multiple files to reflect that we are in the modular repo, not the single file repo. * README.md: removed some trailing spaces * fix: incorrect reference to init.lua in README.md * README.md: minor update to the modular fork note * chore(docs): Update README.md (nvim-lua#1344) Neovim has renamed the "linux64" binary to "linux-x86_64". * docs: clarify using opts = {} vs config = function() ... require('plu… (nvim-lua#1316) * docs: clarify using opts = {} vs config = function() ... require('plugin').setup({}) .. end The current documentation mentioning that using "require" is equivalent to using "opts" without detailing the use in the "config = function()" block seems inaccurate. Lower in the configuration the "config = function()" block is used without clarifying why it needed and what it does. This clarification may help new users understand the difference between the two, or how and where to place the "require" statement. * Update init.lua * remove whitespace * fix (nvim-lua#1319): gitsigns deprecated functions (nvim-lua#1321) - This commit change two functions that are marked as deprecated now: `gitsigns.stage_hunk` and `gitsigns.toggle_deleted` * Add a blurb about installing missing emoji on Ubuntu Right next to the nerdfonts blurb as requested. * fix: arguments for the `vim.lsp.Client.supports_method` method (nvim-lua#1356) * feat(diagnostic): add diagnostic config (nvim-lua#1335) Co-authored-by: gelocraft <[email protected]> * perf: load tokyonight.nvim in the intended way (nvim-lua#1360) Fixes nvim-lua#1357 * feat: add basic function signature help (nvim-lua#1358) * feat: add basic function signature help * Update init.lua Co-authored-by: makeworld <[email protected]> --------- Co-authored-by: makeworld <[email protected]> * Fix: fix the cmp-nvim-lsp-signature-help link (nvim-lua#1363) * fix: regression introduced in db78c0b (nvim-lua#1367) * Remove duplicate cmp-path (nvim-lua#1369) * Propsed fix for init.lua warnings as per nvim-lua#1305 (comment) (nvim-lua#1354) * feat: add `vim.opt.confirm = true` (nvim-lua#1384) * fix: use correct github abmonition syntax (nvim-lua#1414) * changed Conform's format_on_save lambda so that buffers that match disable_filetypes return nil. This allows you to enable a formatter for langages in the disable_filetypes table to have a formatter that can be run manually with Leader-f but doesnt enable format_on_save for them (nvim-lua#1395) * feat(keymap): move windows without `<C-w>` (nvim-lua#1368) * fix: minor misspellings (nvim-lua#1450) * fix: minor misspellings * revert change for `-Bbuild` * Change LSP Keybindings to Match the Default `gr` Bindings Introduced in Neovim 0.11 (nvim-lua#1427) * refactor: change LSP keybindings to the default gr bindings introduced in 0.11 * refactor: modify existing LSP functions to follow convention * Remove Telescope `0.1` branch lock (nvim-lua#1448) * feat: switch nvim-cmp for blink.cmp (nvim-lua#1426) * remove cmp.lua which was replaced with blink-cmp.lua * Change to Mason's new address (nvim-lua#1516) * feat: switch vim-sleuth for guess-indent.nvim (nvim-lua#1512) * Replace vim.opt with vim.o (nvim-lua#1495) * Replace vim.opt with vim.o Because it offers a nicer interface and info on hover. For now leave vim.opt when using the table interface (until vim.o with tables is implemented) * Add type hint for vim.opt.rtp * Add a comment about using vim.opt instead of vim.o * don't lazy-load neo-tree so netrw hijacking on startup works (nvim-lua#1489) * README: mention fd-find in requirements (nvim-lua#1477) Fixes nvim-lua#1476 * fix: rename vim.highlight.on_yank to vim.hl.on_yank (nvim-lua#1482) The functions of vim.highlight were renamed to vim.hl on commit 18b43c331d8a0ed87d7cbefe2a18543b8e4ad360 of neovim, which was applied with the release of nvim version 0.11. Now, the use of vim.highlight is deprecated, and instead, one should use vim.hl functions. In practice, vim.highlight is still working, however, asking for help for vim.highlight.on_yank fails (E149), while asking for help for vim.hl.on_yank works as expected. So, by updating the used function, a new user will have easier time looking getting the relevant help. Co-authored-by: Omri Sarig <[email protected]> * Update windows installation command * remove conflicting stuff * more changes * more --------- Co-authored-by: Damjan 9000 <[email protected]> Co-authored-by: Peter S. Jaglom <[email protected]> Co-authored-by: Vinit Neogi <[email protected]> Co-authored-by: Ryan Nevius <[email protected]> Co-authored-by: bleacheda <[email protected]> Co-authored-by: Erlan Rangel <[email protected]> Co-authored-by: Chris Patti <[email protected]> Co-authored-by: Jonas Zeltner <[email protected]> Co-authored-by: GeloCraft <[email protected]> Co-authored-by: gelocraft <[email protected]> Co-authored-by: Joaquín Guerra <[email protected]> Co-authored-by: Rob <[email protected]> Co-authored-by: makeworld <[email protected]> Co-authored-by: Aryan Rajoria <[email protected]> Co-authored-by: Ari Pollak <[email protected]> Co-authored-by: Crypto-Spartan <[email protected]> Co-authored-by: Luca Saccarola <[email protected]> Co-authored-by: RulentWave <[email protected]> Co-authored-by: Sander <[email protected]> Co-authored-by: dasvh <[email protected]> Co-authored-by: Theo P. <[email protected]> Co-authored-by: Dmytro Onypko <[email protected]> Co-authored-by: Liam Dyer <[email protected]> Co-authored-by: guru245 <[email protected]> Co-authored-by: Ori Perry <[email protected]> Co-authored-by: pynappo <[email protected]> Co-authored-by: Omri Sarig <[email protected]> Co-authored-by: Omri Sarig <[email protected]> Co-authored-by: jaho5 <[email protected]>
1 parent b555a56 commit da685b4

30 files changed

Lines changed: 1048 additions & 968 deletions

README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# kickstart.nvim
1+
# kickstart-modular.nvim
22

33
## Introduction
44

5+
*This is a fork of [nvim-lua/kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim) that moves from a single file to a multi file configuration.*
6+
57
A starting point for Neovim that is:
68

79
* Small
8-
* Single-file
10+
* Modular
911
* Completely Documented
1012

1113
**NOT** a Neovim distribution, but instead a starting point for your configuration.
@@ -23,22 +25,24 @@ If you are experiencing issues, please make sure you have the latest versions.
2325

2426
External Requirements:
2527
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
26-
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
28+
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
29+
[fd-find](https://github.com/sharkdp/fd#installation)
2730
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
2831
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
2932
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
33+
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
3034
- Language Setup:
3135
- If you want to write Typescript, you need `npm`
3236
- If you want to write Golang, you will need `go`
3337
- etc.
3438

35-
> **NOTE**
39+
> [!NOTE]
3640
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
3741
> and quick install snippets
3842
3943
### Install Kickstart
4044

41-
> **NOTE**
45+
> [!NOTE]
4246
> [Backup](#FAQ) your previous configuration (if any exists)
4347
4448
Neovim's configurations are located under the following paths, depending on your OS:
@@ -55,23 +59,24 @@ Neovim's configurations are located under the following paths, depending on your
5559
so that you have your own copy that you can modify, then install by cloning the
5660
fork to your machine using one of the commands below, depending on your OS.
5761

58-
> **NOTE**
62+
> [!NOTE]
5963
> Your fork's URL will be something like this:
60-
> `https://github.com/<your_github_username>/kickstart.nvim.git`
64+
> `https://github.com/<your_github_username>/kickstart-modular.nvim.git`
6165
6266
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
6367
too - it's ignored in the kickstart repo to make maintenance easier, but it's
6468
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
6569

6670
#### Clone kickstart.nvim
67-
> **NOTE**
71+
72+
> [!NOTE]
6873
> If following the recommended step above (i.e., forking the repo), replace
69-
> `nvim-lua` with `<your_github_username>` in the commands below
74+
> `dam9000` with `<your_github_username>` in the commands below
7075
7176
<details><summary> Linux and Mac </summary>
7277

7378
```sh
74-
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
79+
git clone https://github.com/dam9000/kickstart-modular.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
7580
```
7681

7782
</details>
@@ -81,13 +86,13 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
8186
If you're using `cmd.exe`:
8287

8388
```
84-
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
89+
git clone https://github.com/dam9000/kickstart-modular.nvim.git "%localappdata%\nvim"
8590
```
8691

8792
If you're using `powershell.exe`
8893

8994
```
90-
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
95+
git clone https://github.com/dam9000/kickstart-modular.nvim.git "${env:LOCALAPPDATA}\nvim"
9196
```
9297

9398
</details>
@@ -143,6 +148,9 @@ examples of adding popularly requested plugins.
143148
into smaller parts. A fork of kickstart that does this while maintaining the
144149
same functionality is available here:
145150
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
151+
* *NOTE: This is the fork that splits the configuration into smaller parts.*
152+
The original repo with the single `init.lua` file is available here:
153+
* [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim)
146154
* Discussions on this topic can be found here:
147155
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
148156
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
@@ -212,14 +220,14 @@ sudo apt update
212220
sudo apt install make gcc ripgrep unzip git xclip curl
213221
214222
# Now we install nvim
215-
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
216-
sudo rm -rf /opt/nvim-linux64
217-
sudo mkdir -p /opt/nvim-linux64
218-
sudo chmod a+rX /opt/nvim-linux64
219-
sudo tar -C /opt -xzf nvim-linux64.tar.gz
223+
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
224+
sudo rm -rf /opt/nvim-linux-x86_64
225+
sudo mkdir -p /opt/nvim-linux-x86_64
226+
sudo chmod a+rX /opt/nvim-linux-x86_64
227+
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
220228
221229
# make it available in /usr/local/bin, distro installs to /usr/bin
222-
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
230+
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
223231
```
224232
</details>
225233
<details><summary>Fedora Install Steps</summary>

0 commit comments

Comments
 (0)