如何在新项目和现有项目中使用 Prettier 设置 Tailwind CSS 自动类排序

介绍

Tailwind CSS 是一种流行的实用程序优先 CSS 框架，它提供低级实用程序类来直接在标记中应用样式，从而缩短开发周期。

另一方面，Prettier 是一种广泛使用的代码格式化程序，它通过解析代码并使用自己的规则重新打印来确保代码的格式一致。这有助于在整个项目中保持统一的代码风格，使代码库更干净、更易于阅读。

使用 Tailwind CSS 时的一个常见挑战是管理实用程序类的顺序，尤其是随着样式和 HTML 的复杂性增加。手动对这些类进行排序可能很乏味且容易出错。这就是自动类排序的用武之地。通过利用 Prettier 等工具以及 prettier-plugin-tailwindcss 等插件，我们可以自动对 Tailwind CSS 类进行排序，确保顺序一致，提高类的可读性和可维护性。

本文的目的是指导您完成在新项目和现有项目中使用 Prettier 设置 Tailwind CSS 自动类排序的过程。无论您是开始一个新项目还是融入一个正在进行的项目，这份综合指南都将为您提供分步说明。

目录

• 在新项目中设置 Tailwind CSS 和 Prettier
  • 初始化项目并安装 Tailwind CSS
  • 安装并配置 Prettier
• 在现有 Tailwind CSS 项目中设置 prettier-plugin-tailwindcss
• 结论

在新项目中设置 Tailwind CSS 和 Prettier

在我们开始之前，请确保您已安装以下软件：

• Node.js
• 包管理器（我们将在这个项目中使用bun，但如果你愿意，你可以使用npm、yarn或pnpm）
• 代码编辑器（例如 VS Code）

初始化项目并安装 Tailwind CSS

首先创建一个新项目。具体步骤可能会有所不同，具体取决于您首选的框架或设置。有关详细说明，请参阅 Tailwind CSS 安装框架指南。如果您已完成 Tailwind CSS 安装步骤，则可以继续执行在现有 Tailwind CSS 项目中设置 prettier-plugin-tailwindcss 部分。以下是使用 Vite 的操作方法：

bun create vite my-app --template react-ts
cd my-app
bun install

现在让我们安装并配置 Tailwind CSS

bun install -D tailwindcss postcss autoprefixer
bunx tailwindcss init -p

你应该看到一个 Tailwind CSS 配置文件：tailwind.config.js，将以下内容复制到其中。

/** @type {import('tailwindcss').Config} */
export default {
  content: ["./index.html", "./src/**/*.{js,ts,jsx,tsx}"],
  theme: {
    extend: {},
  },
  plugins: [],
};

将以下 Tailwind 指令添加到 CSS 文件的顶部（例如 src/index.css）：

@tailwind base;
@tailwind components;
@tailwind utilities;

安装和配置 Prettier

bun install -D prettier prettier-plugin-tailwindcss

在项目根目录创建一个 prettier 配置文件，并将 prettier-plugin-tailwindcss 插件添加到配置文件中，我们使用 .prettierrc，您可以在此处查看其他可接受的 prettier 配置文件类型

{
  "plugins": ["prettier-plugin-tailwindcss"]
}

现在让我们测试设置，修改 src/App.tsx 文件并保存。

import { useState } from "react";
import "./App.css";

const App = () => {
  const [count, setCount] = useState(0);

  return (
    <>
      <div className="card">
        <button
          className="border-2 border-teal-700 hover:border-white bg-white hover:bg-teal-700 text-slate-800 hover:text-white transition-colors duration-300 custom-btn"
          onClick={() => setCount((count) => count + 1)}
        >
          Count is {count}
        </button>
      </div>
    </>
  );
};

export default App;

结果：

import { useState } from "react";
import "./App.css";

const App = () => {
  const [count, setCount] = useState(0);

  return (
    <>
      <div className="card">
        <button
          className="custom-btn border-2 border-teal-700 bg-white text-slate-800 transition-colors duration-300 hover:border-white hover:bg-teal-700 hover:text-white"
          onClick={() => setCount((count) => count + 1)}
        >
          Count is {count}
        </button>
      </div>
    </>
  );
};

export default App;

在现有 Tailwind CSS 项目中设置 prettier-plugin-tailwindcss

如果您的项目已经设置了 Prettier，则集成 prettier-plugin-tailwindcss 插件非常简单。您只需要安装插件并配置它。如果 Prettier 尚未安装，您需要将其与插件一起设置。

对于具有现有更漂亮设置的项目，运行：

bun add -D prettier-plugin-tailwindcss

对于没有现有 Prettier 设置的项目，运行：

bun add -D prettier prettier-plugin-tailwindcss

将该插件添加到您现有的 Prettier 配置中。如果没有现有的 Prettier 配置，请在项目的根目录中创建一个 .prettierrc 文件。然后添加以下内容：

{
  "plugins": ["prettier-plugin-tailwindcss"]
}

通过使用 Tailwind CSS 类更改文件来确保 Prettier 正常工作。保存文件并检查 Tailwind CSS 类是否自动排序。

结论

将 prettier-plugin-tailwindcss 集成到新的和现有的 Tailwind CSS 项目中，通过确保一致且有组织的类排序来改进您的开发工作流程。对于新项目，您可以同时设置 Prettier 和插件以简化初始配置。对于现有项目，只需将插件添加到现有 Prettier 设置中，或者如果尚未配置 Prettier，则安装 Prettier 和插件。

有关其他配置选项，例如对非标准属性中的类进行排序，请访问 prettier-plugin-tailwindcss 文档。

以上是如何在新项目和现有项目中使用 Prettier 设置 Tailwind CSS 自动类排序的详细内容。更多信息请关注PHP中文网其他相关文章！