Посібник зі стилю кодування для додатків node.js? [зачинено]

Чи існує (або кілька) посібник зі стилю кодування для node.js? Якщо ні, то які нові стилі використовуються в топ-проектах з відкритим вихідним кодом?

Я шукаю посібник (або кілька путівників) по лінії PEP 8 , канонічного посібника зі стилю кодування для Python. Я бачив різні посібники JavaScript, які не варто посилатися тут (переважно старі та орієнтовані на JavaScript на стороні клієнта). Я знайшов один цікавий Node.js стиль керівництва .

Посібник зі стилю кодування або конвенції про кодування повинні містити (але не обмежується цим):

• Макет коду: відступ (2 пробіли, 4 пробіли, вкладки, ...), нові рядки, розриви рядків тощо.
• Пробіл, наприклад, "функція (arg)" проти "функція (arg)"
• Точка з комою або без крапки з комою, декларація var, ...
• Назви, наприклад, do_this () vs. doThis (), var_name vs. varName, ...
• ідіоми node.js та JavaScript, наприклад, == vs. ===, перший аргумент зворотного виклику - це об'єкт помилки, ...
• Коментарі та документація
• Супровідні інструменти, такі як перевірка волокон, рамка тестування блоку, ...

Ця тема, очевидно, є дуже суб'єктивною, але я вважаю, що це важливий крок спільноти до встановлення загального і широко прийнятого стилю кодування в процесі дозрівання. Крім того, справа не лише в смаку. Зокрема, такі правила, як "використання === замість ==", мають прямий вплив на якість коду.

Я переглянув стандарти кодування, перевірені JSLint, або подивився б на автора стандартів кодування NPM (Isaac Shlueter's) .

Ви також можете подивитися на стиль, який використовують помітні кодери Node.JS:

• Т. Я. Головайчук
• Ісаак Шлютер
• Тім Касвелл
• Джеремі Ашкенас
• Фелікс Гейзендорфер
• Чарлі Роббінс
• Марак Сквайрс
• Аарон Гекман
• Гільєрмо Раух
• Майкл Роджерс
• Ryan Dahl + ви можете подивитися фактичну базу даних коду Node.JS

Я кину туди на добру міру;)

Редагувати: пропозиції від @alienhard

• Посібник зі стилю Google JavaScript
• Посібник зі стилю Node.js Фелікса

IMO є кілька золотих правил, яких слід дотримуватися:

• Ніколи не використовуйте withабоeval
• Використовуйте ===понад==
• Завжди оголошуйте свої змінні varу відповідній області - не відступайте до глобальної області
• Закрийте додаток, (function(){})()якщо ви плануєте випустити код, який працює як на сервері, так і в браузері
• Відклики errвикликів повинні братися за перший аргумент, і якщо вони самі приймають зворотний зв'язок як аргумент, він повинен бути останнім, наприкладcallback(err, param1, param2, callback)

Відступ, проміжок між дужками та ключовими словами та розміщення крапки з комою - це питання переваги.

У місті є новий стандарт.

Використовуйте стандартний стиль .

Ви можете дізнатися багато корисних практик стилів кодування з посібників JavaScript, орієнтованих на клієнта (більшість із них застосовується також до node.js загалом, оскільки різниця між стороною клієнта та сервера здебільшого в бібліотеках, а не в самій мові). Наприклад, книга Шаблони JavaScript присвячує цій темі деякі частини Глави 2 . Також веб-сайт , книги та відеозаписи Дугласа Крокфорда є обов'язковими для ознайомлення з матеріалами для того, щоб прийняти конкретні стилі кодування та найкращі практики, які я б сказав.

Під час використання вузла з терміналу корисно для вашого вихідного коду використовувати пробіли для відступу. В іншому випадку карета "помилка тут" не вирівняється.

За допомогою вкладок:

        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

Для кави-сценарію, де погані відступи означають помилки компіляції

використання

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

популярний кави проекти zombie, brunchвикористовує цю установку для заглиблень.

Редагувати:

Власне, просто використовуйте це! https://github.com/paulmillr/code-style-guides (один з основних учасників brunch)