作者目前没有实现官方 neovim 插件，建议根据实际使用情况自行配置。

以 neovim + nvim-cmp 为例，下面给出一些可行的配置方法 (需填入正确的程序路径和 rime 需要的目录)。

初始化 rime-ls

为每个 buffer 开启一个 lsp server (不推荐)

local start_rime = function()
  local client_id = vim.lsp.start_client({
    name = "rime-ls",
    cmd = { '/home/wlh/coding/rime-ls/target/release/rime_ls' },
    init_options = {
      enabled = false, -- 初始关闭, 手动开启
      shared_data_dir = "/usr/share/rime-data", -- rime 公共目录
      user_data_dir = "~/.local/share/rime-ls", -- 指定用户目录, 最好新建一个
      log_dir = "~/.local/share/rime-ls", -- 日志目录
      max_candidates = 10, -- [v0.2.0 后不再有用] 与 rime 的候选数量配置最好保持一致
      paging_characters = {",", ".", "-", "="}, -- [since v0.2.4] 这些字符会强制触发一次补全，可用于翻页 见 issue #13
      trigger_characters = {}, -- 为空表示全局开启
      schema_trigger_character = "&" -- [since v0.2.0] 当输入此字符串时请求补全会触发 “方案选单”
      always_incomplete = false -- [since v0.2.3] true 强制补全永远刷新整个列表，而不是使用过滤
      max_tokens = 0 -- [since v0.2.3] 大于 0 表示会在删除到这个字符个数的时候，重建所有候选词，而不使用删除字符操作
      preselect_first = false -- [since v0.2.3] 是否默认第一个候选项是选中状态，default false
    },
  });
  vim.lsp.buf_attach_client(0, client_id)
  if client_id then
    -- 定义常用命令
    vim.lsp.buf_attach_client(0, client_id)
    vim.api.nvim_create_user_command('RimeToggle', function ()
      -- before v0.1.2
      -- vim.lsp.buf.execute_command({ command = "toggle-rime" })
      -- since v0.1.2
      vim.lsp.buf.execute_command({ command = "rime-ls.toggle-rime" })
    end, { nargs = 0 })
    -- since v0.1.2
    vim.api.nvim_create_user_command('RimeSync', function ()
      vim.lsp.buf.execute_command({ command = "rime-ls.sync-user-data" })
    end, { nargs = 0 })

    -- 自定义快捷键
    vim.keymap.set('n', '<leader><space>', '<cmd>RimeToggle<cr>')
    vim.keymap.set('n', '<leader>rs', '<cmd>RimeSync<cr>')
    -- ...
  end
end
-- 对每个文件都默认开启
vim.api.nvim_create_autocmd('BufReadPost', {
  callback = function()
    start_rime()
  end,
  pattern = '*',
})

以上配置进入文件便开启 LSP, 用快捷键切换是否开启补全

基于 lspconfig 的全局 LSP 状态

如果希望保持一个全局的输入法状态，可以参考以下配置给 lspconfig 添加一个 custom server：

local M = {}

function M.setup_rime()
  -- global status
  vim.g.rime_enabled = false

  -- update lualine
  local function rime_status()
    if vim.g.rime_enabled then
      return 'ㄓ'
    else
      return ''
    end
  end

  require('lualine').setup({
    sections = {
      lualine_x = { rime_status, 'encoding', 'fileformat', 'filetype' },
    }
  })

  -- add rime-ls to lspconfig as a custom server
  -- see `:h lspconfig-new`
  local lspconfig = require('lspconfig')
  local configs = require('lspconfig.configs')
  if not configs.rime_ls then
    configs.rime_ls = {
      default_config = {
        name = "rime_ls",
        cmd = { 'rime_ls' },
        -- cmd = vim.lsp.rpc.connect('127.0.0.1', 9257),
        filetypes = { '*' },
        single_file_support = true,
      },
      settings = {},
      docs = {
        description = [[
https://www.github.com/wlh320/rime-ls

A language server for librime
]],
      }
    }
  end

  local rime_on_attach = function(client, _)
    -- 定义常用命令
    vim.api.nvim_create_user_command('RimeToggle', function ()
      client.request('workspace/executeCommand',
        { command = "rime-ls.toggle-rime" },
        function(_, result, ctx, _)
          if ctx.client_id == client.id then
            vim.g.rime_enabled = result
          end
        end
      )
    end, { nargs = 0 })
    vim.api.nvim_create_user_command('RimeSync', function ()
      vim.lsp.buf.execute_command({ command = "rime-ls.sync-user-data" })
    end, { nargs = 0 })

    -- 自定义快捷键
    vim.keymap.set('n', '<leader><space>', '<cmd>ToggleRime<cr>')
    vim.keymap.set('i', '<C-x>', '<cmd>ToggleRime<cr>')
    vim.keymap.set('n', '<leader>rs', '<cmd>RimeSync<cr>')
    -- ...
  end

  -- nvim-cmp supports additional completion capabilities, so broadcast that to servers
  local capabilities = vim.lsp.protocol.make_client_capabilities()
  capabilities = require('cmp_nvim_lsp').default_capabilities(capabilities)

  lspconfig.rime_ls.setup {
    init_options = {
      enabled = vim.g.rime_enabled,
      shared_data_dir = "/usr/share/rime-data",
      user_data_dir = "~/.local/share/rime-ls",
      log_dir = "~/.local/share/rime-ls",
      max_candidates = 9,
      trigger_characters = {},
      schema_trigger_character = "&" -- [since v0.2.0] 当输入此字符串时请求补全会触发 “方案选单”
    },
    on_attach = rime_on_attach,
    capabilities = capabilities,
  }
end

return M

按需调整 cmp 的排序

cmp 会对补全候选进行排序, 为了更好的使用体验, 还需要配置 nvim-cmp

-- cmp 會自己排序, 要配置裏把 sort_text 手動提前
local cmp = require 'cmp'
local compare = require 'cmp.config.compare'
cmp.setup {
  -- 其他设置 blabla
  -- ......

  -- 设置排序顺序
  sorting = {
    comparators = {
      compare.sort_text,
      compare.offset,
      compare.exact,
      compare.score,
      compare.recently_used,
      compare.kind,
      compare.length,
      compare.order,
    }
  },

  -- 其他配置 blabla
  -- ......
}

状态栏显示

since v0.1.2, 可以参考以下配置在 lualine 显示 rime-ls 的当前状态:

-- toggle rime
vim.b.rime_enabled = false
local toggle_rime = function(client_id)
  vim.lsp.buf_request(0, 'workspace/executeCommand',
    { command = "rime-ls.toggle-rime" },
    function(_, result, ctx, _)
      if ctx.client_id == client_id then
        vim.b.rime_enabled = result
      end
    end
  )
end

-- update lualine
local function rime_status()
  if vim.b.rime_enabled then
    return 'ㄓ'
  else
    return ''
  end
end

require('lualine').setup({
  sections = {
    lualine_x = { rime_status, 'encoding', 'fileformat', 'filetype' },
  }
})

特定 buffer 无法使用问题

相关 issue ：copilot-chat窗口不能正常触发。

该问题往往是因为这些 buffer 被设置了 hidden 属性，导致 rime-ls 没有启动。可以通过运行 :LspStart rime_ls 来手动启动 rime-ls，或者使用以下自动命令（这里两种方法均需要使用全局 LSP 配置）：

-- update the variable to your needs
local rime_ls_filetypes = {'*'}
vim.api.nvim_create_autocmd('FileType', {
  pattern = rime_ls_filetypes,
  callback = function(env)
    -- some buffers cannot attach client automatically, we must attach manually.
    local rime_ls_client = vim.lsp.get_clients({ name = 'rime_ls' })
    if #rime_ls_client == 0 then
      vim.cmd('LspStart rime_ls')
      rime_ls_client = vim.lsp.get_clients({ name = 'rime_ls' })
    end
    if #rime_ls_client > 0 then
      vim.lsp.buf_attach_client(env.buf, rime_ls_client[1].id)
    end
  end
})

即使有了上面的配置，在 No Name 文件中依然不能自动启动，对于这种情况，需要先保存 No Name 文件，然后再重新打开。

通过 TCP 远程使用

将运行命令修改为 cmd = vim.lsp.rpc.connect('<ip>', <port>)。

还原输入法体验

这部分配置来自使用 nvim-cmp + rime-ls 配置 nvim 中文输入法。

为了不影响其他不需要中文输入地方的体验，这一部分的实现逻辑是在启动 rime-ls 时增加 key-mapping ，关闭时删除 key-mapping 实现。因此配置的整体结构如下：

map.set({ 'n', 'i' }, '<c-space>', function()
  -- We must check the status before the toggle
  if vim.g.rime_enabled then
    -- delete key mappings here
  else
    -- add key mappings here
  end
  -- toggle Rime
  vim.cmd('RimeToggle')
end, opts())

删除按键部分没有难度，后文将重点讨论添加按键部分。

首先给出几个基础函数：

local cmp = require'cmp'

-- Feed keys with term code
-- keys: the keys to feed
-- mode: n for no-remap, m for re-map
local function feedkeys(keys, mode)
    local termcodes = vim.api.nvim_replace_termcodes(keys, true, true, true)
    vim.api.nvim_feedkeys(termcodes, mode, false)
end

-- return true if the content contains Chinese characters
local function contain_chinese_character(content)
    for i = 1, #content do
        local byte = string.byte(content, i)
        if byte >= 0xE4 and byte <= 0xE9 then
            return true
        end
    end
    return false
end

-- Return true if the entry of cmp is acceptable
-- you can define some other rules here to accept more
-- in this situation we only think the entry
-- whose content contains Chinese or is like time is acceptable
local function rime_entry_acceptable(entry)
    return entry ~= nil and entry.source.name == "nvim_lsp"
        and entry.source.source.client.name == "rime_ls"
        and (entry.word:match("%d%d%d%d%-%d%d%-%d%d %d%d:%d%d:%d%d%") or contain_chinese_character(entry.word))
end

-- Return the first n entries which make rime_entry_acceptable(entry) return true
-- we call those entries rime-ls entries below
local function get_n_rime_ls_entries(n)
    local entries = cmp.get_entries()
    local result = {}
    if entries == nil or #entries == 0 then
        return result
    end
    for _, entry in ipairs(entries) do
        if rime_entry_acceptable(entry) then
            result[#result + 1] = entry
            if #result == n then
                break;
            end
        end
    end
    return result
end

-- Confirm the rime-ls entry
local function confirm_rime_ls_entry(entry)
    cmp.core:confirm(entry, { behavior = cmp.ConfirmBehavior.Insert }, function()
        cmp.core:complete(cmp.core:get_context({ reason = cmp.ContextReason.TriggerOnly }))
    end)
end

-- index: the index-th rime-ls entry
-- select_with_no_num: set true to upload the index-th rime-ls entry directly
--                     set false to feed index as number at first, then upload if only one rime-ls entry
-- return true if the number of rime-ls entries is enough
local function auto_upload_rime(index, select_with_no_num)
    local rime_ls_entries = get_n_rime_ls_entries(index)
    if #rime_ls_entries < index then
        return false
    end
    if select_with_no_num then
        confirm_rime_ls_entry(rime_ls_entries[index])
        return true
    end
    feedkeys(tostring(index), 'n')
    vim.schedule(function()
        -- auto upload when only one rime_ls entry
        -- this is lag, because we must wait for the next completion list pop up
        local first_rime_ls_entry = get_n_rime_ls_entries(2)
        if #first_rime_ls_entry ~= 1 then
            return
        end
        confirm_rime_ls_entry(first_rime_ls_entry[1])
    end)
    return true;
end

-- Feed a key with schedule
-- When k and v are not equal, feed v with remap mode,
-- otherwise feed k with no-remap mode
-- This function is used to make sure the completion not stop even if typing fast
-- and this function is also used when the original key is mapped to other functionality
local function feed_key(k, v)
    -- use schedule to make sure next input will trigger the completion list
    vim.schedule(function()
        if k == v then
            feedkeys(k, 'n')
        else
            feedkeys(v, 'm')
        end
    end)
end

注意：后文使用的按键可能被某些插件绑定了一些其他的功能（例如 auto-pairs 绑定 <space> 来在括号中插入两个空格），或者你自己绑定了一些功能，如果你想同时保留两部分功能，你可以参考空格上屏部分的配置。

空格上屏

对于空格已经被绑定的情况，先进行如下操作：

-- find a key will never be used, here we use <f30>
-- bind <f30> to the functionality that <space> should have
-- bind <space> to the functionality that <space> should have
map.set({ 'i' }, '<f30>', '<c-]><c-r>=AutoPairsSpace()<cr>', opts())
map.set({ 'i' }, '<space>', '<c-]><c-r>=AutoPairsSpace()<cr>', opts())

接下来绑定空格上屏的功能：

map.set({ 'i' }, '<space>', function()
    -- when having selected an entry we do not upload
    -- if you want to upload, comment those lines
    local entry = cmp.get_selected_entry()
    if entry ~= nil then
        -- if your <space> key is not bind to other functionality
        -- use feed_key('<space>', '<space>')
        feed_key('<space>', '<f30>')
        return
    end

    if not auto_upload_rime(1, true) then
        -- if your <space> key is not bind to other functionality
        -- use feed_key('<space>', '<space>')
        feed_key('<space>', '<f30>')
    end
end, opts())

auto_upload_rime(1, true) 意味着会直接 confirm 第一个 rime-ls 的候选词，这表示你不能再进行后续后续选择。如果你喜欢输入句子，而不是单个词，你可以将 true 改为 false。不过这样会导致快速输入时，输入法无法及时切换到下一个候选词。这是由 rime-ls 的设计决定的。

我个人建议在绑定空格和二三候选时使用 auto_upload_rime(x, true)，在绑定数字按键时使用 auto_upload_rime(x, false)。

二三候选

以 ; 和 ' 为例：

map.set({ 'i' }, ';', function()
    -- when having selected an entry we do not upload
    -- if you want to upload, comment those lines
    local entry = cmp.get_selected_entry()
    if entry ~= nil then
        feed_key(';', ';')
        return
    end

    if not auto_upload_rime(2, true) then
        feed_key(';', ';')
    end
end, opts())

map.set({ 'i' }, "'", function()
    -- when having selected an entry we do not upload
    -- if you want to upload, comment those lines
    local entry = cmp.get_selected_entry()
    if entry ~= nil then
        feed_key("'", "'")
        return
    end

    if not auto_upload_rime(3, true) then
        feed_key("'", "'")
    end
end, opts())

数字键选择

相关 issue ：用数字选词以后还需要一次空格才能上屏幕。

for numkey = 1, 9 do
    local numkey_str = tostring(numkey)
    map.set({ 'i' }, numkey_str, function()
        -- when having selected an entry we do not upload
        -- if you want to upload, comment those lines
        local entry = cmp.get_selected_entry()
        if entry ~= nil then
            feed_key(k, v)
            return
        end

        if not auto_upload_rime(numkey, false) then
            feed_key(numkey_str, numkey_str)
        end
    end, opts())
end

中文标点

相关 issue ：英文标点符号后空格才能触发补全。

如果使用 rime-ls 进行标点输入，因为 lsp 的特性必须伴随一次选择才能触发上屏，所以在输入标点时会有一些不同的体验。这里提供一种解决方案，即在输入标点时，先输入标点，然后再输入空格来实现插入中文标点, 首先设置 rime-ls 为西方标点模式，然后增加如下配置：

local mapped_punc = {
    [','] = '，',
    ['.'] = '。',
    [':'] = '：',
    [';'] = '；',
    ['?'] = '？',
    ['\\'] = '、'
    -- ...
    -- add more you want here
}
for k, v in pairs(mapped_punc) do
    map.set({ 'i' }, k .. '<space>', function()
        -- when typing comma or period with space,
        -- upload the first rime_ls entry and make comma and period in Chinese edition
        -- if you don't want this just comment those lines
        if k == ',' or k == '.' then
            auto_upload_rime(1, true)
        end

        feed_key(v, v)
    end, opts())
end

输入过快补全列表消失

该情况指用户在输入过快时，补全列表会消失，导致内容与预期不一致。这里主要通过 vim.schedule 保证输入按键在补全发生后触发，这样快速输入会卡顿，但能保证内容与预期一致。

-- the alphabet your schema used，usually is "abcdefghijklmnopqrstuvwxyz"
local alphabet = "abcdefghijklmnopqrstuvwxyz"
for i = 1, #alphabet do
    local k = alphabet:sub(i, i)
    map.set({ 'i' }, k, function()
        feed_key(k, k)
    end, opts())
end

五笔或者双形用户

确保 max_token 为最大码长，always_incomplete 为 true，这样可以保证每次输入都会重新生成候选词。

require('lspconfig').rime_ls.setup {
  init_options = {
    -- ...
    max_tokens = 4, -- 强制在删除到4字的时候重建一次候选词，避免用退格造成的空列表的问题
    always_incomplete = true, -- 将 incomplete 永远设为 true，防止任何时候的过滤代替候选词重建
    -- ...
  },
  on_attach = rime_on_attach,
  capabilities = capabilities,
}

顶字上屏 + 快速输入不中断

相关 issue ：如何实现顶字上屏。

-- the alphabet your schema used，usually is "abcdefghijklmnopqrstuvwxyz"
local alphabet = "abcdefghijklmnopqrstuvwxyz"
-- the max_code of your schema, wubi and flypy are 4
local max_code = 4
-- Return if the number of characters for completion reaches max_code
local function reach_max_code()
    local first_rime_ls_entry = get_n_rime_ls_entries(1)
    if #first_rime_ls_entry ~= 1 then
        return false
    end
    local line = vim.api.nvim_get_current_line()
    local completion_start = first_rime_ls_entry[1].insert_range.start.character
    local completion_end = vim.api.nvim_win_get_cursor(0)[2]
    if completion_end - completion_start ~= max_code then
        return false
    end
    local code = string.sub(line, completion_start + 1, completion_end)
    -- translate some special characters in alphabet
    local allowed = string.gsub(alphabet, "([%.%*%+%?%-%^%$%(%)%[%]%-{%}|\\])", "%%%1")

    -- NOTE: This is for wubi users: remove the z letter
    -- flypy users should comment this line
    allowed = allowed.gsub(allowed, "z", "")
    
    if string.match(code, '^[' .. allowed .. ']+$') ~= nil then
        return true
    end
    return false
end
-- select first entry when typing more than max_code
-- note that this part is also used to make completion list visible when typing fast
-- if you don't want select the first entry when typing more than max_code, set max_code to -1
for i = 1, #alphabet do
    local k = alphabet:sub(i, i)
    map.set({ 'i' }, k, function()
        if reach_max_code() then
            auto_upload_rime(1, true)
        end
        feed_key(k, k)
    end, opts())
end

完整配置

查看 kaiser-rime-ls 。

使用其他用户开发的插件

目前没有官方实现的 neovim 插件，但已有用户将相关功能封装成了插件，例如：

liubianshi/cmp-lsp-rimels

也可参考 issues 里其他用户的配置片段。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nvim-with-cmp.md

nvim-with-cmp.md

初始化 rime-ls

为每个 buffer 开启一个 lsp server (不推荐)

基于 lspconfig 的全局 LSP 状态

按需调整 cmp 的排序

状态栏显示

特定 buffer 无法使用问题

通过 TCP 远程使用

还原输入法体验

空格上屏

二三候选

数字键选择

中文标点

输入过快补全列表消失

五笔或者双形用户

顶字上屏 + 快速输入不中断

完整配置

使用其他用户开发的插件

Files

nvim-with-cmp.md

Latest commit

History

nvim-with-cmp.md

File metadata and controls

初始化 rime-ls

为每个 buffer 开启一个 lsp server (不推荐)

基于 lspconfig 的全局 LSP 状态

按需调整 cmp 的排序

状态栏显示

特定 buffer 无法使用问题

通过 TCP 远程使用

还原输入法体验

空格上屏

二三候选

数字键选择

中文标点

输入过快补全列表消失

五笔或者双形用户

顶字上屏 + 快速输入不中断

完整配置

使用其他用户开发的插件