Coding Style Guide สำหรับแอพ node.js? [ปิด]

มีคู่มือรูปแบบการเข้ารหัส (หรือหลายรายการ) สำหรับ node.js หรือไม่ ถ้าไม่สไตล์ใหม่ๆ ที่โปรเจ็กต์โหนดโอเพนซอร์สใช้คืออะไร

ฉันกำลังมองหาคำแนะนำ (หรือหลายคำแนะนำ) ตามบรรทัดของPEP 8ซึ่งเป็นแนวทางรูปแบบการเข้ารหัสมาตรฐานสำหรับ Python ฉันเห็นคู่มือ JavaScript ต่างๆไม่คุ้มค่าที่จะเชื่อมโยงที่นี่ (ส่วนใหญ่เก่าและกำหนดเป้าหมายไปที่ JavaScript ฝั่งไคลเอ็นต์) ฉันพบหนึ่งที่น่าสนใจ Node.js คู่มือสไตล์

คู่มือรูปแบบการเข้ารหัสหรือรูปแบบการเข้ารหัสควรรวมถึง (แต่ไม่ จำกัด เพียง):

• เค้าโครงโค้ด: การเยื้อง (2 ช่องว่าง 4 ช่องว่างแท็บ ... ) ขึ้นบรรทัดใหม่ตัวแบ่งบรรทัด ฯลฯ
• ช่องว่างเช่น "function (arg)" vs. "function (arg)"
• อัฒภาคหรือไม่มีอัฒภาค, การประกาศ var, ...
• การตั้งชื่อเช่น do_this () เทียบกับ doThis (), var_name เทียบกับ varName, ...
• node.js และ JavaScript idioms เช่น == เทียบกับ === อาร์กิวเมนต์แรกของการเรียกกลับคืออ็อบเจ็กต์ข้อผิดพลาด ...
• ความคิดเห็นและเอกสาร
• เครื่องมือที่มาพร้อมกันเช่นตัวตรวจสอบผ้าสำลีกรอบการทดสอบหน่วย ...

เห็นได้ชัดว่าหัวข้อนี้มีความเป็นส่วนตัวสูง แต่ฉันคิดว่าเป็นขั้นตอนสำคัญของชุมชนในการสร้างรูปแบบการเข้ารหัสที่ใช้กันทั่วไปและได้รับการยอมรับอย่างกว้างขวางในกระบวนการเติบโตเป็นผู้ใหญ่ นอกจากนี้ไม่ใช่แค่เรื่องของรสชาติเท่านั้น โดยเฉพาะกฎอย่าง "use === แทน ==" มีผลโดยตรงต่อคุณภาพโค้ด

ฉันต้องการทบทวนมาตรฐานการเข้ารหัสการตรวจสอบโดยJSLintหรือดูที่ผู้เขียนNPM (ไอแซค Shlueter ของ) มาตรฐานการเข้ารหัส

นอกจากนี้คุณยังสามารถดูสไตล์ที่ใช้โดยตัวเข้ารหัส Node.JS ที่โดดเด่น:

• TJ Holowaychuk
• ไอแซคชลูเอเทอร์
• ทิมแคสเวลล์
• Jeremy Ashkenas
• Felix Geisendörfer
• ชาร์ลีร็อบบินส์
• Marak Squires
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + คุณสามารถดูNode.JS codebase ที่แท้จริงได้

ฉันจะโยนของฉันไปที่นั่นเพื่อการวัดที่ดี;)

แก้ไข: คำแนะนำจาก@alienhard

• คู่มือสไตล์ Google JavaScript
• คู่มือสไตล์ Node.js ของ Felix

IMO มีกฎทองบางประการที่คุณควรปฏิบัติตาม:

• ห้ามใช้withหรือeval
• ใช้===เกิน==
• ประกาศตัวแปรของคุณvarในขอบเขตที่เหมาะสมเสมอ - อย่าถอยกลับไปที่ขอบเขตส่วนกลาง
• ปิดแอปของคุณ(function(){})()หากคุณวางแผนที่จะปล่อยโค้ดที่เรียกใช้ฝั่งเซิร์ฟเวอร์และในเบราว์เซอร์
• การโทรกลับควรใช้errเป็นอาร์กิวเมนต์แรกและหากพวกเขาใช้การเรียกกลับเป็นอาร์กิวเมนต์ก็ควรเป็นครั้งสุดท้ายเช่นcallback(err, param1, param2, callback)

การเยื้องระยะห่างระหว่างวงเล็บปีกกากับคีย์เวิร์ดและการจัดตำแหน่งอัฒภาคล้วนแล้วแต่เป็นเรื่องที่คุณต้องการ

มีมาตรฐานใหม่ในเมือง

ใช้รูปแบบมาตรฐาน

คุณสามารถเรียนรู้แนวทางปฏิบัติเกี่ยวกับรูปแบบการเขียนโค้ดที่ดีมากมายจากคู่มือ JavaScript ที่เน้นฝั่งไคลเอ็นต์ (ส่วนใหญ่ใช้กับ node.js โดยทั่วไปเนื่องจากความแตกต่างระหว่างฝั่งไคลเอ็นต์และเซิร์ฟเวอร์ส่วนใหญ่อยู่ในไลบรารีและไม่ใช่ในภาษานั้น ๆ ) ตัวอย่างเช่นรูปแบบ JavaScriptจอง dedicates กับหัวข้อนี้บางส่วนของบทที่ 2 นอกจากนี้ยังดักลาส Crockford ของเว็บไซต์ , หนังสือและวิดีโอจะต้องดูวัสดุในการสั่งซื้อเพื่อนำมาใช้งาน JavaScript เฉพาะรูปแบบการเข้ารหัสและการปฏิบัติที่ดีที่สุดที่ฉันจะบอกว่า

เมื่อใช้โหนดจากเทอร์มินัลจะมีประโยชน์สำหรับซอร์สโค้ดของคุณในการใช้ช่องว่างสำหรับการเยื้อง มิฉะนั้นเครื่องหมาย "ข้อผิดพลาดที่นี่" จะไม่ปรากฏขึ้น

ด้วยแท็บ:

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

ด้วยช่องว่าง:

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

นี่อาจเป็นปัญหาเฉพาะสำหรับ Mac แต่ฉันสงสัยว่าจะไม่

เป็นเวลานานแล้วที่ฉันถามคำถามนี้ ... และในระหว่างนี้ฉันได้พบคู่มือ JavaScript ที่ยอดเยี่ยมนี้:

หลักการเขียน JavaScript ที่สอดคล้องกันสำนวน

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

Airbnb มีคู่มือสไตล์ Javascript ที่ค่อนข้างดี https://github.com/airbnb/javascript

สำหรับ Coffee-Script การเยื้องที่ไม่ถูกต้องหมายถึงข้อผิดพลาดในการคอมไพล์

ใช้

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

นิยมโครงการกาแฟzombie, brunchใช้การตั้งค่านี้สำหรับรอยบุ๋ม

แก้ไข:

ใช้ได้จริงแค่นี้! https://github.com/paulmillr/code-style-guides (หนึ่งในผู้ร่วมให้ข้อมูลหลักbrunch)