Skip to content

Commit

Permalink
Patch/upstream merge 24.9.1 (#1)
Browse files Browse the repository at this point in the history
* Add nvim-nio as dependency for nvim-dap-ui (nvim-lua#774)

It's a dependency now

* Update README.md (nvim-lua#781)

The recommended step of forking the repo coming sequentially after the step instructing users to clone the current repo doesn't make sense.

This commit orders the install instructions in a manner that's more logical.

* README: wrap long lines (nvim-lua#784)

* fix nvim-lua#799 (nvim-lua#800)

Add `'luadoc'`, to the `ensure_installed` of `nvim-treesitter/nvim-treesitter`

* Add instructions to quit :lazy. Fixes nvim-lua#761

* Add a keymap space-f to format buffer using conform (nvim-lua#817)

This works also for visual range selection
Copied from conform recipe:
https://github.com/stevearc/conform.nvim/blob/master/doc/recipes.md

* Don't lazy load conform plugin (nvim-lua#818)

* README: move backup and paths from external deps to install section (nvim-lua#819)

* Add a pull request template (nvim-lua#825)

* Update README (nvim-lua#832)

* Arch, btw (nvim-lua#852)

* Arch, btw

* Add unzip

* Add unzip for Fedora and --needed arg for Arch

* Comment about nerd font selection. Fixes nvim-lua#853 (nvim-lua#854)

* Fix: nvim-lua#847 - add prefer_git to treesitter config (nvim-lua#856)

* Enable inlay hints for the supporting servers (nvim-lua#843)

* Move plugin examples from README to optional plugin files (nvim-lua#831)

* Move autopairs example from README to an optional plugin

* Move neo-tree example from README to an optional plugin

* Add gitsigns recommended keymaps as an optional plugin (nvim-lua#858)

* fix: restore Mason config timing for DAP startup (again) (nvim-lua#865)

* Update README.md (nvim-lua#860)

Attempted fix for nvim-lua#859, provide reasonable Debian install instructions -- comment on GitHub issue with refinement.

* Minor improvements of debian install instructions. Fixes nvim-lua#859 (nvim-lua#869)

* Add a commented out example of the classic complete keymaps. Fixes nvim-lua#866 (nvim-lua#868)

* Fix deprecation notice of inlay hints (nvim-lua#873)

* Fix highlight errors when lsp crash or stop (nvim-lua#864)

* Fix highlight errors when lsp crash or stop

It adds a check wether the client is still available before
highlighting.

If the client is not there anymore it returns `true` to unregister the
autocommand

This fix the
`method textDocument/documentHighlight is not supported by any of the servers registered for the current buffer`
errors when doing a LspRestart or the server crashes

* Delete the highlight autocommands in the LspDetatch event

* Only delete autocmds for the current buffer with the group name

* Simplify clearing the autocommands

---------

Co-authored-by: Francis Belanger <francis.belanger@ubisoft.com>

* fix: highlight group clear on each attach (nvim-lua#874)

* Update README.md (nvim-lua#875)

Line 102. Placed 'also' before the 'includes'.

"That includes also examples of adding popularly requested plugins." ---> "That also includes examples of adding popularly requested plugins."

* README: add clipboard tool dependency (nvim-lua#886)

Fixes: nvim-lua#884
Neovim requires an external tool for proper system clipboard integration.
Some systems install this already by default:
- on Fedora xsel is already installed by default
- on Windows using the choko install the win32yank is alredy installed
This is not installed by default on ubuntu or debian so adding that
to the dependencies list and to the install instructions snippets.

* Move LspDetach handler near kickstart-lsp-highlight group (nvim-lua#900)

Moved to make sure the kickstart-lsp-highlight group exists when
the LspDetach handler is invoked. The LspDetach handler is used
to clean up any lsp highlights that were enabled by CursorHold
if the LSP is stopped or crashed.

* Add diff to treesitter's ensure_installed languages (nvim-lua#908)

* fix: debug.lua (nvim-lua#918)

* Automatically set detached state as needed. (nvim-lua#925)

* Automatically set detached state as needed.

* Use vim.fn.has instead.

* Fix int vs bool.

* which-key v3 update (nvim-lua#1022)

* which-key v3 update

* remove unneeded brackets from which-key registration

* fix(lazy): added error handling for bootstrap (nvim-lua#1001)

* fix: add required parsers from nvim-treesitter

* Fix neo-tree keymap description (nvim-lua#932)

The lazy.nvim keys parameter does not need the `desc` to
be inside a table in the way that vim.keymap.set() does.
With this fix the keymap description will be properly
shown for example in telescope keymap search

* Remove redundant require (nvim-lua#959)

* Make debug lazy loadable (nvim-lua#978)

* Update README.md | %userprofile%\appdata\local -> %localappdata% (nvim-lua#963)

- Replace `%userprofile%\AppData\Local\nvim\` and `$env:USERPROFILE\AppData\Local\nvim` to `%localappdata%\nvim` and `$env:LOCALAPPDATA\nvim respectfully`

* Make conform.nvim be lazy-loadable again (nvim-lua#977)

The PR that disabled lazy loading (nvim-lua#818) was to fix plugin not being
loaded before write. This sets up lazy to load conform before write.

* Fix comment about mini.ai example (nvim-lua#985)

This example wasn't using `'` so this makes more sense

* Neovim 0.10 updates (nvim-lua#936)

* Neovim 0.10 updates

Provide the buffer for which to enable inlay hints

Co-authored-by: Matt Mirus <matt@mattmirus.com>

* refactor: replace vim.loop with vim.uv

* Upgrade folke/neodev (sunsetting) to folke/lazydev

* Update checkhealth for 0.10 release

---------

Co-authored-by: Matt Mirus <matt@mattmirus.com>
Co-authored-by: mrr11k <me+github@mrr11k.dev>
Co-authored-by: Seb Tomasini <sebt@qgates.com>

* Update lazydev config to fix "Undefined field `fs_stat`" LSP error (nvim-lua#1040)

7513ec8 switched from neodev to
lazydev, but in the process it introduced an LSP error in `init.lua`,
which degrades the desired "first timer" experience of kickstart.nvim.

This commit follows the configuration suggested in
https://github.com/folke/lazydev.nvim/tree/6184ebbbc8045d70077659b7d30c705a588dc62f#-installation
which resolves the LSP error.

* lint: fix lsp warning in `vim.lsp.inlay_hint.is_enabled` (nvim-lua#947)

* fix: lsp warning

* review suggestion

Co-authored-by: Tom Kuson <mail@tjkuson.me>

---------

Co-authored-by: Tom Kuson <mail@tjkuson.me>

* Update comment about the toggle inlay hints keymap (nvim-lua#1041)

* Remove redundant hlsearch option (nvim-lua#1058)

* Modify conform comments to prevent deprecation warning when used (nvim-lua#1057)

* refactor: remove lazydev and luvit-meta as lsp dependencies (nvim-lua#1047)

* performance: defer clipboard because xsel and pbcopy can be slow (nvim-lua#1049)

* Remove treesitter prefer_git option (nvim-lua#1061)

- It's not safe and can corrupt other git repos
- nvim-treesiter maintainers consider `prefer_git` as deprecated and no
  longer needed.

See nvim-treesitter PR for details: nvim-treesitter/nvim-treesitter#6959

* Add explicit dependency of nvim-lspconfig on cmp-nvim-lsp (nvim-lua#1042)

* Update README.md (nvim-lua#1091)

* Add note in README about lazy-lock.json (nvim-lua#1090)

* Check for loop or uv for lazypath (nvim-lua#1095)

* refactor: update treesitter and which-key config (nvim-lua#1068)

* Include visual mode in LSP code action keymap (nvim-lua#1060) (nvim-lua#1064)

* Enable silent option for default neo-tree plugin keybinding (nvim-lua#1108)

* Fix: updated the windows installation commands (nvim-lua#1101)

* Update README.md

* Update README.md

* Fix: updated the windows installation commands

* fix: remove deprecated opt for conform.nvim (nvim-lua#1070)

- changed lsp_fallback -> lsp_format
- updated format_on_save function to reflect change above

* cleanup: refactor which-key configuration for cleaner setup (nvim-lua#1102)

- Moved `which-key` configuration from inline `config` to `opts` for better organization.
- Updated the key mappings setup to use `spec` for defining existing key chains.
- Removed deprecated or unnecessary comments and code.

This change aligns with updated `which-key` configuration practices, improving readability and maintainability as recommended by @VlaDexa in nvim-lua#1068.

* Fix the which-key spec issue caused by recent cleanup (nvim-lua#1113)

The recent cleanup accidentally broke the leader key specs
because the spec block was in the wrong level of braces.
That resulted in which-key no longer showing the description
of the <leader> key chains such as [S]earch and others.

---------

Co-authored-by: José Miguel Sarasola <alosarjos@gmail.com>
Co-authored-by: E <2061889+bozoputer@users.noreply.github.com>
Co-authored-by: Damjan 9000 <damjan.9000@gmail.com>
Co-authored-by: Liu Qisheng <81770798+Saplyn@users.noreply.github.com>
Co-authored-by: Chris Patti <feoh@feoh.org>
Co-authored-by: Viet <51826956+hoangvietdo@users.noreply.github.com>
Co-authored-by: rdvm <git@rvm.dev>
Co-authored-by: Vladislav Grechannik <52157081+VlaDexa@users.noreply.github.com>
Co-authored-by: GameFuzzy <mail@gamefuzzy.dev>
Co-authored-by: Evan Carroll <me@evancarroll.com>
Co-authored-by: Francis Belanger <francis.belanger@gmail.com>
Co-authored-by: Francis Belanger <francis.belanger@ubisoft.com>
Co-authored-by: Adolfo Gante <adolfogante@gmail.com>
Co-authored-by: Richard Macklin <1863540+rmacklin@users.noreply.github.com>
Co-authored-by: Smig <89040888+smiggiddy@users.noreply.github.com>
Co-authored-by: Per Malmberg <PerMalmberg@users.noreply.github.com>
Co-authored-by: Folke Lemaitre <folke.lemaitre@gmail.com>
Co-authored-by: TJ DeVries <devries.timothyj@gmail.com>
Co-authored-by: Tom Kuson <mail@tjkuson.me>
Co-authored-by: Artyom <84637383+MZhuvka@users.noreply.github.com>
Co-authored-by: Matt Mirus <matt@mattmirus.com>
Co-authored-by: mrr11k <me+github@mrr11k.dev>
Co-authored-by: Seb Tomasini <sebt@qgates.com>
Co-authored-by: srdtrk <59252793+srdtrk@users.noreply.github.com>
Co-authored-by: Arvin Verain <arvinverain@proton.me>
Co-authored-by: Brandon Clark <bwclark97@gmail.com>
Co-authored-by: Ihsan Tonuzi <115842560+iton0@users.noreply.github.com>
Co-authored-by: abeldekat <58370433+abeldekat@users.noreply.github.com>
Co-authored-by: jstrot <44594069+jstrot@users.noreply.github.com>
Co-authored-by: theoboldalex <44616505+theoboldalex@users.noreply.github.com>
Co-authored-by: Matt Gallagher <46973220+mattgallagher92@users.noreply.github.com>
Co-authored-by: Michael L. <m@lehenauer.com>
Co-authored-by: Bayram Kazik <48856944+bayramkzk@users.noreply.github.com>
Co-authored-by: Harshit Pant <97608579+pantharshit007@users.noreply.github.com>
  • Loading branch information
Show file tree
Hide file tree
Showing 9 changed files with 365 additions and 163 deletions.
8 changes: 8 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
***************************************************************************
**NOTE**
Please verify that the `base repository` above has the intended destination!
Github by default opens Pull Requests against the parent of a forked repository.
If this is your personal fork and you didn't intend to open a PR for contribution
to the original project then adjust the `base repository` accordingly.
**************************************************************************

153 changes: 63 additions & 90 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,52 @@ If you are experiencing issues, please make sure you have the latest versions.

### Install External Dependencies

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

> **NOTE**
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
> and quick install snippets
### Install Kickstart

> **NOTE**
> [Backup](#FAQ) your previous configuration (if any exists)
Neovim's configurations are located under the following paths, depending on your OS:

| OS | PATH |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
| Windows (cmd)| `%localappdata%\nvim\` |
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |

### Install Kickstart
#### Recommended Step

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

> **NOTE**
> Your fork's url will be something like this:
> `https://github.com/<your_github_username>/kickstart.nvim.git`
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).

#### Clone kickstart.nvim
> **NOTE**
> If following the recommended step above (i.e., forking the repo), replace
> `nvim-lua` with `<your_github_username>` in the commands below
<details><summary> Linux and Mac </summary>

Expand All @@ -63,13 +81,13 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
If you're using `cmd.exe`:

```
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
```

If you're using `powershell.exe`

```
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
```

</details>
Expand All @@ -83,93 +101,34 @@ nvim
```

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

Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim.
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.


### Getting Started

[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)

### Recommended Steps

[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
(so that you have your own copy that you can modify) and then install. You
can install it on your machine using the methods above.

> **NOTE**
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
#### Examples of adding popularly requested plugins

NOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins.

<details>
<summary>Adding autopairs</summary>

This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).

In the file: `lua/custom/plugins/autopairs.lua`, add:

```lua
-- File: lua/custom/plugins/autopairs.lua

return {
"windwp/nvim-autopairs",
-- Optional dependency
dependencies = { 'hrsh7th/nvim-cmp' },
config = function()
require("nvim-autopairs").setup {}
-- If you want to automatically add `(` after selecting a function or method
local cmp_autopairs = require('nvim-autopairs.completion.cmp')
local cmp = require('cmp')
cmp.event:on(
'confirm_done',
cmp_autopairs.on_confirm_done()
)
end,
}
```

</details>
<details>
<summary>Adding a file tree plugin</summary>

This will install the tree plugin and add the command `:Neotree` for you. For more information, see the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).

In the file: `lua/custom/plugins/filetree.lua`, add:

```lua
-- File: lua/custom/plugins/filetree.lua

return {
"nvim-neo-tree/neo-tree.nvim",
version = "*",
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
"MunifTanjim/nui.nvim",
},
config = function ()
require('neo-tree').setup {}
end,
}
```

</details>

### FAQ

* What should I do if I already have a pre-existing neovim configuration?
* You should back it up and then delete all associated files.
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
* This includes your existing init.lua and the neovim files in `~/.local`
which can be deleted with `rm -rf ~/.local/share/nvim/`
* Can I keep my existing configuration in parallel to kickstart?
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example, you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
to maintain multiple configurations. For example, you can install the kickstart
configuration in `~/.config/nvim-kickstart` and create an alias:
```
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
When you run Neovim using `nvim-kickstart` alias it will use the alternative
config directory and the matching local directory
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
distribution that you would like to try out.
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
Expand Down Expand Up @@ -228,7 +187,7 @@ wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip neovim
sudo apt install make gcc ripgrep unzip git xclip neovim
```
</details>

Expand All @@ -238,23 +197,37 @@ sudo apt install make gcc ripgrep unzip neovim
```
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip neovim
sudo apt install make gcc ripgrep unzip git xclip neovim
```
</details>
<details><summary>Debian Install Steps</summary>

```
sudo apt update
sudo apt install make gcc ripgrep unzip git
echo "deb https://deb.debian.org/debian unstable main" | sudo tee -a /etc/apt/sources.list
sudo apt update
sudo apt install -t unstable neovim
sudo apt install make gcc ripgrep unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
```
</details>
<details><summary>Fedora Install Steps</summary>

```
sudo dnf install -y gcc make git ripgrep fd-find neovim
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
```
</details>

<details><summary>Arch Install Steps</summary>

```
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```
</details>

Loading

0 comments on commit af6c343

Please sign in to comment.