Hướng dẫn về kiểu mã hóa cho các ứng dụng node.js? [đóng cửa]

Có một (hoặc một vài) hướng dẫn kiểu mã hóa cho node.js không? Nếu không, các kiểu mới nổi được sử dụng bởi các dự án nút nguồn mở hàng đầu là gì?

Tôi đang tìm một hướng dẫn (hoặc một vài hướng dẫn) dọc theo các dòng của PEP 8 , Hướng dẫn kiểu mã hóa chính tắc cho Python. Tôi đã thấy các hướng dẫn JavaScript khác nhau không đáng để liên kết ở đây (chủ yếu là cũ và nhắm mục tiêu vào JavaScript phía máy khách). Tôi tìm thấy một hướng dẫn phong cách node.js thú vị .

Hướng dẫn về kiểu mã hóa, hoặc các quy ước mã hóa, nên bao gồm (nhưng không giới hạn ở):

• Bố cục mã: thụt lề (2 dấu cách, 4 dấu cách, tab, ...), dòng mới, ngắt dòng, v.v.
• Khoảng trắng, ví dụ: "function (arg)" vs. "function (arg)"
• Dấu chấm phẩy hoặc không có dấu chấm phẩy, khai báo var, ...
• Đặt tên, ví dụ: do_this () so với do This (), var_name so với varName, ...
• thành ngữ node.js và JavaScript, ví dụ: == vs. ===, đối số đầu tiên của cuộc gọi lại là một đối tượng lỗi, ...
• Nhận xét và tài liệu
• Các công cụ đi kèm, như trình kiểm tra xơ vải, khung kiểm tra đơn vị, ...

Chủ đề này rõ ràng là rất chủ quan, nhưng tôi nghĩ đó là một bước quan trọng của cộng đồng để thiết lập một phong cách mã hóa phổ biến và được chấp nhận rộng rãi trong quá trình trưởng thành. Ngoài ra, nó không chỉ là về hương vị. Cụ thể, các quy tắc như "use === thay vì ==" có ảnh hưởng trực tiếp đến chất lượng mã.

Tôi sẽ xem xét các tiêu chuẩn mã hóa được kiểm tra bởi JSLint hoặc xem xét tác giả của các tiêu chuẩn mã hóa NPM (Isaac Shlueter) .

Bạn cũng có thể xem phong cách được sử dụng bởi các lập trình viên Node.JS đáng chú ý:

• TJ Holowaychuk
• Isaac Shlueter
• Tim Caswell
• Jeremy Ashkenas
• Felix Geisendorfer
• Charlie Robbins
• Marak Squires
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + bạn có thể nhìn vào cơ sở mã Node.JS thực tế

Tôi sẽ ném của tôi vào đó để có biện pháp tốt;)

Chỉnh sửa: Gợi ý từ @alienhard

• Hướng dẫn về phong cách Google JavaScript
• Hướng dẫn về phong cách Node.js của Felix

IMO có một vài quy tắc vàng bạn nên tuân theo:

• Không bao giờ sử dụng withhoặceval
• Sử dụng ===hơn==
• Luôn khai báo các biến của bạn vartrong phạm vi thích hợp - không dự phòng phạm vi toàn cầu
• Gói ứng dụng của bạn trong trạng thái đóng (function(){})()nếu bạn dự định phát hành mã chạy phía máy chủ cũng như trong trình duyệt
• Các cuộc gọi lại nên lấy errlàm đối số đầu tiên và nếu chính chúng gọi cuộc gọi lại làm đối số thì nó sẽ là cuộc tranh luận cuối cùng, vdcallback(err, param1, param2, callback)

Việc thụt lề, khoảng cách giữa dấu ngoặc nhọn và từ khóa và vị trí dấu chấm phẩy đều là vấn đề ưu tiên.

Có một tiêu chuẩn mới trong thị trấn.

Sử dụng Phong cách tiêu chuẩn .

Bạn có thể tìm hiểu rất nhiều cách thực hành kiểu mã hóa tốt từ các hướng dẫn JavaScript hướng về phía máy khách (hầu hết chúng cũng áp dụng cho node.js nói chung vì sự khác biệt giữa phía máy khách và máy chủ chủ yếu là ở các thư viện chứ không phải ở ngôn ngữ). Ví dụ, sách Mẫu JavaScript dành cho chủ đề này một số phần của Chương 2 . Ngoài ra, trang web , sách và video của Douglas Crockford là những tài liệu phải xem để áp dụng các kiểu mã hóa cụ thể của JavaScript và các cách thực hành tốt nhất mà tôi muốn nói.

Khi sử dụng nút từ thiết bị đầu cuối, mã nguồn của bạn sẽ hữu ích để sử dụng khoảng trắng để thụt lề. Nếu không, "lỗi ở đây" sẽ không xếp hàng.

Với các tab:

        var preps = files.map(function(f) { 
            ^
TypeError: Cannot call method 'map' of null

Với không gian:

        var preps = files.map(function(f) { 
                          ^
TypeError: Cannot call method 'map' of null

Đây có thể là vấn đề duy nhất của Mac, nhưng tôi nghi ngờ là không.

Đã được một thời gian kể từ khi tôi hỏi câu hỏi này ... và trong lúc đó tôi đã tìm thấy hướng dẫn JavaScript tuyệt vời này:

Nguyên tắc viết JavaScript nhất quán, thành ngữ

https://github.com/rwldrn/idiomatic.js/

Airbnb có một hướng dẫn phong cách Javascript khá tốt https://github.com/airbnb/javascript

Đối với Coffee-Script, trong đó thụt lề xấu có nghĩa là lỗi biên dịch

sử dụng

:set tabstop=2
:set shiftwidth=2
:set expandtab

các dự án cà phê phổ biến zombie, brunchsử dụng thiết lập này cho các vết lõm.

Biên tập:

Trên thực tế, chỉ cần sử dụng này! https://github.com/paulmillr/code-style-guides (một trong những người đóng góp chính cho brunch)