Tailwind Sorter for Neovim 使用教程

Tailwind Sorter for Neovim 使用教程

tailwind-sorter.nvimEasily sort Tailwind classes in Neovim.项目地址:https://gitcode.com/gh_mirrors/ta/tailwind-sorter.nvim

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

tailwind-sorter.nvim/
├── lua/
│   └── tailwind_sorter/
│       ├── init.lua
│       ├── config.lua
│       ├── parser.lua
│       └── utils.lua
├── queries/
│   └── tailwind.scm
├── README.md
├── LICENSE
└── plugin/
    └── tailwind_sorter.lua

• lua/: 包含项目的核心逻辑文件。
  • init.lua: 项目的入口文件。
  • config.lua: 配置文件处理逻辑。
  • parser.lua: 解析器逻辑。
  • utils.lua: 工具函数。
• queries/: 包含用于解析Tailwind类名的查询文件。
  • tailwind.scm: 查询文件。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。
• plugin/: 包含插件的加载文件。
  • tailwind_sorter.lua: 插件加载文件。

2. 项目的启动文件介绍

项目的启动文件是 lua/tailwind_sorter/init.lua。这个文件负责初始化插件，并加载必要的模块和配置。

-- lua/tailwind_sorter/init.lua
require('tailwind_sorter').setup()

3. 项目的配置文件介绍

项目的配置文件是 lua/tailwind_sorter/config.lua。这个文件定义了插件的默认配置，并提供了用户自定义配置的接口。

-- lua/tailwind_sorter/config.lua
local config = {
  on_save_pattern = { '*.*' },
  sort_on_save = true,
  custom_queries = {}
}

return config

用户可以通过在 init.lua 中调用 setup 函数来覆盖默认配置：

require('tailwind_sorter').setup({
  on_save_pattern = { '*.html', '*.jsx' },
  sort_on_save = false,
  custom_queries = {
    javascript = 'queries/javascript/tailwind.scm'
  }
})

以上是 Tailwind Sorter for Neovim 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

tailwind-sorter.nvimEasily sort Tailwind classes in Neovim.项目地址:https://gitcode.com/gh_mirrors/ta/tailwind-sorter.nvim