Panduan Gaya Pengodean untuk aplikasi node.js? [Tutup]

Apakah ada (atau beberapa) panduan gaya pengkodean untuk node.js? Jika tidak, apa gaya yang muncul yang digunakan oleh proyek simpul open-source teratas?

Saya mencari panduan (atau beberapa panduan) di sepanjang garis PEP 8 , Panduan Gaya Coding kanonik untuk Python. Saya telah melihat berbagai panduan JavaScript yang tidak perlu ditautkan di sini (kebanyakan tua dan ditargetkan pada JavaScript sisi klien). Saya menemukan satu panduan gaya node.js yang menarik .

Panduan gaya pengkodean, atau konvensi pengkodean, harus mencakup (tetapi tidak terbatas pada):

• Tata letak kode: indentasi (2 spasi, 4 spasi, tab, ...), baris baru, pemisah baris, dll.
• Spasi putih, misalnya, "function (arg)" vs. "function (arg)"
• Titik koma atau tidak ada titik koma, deklarasi var, ...
• Memberi nama, misalnya, do_this () vs. doThis (), var_name vs. varName, ...
• node.js dan idiom JavaScript, misalnya, == vs. ===, arg pertama callback adalah objek kesalahan, ...
• Komentar dan dokumentasi
• Alat pendamping, seperti pemeriksa serat, kerangka uji unit, ...

Topik ini jelas sangat subyektif, tetapi saya pikir ini merupakan langkah penting dari komunitas untuk membangun gaya pengkodean yang umum dan diterima secara luas dalam proses menjadi dewasa. Juga, ini bukan hanya tentang rasa. Secara khusus, aturan seperti "use === bukannya ==" memiliki pengaruh langsung pada kualitas kode.

Saya akan meninjau standar pengkodean diperiksa oleh JSLint atau melihat penulis standar pengkodean NPM (Isaac Shlueter) .

Anda juga bisa melihat gaya yang digunakan oleh Node.JS coders terkenal:

• TJ Holowaychuk
• Isaac Shlueter
• Tim Caswell
• Jeremy Ashkenas
• Felix Geisendörfer
• Charlie Robbins
• Marak Squires
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + Anda bisa melihat basis kode Node.JS yang sebenarnya

Saya akan melemparkan milik saya di sana untuk mengukur baik;)

Sunting: Saran dari @alienhard

• Panduan gaya Google JavaScript
• Panduan Gaya Node.js Felix

IMO ada beberapa aturan emas yang harus Anda ikuti:

• Jangan pernah gunakan withataueval
• Gunakan ===lebih==
• Selalu mendeklarasikan variabel Anda dengan vardalam cakupan yang sesuai - jangan mundur ke lingkup global
• Bungkus aplikasi Anda dalam penutupan (function(){})()jika Anda berencana merilis kode yang menjalankan sisi server maupun di browser
• Callback harus mengambil errsebagai argumen pertama dan jika mereka sendiri mengambil callback sebagai argumen, itu harus menjadi yang terakhir, misalnyacallback(err, param1, param2, callback)

Lekukan, jarak antara kurung kurawal dan kata kunci dan penempatan titik koma adalah masalah pilihan.

Ada standar baru di kota.

Gunakan Gaya Standar .

Anda dapat mempelajari banyak praktik gaya pengkodean yang baik dari panduan JavaScript berorientasi sisi klien (kebanyakan dari mereka berlaku juga untuk node.js secara umum karena perbedaan antara sisi klien dan server sebagian besar di perpustakaan dan bukan dalam bahasa itu sendiri). Misalnya buku Pola Javascript mendedikasikan untuk topik ini beberapa bagian dari Bab 2 . Juga situs web Douglas Crockford , buku dan video adalah harus melihat bahan untuk mengadopsi gaya pengkodean spesifik JavaScript dan praktik terbaik yang akan saya katakan.

Saat menggunakan simpul dari terminal, kode sumber Anda berguna untuk menggunakan spasi untuk indentasi. Kalau tidak, tanda "kesalahan di sini" tidak akan berbaris.

Dengan tab:

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

Dengan spasi:

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

Ini mungkin hanya masalah Mac, tapi saya kira tidak.

Sudah lama sejak saya mengajukan pertanyaan ini ... dan sementara itu saya telah menemukan panduan JavaScript yang luar biasa ini:

Prinsip-Prinsip Penulisan yang Konsisten, JavaScript Idiomatik

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

Airbnb memiliki panduan gaya Javascript yang cukup bagus https://github.com/airbnb/javascript

Untuk Coffee-Script, di mana indentasi buruk berarti kesalahan kompilasi

menggunakan

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

proyek kopi populer zombie,, brunchmenggunakan pengaturan ini untuk lekukan.

Edit:

Sebenarnya, gunakan ini saja! https://github.com/paulmillr/code-style-guides (salah satu kontributor utama brunch)