Codestyle по верстке
Codestyle - это как мы оформляем код в файлах. Чтобы он был понятным и читаемым для других разработчиков.
- Табуляция для отступов.
- В файлах с кодом должно быть аккутарное выравнивание, с учетом вложенности.
- Отступы внутри файлов делются только одной пустой строкой. Там где вы посчитаете нужным.
- Отступы в 2 пустые строки и более - недопустимы нигде.
- Аккуратно выравниваем отступ у свойств от левого края. Недопускается хаотичное прыгание отступов. Когда отступы чередуют в себе табуляцию и пробелы - это жесть. Не делайте так. Используйте
Alt + Shift + Fдля ре-индентации кода.
Табуляция для отступов
В данном проекте в качестве стандарта используется индентация (отступы) с помощью табуляции. Это критично. Например в PUG внутри одного файла можно использовать либо TAB либо Space (пробелы), но не оба вместе.
Оформление кода
В файлах с кодом должно быть аккуратное выравниваение. Аккуратно выравнены стили в CSS. Внутри описания селекторов пустые строки допускаются только в случае если у вас около 10 свойств и более и вы хотите разделить их структурно. В остальном просто отступы в одну строку внутри селекторов не допустимы.
Отступы в 2 пустые строки - недопустимы нигде!
Ни в CSS, ни в PUG, ни в JS файлах.
Аккуратно выравнивайте отступ у свойств от левого края. Недопускается хаотичное прыгание отступов. Исключение - кроссбраузерные префиксы. Когда отступы чурудуют в себе табуляцию и пробелы - это жесть. Не делайте так. Используйте Alt + Shift + F для ре-индентации кода. Предварительно команда реиндентации должна быть настроена на эти клавиши у вас в редакторе.
Именование файлов
Если мы делаем файлы для мастер шаблонов - layouts, и кладем их все в папку layouts, то нет смысла добавлять в имя каждого файла слово layouts и подписывать каждый файл layout-main, login-layout и ui-layout. Они и так лежат в папке layouts.
Плохо:
Много ненужных повторений.
layouts/
layout-main.pug
ui-layout.pug
login.pug
Хорошо:
Структура должна быть такая. Чисто и без повторений.
layouts/
main.pug
ui.pug
login.pug