从零配置专属neovim - 1.配置设计概述

最新推荐文章于 2024-04-30 18:32:58 发布
最新推荐文章于 2024-04-30 18:32:58 发布
阅读量3.1k 收藏 8
点赞数 3
分类专栏： 从零配置专属neovim 文章标签： vim
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/mithril_hermit/article/details/127585797
版权

文章目录

前言

这一篇主要介绍专属配置的目录结构，希望配置支持的特性，以及一些关联的知识(neovim或lua的)~
目前配置的开发还没有完全完成，属于边做边写博客记录。

配置构想

我的配置具有以下特点(或者说特性)：

  1. 不需要支持vim，这个配置就是安装了neovim(后续也可能简化成nvim)以后使用的。原因：
    • 因为vim不支持lua，且目前大部分neovim的插件都是使用lua实现，不知道能不能很好地兼容vim；
    • 如果是自己的机器，那么安装并配置neovim还是比较方便，如果是公用环境，一般使用vim只需要基础指令即可，不需要额外配置；
  2. 除了开发工具栈，尽量不需要额外安装其它程序，真需要安装也是通过插件内部安装：
    • 目标是下载配置后放到指定目录下，剩下的安装配置功能可以全由配置控制，不需要手动执行apt install等命令；
    • 期望兼容各操作系统，如果任务要额外安装其它程序，有可能出现linux和macos下面比较好安装但是windows下找不到平替或不兼容的情况。neovim使用lua可以尽量避免这种情况发生；
  3. 配置结构和插件分组管理：配置不与其它配置冲突，如果不想使用本配置只需要注释一行即可让整个配置失效。插件配置分模块管理；
  4. 插件安装代理模式：因为插件基本都是放在github上面管理的，国内拉取有的时候可能会超时，需要手动反复多拉几次才能安装成功。因此期望增加代理配置项，当某个插件设置代理配置项并启用代理模式时，通过国内的插件镜像仓库中(比如在gitee上设置一个定时同步的仓库)拉取，从而加速插件同步；
  5. nerd font可选生效：目前一些比较出名的neovim或vim配置都会选择把nerd font作为必须项，而nerd font并不是要安装在neovim所在机器上生效，而是要安装在使用neovim的机器(即客户端)上才能生效，导致有的时候在不同的客户端机器上如果没有安装nerd font，则neovim中的图形字符会变成乱码。该特性是期望在使用没有安装nerd font的机器上能正常使用neovim，在安装了nerd font的机器上能得到更好的视觉体验；
  6. 支持快捷键映射说明：vim最让初学者头痛的一点就是快捷键过滤多且使用不多很难记住。这个问题通常的解决方案是采用which-key插件，增加一个快捷键映射说明，通过交互式操作让即使不了解当前neovim配置的用户也能正常使用该neovim。本配置也会使用该插件实现类似功能；

配置存放及使用

目前配置存放地址：https://gitee.com/sineatos/dotfiles/tree/master/nvim
linux下使用方法：

# 假如当前所在路径为：~/workspace/
git clone https://gitee.com/sineatos/dotfiles.git
# 建立链接，其中第一项为源地址 第二项为目标地址
ln -s ~/workspace/dotfiles/nvim ~/.config/nvim

windows下的使用方法后续整理。

配置目录说明

|-~/.config/nvim/
	|-init.lua											# neovim的配置入口
	|-lua/												# neovim中所有lua脚本引入的根目录
		|-inori/											# 我的配置名
			|-init.lua
			|-global.lua
			|-options.lua
			|-keymaps.lua
			|-plugin_list.lua
			|-plugin_keymaps.lua
			|-autocommands.lua
			|-plugins/
			|-coding/
			|-ui/
			|-search/
			|-vcs/
			|-project_manage/
			|-other/
			|-util/

内容项说明

~/.config/nvim/init.lua

neovim的配置入口，neovim支持入口文件可以是init.lua或者init.vim，因为不考虑支持vim，所以直接使用init.lua；
这个配置文件中只有一行：require "inori"表示引入实际的配置，如果后续不想配置生效，只需要把这一行屏蔽即可。

~/.config/nvim/lua

neovim中所有lua脚本引入的根目录，比如我的配置中有一个lua模块存在的位置为~/.config/nvim/lua/my_module/tool.lua，则在脚本中使用tool模块时require的路径为require("my_module.tool")；

~/.config/nvim/lua/inori

我的配置实际目录，inori是“祈”的日语发音。
假如读者想要自定义自己的配置，名为user，则可以将自己的配置都放到~/.config/nvim/lua/user中。
没有把配置直接放在~/.config/nvim/lua/下，而特意都放到~/.config/nvim/lua/inori的原因：把自己的配置全都放到同一个作用域下面，避免与其他插件或配置冲突；

~/.config/nvim/lua/inori/init.lua：我的配置的实际入口。在~/.config/nvim/init.lua中引入该文件时用的是require "inori"，即当前的init.lua是inori模块的具体逻辑，因此init.lua在这里的作用有点像python中模块的__init__.py文件。但需要注意：这其实是neovim启动后对lua解析器的设置使其拥有类似的行为，lua默认是不支持这种语法的，这在调试时需要注意。

~/.config/nvim/lua/inori下的文件说明

  • global.lua：全局配置文件，比如说是否打印调试日志、是否让nerd font生效、是否启动插件仓库代理等；
  • options.lua：nvim的基础选项设置，该脚本会在其它插件加载之前执行，可以认为是默认的选项设置，里面的选项也有可能会被插件中的选项覆盖；
  • keymaps.lua：nvim的基础快捷键设置，该脚本会在其它插件加载之前执行，可以认为是默认的快捷键设置，里面的设置也有可能会被插件中的设置覆盖；
  • plugin_list.lua：inori需要加载的插件列表，列表中每一项是一个table，用于插件加载；
  • plugin_keymaps.lua：inori中插件的快捷键设置，之所以放在一个模块中设置而不是由每个插件自行管理，是因为有的插件的快捷键之间会有联系，所以还是统一管理比较好；
  • autocommands.lua：一些autocommand；

~/.config/nvim/lua/inori下的目录说明

  • plugins/：保存插件管理相关的插件配置，以及inori进行插件加载的模块；
  • coding/：编码相关插件配置，比如代码补全、TreeSitter、LSP、代码片段等‘；
  • ui/：UI配置，比如状态栏，缓冲区信息栏、配色方案、缩进提示、文件树、启动页等；
  • search/：搜索相关，主要是Telescope的配置；
  • vcs/：版本控制配置，主要是git的控制；
  • project_manage/：项目管理；
  • other/：其它插件；
  • util/：一些通用方法实现；

inori启动流程

inori启动流程如图所示：
inori启动流程
该启动流程参考了 neovim-from-scratch 的设计，inori的配置目录设计与其区别包括：

  1. neovim-from-scratch的加载脚本入口是~/.config/nvim/init.lua，而inori则是~/.config/nvim/inori/init.lua，虽然inori这样设计看起来~/.config/nvim/init.lua完成的工作比较鸡肋(只引入inori)，但这样设计的目的是把inori的逻辑全放在~/.config/nvim/inori中管理，如果需要整个屏蔽inori时，只需要移除~/.config/nvim/init.lua中的require "inori"即可(也可以认为这样是为了把具体实现细节隐藏起来)；
  2. neovim-from-scratch把各种插件的配置及基础设置都放在同一个目录(~/.config/nvim/lua/user/)下，而inori只是把基础设置项放在~/.config/nvim/lua/inori下，插件相关逻辑按照插件的类别分别放在不同的目录下，并且每个插件的配置都单独保存在一个模块(文件)中，这样做是为了更好地管理各个插件的配置，也更好地实现最开始计划inori需要支持的特性；

inori启动流程设计的缺点：与neovim-from-scratch相比流程比较复杂，且有一些需要互相协作的插件的配置可能只能放在其中一个插件的配置中，与前面提到的插件配置互相分离的想法冲突。

inori使用的插件简介

inori使用的插件主要参考neovim-from-scratch，如下图所示：
inori插件整理
本系列文章计划专注描述inori是怎么规划插件加载流程的以及简单介绍代码解析方面插件是怎么辅助开发者完成编码工作的。
本系列文章不会画太多笔墨介绍插件的用法，原因有二：

  1. 有的插件更新比较频繁如果讲解插件的api如何使用或者使用什么快捷键，很有可能因为插件版本升级而失效；
  2. 插件的使用方法在插件的仓库首页README或者wiki中有非常详细的介绍，也可以阅读插件的源码了解其工作原理；

小结

本文主要介绍inori的配置构想、配置目录解析、inori的启动流程及使用了哪些插件。

资料

  • Lua Tutorial：https://www.tutorialspoint.com/lua/index.htm
  • neovim lua指南：https://github.com/glepnir/nvim-lua-guide-zh
  • neovim-from-scratch: https://github.com/LunarVim/Neovim-from-scratch
只想静静发育
关注
  • 3
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
nvim:neovim配置文件
04-21
nvim安装准备 sudo apt update && sudo apt upgrade && sudo apt-get install -y ninja-build gettext libtool libtool-bin \ autoconf automake cmake g++ pkg-config unzip git bash fzf wget libssl-dev libffi-dev locales curl ripgrep \ nodejs npm clang-tools-11 clangd-11 sudo update-alternatives --install /usr/bin/clangd clangd /usr/bin/clangd-11 100 sudo npm i -g neovim sudo npm i -g bash-language-server pip2
开箱即用的LunarVim 手把手安装
weixin_43367137的博客
10-25 554
使用LunarVim已经有一段时间了，在过去的时间我使用了nvim，spacevim等一系列开箱即用的vim软件，综合体验下来，lunarvim使用丝滑，添加插件也极为方便。但是LunarVim的安装着实有一些麻烦，因此写了本篇文章帮助大家安装。
安装配置neovim
qq_45950599的博客
03-06 404
注意是将里面的Nvim文件放到 ~/.config文件下。进入 ~/.config/nvim/lua/plugins文件下，使用nvim plugins-setup.lua打开脚本，在命令行模式输入:w下载插件(这里需要在命令行中使用科学上网，如果没下起则多下几次)。本次配置使用的是nvim 0.8.4，最好不要使用过高的版本，因为版本过高，telecope会无法使用等一系列报错。在~/.config文件下放入以下连接下载的配置文件。
Ubuntu 22.04 上配置 LunarVim 浏览linux kernel代码
weixin_44420689的博客
05-08 1187
微软的Visual Studio Code 无疑是目前最流行的代码IDE, 最丰富的插件,最容易上手,但缺点也是有的,比如还是有许多操作需要鼠标来完成,特别是使用laptop看代码,使用鼠标是很不方便的一件事,查看远程机器上的代码总没有ssh再去vim编辑来得方便.
Linux下配置lunavim
weixin_46120107的博客
06-18 1543
lunarvim配置安装的3种方法。保证一定能够成功
Windows下Vim的简单配置
weixin_44586474的博客
10-06 832
前言 做为一个程序员，Linux系统和Vim编译器是躲不过，必须要学习的。VsCode、JetBrians、Eclipse包括Atom等平台给我们提供了良好的语言开发环境，省去了我们很多的麻烦。但如果我们不了解语言编译测试的根本，而只是利用各种工具帮助我们解决那些问题，我们永远也不能说真正掌握了这门语言，更多的只是掌握了这个工具。Vim对于程序员和开发者来说是很有必要的，接下来我会介绍在Window系统下Vim的简单配置，以及可能会遇到的问题 下载 上浏览器在官网找到Vim的最新版本进行下载即可，我是在这个
『Neovim』配置教程
ReturnTmp的博客
05-13 5580
Neovim 个人配置学习笔记
Neovim配置
qq_63122679的博客
07-08 2396
使用包管理器安装stow，然后mkdir ~/.dotfiles，之后可以把所有的dotfiles放进这个文件夹进行集中管理，写完后在~/.dotfiles这个路径下使用stow xxx 就可以把xxx软链接到~里面。dap的思路和lsp是一样的，也是将调试这个步骤与编辑器分开，进行解耦操作，这种思想简单来说就是标准化一个抽象协议，用于开发工具如何与具体调试器通信。至于lint和format就可以简单理解为是语法的静态分析（lsp的server本身也有这个能力，但是可以添加其他工具增强）和代码的格式化。
NeoVim 安装及配置
Auto
03-27 1万+
NeoVim安装
安装配置neovim详细教程
热门推荐
吾无法无天的博客
02-06 2万+
安装配置neovim（系统：deepin）环境配置安装nodejs安装python环境其他安装安装配置neovim安装neovim安装插件管理器安装插件tab补全安装coc.nvim配置C++环境：其他语言配置配色 环境配置 安装nodejs 首先安装nodejs(后面安装coc.nvim要用): 官网下载：nodejs下载 然后解压到一个目录，我在home目录下新建了一个“软件”目录，创建软链接： sudo ln -s /data/home/ykh/软件/nodejs/bin/node /usr/loc
干掉vim的神奇neovim替代IDE, 来教你快速上手配置，保姆教程
weixin_51195001的博客
03-10 1379
干掉vim的神奇neovim替代IDE, 来教你快速上手配置，保姆教程
neovim-qt.zip
08-23
neovim-qt
neovim-0.4.3.tar.gz
03-05
这是neovim源码，在终端输入： tar -xvzf neovim-0.4.3.tar.gz 进行解压
leetcode括号生成python-neovim:neovim-init.vim
07-07
Neovim 配置文件 快捷键 文件操作 快捷键 行为 fw 保存文件 fq 退出文件 fwq 保存并退出文件 fqq 放弃保存直接退出文件 文本编辑 快捷键 行为 + 数字加1 - 数字减1 Y 复制到系统剪切板 <leader>J 将多行拼接为一行，...
Python库 | neovim-0.0.5.tar.gz
03-09
python库。 资源全名：neovim-0.0.5.tar.gz
nvim-tree.lua：用lua编写的neovim的文件浏览器树
02-03
nvim-tree.lua：用lua编写的neovim的文件浏览器树
vim与tmux配置文件及常用命令总结
最新发布
qq_55135139的博客
04-30 332
注意，以下命令均基于所给配置文件，默认命令前缀为。：全文件替换，“old”替换为“new”。：打开一个文件进行编辑。：不保存并强制退出。
燃冬之yum、vim和你
chestnut_orenge的博客
04-22 1538
了解了很多指令和权限，搞点真枪实弹来瞅瞅学Linux不是天天就在那掰扯指令玩，也不是就研究那个权限准备好迎接Linux相关工具的使用了么码农桑~
Linux基础——Linux开发工具(上)_vim
EterNity_TiMe_的计算机学习之路
04-25 696
首先在开始时，了解一下软件包是什么。在Linux下安装软件, 一个通常的办法是下载到程序的源代码, 并进行编译, 得到可执行程序.但是这样太麻烦了, 于是有些人把一些常用的软件提前编译好, 做成软件包放在一个服务器上, 通过包管理器可以很方便的获取到这个编译好的软件包, 直接进行安装.软件包和软件包管理器, 就好比 “App” 和 “应用商店” 这样的关系.
ubuntu配置neovim
11-26
以下是在Ubuntu上配置Neovim的步骤： 1. 安装Neovim 在终端中运行以下命令来安装Neovim： ```shell sudo apt-get update sudo apt-get install neovim ``` 2. 安装Python3和pip3 Neovim需要Python3支持，因此需要安装Python3和pip3。在终端中运行以下命令来安装： ```shell sudo apt-get install python3 python3-pip ``` 3. 安装Node.js和npm 如果你需要使用一些插件，例如coc.nvim，你需要安装Node.js和npm。在终端中运行以下命令来安装： ```shell sudo apt-get install nodejs npm ``` 4. 安装vim-plug插件管理器 在终端中运行以下命令来安装vim-plug插件管理器： ```shell curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs \ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim ``` 5. 配置init.vim文件 在终端中运行以下命令来创建init.vim文件： ```shell mkdir -p ~/.config/nvim touch ~/.config/nvim/init.vim ``` 然后将以下内容添加到init.vim文件中： ```vim " 启用vim-plug插件管理器 call plug#begin('~/.local/share/nvim/plugged') " 插件列表 Plug 'kyazdani42/nvim-tree.lua' " 其他插件... " 结束插件列表 call plug#end() " 配置插件 " nvim-tree require("nvim-tree").setup({ -- 配置选项 }) " 其他插件配置... ``` 6. 安装插件 在终端中运行以下命令来安装插件： ```vim :PlugInstall ``` 7. 配置插件 根据你安装的插件，你需要在init.vim文件中添加相应的配置。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值