Prettier.nvim 插件使用教程

Prettier.nvim 插件使用教程

prettier.nvimPrettier plugin for Neovim's built-in LSP client.项目地址:https://gitcode.com/gh_mirrors/pr/prettier.nvim

1. 项目的目录结构及介绍

Prettier.nvim 是一个用于 Neovim 的 Prettier 插件，支持通过 Neovim 的内置 LSP 客户端进行代码格式化。以下是项目的目录结构及其介绍：

prettier.nvim/
├── LICENSE
├── README.md
├── lua/
│   └── prettier/
│       ├── init.lua
│       └── config.lua
├── plugin/
│   └── prettier.lua
└── stylua.toml

• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的说明文档，包含安装和使用说明。
• lua/prettier/: 包含插件的主要逻辑和配置文件。
  • init.lua: 插件的初始化文件，负责加载和设置 Prettier。
  • config.lua: 配置文件，定义了 Prettier 的默认设置和选项。
• plugin/prettier.lua: 插件的主文件，负责注册和加载插件。
• stylua.toml: 用于配置 StyLua 代码格式化工具的文件。

2. 项目的启动文件介绍

项目的启动文件是 lua/prettier/init.lua，该文件负责初始化和设置 Prettier 插件。以下是该文件的主要内容和功能：

require("prettier").setup({
  bin = 'prettier', -- 或者 'prettierd' (v0.23.3+)
  filetypes = {
    "css", "graphql", "html", "javascript", "javascriptreact", "json",
    "less", "markdown", "scss", "typescript", "typescriptreact", "yaml"
  }
})

• require("prettier").setup(): 初始化 Prettier 插件，并传入配置选项。
• bin: 指定使用的 Prettier 二进制文件，可以是 prettier 或 prettierd。
• filetypes: 指定支持的文件类型。

3. 项目的配置文件介绍

项目的配置文件是 lua/prettier/config.lua，该文件定义了 Prettier 插件的默认设置和选项。以下是该文件的主要内容和功能：

local prettier = require("prettier")

prettier.setup({
  bin = 'prettier', -- 或者 'prettierd' (v0.23.3+)
  filetypes = {
    "css", "graphql", "html", "javascript", "javascriptreact", "json",
    "less", "markdown", "scss", "typescript", "typescriptreact", "yaml"
  },
  ["null-ls"] = {
    condition = function()
      return prettier.config_exists({
        check_package_json = true
      })
    end,
    runtime_condition = function(params)
      return false -- 返回 false 以跳过运行 Prettier
    end
  }
})

• bin: 指定使用的 Prettier 二进制文件，可以是 prettier 或 prettierd。
• filetypes: 指定支持的文件类型。
• null-ls: 配置 null-ls 的相关选项，包括条件检查和运行时条件。

通过以上配置，可以灵活地设置和使用 Prettier.nvim 插件，实现代码的自动格式化。

prettier.nvimPrettier plugin for Neovim's built-in LSP client.项目地址:https://gitcode.com/gh_mirrors/pr/prettier.nvim