Skip to content

Commit

Permalink
Add lsp-bridge-enable-with-tramp option in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
manateelazycat committed Oct 11, 2023
1 parent 303d3d1 commit f1517f0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ lsp-bridge first looks for the content of the first *.pub file in the `~/.ssh` d

- `lsp-bridge-python-command`: The path of the python command, if you use `conda`, you may customize this option. Windows platform using `python.exe` rather than `python3`, if lsp-bridge can’t work, try set to `python3`
- `lsp-bridge-complete-manually`: Only popup completion menu when user call `lsp-bridge-popup-complete-menu` command, default is nil
- `lsp-bridge-enable-with-tramp`: When this option is enabled, lsp-bridge provides remote autocompletion support for files opened by tramp. It requires the lsp_bridge.py to be installed and started on the server side in advance. Note that this option only uses tramp to open files, it does not use tramp technology to implement autocompletion, because the implementation principle of tramp has serious performance issues.
- `lsp-bridge-get-workspace-folder`: You need to put multiple project in a `workspace` directory in Java before you can jump function defintion normally. This function can be customized, the function input is the project path and returns the `workspace` directory corresponding
- `lsp-bridge-default-mode-hooks`: The list of modes that automatically start lsp-bridge, you can customize this option to control the scope of starting lsp-bridge
- `lsp-bridge-org-babel-lang-list`: list of language to support org-mode code block completion, nil enable all languages, default is nil
Expand Down
1 change: 1 addition & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ lsp-bridge 优先从`~/.ssh`目录下找第一个 *.pub 文件的内容作为远

- `lsp-bridge-python-command`: Python 命令的路径, 如果你用 `conda`, 你也许会定制这个选项。 Windows 平台用的是 `python.exe` 而不是 `python3`, 如果 lsp-bridge 不能工作, 可以尝试改成 `python3`
- `lsp-bridge-complete-manually`: 只有当用户手动调用 `lsp-bridge-popup-complete-menu` 命令的时候才弹出补全菜单, 默认关闭
- `lsp-bridge-enable-with-tramp`: 打开这个选项后, lsp-bridge 会对 tramp 打开的文件提供远程补全支持, 需要提前在服务端安装并启动 lsp_bridge.py, 注意的是这个选项只是用 tramp 打开文件, 并不会用 tramp 技术来实现补全, 因为 tramp 的实现原理有严重的性能问题
- `lsp-bridge-get-workspace-folder`: 在 Java 中需要把多个项目放到一个 Workspace 目录下, 才能正常进行定义跳转, 可以自定义这个函数, 函数输入是项目路径, 返回对应的 Workspace 目录
- `lsp-bridge-default-mode-hooks`: 自动开启 lsp-bridge 的模式列表, 你可以定制这个选项来控制开启 lsp-bridge 的范围
- `lsp-bridge-org-babel-lang-list`: 支持 org-mode 代码块补全的语言列表, 默认 nil 对于所有语言使用
Expand Down

0 comments on commit f1517f0

Please sign in to comment.