团队约定与样式指南
制定团队样式指南,规定类名排序、组件命名、@apply 的使用时机,以及如何一致地处理一次性任意值。
团队约定与样式指南 是 CoddyKit 上的免费 Tailwind CSS Academy 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Tailwind CSS Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Tailwind CSS Academy 课程共包含 4 节课。
本课时的部分内容尚未翻译,以英文显示。
Why Teams Need a Tailwind Style Guide
Without agreed conventions, Tailwind projects drift into inconsistency. One developer writes p-4 everywhere, another uses px-4 py-4. One uses @apply liberally, another avoids it entirely. A team style guide documents the decisions your team has made so that everyone writes Tailwind the same way, making code reviews faster and the codebase easier to maintain.
Defining Class Ordering Conventions
Even with the Prettier plugin enforcing order automatically, your style guide should document why the canonical order is used and what it looks like so developers understand it rather than just following it blindly. Include the group order — layout, sizing, spacing, typography, visual, interactive — so team members can predict where a class belongs.
<!-- Canonical order groups -->
<div class="
flex items-center gap-4 /* Layout */
w-full max-w-md /* Sizing */
p-6 mx-auto /* Spacing */
text-sm font-medium /* Typography */
bg-white rounded-lg shadow /* Visual */
hover:shadow-md transition /* Interactive */
">When to Use @apply
A common source of disagreement is when to extract utilities with @apply. Define a clear rule: for example, use @apply only when a pattern repeats more than three times across different components AND cannot be solved with a shared JSX or template component. This prevents premature abstraction while catching genuine duplication.
/* ALLOWED: repeated button pattern with no JSX component possible */
.btn-primary {
@apply rounded-lg bg-blue-600 px-4 py-2 text-sm font-semibold text-white hover:bg-blue-700;
}
/* DISCOURAGED: abstracting a one-off layout that appears only once */
.hero-section {
@apply flex min-h-screen flex-col items-center justify-center bg-gray-50;
}Arbitrary Value Conventions
Tailwind's bracket notation like w-[347px] is powerful but can lead to a proliferation of magic numbers that are hard to maintain. Your style guide should require that arbitrary values be justified in a comment, and that values appearing more than once be added to the theme's extend block as a named token instead.
<!-- DISCOURAGED: unexplained magic number -->
<div class="h-[347px]">
<!-- BETTER: explain the constraint with a comment -->
<!-- Height matches the sidebar for visual alignment -->
<div class="h-[347px]">
<!-- BEST: promote to a named token in the config -->
<!-- tailwind.config.js: extend.height: { sidebar: '347px' } -->
<div class="h-sidebar">Safelist Governance
Every entry in the safelist adds cost to every build. Your style guide should require that safelisted classes include a comment explaining why they cannot be statically detected. Create a safelist audit schedule — for example, quarterly — to remove entries for features that have been removed or refactored.
// tailwind.config.js
module.exports = {
safelist: [
// REASON: color comes from CMS content, cannot be statically detected
// REVIEW DATE: 2026-Q3
{ pattern: /bg-(red|green|blue|yellow)-(100|500)/ },
// REASON: toast severity classes set by JS at runtime
'border-red-500',
'border-green-500',
],
};Component Naming Conventions
If your project uses @apply to create component classes, establish a naming convention. BEM-inspired names like .btn-primary and .card-body are a common choice. Document which naming pattern your team uses and ensure custom component classes never conflict with Tailwind's own utility names.
/* Naming convention: {component}-{variant} */
.btn { @apply rounded-lg px-4 py-2 font-semibold; }
.btn-primary { @apply btn bg-blue-600 text-white hover:bg-blue-700; }
.btn-outline { @apply btn border border-blue-600 text-blue-600 hover:bg-blue-50; }
.card { @apply rounded-xl bg-white shadow; }
.card-header { @apply border-b border-gray-100 p-4 font-semibold; }
.card-body { @apply p-4; }Responsive Prefix Conventions
Document how your team handles responsive design. Common conventions include mobile-first always (base styles are mobile, prefixes add larger-screen behavior), using only a subset of breakpoints (e.g., md and lg only), and never applying a prefix without also defining the base case so styles cascade correctly.
<!-- GOOD: mobile-first base, then larger breakpoints -->
<div class="flex-col gap-4 md:flex-row md:gap-6 lg:gap-8">
<!-- CONFUSING: responsive prefix without a base style -->
<div class="md:flex-row">
<!-- What displays on mobile? The browser's UA default — unpredictable -->Dark Mode Conventions
Choose and document one dark mode strategy for the entire project — either the class strategy or the media strategy — and never mix them. Specify which elements always need a dark variant (backgrounds, text, borders) and which can inherit. Include a checklist for reviewing new components for dark mode completeness before merging.
/* Documented decision: we use class strategy */
/* tailwind.config.js: darkMode: 'class' */
/* Component dark mode checklist:
[ ] bg-* has a dark:bg-* variant
[ ] text-* has a dark:text-* variant
[ ] border-* has a dark:border-* variant
[ ] ring-* has a dark:ring-* variant if used as focus indicator
*/
<div class="bg-white dark:bg-gray-900 text-gray-900 dark:text-gray-100">Pull Request Review Checklist
Embed Tailwind conventions into your PR review process. A short checklist in the PR template reminds both author and reviewer to verify key conventions. Items might include: classes are sorted, no unsafed dynamic class construction, arbitrary values have a comment, dark mode variants are complete, and no contradicting utilities are present.
## Tailwind Checklist
- [ ] Classes sorted (Prettier ran)
- [ ] No typos (ESLint passed)
- [ ] Arbitrary values explained with comments
- [ ] Dark mode variants added for new surfaces
- [ ] No dynamic class concatenation without safelist
- [ ] Responsive base styles defined before breakpoint prefixesDocumenting the Style Guide
Write the style guide in a STYLE_GUIDE.md file committed to the repository. Keep it close to the code, not in a separate wiki that goes stale. Each convention should include a brief rationale so new team members understand the why, making it easier to accept and follow. Review the guide quarterly and update it as the project evolves.
# Tailwind CSS Style Guide
## 1. Class Ordering
Use Prettier plugin — no manual sorting required.
## 2. @apply Usage
Only for patterns repeated 3+ times with no component solution.
## 3. Arbitrary Values
Add a comment. If used 2+ times, promote to theme.extend.
## 4. Dark Mode
Class strategy. Every new background and text color needs dark variant.Onboarding New Developers
A style guide is only effective if new developers read it. Include a link to the Tailwind style guide in your project's README and in the onboarding checklist for new team members. Consider adding a short quiz or exercise that lets new developers apply the conventions on a practice component before touching production code.
# README.md
## Getting Started
1. `npm install`
2. Read [STYLE_GUIDE.md](./STYLE_GUIDE.md) before writing any Tailwind classes
3. Enable the recommended VS Code extensions from `.vscode/extensions.json`
4. Run `npm run lint && npm run format:check` before every commitQuick Check
Test your understanding of Tailwind CSS Mastery concepts from this lesson.
Lesson Recap
In this lesson you learned: defining @apply and arbitrary value conventions to prevent misuse, embedding conventions into PR checklists for consistent review, and documenting the style guide in the repository so it stays up to date. Next up we build a complete landing page hero and navigation section.
常见问题解答
「团队约定与样式指南」课时是免费的吗?
是的 — 「团队约定与样式指南」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Tailwind CSS Academy 课程的其余内容,请升级到 CoddyKit PRO。 Tailwind CSS Academy 课程共包含 4 节课。
「团队约定与样式指南」这节课中我会学到什么?
制定团队样式指南,规定类名排序、组件命名、@apply 的使用时机,以及如何一致地处理一次性任意值。 你通过在浏览器中直接运行的动手代码来练习 Tailwind CSS Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Tailwind CSS Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 Tailwind CSS Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。
「团队约定与样式指南」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 Tailwind CSS Academy 课中编写并运行代码吗?
能。每节 Tailwind CSS Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。