flatten.nvim 使用教程

flatten.nvim 使用教程

flatten.nvim Open files and command output from wezterm, kitty, and neovim terminals in your current neovim instance 项目地址: https://gitcode.com/gh_mirrors/fl/flatten.nvim

1. 项目介绍

flatten.nvim 是一个用于 Neovim 的插件，旨在简化从终端（如 Wezterm、Kitty 和 Neovim 终端）打开文件和命令输出的过程。它允许用户在当前的 Neovim 实例中直接打开文件，而无需创建嵌套的会话。此外，它还支持从终端将命令输出管道到新的 Neovim 缓冲区中。

2. 项目快速启动

安装

使用 folke/lazy.nvim 安装

require("lazy").setup({
  {
    "willothy/flatten.nvim",
    config = true,
    -- 或者通过 opts 传递配置
    -- opts = {},
    -- 确保它在打开文件时首先运行，以最小化延迟
    lazy = false,
    priority = 1001,
  },
})

使用 nvim-neorocks/rocks.nvim 安装

:Rocks install flatten.nvim

然后在 plugins/flatten.lua 中配置：

require("flatten").setup({
  -- 你的配置
})

使用

打开文件

nvim file1 file2

强制阻塞模式

nvim --cmd 'let g:flatten_wait=1' file1

在差异模式下打开文件

nvim -d file1 file2

启用阻塞模式

export VISUAL="nvim --cmd 'let g:flatten_wait=1'"

启用手册页格式化

export MANPAGER="nvim +Man"

3. 应用案例和最佳实践

案例1：从终端快速打开文件

在终端中，你可以直接使用 nvim file1 file2 命令来打开文件，而不需要启动一个新的 Neovim 实例。这对于快速编辑多个文件非常有用。

案例2：使用阻塞模式进行 Git 提交

在 Git 提交时，你可以使用阻塞模式来确保 Neovim 等待提交完成后再继续工作。例如：

nvim -b file1

最佳实践

• 配置回调函数：通过配置回调函数，你可以自定义文件打开后的行为，例如在打开文件后自动执行某些命令。
• 使用智能打开模式：通过设置 window.open 为 "smart"，可以避免在特殊缓冲区中打开文件。

4. 典型生态项目

1. folke/lazy.nvim

lazy.nvim 是一个用于管理 Neovim 插件的插件管理器，它可以帮助你更方便地安装和管理 flatten.nvim 等插件。

2. nvim-neorocks/rocks.nvim

rocks.nvim 是一个基于 LuaRocks 的 Neovim 插件管理器，它允许你通过简单的命令安装 flatten.nvim。

3. wezterm 和 kitty

wezterm 和 kitty 是两个流行的终端模拟器，flatten.nvim 支持在这两个终端中直接打开文件和命令输出。

通过这些生态项目，你可以更好地集成 flatten.nvim 到你的 Neovim 工作流中，提升工作效率。

flatten.nvim Open files and command output from wezterm, kitty, and neovim terminals in your current neovim instance 项目地址: https://gitcode.com/gh_mirrors/fl/flatten.nvim