dotnvim 项目教程

dotnvim 项目教程

dotnvim Neovim Lua configuration pre-configured for Java, JavaScript, Typescript etc... 项目地址: https://gitcode.com/gh_mirrors/do/dotnvim

1. 项目的目录结构及介绍

dotnvim/
├── after/
│   └── ftplugin/
├── doc/
├── lua/
│   └── nvim/
├── scripts/
├── spell/
├── .dockerignore
├── .gitignore
├── .gitmodules
├── .luacheckrc
├── .luarc.json
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
├── init.lua
├── lazy-lock.json
└── stylua.toml

目录结构介绍

• after/ftplugin/: 存放文件类型特定的插件配置。
• doc/: 存放项目的文档文件。
• lua/nvim/: 存放 Neovim 的 Lua 配置文件。
• scripts/: 存放项目的脚本文件。
• spell/: 存放拼写检查相关的文件。
• .dockerignore: Docker 忽略文件。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• .luacheckrc: Lua 代码检查配置文件。
• .luarc.json: Lua 配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• docker-compose.yml: Docker Compose 配置文件。
• init.lua: Neovim 的初始化配置文件。
• lazy-lock.json: 插件懒加载配置文件。
• stylua.toml: Lua 代码格式化配置文件。

2. 项目的启动文件介绍

init.lua

init.lua 是 Neovim 的初始化配置文件，包含了项目的核心配置。它负责加载所有的插件、设置全局变量、配置编辑器行为等。

-- init.lua 文件内容示例
require('nvim')

docker-compose.yml

docker-compose.yml 文件用于定义和运行多容器 Docker 应用程序。它包含了 Neovim 的 Docker 环境配置。

version: '3'
services:
  nvim:
    build: .
    volumes:
      - .:/root/.config/nvim

3. 项目的配置文件介绍

.luarc.json

.luarc.json 是 Lua 的配置文件，用于配置 Lua 代码的格式化和检查工具。

{
  "indent_style": "space",
  "indent_size": 2
}

lazy-lock.json

lazy-lock.json 文件用于配置插件的懒加载行为，确保插件只在需要时加载，提高启动速度。

{
  "plugins": {
    "plugin1": {
      "load": "on_event"
    },
    "plugin2": {
      "load": "on_filetype"
    }
  }
}

stylua.toml

stylua.toml 是 Lua 代码格式化工具 StyLua 的配置文件，用于定义代码格式化的规则。

column_width = 80
indent_width = 2

通过以上配置文件，可以灵活地调整 Neovim 的行为和外观，满足不同开发者的需求。

dotnvim Neovim Lua configuration pre-configured for Java, JavaScript, Typescript etc... 项目地址: https://gitcode.com/gh_mirrors/do/dotnvim