efm-langserver 使用教程

efm-langserver 使用教程

efm-langserverGeneral purpose Language Server项目地址:https://gitcode.com/gh_mirrors/ef/efm-langserver

项目介绍

efm-langserver 是一个通用的语言服务器，支持多种编程语言的格式化、代码检查和代码重构等功能。它是一个开源项目，由 mattn 开发并维护，遵循 MIT 许可证。efm-langserver 可以与多种编辑器和IDE集成，如 Vim、Neovim、Emacs 和 VSCode 等。

项目快速启动

安装

你可以通过 Homebrew 安装 efm-langserver：

brew install efm-langserver

或者通过 Go 安装：

go install github.com/mattn/efm-langserver@latest

配置

以下是一个基本的配置示例，用于在 Neovim 中启用 efm-langserver：

1. 创建配置文件 config.yaml：

version: 2
root-markers:
  - .git/
languages:
  python:
    - lint-command: 'flake8 --stdin-display-name ${INPUT} -'
      lint-stdin: true
    - format-command: 'black --quiet -'
      format-stdin: true

2. 在 Neovim 中配置 LSP：

require'lspconfig'.efm.setup {
  init_options = {
    documentFormatting = true,
    documentRangeFormatting = true,
    hover = true,
    documentSymbol = true,
    codeAction = true,
    completion = true,
  },
  settings = {
    rootMarkers = {".git/"},
    languages = {
      python = {
        {lintCommand = "flake8 --stdin-display-name ${INPUT} -", lintStdin = true},
        {formatCommand = "black --quiet -", formatStdin = true},
      },
    },
  },
}

应用案例和最佳实践

案例1：Python 代码格式化和检查

使用 efm-langserver 可以自动格式化 Python 代码并进行代码检查。配置如上所示，使用 black 进行代码格式化，使用 flake8 进行代码检查。

案例2：Markdown 文件格式化

对于 Markdown 文件，可以使用 markdownlint-cli 进行格式化：

markdown:
  - lint-command: 'markdownlint-cli --stdin'
    lint-stdin: true

典型生态项目

Neovim LSP 配置

efm-langserver 可以与 Neovim 的内置 LSP 客户端 nvim-lspconfig 集成，提供强大的代码编辑功能。

VSCode 插件

efm-langserver 也可以与 VSCode 集成，通过配置文件实现代码格式化和检查。

Vim-lsp

对于 Vim 用户，可以使用 vim-lsp 插件与 efm-langserver 集成，提供类似的功能。

通过以上配置和集成，efm-langserver 可以大大提升你的代码编辑体验，帮助你更高效地编写和维护代码。

efm-langserverGeneral purpose Language Server项目地址:https://gitcode.com/gh_mirrors/ef/efm-langserver