1. Base

1. Đọc style code chuẩn typescript: https://google.github.io/styleguide/tsguide.html

2. Dùng các lib check convention và format: eslint, prettier. Chạy cmd để check

   npm run format
   npm run lint
   

3. Đặt tên file, tên hàm, tên class chuẩn như các ngôn ngữ lập trình khác, ngắn gọn, rõ nghĩa và đúng chính tả

   • folder, file format kebab-case, ví dụ credit-sync-data.ts
   • file là component (jsx) thì format PascalCase, ví dụ: CreditSyncData.vue
   • tên biến, tên hàm format camelCase, ví dụ: creditSyncData
   • tên class format PascalCase, ví dụ class CreditSyncData

4. RESTful API chuẩn.

   • Request Method GET, POST, PUT, DELETE.
   • Request uri: kebab-case hoặc camelCase (thống nhất tùy dự án)
   • Response http status

2. Coding convention

Hãy tham khảo thêm các rule chuẩn ở trên mạng, để có nhiều thông tin hơn.

• Code rõ ràng, đọc hiểu đoạn code mà không cần comment là tốt nhất
• Comment code những logic xử lý phức tạp
• Hàm ngắn gọn, tách hàm nhỏ nếu thấy cần thiết
• Không lặp code, tách hàm để tái sử dụng
• Không có code thừa, code không dùng đến xóa đi
• Dùng flag TODO: short description đánh dấu đoạn code tạm, sẽ sửa ở tương lai gần, nhưng hạn chế dùng
• Log đầy đủ rõ ràng
• Dùng constant, enum, config env thay vì hardcode số liệu

3. Cấu trúc folder

• Module → Router → Controller → Service → Model (repository) rõ ràng
• Base, Layout, Shared, Page, Component rõ ràng
• Tên file trùng tên class bên trong nó
• Tách cấu trúc theo scope (admin, user), tách theo object