Vim-fork focused on extensibility and usability
Go to file
dundargoc bb9c673d2c
ci: automatically maximize MIN_LOG_LEVEL if CI detected (#22248)
Detect if on CI by checking that the CI environment variable is set to "true".
This is a common pattern among CI providers, including github actions and
cirrus.
2023-02-13 20:04:54 +01:00
.github ci: automatically maximize MIN_LOG_LEVEL if CI detected (#22248) 2023-02-13 20:04:54 +01:00
cmake build: don't check environment variable to detect CI (#22234) 2023-02-12 14:42:00 +01:00
cmake.config build: mark uninteresting variables as advanced (#22208) 2023-02-10 20:20:18 +01:00
cmake.deps refactor(tests): move lua-client into core and use it for functionaltests 2023-02-10 20:19:04 +01:00
cmake.packaging feat(windows): show icon in terminal titlebar, taskbar #20607 2022-10-13 05:48:12 -07:00
contrib build: add git sha to version when built with nix flake (#21210) 2022-12-30 18:24:40 +01:00
runtime Merge pull request #22191 from lewis6991/feat/playground_imp 2023-02-13 10:54:03 +00:00
scripts ci(lintcommit): allow UPPER_CASE first word (#22245) 2023-02-13 18:26:27 +01:00
snap cmake: install app icon in XDG hicolor icon theme (#14656) 2021-05-27 22:37:24 +02:00
src ci: automatically maximize MIN_LOG_LEVEL if CI detected (#22248) 2023-02-13 20:04:54 +01:00
test Merge pull request #22191 from lewis6991/feat/playground_imp 2023-02-13 10:54:03 +00:00
.cirrus.yml ci: automatically maximize MIN_LOG_LEVEL if CI detected (#22248) 2023-02-13 20:04:54 +01:00
.clang-format docs(clang-format): one space in directives indent (#18800) 2022-05-30 23:49:11 +08:00
.clang-tidy build: treat clang-tidy warnings as errors (#22238) 2023-02-12 17:41:54 +01:00
.clangd Adding clangd language serever config file to point to build/ directory for compile_commands.json 2021-06-28 11:03:09 -04: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 build: remove codecov related files (#20859) 2023-02-09 11:04:02 +01:00
.gitignore build(nix): clean up nix flake (#21565) 2022-12-28 14:26:59 +01:00
.luacheckrc fix(treesitter): fix most diagnostics 2023-02-04 14:58:38 +00:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.mailmap docs: update .mailmap (#20086) 2022-09-06 08:57:03 +02:00
.stylua.toml refactor(lua): reformat with stylua 0.14.0 (#19264) 2022-07-07 18:27:18 +02:00
.styluaignore ci: lint runtime with stylua 2022-05-09 16:31:55 +02: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
CMakeLists.txt ci: inline test.sh to run_tests.sh (#22198) 2023-02-10 00:42:37 +01:00
CMakePresets.json build: enable cmake workflow presets (#21860) 2023-01-19 10:34:45 +01:00
CONTRIBUTING.md build(ci): let ASAN print tracebacks for more errors (SIGABORT, SIGILL) 2023-02-10 22:14:45 +01:00
LICENSE.txt docs: fix/remove invalid URLs #20647 2022-10-14 08:01:13 -07:00
MAINTAIN.md docs(maintain): add note on updating luvref.txt 2023-02-09 11:45:54 +01:00
Makefile build: replace check-single-includes with clang-tidy (#22061) 2023-02-08 18:16:48 +01:00
README.md docs: readme cleanup 2023-01-02 15:18:18 -08:00

Neovim

Documentation | Chat

GitHub CI Coverity Scan analysis Clang analysis PVS-Studio 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 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

├─ ci/              build automation
├─ 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/         VimL 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.