Vim-fork focused on extensibility and usability
Go to file
Jongwook Choi 6c35fb421e fix(gen_lsp.lua): improve type name, and fix wrong type inheritance
Style improvements:

1. Anonymous classes derived from `StructureLiteralType` should have a
   better name. The class name can be also nested. Examples:

```diff
----@field serverInfo? anonym1
+---@field serverInfo? lsp._anonym1.serverInfo
```
```diff
----@field insertTextModeSupport? anonym26
+---@field insertTextModeSupport? lsp._anonym26.completionItem.insertTextModeSupport
```

2. Add one separate empty line before each `@field` definition. Without
   these, empty lines the doc can look confusing because descriptions
   also may contain empty lines. See `lsp.CompletionItem` for example:

```lua
---The kind of this completion item. Based of the kind
---an icon is chosen by the editor.
---@field kind? lsp.CompletionItemKind
---Tags for this completion item.
---
---@since 3.15.0
---@field tags? lsp.CompletionItemTag[]
```

   It might feel like "Tags for this completion item" belongs to `kind`,
   not `tags` due to the lack of separator blank lines. The following
   (after this commit) should look much better:

```diff
 ---The kind of this completion item. Based of the kind
 ---an icon is chosen by the editor.
 ---@field kind? lsp.CompletionItemKind
+---
 ---Tags for this completion item.
 ---
 ---@since 3.15.0
 ---@field tags? lsp.CompletionItemTag[]
```

3. Escape some LSP-specific annotations that can't be recognized by
   lua-ls. It'd be better to make them visible in LSP hover doc windows.

   Example: `@sample ...`.

Fixes:

1. A type may extend from more than one base types (as well as mixin
   types). Previously only the first base class was being considered,
   resulting incomplete base classes for `@class` definitions.

   Example: `InlayHintOptions` (should have both of `resolveProvider`
   and `workDoneProgress`, the latter is from `WorkDoneProgressOptions`)

```diff
----@class lsp.InlayHintOptions
+---@class lsp.InlayHintOptions: lsp.WorkDoneProgressOptions
```

2. Remove `<200b>` (zero-width space) unicode characters.

3. Add the missing newline at EOF.
2023-12-27 10:48:06 +01:00
.github ci: disable libintl on mac release 2023-12-26 22:46:10 +01:00
cmake build: cmake fixes 2023-12-16 21:06:28 +01:00
cmake.config refactor: run IWYU on entire repo 2023-12-21 17:38:42 +01:00
cmake.deps build(deps): bump luajit to HEAD - c525bcb90 2023-12-24 09:51:10 +01:00
cmake.packaging build!: remove neovim qt 2023-06-06 19:19:00 +02:00
contrib build(nix): update flake.lock (#26702) 2023-12-23 00:50:24 +01:00
runtime fix(gen_lsp.lua): improve type name, and fix wrong type inheritance 2023-12-27 10:48:06 +01:00
scripts fix(gen_lsp.lua): improve type name, and fix wrong type inheritance 2023-12-27 10:48:06 +01:00
src fix(inccommand): don't preview in Ex mode (#26587) 2023-12-27 15:18:22 +08:00
test fix(inccommand): don't preview in Ex mode (#26587) 2023-12-27 15:18:22 +08:00
.cirrus.yml vim-patch:9.0.1892: CI: no FreeBSD 14 support (#26604) 2023-12-16 21:12:31 +08:00
.clang-format build: align .clang-format rules with uncrustify config 2023-05-28 15:39:43 +02:00
.clang-tidy refactor: eliminate cyclic includes 2023-12-20 19:52:02 +01:00
.clangd build: disable UnusedIncludes from clangd 2023-11-28 20:22:59 +01:00
.editorconfig build(editorconfig): set indent_size to 4 for python files (#21135) 2022-11-21 06:53:29 -07:00
.git-blame-ignore-revs docs: .git-blame-ignore-revs (#20820) 2022-10-27 20:31:09 +02:00
.gitattributes feat: generate types and docs for v variables 2023-12-21 14:19:10 +00:00
.gitignore feat: add .luarc.json (#24592) 2023-08-07 16:27:53 +01:00
.luacheckrc build: rework formatting to use add_glob_target 2023-12-04 20:21:38 +01:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.luarc.json fix(luarc.json): ignore test directory to save memory 2023-08-23 14:25:36 +01:00
.mailmap docs: update .mailmap (#20086) 2022-09-06 08:57:03 +02:00
.stylua.toml build: enable lintlua for scripts/ dir #26391 2023-12-04 12:38:31 -08:00
.styluaignore build: enable lintlua for test/unit/ dir #26396 2023-12-04 14:32:39 -08:00
BACKERS.md Update backer URL 2015-11-11 19:50:33 -08:00
BSDmakefile feat(lua)!: register_keystroke_callback => on_key 2021-09-09 06:09:33 -07:00
BUILD.md docs: simplify build instructions 2023-12-16 21:49:00 +01:00
CMakeLists.txt ci: disable libintl on mac release 2023-12-26 22:46:10 +01:00
CMakePresets.json build: add "ci" configure preset to reduce verbosity 2023-04-23 17:12:46 +02:00
CONTRIBUTING.md docs: move vim-patch wiki page to runtime documentation 2023-12-13 18:31:05 +01:00
INSTALL.md docs: fix links 2023-12-13 20:31:16 +01:00
LICENSE.txt vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
MAINTAIN.md refactor: use vim.deprecate on all deprecated functions 2023-12-27 00:05:36 +01:00
Makefile refactor: run IWYU on entire repo 2023-12-21 17:38:42 +01:00
README.md docs: small fixes (#26448) 2023-12-19 13:29:13 +08:00

Neovim

Documentation | Chat

Coverity Scan analysis Clang analysis Packages Debian CI Downloads

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

See the Introduction wiki page and Roadmap for more information.

Features

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 BUILD.md 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.