如何使用纯Vimscript代码创建symlink

所有实现完全基于Vim原生内建能力，不通过system()、!等接口调用任何外部系统命令，兼容Vim 7.4.1556及以上版本、全版本Neovim。

核心原生接口 #

Vim从7.4.1556版本开始内置了symlink()函数，直接封装了操作系统创建符号链接的系统调用，是纯脚本实现该需求的唯一官方原生方案，函数签名如下：

symlink({source}, {target})

参数规则：

• {source}：符号链接指向的真实文件/目录路径，支持相对路径、绝对路径
• {target}：待创建的符号链接文件本身的存放路径
• 返回值：创建成功返回0，失败返回-1，失败详情会存入内置变量v:errmsg

可复用实现代码 #

下面是带前置校验、错误提示的生产可用封装，直接放到你的Vim脚本里即可调用：

function! lf#create_symlink(source, target, ...) abort
    let l:force = get(a:000, 0, v:false)
    " 校验源路径合法性
    if !filereadable(a:source) && !isdirectory(a:source)
        echohl ErrorMsg
        echo printf('[symlink error] 源路径不存在: %s', a:source)
        echohl None
        return v:false
    endif
    " 处理已存在的目标路径
    if filereadable(a:target) || isdirectory(a:target)
        if !l:force
            echohl WarningMsg
            echo printf('[symlink warn] 目标路径已存在，跳过创建: %s', a:target)
            echohl None
            return v:false
        endif
        call delete(a:target)
    endif
    " 自动创建父目录（不需要可删除以下3行）
    let l:target_parent = fnamemodify(a:target, ':h')
    if !isdirectory(l:target_parent)
        call mkdir(l:target_parent, 'p')
    endif
    " 调用原生接口创建软链接
    let l:res = symlink(a:source, a:target)
    if l:res != 0
        echohl ErrorMsg
        echo printf('[symlink error] 创建失败: %s', v:errmsg)
        echohl None
        return v:false
    endif
    return v:true
endfunction

操作说明 #

• 常规调用：执行call lf#create_symlink('真实文件路径', '要创建的软链接路径')即可完成创建
• 强制覆盖调用：如果需要覆盖已存在的目标路径，传入第三个参数为v:true，即call lf#create_symlink('源路径', '目标路径', v:true)
• 路径处理注意点：
  • 传入相对路径时，Vim默认基于当前工作目录（getcwd()返回值）解析路径，不会自动转换成相对于软链接位置的相对路径
  • 如果需要软链接存储绝对真实路径，可以先把源路径通过fnamemodify(a:source, ':p')做归一化处理再传入
  • 该函数同时支持文件、目录类型的软链接创建，无需额外传参区分
• 跨平台注意点：Windows系统下创建软链接需要当前Vim进程拥有管理员权限，或系统已开启开发者模式，否则会触发权限错误。

低版本兼容说明 #

Vim 7.4.1556是2016年发布的版本，在此之前的Vim版本没有暴露创建软链接的原生接口，不存在纯Vimscript无外部命令的实现方式，这类场景只能选择升级Vim版本，或通过外部命令调用实现。
注意不要和Vim内置的hardlink()函数混淆，该函数用于创建硬链接，和符号链接的文件系统逻辑完全不同。

内容的提问来源于stack exchange，提问作者Benjamin Frazier