frontend-code-quality

前端代码质量指南

这是严格指南。 请严格遵守这些规则。

编写清晰、易维护的前端代码的基本指南。

---

1. 组件简洁性

指南：让组件专注于单一职责。

// ❌ Avoid: Component doing too much
function UserDashboard() {
  const [user, setUser] = useState(null);
  const [posts, setPosts] = useState([]);
  const [comments, setComments] = useState([]);
  
  useEffect(() => {
    fetch('/api/user').then(r => r.json()).then(setUser);
    fetch('/api/posts').then(r => r.json()).then(setPosts);
    fetch('/api/comments').then(r => r.json()).then(setComments);
  }, []);
  
  return (
    <div>
      {/* Complex rendering logic for user, posts, comments */}
    </div>
  );
}

// ✅ Preferred: Split into focused components
function UserDashboard() {
  return (
    <div>
      <UserProfile />
      <UserPosts />
      <UserComments />
    </div>
  );
}

指南：

• 让文件专注于单一职责。接口简单、内聚性强的模块可以超过 200 行（最多约 400 行）——深度胜过行数。只有当文件包含多个无关职责时才拆分，而不是为了达到长度目标。
• 当复杂逻辑属于独立职责时，将其提取到自定义 Hook 或工具函数中
• 避免在 JSX 中使用嵌套三元表达式和复杂条件判断

// ❌ Avoid: Complex nested conditionals
{isLoading ? <Spinner /> : error ? <Error /> : data ? <Content data={data} /> : <Empty />}

// ✅ Preferred: Early returns or extracted logic
if (isLoading) return <Spinner />;
if (error) return <Error />;
if (!data) return <Empty />;
return <Content data={data} />;

---

2. 状态管理清晰性

指南：让状态尽可能靠近其使用位置。

// ❌ Avoid: Unnecessary state lifting
function App() {
  const [modalOpen, setModalOpen] = useState(false);
  return <UserProfile modalOpen={modalOpen} setModalOpen={setModalOpen} />;
}

// ✅ Preferred: State where it's used
function UserProfile() {
  const [modalOpen, setModalOpen] = useState(false);
  return <Modal open={modalOpen} onClose={() => setModalOpen(false)} />;
}

指南：

• 只有在多个组件需要共享状态时才提升状态
• 谨慎使用 context（仅用于身份验证、主题和全局配置）
• 避免超过 2-3 层的属性逐层传递——改用组合或 context

// ❌ Avoid: Deep prop drilling
<Parent user={user}>
  <Child user={user}>
    <GrandChild user={user}>
      <GreatGrandChild user={user} />
    </GrandChild>
  </Child>
</Parent>

// ✅ Preferred: Context for deeply shared data
const UserContext = createContext<User | null>(null);

function Parent() {
  const user = useUser();
  return (
    <UserContext.Provider value={user}>
      <Child />
    </UserContext.Provider>
  );
}

function GreatGrandChild() {
  const user = useContext(UserContext);
  return <div>{user.name}</div>;
}

---

3. 类型安全

指南：为所有组件接口定义明确的类型。

// ❌ Avoid: Implicit or missing types
function UserCard({ user, onEdit }) {
  return <div onClick={onEdit}>{user.name}</div>;
}

// ✅ Preferred: Explicit types
interface UserCardProps {
  user: {
    id: string;
    name: string;
    email: string;
  };
  onEdit: (userId: string) => void;
}

function UserCard({ user, onEdit }: UserCardProps) {
  return <div onClick={() => onEdit(user.id)}>{user.name}</div>;
}

指南：

• 避免使用 any——如果类型确实未知，请使用 unknown
• 对变体组件使用可辨识联合类型
• 明确标注事件处理程序的类型

// ✅ Discriminated unions for variants
type ButtonProps = 
  | { variant: 'primary'; onClick: () => void }
  | { variant: 'link'; href: string };

function Button(props: ButtonProps) {
  if (props.variant === 'link') {
    return <a href={props.href}>Link</a>;
  }
  return <button onClick={props.onClick}>Button</button>;
}

// ✅ Explicit event handler types
function SearchInput() {
  const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
    console.log(e.target.value);
  };
  
  return <input onChange={handleChange} />;
}

---

4. 数据获取模式

指南：将数据获取与展示分离。

// ❌ Avoid: Fetching in component
function UserList() {
  const [users, setUsers] = useState([]);
  
  useEffect(() => {
    fetch('/api/users').then(r => r.json()).then(setUsers);
  }, []);
  
  return <ul>{users.map(u => <li key={u.id}>{u.name}</li>)}</ul>;
}

// ✅ Preferred: Custom hook for data fetching
function useUsers() {
  const [users, setUsers] = useState([]);
  const [loading, setLoading] = useState(true);
  const [error, setError] = useState(null);
  
  useEffect(() => {
    fetch('/api/users')
      .then(r => r.json())
      .then(setUsers)
      .catch(setError)
      .finally(() => setLoading(false));
  }, []);
  
  return { users, loading, error };
}

function UserList() {
  const { users, loading, error } = useUsers();
  
  if (loading) return <Spinner />;
  if (error) return <Error message={error.message} />;
  
  return <ul>{users.map(u => <li key={u.id}>{u.name}</li>)}</ul>;
}

指南：

• 明确处理加载、错误和空状态
• 避免在渲染期间获取数据——使用 Hook 或 effect
• 使用数据获取库时，对请求进行缓存和去重

// ✅ Handle all states
function DataDisplay() {
  const { data, loading, error } = useData();
  
  if (loading) return <LoadingState />;
  if (error) return <ErrorState error={error} />;
  if (!data || data.length === 0) return <EmptyState />;
  
  return <DataList data={data} />;
}

---

5. 命名约定

指南：使用一致且描述性强的名称，清楚表达意图。

// ❌ Avoid: Unclear or inconsistent names
function Card({ data, fn, flag }) {
  return <div onClick={fn}>{flag && data.txt}</div>;
}

// ✅ Preferred: Clear, consistent names
function UserCard({ user, onEdit, isEditable }: UserCardProps) {
  return <div onClick={onEdit}>{isEditable && user.name}</div>;
}

约定：

• 组件：PascalCase（UserProfile.tsx）
• Hook：以 use 为前缀的 camelCase（useUserData.ts）
• 工具函数：camelCase（formatDate.ts）
• 常量：UPPER_SNAKE_CASE（API_BASE_URL）
• 布尔属性/变量：使用 is、has、should 前缀

// ✅ Boolean naming
interface ModalProps {
  isOpen: boolean;
  hasCloseButton: boolean;
  shouldShowOverlay: boolean;
}

// ✅ Event handler naming
interface FormProps {
  onSubmit: (data: FormData) => void;
  onChange: (field: string, value: string) => void;
  onValidate: (data: FormData) => ValidationResult;
}

---

6. 文件组织

指南：按类型而不是按功能组织。

frontend/
├── components/          # All components
│   ├── ui/             # Reusable UI components
│   │   ├── Button.tsx
│   │   ├── Input.tsx
│   │   └── Modal.tsx
│   ├── UserProfile.tsx
│   ├── UserSettings.tsx
│   ├── PostList.tsx
│   └── PostCard.tsx
├── hooks/              # Custom hooks
│   ├── useUser.ts
│   ├── usePost.ts
│   └── useAuth.ts
├── lib/                # Utilities and helpers
│   ├── api/
│   ├── auth/
│   └── utils/
├── types/              # Type definitions
│   ├── user.ts
│   └── post.ts
└── queries/            # API queries (GraphQL, etc.)
    ├── user.ts
    └── post.ts

按类型组织的原因：

• 高复用性会让功能边界变得模糊
• 当组件被多个功能使用时，更容易找到它们
• 非常适合组件库和共享工具

指南：

• 在子目录中归类高度相关的文件（例如，components/ui/）
• 将共享/可复用代码放在 lib/ 或 utils/ 中，方便访问
• 将业务逻辑与 UI 逻辑分开

---

相关模式

• 组件组织 - 目录结构模式
• 核心原则 - 通用编码原则

---

致 AI 助手：编写或审查前端代码时，请遵循这些指南。优先考虑清晰性和可维护性，而不是炫技。

---

渐进式改进

如果开发者纠正了本技能本应避免的行为，请提出针对本技能的具体修订建议，以防止今后再次出现同样的纠正。