Neovim 专注模式插件 zen-mode.nvim 使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00341/article/details/148917768

Neovim 专注模式插件 zen-mode.nvim 使用指南

zen-mode.nvim 🧘 Distraction-free coding for Neovim 项目地址: https://gitcode.com/gh_mirrors/ze/zen-mode.nvim

概述

zen-mode.nvim 是一款专为 Neovim 设计的专注模式插件，它通过创建一个全屏浮动窗口，帮助开发者屏蔽干扰，专注于代码编写。该插件支持 Neovim 0.5.0 及以上版本，特别适合需要深度专注的编程场景。

核心特性

无干扰环境：创建一个全新的全屏浮动窗口，不影响现有窗口布局
智能适配：完美兼容其他浮动窗口（如 LSP 悬停提示、WhichKey 等）
动态调整：支持运行时调整窗口大小
视觉优化：可配置背景遮罩效果，降低周围内容的视觉干扰
界面精简：自动隐藏状态栏，可选隐藏行号、标记列等界面元素
高度可定制：提供打开/关闭时的 Lua 回调函数
插件集成：支持与多种终端模拟器（Kitty、Alacritty、WezTerm）和工具（tmux、gitsigns）集成

安装要求

Neovim 0.5.0 或更高版本（需包含 2021年5月15日后的 z-index 功能）
可选搭配 Twilight 插件实现代码区域高亮效果

安装方法

使用你偏好的包管理器安装插件，以下是使用 Lazy.nvim 的配置示例：

{
  "folke/zen-mode.nvim",
  opts = {
    -- 可在此处添加自定义配置
    -- 或留空使用默认设置
  }
}

详细配置

zen-mode.nvim 提供了丰富的配置选项，以下是默认配置及说明：

{
  window = {
    backdrop = 0.95, -- 背景遮罩透明度（1表示不遮罩）
    width = 120,     -- 窗口宽度（数值>1表示绝对单元格数，<=1表示编辑器比例）
    height = 1,      -- 窗口高度（同上）
    options = {      -- 窗口选项
      -- signcolumn = "no",   -- 禁用标记列
      -- number = false,      -- 禁用行号
      -- relativenumber = false, -- 禁用相对行号
      -- 其他 vim.wo 选项...
    },
  },
  plugins = {
    options = {
      enabled = true,
      ruler = false,    -- 禁用命令行区域标尺
      showcmd = false,  -- 禁用屏幕最后一行命令显示
      laststatus = 0,   -- 关闭状态栏
    },
    twilight = { enabled = true },  -- 启用 Twilight 集成
    gitsigns = { enabled = false }, -- 禁用 git 标记
    tmux = { enabled = false },     -- 禁用 tmux 状态栏
    -- 终端模拟器集成配置
    kitty = { enabled = false, font = "+4" },
    alacritty = { enabled = false, font = "14" },
    wezterm = { enabled = false, font = "+4" },
  },
  -- 自定义回调函数
  on_open = function(win) end,
  on_close = function() end,
}

使用方式

基本使用：在命令模式下输入 :ZenMode 即可切换专注模式
高级使用：通过 Lua API 调用并传递自定义参数

require("zen-mode").toggle({
  window = {
    width = .85 -- 设置窗口宽度为编辑器宽度的85%
  }
})

终端模拟器集成

WezTerm 特别配置

要实现 WezTerm 字体大小自动调整功能，需在 WezTerm 配置中添加以下代码：

wezterm.on('user-var-changed', function(window, pane, name, value)
    local overrides = window:get_config_overrides() or {}
    if name == "ZEN_MODE" then
        local incremental = value:find("+")
        local number_value = tonumber(value)
        if incremental ~= nil then
            while (number_value > 0) do
                window:perform_action(wezterm.action.IncreaseFontSize, pane)
                number_value = number_value - 1
            end
            overrides.enable_tab_bar = false
        elseif number_value < 0 then
            window:perform_action(wezterm.action.ResetFontSize, pane)
            overrides.font_size = nil
            overrides.enable_tab_bar = true
        else
            overrides.font_size = number_value
            overrides.enable_tab_bar = false
        end
    end
    window:set_config_overrides(overrides)
end)