Loading...
Loading...
Essential guidelines for clear, maintainable frontend code. Follow when writing or reviewing frontend components, composables, or pages.
npx skill4agent add loxosceles/ai-dev frontend-code-quality// ❌ 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>
);
}// ❌ 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} />;// ❌ 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)} />;
}// ❌ 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>;
}// ❌ 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>;
}anyunknown// ✅ 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} />;
}// ❌ 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>;
}// ✅ 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} />;
}// ❌ 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>;
}UserProfile.tsxuseuseUserData.tsformatDate.tsAPI_BASE_URLishasshould// ✅ 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;
}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.tscomponents/ui/lib/utils/