Fyler.nvim API参考open、toggle、close、getcwd公开接口与:Fyler命令完整清单【免费下载链接】fyler.nvimA neovim file manager which can edit file system like a buffer with tree view项目地址: https://gitcode.com/gh_mirrors/fy/fyler.nvimFyler.nvim 是一款 Neovim 文件管理器插件让你像编辑 buffer 一样操作文件系统并呈现完整的文件树视图。本文是它的 API 参考手册系统整理open、toggle、close、getcwd四个公开接口与:Fyler命令的完整用法帮你快速上手这个 Neovim 文件树工具。一屏看懂4 个公开接口 1 个命令Fyler.nvim 的公开 API 非常精简——4 个接口 1 个用户命令全部围绕打开、关闭、切换、查询四个动作。先建立全局认知接口 / 命令作用一句话说明Fyler.open(opts)打开文件管理器窗口已存在时直接聚焦不会重复打开Fyler.toggle(opts)开/关切换打开着就关关着就开适合做快捷键Fyler.close()关闭文件管理器当前 tab 没有实例时安全无副作用Fyler.getcwd()获取当前目录返回文件树伪根目录即树顶所在路径:Fyler [api] [kv]命令行入口一个命令覆盖所有 API还支持范围参数所有接口都挂在同一个模块上通过require(fyler)获取setup完成后还会注册全局变量_G.Fyler可直接用Fyler.open()调用。前置条件先跑一次 Fyler.setup所有接口在Fyler.setup()之后才可用见 lua/fyler.lua 中setup函数内的 Public APIs 段落。setup有两个硬性约定只能调用一次重复调用会提示 Fyler.nvim can be setup once 并直接返回要求 Neovim ≥ 0.11低版本会收到错误通知最小配置只需一行放在 lazy.nvim 的opts里即可require(fyler).setup({})逐个拆解4 个公开 API 接口1. Fyler.open(opts) —— 打开文件树窗口签名Fyler.open(opts?)参数opts为可选的配置表类型fyler.FinderOpts。行为要点不重复打开如果同参数的文件树窗口已存在直接聚焦源码见lua/fyler/finder.lua的Finder:open按 tab 隔离每个 tab 页持有独立实例传不同opts会关闭旧实例再新建支持自定义根目录root_path决定从哪个目录开始展示local fyler require(fyler) fyler.open() -- 默认打开跟随当前工作目录 fyler.open({ kind split_left_most }) -- 在最左侧分栏打开 fyler.open({ root_path ~ }) -- 从主目录打开最常见的用法是绑到 leader 键上按一下就展开文件管理器vim.keymap.set(n, leadere, fyler.open, { desc Fyler.nvim - Open })2. Fyler.toggle(opts) —— 一键开/关切换签名Fyler.toggle(opts?)参数规则与open相同。这是做按键绑定时最实用的接口——打开着就关闭、关着就打开实现见lua/fyler/finder.lua的Finder:togglevim.keymap.set(n, leadere, fyler.toggle, { desc Fyler.nvim - Toggle }) 新手建议用toggle替代open绑定按键体验更贴近按一下就出现/消失的直觉。3. Fyler.close() —— 关闭文件管理器签名Fyler.close()无参数。行为要点当前 tab 没有文件树实例时直接返回不会报错replace模式下会智能恢复你之前的 buffer而不是留一个空白窗口floating模式关闭后会自动把焦点还给原来的窗口4. Fyler.getcwd() —— 获取当前目录签名Fyler.getcwd()无参数返回值为字符串或nil。它返回的不是系统当前目录而是文件树的pseudo_root_path伪根路径——即文件树顶部落在哪个目录。当你按-逐级向上导航后这个值会跟着变。当前没有实例时返回nil调用前建议判空local dir Fyler.getcwd() if dir then print(文件树当前位于: .. dir) end 注意默认配置下follow_root_dir true文件树移动目录时会同步 tab 的本地工作目录此时getcwd的结果通常与vim.fn.getcwd(-1, -1)一致。:Fyler 命令完整清单:Fyler由 plugin/fyler.lua 注册、lua/fyler/command.lua 实现它其实是一个API 转发器——把命令行的名字和参数直接映射到公开接口上。命令写法等价 Lua效果:FylerFyler.open({})按默认配置打开:Fyler openFyler.open({})显式调用 open省略 API 名时默认就是 open:Fyler toggleFyler.toggle({})开/关切换:Fyler closeFyler.close({})关闭文件树:Fyler getcwdFyler.getcwd({})执行并显示当前目录:Fyler root_path~/codeFyler.open({ root_path ~/code })指定目录打开:Fyler kindfloatingFyler.open({ kind floating })浮动窗口方式打开:1,5Fyler选中目录名—把选中的目录路径作为root_path三个实用细节参数格式keyvalue形式可叠加多个如:Fyler kindsplit_left width20%未知 API 会友好提示输入:Fyler xxx时收到 Unknown API 通知不会报错崩溃范围range参数命令声明了range true如果你在某行目录名上划选后执行:Fyler它会自动把该目录作为根路径打开10 种窗口打开方式kind 参数速查open/toggle的opts.kind决定文件树长什么样共 10 种取值定义于lua/fyler/finder.lua顶部的fyler.FinderWindowKindkind效果适合场景replace替换当前窗口默认快速查看、临时浏览floating浮动窗口默认 60%×80% 居中不想打乱窗口布局split_above/split_below在上方/下方分栏就近对比文件split_above_all/split_below_all对当前 tab 所有窗口分栏全局布局split_left/split_right在左侧/右侧分栏就近对比文件split_left_most/split_right_most贴最左/最右边缘常驻侧边栏文件管理器 想要 Neo-tree 式的常驻侧栏就把split_left_most写进 setup 的kind配置项全局生效。文件树内默认按键清单打开文件树后以下按键开箱即用定义于 lua/fyler/config.lua 的mappings字段按键动作说明-上跳一级回到父目录.进入目录进入光标下的目录BS折叠父目录收起上一级展开项回到根跳回文件树根目录CR打开文件通过窗口选择器挑一个窗口打开C-S水平分栏打开C-V垂直分栏打开C-T新 tab 打开C-R强制刷新递归重建整棵树g.切换隐藏文件显示/隐藏点文件等gi切换缩进线文件树层级引导线开关q关闭文件树等价于Fyler.close()所有按键都可以在setup的mappings全局或kind_presets按窗口样式中覆盖、禁用或替换为自定义函数。三个高频组合场景场景一侧边栏文件管理器require(fyler).setup({ kind split_left_most, width 25% })场景二toggle 快捷键 浮动窗口vim.keymap.set(n, leaderf, function() require(fyler).toggle({ kind floating }) end, { desc Fyler - Toggle Floating })场景三让插件自动跟随当前文件follow_current_file默认开启切换 buffer 时文件树会自动展开到对应位置并把光标移过去无需任何额外调用。源码路径索引想深入某一接口的实现细节按路径直奔源码想查什么看哪里4 个公开 API 的定义lua/fyler.luasetup 内 Public APIs 段:Fyler命令的参数解析lua/fyler/command.luaopen/close/toggle 窗口逻辑lua/fyler/finder.lua默认配置与按键表lua/fyler/config.lua文件树状态与目录导航lua/fyler/state.luagit / trash / watcher 扩展lua/fyler/extensions/目录命令自动补全行为ftplugin/fyler_finder.lua帮助文档doc/fyler.txt四个接口 一个命令就是 Fyler.nvim 全部的对外能力面。掌握open打开、toggle切换、close关闭、getcwd查询这四件事再配上:Fyler命令的参数技巧这个 Neovim 文件管理器就能完全融入你的工作流。【免费下载链接】fyler.nvimA neovim file manager which can edit file system like a buffer with tree view项目地址: https://gitcode.com/gh_mirrors/fy/fyler.nvim创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考