translate.nvim 项目教程

translate.nvim 项目教程

translate.nvimUse any external translate command/API in nvim.项目地址:https://gitcode.com/gh_mirrors/tr/translate.nvim

1. 项目目录结构及介绍

translate.nvim/
├── lua/
│   └── translate/
│       ├── init.lua
│       ├── config.lua
│       ├── engine.lua
│       └── utils.lua
├── LICENSE
├── README.md
└── plugin/
    └── translate.vim

• lua/: 存放项目的核心代码。
  • translate/: 包含项目的各个模块。
    • init.lua: 项目的入口文件，负责初始化插件。
    • config.lua: 配置文件，定义了插件的默认配置和用户自定义配置。
    • engine.lua: 翻译引擎的实现，支持多种翻译API。
    • utils.lua: 工具函数，提供一些通用的辅助功能。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档，包含基本的使用说明和安装方法。
• plugin/: 存放Vim插件文件。
  • translate.vim: 插件的主文件，负责加载和配置插件。

2. 项目启动文件介绍

lua/translate/init.lua 是项目的启动文件，主要负责以下功能：

• 加载项目的各个模块。
• 初始化插件的配置。
• 注册插件的命令和快捷键。

-- 加载配置文件
require('translate.config')

-- 加载翻译引擎
require('translate.engine')

-- 加载工具函数
require('translate.utils')

-- 注册插件命令和快捷键
vim.api.nvim_create_user_command('Translate', function(opts)
  -- 翻译逻辑
end, { nargs = '?' })

vim.keymap.set('n', '<space>T', '<cmd>Translate<CR>', { silent = true })

3. 项目配置文件介绍

lua/translate/config.lua 是项目的配置文件，定义了插件的默认配置和用户自定义配置。

local config = {
  output = {
    float_win = {
      max_width = 40,
      max_height = 5,
      close_on_cursor_move = true,
    },
    clipboard = true,
    notify = true,
    insert = false,
  },
  engine = 'google',
  default_target_lang = 'en',
}

-- 用户自定义配置
local user_config = require('translate.user_config')

-- 合并默认配置和用户配置
for key, value in pairs(user_config) do
  config[key] = value
end

return config

用户可以通过在 init.lua 中覆盖默认配置来定制插件的行为。例如：

require('translate').setup({
  output = {
    float_win = {
      max_width = 50,
      max_height = 10,
    },
    clipboard = false,
  },
  engine = 'bing',
  default_target_lang = 'zh',
})

通过以上配置，用户可以自定义翻译结果的输出方式、使用的翻译引擎以及默认的目标语言。

translate.nvimUse any external translate command/API in nvim.项目地址:https://gitcode.com/gh_mirrors/tr/translate.nvim