Skip to content

Commit 8834358

Browse files
committed
Merge remote-tracking branch 'upstream/master'
* upstream/master: (55 commits) Fix the which-key spec issue caused by recent cleanup (nvim-lua#1113) cleanup: refactor which-key configuration for cleaner setup (nvim-lua#1102) fix: remove deprecated opt for conform.nvim (nvim-lua#1070) Fix: updated the windows installation commands (nvim-lua#1101) Enable silent option for default neo-tree plugin keybinding (nvim-lua#1108) Include visual mode in LSP code action keymap (nvim-lua#1060) (nvim-lua#1064) refactor: update treesitter and which-key config (nvim-lua#1068) Check for loop or uv for lazypath (nvim-lua#1095) Add note in README about lazy-lock.json (nvim-lua#1090) Update README.md (nvim-lua#1091) Add explicit dependency of nvim-lspconfig on cmp-nvim-lsp (nvim-lua#1042) Remove treesitter prefer_git option (nvim-lua#1061) performance: defer clipboard because xsel and pbcopy can be slow (nvim-lua#1049) refactor: remove lazydev and luvit-meta as lsp dependencies (nvim-lua#1047) Modify conform comments to prevent deprecation warning when used (nvim-lua#1057) Remove redundant hlsearch option (nvim-lua#1058) Update comment about the toggle inlay hints keymap (nvim-lua#1041) lint: fix lsp warning in `vim.lsp.inlay_hint.is_enabled` (nvim-lua#947) Update lazydev config to fix "Undefined field `fs_stat`" LSP error (nvim-lua#1040) Neovim 0.10 updates (nvim-lua#936) ...
2 parents 4caec7d + a229761 commit 8834358

File tree

11 files changed

+557
-381
lines changed

11 files changed

+557
-381
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
***************************************************************************
2+
**NOTE**
3+
Please verify that the `base repository` above has the intended destination!
4+
Github by default opens Pull Requests against the parent of a forked repository.
5+
If this is your personal fork and you didn't intend to open a PR for contribution
6+
to the original project then adjust the `base repository` accordingly.
7+
**************************************************************************
8+

README.md

Lines changed: 40 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -21,45 +21,48 @@ If you are experiencing issues, please make sure you have the latest versions.
2121

2222
### Install External Dependencies
2323

24-
> **NOTE**
25-
> [Backup](#FAQ) your previous configuration (if any exists)
26-
2724
External Requirements:
2825
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
2926
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
27+
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
3028
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
3129
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
3230
- Language Setup:
33-
- If want to write Typescript, you need `npm`
34-
- If want to write Golang, you will need `go`
31+
- If you want to write Typescript, you need `npm`
32+
- If you want to write Golang, you will need `go`
3533
- etc.
3634

3735
> **NOTE**
3836
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
3937
> and quick install snippets
4038
39+
### Install Kickstart
40+
41+
> **NOTE**
42+
> [Backup](#FAQ) your previous configuration (if any exists)
43+
4144
Neovim's configurations are located under the following paths, depending on your OS:
4245

4346
| OS | PATH |
4447
| :- | :--- |
4548
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
46-
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
47-
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
48-
49-
### Install Kickstart
49+
| Windows (cmd)| `%localappdata%\nvim\` |
50+
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
5051

5152
#### Recommended Step
5253

5354
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
5455
so that you have your own copy that you can modify, then install by cloning the
5556
fork to your machine using one of the commands below, depending on your OS.
5657

57-
58-
5958
> **NOTE**
6059
> Your fork's url will be something like this:
6160
> `https://github.com/<your_github_username>/kickstart.nvim.git`
6261
62+
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
63+
too - it's ignored in the kickstart repo to make maintenance easier, but it's
64+
[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).
65+
6366
#### Clone kickstart.nvim
6467
> **NOTE**
6568
> If following the recommended step above (i.e., forking the repo), replace
@@ -78,13 +81,13 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
7881
If you're using `cmd.exe`:
7982

8083
```
81-
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
84+
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
8285
```
8386

8487
If you're using `powershell.exe`
8588

8689
```
87-
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
90+
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
8891
```
8992

9093
</details>
@@ -98,73 +101,12 @@ nvim
98101
```
99102

100103
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
101-
current plugin status.
104+
current plugin status. Hit `q` to close the window.
102105

103106
Read through the `init.lua` file in your configuration folder for more
104-
information about extending and exploring Neovim.
105-
106-
107-
#### Examples of adding popularly requested plugins
108-
109-
NOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins.
110-
111-
<details>
112-
<summary>Adding autopairs</summary>
113-
114-
This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs)
115-
and enable it on startup. For more information, see documentation for
116-
[lazy.nvim](https://github.com/folke/lazy.nvim).
117-
118-
In the file: `lua/custom/plugins/autopairs.lua`, add:
107+
information about extending and exploring Neovim. That also includes
108+
examples of adding popularly requested plugins.
119109

120-
```lua
121-
-- File: lua/custom/plugins/autopairs.lua
122-
123-
return {
124-
"windwp/nvim-autopairs",
125-
-- Optional dependency
126-
dependencies = { 'hrsh7th/nvim-cmp' },
127-
config = function()
128-
require("nvim-autopairs").setup {}
129-
-- If you want to automatically add `(` after selecting a function or method
130-
local cmp_autopairs = require('nvim-autopairs.completion.cmp')
131-
local cmp = require('cmp')
132-
cmp.event:on(
133-
'confirm_done',
134-
cmp_autopairs.on_confirm_done()
135-
)
136-
end,
137-
}
138-
```
139-
140-
</details>
141-
<details>
142-
<summary>Adding a file tree plugin</summary>
143-
144-
This will install the tree plugin and add the command `:Neotree` for you.
145-
For more information, see the documentation at
146-
[neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
147-
148-
In the file: `lua/custom/plugins/filetree.lua`, add:
149-
150-
```lua
151-
-- File: lua/custom/plugins/filetree.lua
152-
153-
return {
154-
"nvim-neo-tree/neo-tree.nvim",
155-
version = "*",
156-
dependencies = {
157-
"nvim-lua/plenary.nvim",
158-
"nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
159-
"MunifTanjim/nui.nvim",
160-
},
161-
config = function ()
162-
require('neo-tree').setup {}
163-
end,
164-
}
165-
```
166-
167-
</details>
168110

169111
### Getting Started
170112

@@ -245,7 +187,7 @@ wsl --install
245187
wsl
246188
sudo add-apt-repository ppa:neovim-ppa/unstable -y
247189
sudo apt update
248-
sudo apt install make gcc ripgrep unzip neovim
190+
sudo apt install make gcc ripgrep unzip git xclip neovim
249191
```
250192
</details>
251193

@@ -255,22 +197,36 @@ sudo apt install make gcc ripgrep unzip neovim
255197
```
256198
sudo add-apt-repository ppa:neovim-ppa/unstable -y
257199
sudo apt update
258-
sudo apt install make gcc ripgrep unzip neovim
200+
sudo apt install make gcc ripgrep unzip git xclip neovim
259201
```
260202
</details>
261203
<details><summary>Debian Install Steps</summary>
262204

263205
```
264206
sudo apt update
265-
sudo apt install make gcc ripgrep unzip git
266-
echo "deb https://deb.debian.org/debian unstable main" | sudo tee -a /etc/apt/sources.list
267-
sudo apt update
268-
sudo apt install -t unstable neovim
207+
sudo apt install make gcc ripgrep unzip git xclip curl
208+
209+
# Now we install nvim
210+
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
211+
sudo rm -rf /opt/nvim-linux64
212+
sudo mkdir -p /opt/nvim-linux64
213+
sudo chmod a+rX /opt/nvim-linux64
214+
sudo tar -C /opt -xzf nvim-linux64.tar.gz
215+
216+
# make it available in /usr/local/bin, distro installs to /usr/bin
217+
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
269218
```
270219
</details>
271220
<details><summary>Fedora Install Steps</summary>
272221

273222
```
274-
sudo dnf install -y gcc make git ripgrep fd-find neovim
223+
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
224+
```
225+
</details>
226+
227+
<details><summary>Arch Install Steps</summary>
228+
229+
```
230+
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
275231
```
276232
</details>

0 commit comments

Comments
 (0)