Clean Code JavaScript: Hướng Dẫn Viết Code Sạch Cho JS

Tìm Hiểu Clean Code JavaScript

Clean Code JavaScript là một repo GitHub do Ryan McDermott duy trì, tập hợp các nguyên tắc kỹ thuật phần mềm từ cuốn sách Clean Code của Robert C. Martin rồi viết lại từng nguyên tắc bằng ví dụ code JavaScript. README nói rõ đây không phải một style guide, và bao gồm mười hai chương, từ Variables và Functions đến SOLID, Testing, Concurrency, Error Handling, và một chương Translation dẫn tới các bản dịch ngôn ngữ khác.

Các Nguyên Tắc Và Chủ Đề Cốt Lõi

• ✓Chương Variables: đặt tên biến sao cho có nghĩa và dễ đọc, dùng một từ vựng thống nhất cho mỗi khái niệm, thay số ma thuật bằng hằng số có thể tìm kiếm, và dùng default parameter của ES2015 thay cho fallback `||`.
• ✓Chương Functions: giới hạn số lượng tham số còn hai hoặc ít hơn bằng cách destructure một object option, viết hàm chỉ làm một việc, giữ mỗi hàm ở một cấp độ trừu tượng, và bỏ tham số boolean flag để tách thành hai hàm riêng.
• ✓Hai phần "Avoid Side Effects" riêng biệt: một về state toàn cục dùng chung, một về việc thay đổi array/object được truyền vào làm tham số, minh hoạ bằng chính ví dụ giỏ hàng của tài liệu và một gợi ý dùng thư viện Immutable.js.
• ✓Một chương Classes và một chương SOLID riêng, được gắn trực tiếp trong topic GitHub của repo cùng với "composition" và "inheritance."
• ✓Objects and Data Structures, Testing, Concurrency, Error Handling, Formatting, và Comments là các chương còn lại, dù bộ dữ kiện này không mô tả chi tiết nội dung từng chương.
• ✓Một chương Translation khép lại, dẫn tới các bản dịch của cộng đồng sang ngôn ngữ khác.

Áp Dụng Các Nguyên Tắc Này

• •Đưa cặp ví dụ "Bad"/"Good" của một nguyên tắc ra khi review PR thay vì phải giải thích lại từ đầu cùng một góp ý về đặt tên hay số lượng tham số.
• •Tái cấu trúc một hàm quá cồng kềnh bằng quy tắc giới hạn hai-ba tham số và "một cấp độ trừu tượng" của chương Functions như một điểm dừng cụ thể.
• •Truy lỗi mutation state về một array hay object dùng chung bằng các ví dụ Avoid Side Effects, vốn mô tả đúng kiểu lỗi này qua ví dụ array giỏ hàng.
• •Đọc chương SOLID trước khi tái cấu trúc các class JavaScript, vì chính chương Functions cũng dẫn ngược về SOLID khi giải thích lý do loại bỏ code trùng lặp.
• •Kết hợp với một linter thật sự nếu bạn muốn các quy tắc này được thực thi tự động thay vì chỉ dừng ở mức thảo luận, vì bản thân tài liệu không chạy kiểm tra trên code của bạn.

Tài Liệu Này Dành Cho Ai?

Clean Code JavaScript phù hợp với developer muốn một tài liệu tham khảo miễn phí, có ví dụ cụ thể về đặt tên, kích thước hàm, và kỷ luật side effect, cũng như tech lead muốn có một tài liệu chung để chỉ cho người mới thay vì lặp lại cùng một góp ý review code. Nó hợp cho các team thảo luận phong cách code không chính thức trong PR. Bỏ qua nếu bạn cần thực thi tự động (hãy dùng linter cho việc đó) hoặc đang làm việc sâu với các pattern riêng của TypeScript, vì ví dụ ở đây chỉ là JavaScript thuần.

Tài Liệu Và Lựa Chọn Thay Thế Liên Quan

Câu Hỏi Thường Gặp

Repo liên quan