wyj/neovim

mirror of https://github.com/neovim/neovim.git synced 2024-09-17 20:58:20 -04:00

Vim-fork focused on extensibility and usability

Go to file

Sean Dewar cc87dda31a fix(lsp): do not assume client capability exists in watchfiles check (#24550 ) PR #23689 assumes `client.config.capabilities.workspace.didChangeWatchedFiles` exists when checking `dynamicRegistration`, but thats's true only if it was passed to `vim.lsp.start{_client}`. This caused #23806 (still an issue in v0.9.1; needs manual backport), but #23681 fixed it by defaulting `config.capabilities` to `make_client_capabilities` if not passed to `vim.lsp.start{_client}`. However, the bug resurfaces on HEAD if you provide a non-nil `capabilities` to `vim.lsp.start{_client}` with missing fields (e.g: not made via `make_client_capabilities`). From what I see, the spec says such missing fields should be interpreted as an absence of the capability (including those indicated by missing sub-fields): https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#clientCapabilities Also, suggest `vim.empty_dict()` for an empty dict in `:h vim.lsp.start_client()` (`{[vim.type_idx]=vim.types.dictionary}` no longer works anyway, probably since the cjson switch).		2023-08-04 08:10:54 +02:00
.github	feat(lua-types): types for vim.api.* (#24523 )	2023-08-01 14:20:44 +01:00
ci
cmake
cmake.config
cmake.deps	build(deps): bump libvterm to 0.3.3 (#24547 )	2023-08-04 07:08:43 +08:00
cmake.packaging
contrib
runtime	fix(lsp): do not assume client capability exists in watchfiles check (#24550 )	2023-08-04 08:10:54 +02:00
scripts	docs: remove "#" comment char in @return	2023-08-03 14:01:53 +02:00
src	fix(terminal): forward horizontal mouse scrolling (#24552 )	2023-08-04 10:24:27 +08:00
test	fix(lsp): do not assume client capability exists in watchfiles check (#24550 )	2023-08-04 08:10:54 +02:00
.cirrus.yml
.clang-format
.clang-tidy
.clangd
.editorconfig
.git-blame-ignore-revs
.gitattributes	feat(lua-types): types for vim.api.* (#24523 )	2023-08-01 14:20:44 +01:00
.gitignore
.luacheckrc	feat(lua-types): types for vim.api.* (#24523 )	2023-08-01 14:20:44 +01:00
.luacov
.mailmap
.stylua.toml
.styluaignore
BACKERS.md
BSDmakefile
CMakeLists.txt
CMakePresets.json
CONTRIBUTING.md	docs: remove "#" comment char in @return	2023-08-03 14:01:53 +02:00
LICENSE.txt
MAINTAIN.md	docs: misc	2023-08-03 14:01:53 +02:00
Makefile	feat(lua-types): types for vim.api.* (#24523 )	2023-08-01 14:20:44 +01:00
README.md

README.md

Documentation | Chat

Neovim is a project that seeks to aggressively refactor Vim in order to:

Simplify maintenance and encourage contributions
Split the work between multiple developers
Enable advanced UIs without modifications to the core
Maximize extensibility

See the Introduction wiki page and Roadmap for more information.

Features

Modern GUIs
API access from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java/Kotlin, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
Embedded, scriptable terminal emulator
Asynchronous job control
Shared data (shada) among multiple editor instances
XDG base directories support
Compatible with most Vim plugins, including Ruby and Python plugins

See :help nvim-features for the full list, and :help news for noteworthy changes in the latest version!

Install from package

Pre-built packages for Windows, macOS, and Linux are found on the Releases page.

Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!

Install from source

See the Building Neovim wiki page and supported platforms for details.

The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command.

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location:

make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/
make install

CMake hints for inspecting the build:

cmake --build build --target help lists all build targets.
build/CMakeCache.txt (or cmake -LAH build/) contains the resolved values of all CMake variables.
build/compile_commands.json shows the full compiler invocations for each translation unit.

Transitioning from Vim

See :help nvim-from-vim for instructions.

Project layout

├─ cmake/           CMake utils
├─ cmake.config/    CMake defines
├─ cmake.deps/      subproject to fetch and build dependencies (optional)
├─ runtime/         plugins and docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         Vimscript subsystem
│  ├─ event/        event-loop subsystem
│  ├─ generators/   code generation (pre-compilation)
│  ├─ lib/          generic data structures
│  ├─ lua/          Lua subsystem
│  ├─ msgpack_rpc/  RPC subsystem
│  ├─ os/           low-level platform code
│  └─ tui/          built-in UI
└─ test/            tests (see test/README.md)

License

Neovim contributions since b17d96 are licensed under the Apache 2.0 license, except for contributions copied from Vim (identified by the vim-patch token). See LICENSE for details.

Vim is Charityware.  You can use and copy it as much as you like, but you are
encouraged to make a donation for needy children in Uganda.  Please see the
kcc section of the vim docs or visit the ICCF web site, available at these URLs:

        https://iccf-holland.org/
        https://www.vim.org/iccf/
        https://www.iccf.nl/

You can also sponsor the development of Vim.  Vim sponsors can vote for
features.  The money goes to Uganda anyway.