Node.js uygulamaları için Kodlama Stili Kılavuzu? [kapalı]

Node.js için bir (veya birkaç) kodlama stili kılavuzu var mı? Değilse, en iyi açık kaynaklı düğüm projeleri tarafından kullanılan yeni stiller nelerdir?

Python için kanonik Kodlama Stili Kılavuzu olan PEP 8'in çizgileri boyunca bir kılavuz (veya birkaç kılavuz) arıyorum . Buraya bağlanmaya değmeyen çeşitli JavaScript kılavuzları gördüm (çoğunlukla eski ve istemci tarafı JavaScript'i hedefliyordu). İlginç bir node.js stil kılavuzu buldum .

Bir kodlama stili kılavuzu veya kodlama kuralları şunları içermelidir (ancak bunlarla sınırlı değildir):

• Kod düzeni: girinti (2 boşluk, 4 boşluk, sekme, ...), yeni satırlar, satır sonları vb.
• Boşluk, ör. "İşlev (arg)" ve "işlev (arg)"
• Noktalı virgül veya noktalı virgül yok, var bildirimi, ...
• Adlandırma, ör. Do_this () ile doThis (), var_name ve varName, ...
• node.js ve JavaScript deyimleri, örneğin == vs. ===, geri çağrının ilk argümanı bir hata nesnesidir, ...
• Yorumlar ve belgeler
• Tiftik denetleyicisi, birim testi çerçevesi gibi eşlik eden araçlar ...

Bu konu açıkça oldukça özneldir, ancak olgunlaşma sürecinde ortak ve yaygın olarak kabul gören bir kodlama stili oluşturmanın bir topluluğun önemli bir adımı olduğunu düşünüyorum. Ayrıca, hepsi sadece zevkle ilgili değil. Özellikle, == yerine === gibi kuralların kod kalitesi üzerinde doğrudan etkisi vardır.

JSLint tarafından kontrol edilen kodlama standartlarını gözden geçirirdim veya NPM (Isaac Shlueter'ın) kodlama standartlarının yazarına bakardım .

Ayrıca önemli Node.JS kodlayıcıları tarafından kullanılan stile de bakabilirsiniz:

• TJ Holowaychuk
• Isaac Shlueter
• Tim Caswell
• Jeremy Ashkenas
• Felix Geisendörfer
• Charlie Robbins
• Marak Squires
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + gerçek Node.JS kod tabanına bakabilirsiniz

Ben edeceğiz mayın atmak orada iyi ölçmek için;)

Düzenleme: @alienhard'dan öneriler

• Google JavaScript stil Kılavuzu
• Felix'in Node.js Stil Kılavuzu

IMO'ya uymanız gereken birkaç altın kural vardır:

• Asla kullanma withveyaeval
• ===Üzerinde kullan==
• Değişkenlerinizi daima varuygun kapsamda tanımlayın - genel kapsama geri dönmeyin
• Bir kapatma uygulamanızı sarın (function(){})()Sunucu tarafında çalışan kod bırakmadan yanı sıra tarayıcıda planlıyorsanız
• Geri erraramaları ilk argüman olarak almalı ve eğer kendileri bir geri aramayı argüman olarak alırlarsa, bu son olmalıdır, örn.callback(err, param1, param2, callback)

Girinti, kaşlı ayraçlar ve anahtar sözcükler arasındaki boşluk ve noktalı virgül yerleştirme, hepsi tercih meselesidir.

Kasabada yeni bir standart var.

Standart Stili kullanın .

İstemci tarafına yönelik JavaScript kılavuzlarından birçok iyi kodlama stili uygulaması öğrenebilirsiniz (bunların çoğu genel olarak node.js için de geçerlidir çünkü istemci ve sunucu tarafı arasındaki fark çoğunlukla kitaplıklardadır ve dilin kendisinde değildir). Örneğin JavaScript Modelleri kitabı bu konuya Bölüm 2'nin bazı kısımlarını ayırmaktadır . Ayrıca Douglas Crockford'un web sitesi , kitabı ve videoları JavaScript'e özgü kodlama stillerini ve en iyi uygulamaları benimsemek için mutlaka görülmesi gereken malzemelerdir.

Terminalden düğüm kullanırken, kaynak kodunuzun girinti için boşluklar kullanması yararlıdır. Aksi takdirde, "burada hata" imleci sıralanmaz.

Sekmelerle:

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

Boşluklarla:

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

Bu yalnızca Mac'te bir sorun olabilir, ancak şüphelenmem.

Bu soruyu sormayalı uzun zaman oldu ... ve bu arada bu mükemmel JavaScript rehberini buldum:

Tutarlı, Deyimsel JavaScript Yazma İlkeleri

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

Airbnb'de oldukça iyi bir Javascript stil kılavuzu var https://github.com/airbnb/javascript

Coffee-Script için, kötü girintilerin derleme hataları anlamına geldiği

kullanım

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

popüler kahve projeleri, zombie, brunchçentikler için bu düzenleme kullanılmıştır.

Düzenle:

Aslında, bunu kullan! https://github.com/paulmillr/code-style-guides (ana katkıda bulunanlardan biri brunch)