尾风格式化器（Tailwind Formatter）使用指南

尾风格式化器（Tailwind Formatter）使用指南

tailwind_formatter Sorts tailwind classes within elixir projects 项目地址: https://gitcode.com/gh_mirrors/ta/tailwind_formatter

项目概述

Tailwind Formatter 是一个专为基于 Jetbrains IDE 的开发者设计的插件，用于自动整理 Tailwind CSS 类的顺序，遵循推荐的排序规则，而不会像 Prettier 那样过于激进地格式化代码。它确保了类属性中的 Tailwind CSS 类遵循一致且逻辑性的排列，并提供了定制排序的能力。

项目目录结构及介绍

该开源项目基于以下基本的目录布局：

tailwind_formatter/
├── src                       # 源代码目录
│   ├── resources             # 资源文件夹，含默认类列表等配置
│   │   └── classes.txt       # 默认的类排序列表
│   ├── main.kt               # 主入口点或核心逻辑实现
│   └── ...                   # 其他相关 Kotlin 源代码文件
├── build.gradle.kts         # Gradle 构建脚本
├── README.md                 # 项目说明文档
├── LICENSE                   # 许可证文件
└── ...                       # 可能还包含其他开发相关的文件或配置

• src: 包含项目的业务逻辑，main.kt 是主要的执行入口。
• resources: 存放辅助资源，如默认的类排序列表，这对于理解类如何被排序至关重要。
• build.gradle.kts: Gradle 构建配置文件，定义了项目如何构建和依赖管理。

项目的启动文件介绍

• 主启动文件通常位于 src/main/kotlin 目录下，虽然具体文件名未直接提供，假设为 main.kt 或类似命名。这个文件是插件启动的核心，它包含了初始化、监听编辑器事件、调用类排序逻辑等功能的实现。在Jetbrains IDE的插件开发中，启动逻辑往往是通过IDE提供的API来激活，而非传统意义上的“启动文件”，实际交互逻辑可能分散在多个处理类中。

项目的配置文件介绍

主要配置文件

• classes.txt 在 src/resources/ 目录下，这是项目的核心配置之一，列出了所有默认的Tailwind CSS类以及它们建议的排序。开发者可以通过修改此文件或者创建自定义的tailwindorder文件在项目根目录下来调整类的排序方式。

• Gradle构建脚本 (build.gradle.kts): 虽不直接控制插件的功能，但它是配置项目依赖、编译规则和构建流程的关键文件，对于开发者而言，对它的了解有助于进行项目的构建和部署。

自定义配置

• 用户可以通过在自己的项目根目录下创建一个名为 tailwindorder 的配置文件来自定义类排序。这个文件应该包含用户想要自定义的类序列，每类一行，以控制 Tailwind CSS 类的应用顺序。

---

以上是对尾风格式化器项目的基本解析和关键部分的介绍。在实际应用中，开发者应参照其官方文档或插件市场上的说明进行安装和配置，以充分利用该工具提升代码风格的一致性。

tailwind_formatter Sorts tailwind classes within elixir projects 项目地址: https://gitcode.com/gh_mirrors/ta/tailwind_formatter