Tiny Inline Diagnostic 使用教程

Tiny Inline Diagnostic 使用教程

tiny-inline-diagnostic.nvim A Neovim plugin that display prettier diagnostic messages. Display diagnostic messages where the cursor is, with icons and colors. 项目地址: https://gitcode.com/gh_mirrors/ti/tiny-inline-diagnostic.nvim

1. 项目目录结构及介绍

tiny-inline-diagnostic.nvim 是一个为 Neovim 编辑器设计的插件，它可以在光标位置显示格式化的诊断信息，包括图标和颜色。项目的目录结构如下：

tiny-inline-diagnostic.nvim/
├── .github/
│   └── workflows/
├── doc/
│   └── lua/
│       └── tiny-inline-diagnostic/
├── LICENSE
├── README.md
└── selene.toml

• .github/workflows/: 存放 GitHub Actions 工作流文件，用于自动化测试、构建等流程。
• doc/lua/tiny-inline-diagnostic/: 包含了插件的 Lua 源代码。
• LICENSE: 项目的 MIT 许可证文件。
• README.md: 项目的自述文件，介绍了插件的功能、安装和使用方法。
• selene.toml: Selene 配置文件，Selene 是一个 Neovim 插件管理器。

2. 项目的启动文件介绍

selene.toml 是项目的启动配置文件，用于配置 Selene 插件管理器。它定义了如何加载 tiny-inline-diagnostic.nvim 插件。以下是一个基本的配置示例：

[package]
name = "tiny-inline-diagnostic"
description = "A Neovim plugin that display prettier diagnostic messages."
repository = "https://github.com/rachartier/tiny-inline-diagnostic.nvim"
author = "Rachartier"
version = "0.1.0"

在 Neovim 中，您需要设置 vim.diagnostic.config({ virtual_text = false }) 以确保不显示所有诊断信息，只显示 tiny-inline-diagnostic 插件提供的格式化信息。

3. 项目的配置文件介绍

README.md 文件中包含了插件的详细配置选项说明。以下是一些主要配置选项的介绍：

• preset: 选择诊断信息的风格预设，如 "modern"、"classic"、"minimal" 等。
• transparent_bg: 设置诊断信息背景是否透明。
• hi: 定义不同严重性级别的诊断信息的高亮组。
• background: 诊断信息的背景色。
• mixing_color: 用于混合背景色的颜色。
• show_source: 是否显示诊断信息的来源。
• use_icons_from_diagnostic: 是否使用诊断配置中定义的图标。
• set_arrow_to_diag_color: 是否将箭头图标颜色设置为第一个诊断严重性的颜色。
• add_messages: 是否在启用多行诊断时添加消息。
• throttle: 光标移动时更新诊断信息的延迟时间（毫秒）。
• softwrap: 在多少字符后开始自动换行。
• multilines: 是否启用多行诊断信息。
• show_all_diags_on_cursorline: 是否在光标行显示所有诊断信息。
• enable_on_insert: 是否在插入模式下启用诊断信息。
• enable_on_select: 是否在选择模式下启用诊断信息。
• overflow: 设置诊断信息处理溢出的方式。
• break_line: 设置诊断信息在多少字符后断行。
• format: 自定义诊断信息的格式函数。
• virt_texts: 设置虚拟文本的显示优先级。
• severity: 过滤诊断信息的严重性级别。
• overwrite_events: 事件重写，一般不需要更改。

要使用插件，您需要在 Neovim 配置文件中包含 tiny-inline-diagnostic.nvim，并按需配置上述选项。

tiny-inline-diagnostic.nvim A Neovim plugin that display prettier diagnostic messages. Display diagnostic messages where the cursor is, with icons and colors. 项目地址: https://gitcode.com/gh_mirrors/ti/tiny-inline-diagnostic.nvim