gulp-pug-starter

🔥 Особенности

• именование классов по БЭМ
• используется БЭМ-структура
• используются препроцессоры Pug и SCSS
• используется транспайлер Babel для поддержки современного JavaScript (ES6) в браузерах
• используется Webpack для сборки JavaScript-модулей
• используется жёсткий кодгайд
• используется проверка кода на ошибки перед коммитом

🛠️ Установка

• установите NodeJS
• установите глобально:
  • Yarn: npm i -g yarn
  • Gulp: npm i -g gulp
  • Bem Tools: npm i -g bem-tools-core
• скачайте сборку с помощью Git: git clone https://github.com/andreyalexeich/gulp-pug-starter.git
• перейдите в скачанную папку со сборкой: cd gulp-pug-starter
• введите yarn set version berry
• скачайте необходимые зависимости: yarn
• чтобы начать работу, введите команду: yarn run dev (режим разработки)
• чтобы собрать проект, введите команду yarn run build (режим сборки)

Если вы всё сделали правильно, у вас должен открыться браузер с локальным сервером. Режим сборки предполагает оптимизацию проекта: сжатие изображений, минифицирование CSS и JS-файлов для загрузки на сервер.

📂 Файловая структура

gulp-pug-starter
├── dist
├── gulp-tasks
├── src
│   ├── blocks
│   ├── fonts
│   ├── img
│   ├── js
│   ├── styles
│   ├── views
│   └── .htaccess
├── gulpfile.babel.js
├── webpack.config.js
├── package.json
├── .yarnrc.yml
├── .babelrc.js
├── .bemrc.js
├── .eslintrc.json
├── .stylelintrc
├── .stylelintignore
└── .gitignore

• Корень папки:
  • .babelrc.js — настройки Babel
  • .bemrc.js — настройки БЭМ
  • .eslintrc.json — настройки ESLint
  • .gitignore – запрет на отслеживание файлов Git'ом
  • .stylelintrc — настройки Stylelint
  • .stylelintignore – запрет на отслеживание файлов Stylelint'ом
  • .yarnrc.yml – настройка Yarn
  • gulpfile.babel.js — настройки Gulp
  • webpack.config.js — настройки Webpack
  • package.json — список зависимостей
• Папка src - используется во время разработки:
  • БЭМ-блоки и компоненты: src/blocks
  • шрифты: src/fonts
  • изображения: src/img
  • JS-файлы: src/js
  • страницы сайта: src/views/pages
  • SCSS-файлы: src/styles
  • служебные Pug-файлы: src/views
  • конфигурационный файл веб-сервера Apache с настройками gzip (сжатие без потерь): src/.htaccess
• Папка dist - папка, из которой запускается локальный сервер для разработки (при запуске yarn run dev)
• Папка gulp-tasks - папка с Gulp-тасками

⌨️ Команды

• yarn run lint:styles - проверить SCSS-файлы. Для VSCode необходимо установить плагин. Для WebStorm или PHPStorm необходимо включить Stylelint в Languages & Frameworks - Style Sheets - Stylelint (ошибки будут исправлены автоматически при сохранении файла)
• yarn run dev - запуск сервера для разработки проекта
• yarn run build - собрать проект с оптимизацией без запуска сервера
• yarn run build:views - скомпилировать Pug-файлы
• yarn run build:styles - скомпилировать SCSS-файлы
• yarn run build:scripts - собрать JS-файлы
• yarn run build:images - собрать изображения
• yarn run build:webp - сконвертировать изображения в формат .webp
• yarn run build:sprites- собрать спрайты
• yarn run build:fonts - собрать шрифты
• yarn run build:favicons - собрать фавиконки
• yarn run build:gzip - собрать конфигурацию Apache
• yarn run bem-m - добавить БЭМ-блок
• yarn run bem-c - добавить компонент
• yarn run lint:styles --fix - исправить ошибки в SCSS-файлах согласно настройкам Stylelint
• yarn run lint:scripts - проверить JS-файлы
• yarn run lint:scripts --fix - исправить ошибки в JS-файлах согласно настройкам ESLint

💡 Рекомендации по использованию

Компонентный подход к разработке сайтов

• каждый БЭМ-блок имеет свою папку внутри src/blocks/modules
• папка одного БЭМ-блока содержит в себе один Pug-файл, один SCSS-файл и один JS-файл (если у блока используется скрипт)
  • Pug-файл блока импортируется в файл src/views/index.pug (или в необходимый файл страницы, откуда будет вызываться блок)
  • SCSS-файл блока импортируется в файл src/blocks/modules/_modules.scss
  • JS-файл блока импортируется в src/js/import/modules.js

Пример структуры папки с БЭМ-блоком:

blocks
├── modules
│   ├── header
│   │   ├── header.pug
│   │   ├── header.js
│   │   ├── header.scss

Чтобы вручную не создавать соответствующие папку и файлы, достаточно в консоли прописать следующие команды:

• yarn run bem-m my-block - для создания БЭМ-блока в src/block/modules (для основных БЭМ-блоков), где my-block - имя БЭМ-блока (после создания нужно удалить содержимое js-файла БЭМ-блока);
• yarn run bem-с my-component - для создания компонента в src/blocks/components (для компонентов), где my-component - имя компонента (после создания нужно удалить содержимое js-файла БЭМ-компонента);

Компоненты

• компоненты (например, иконки, кнопки) оформляются в Pug с помощью примесей
• каждый компонент имеет свою папку внутри src/blocks/components
• папка одного компонента содержит в себе один Pug-файл, один SCSS-файл и один JS-файл (если у компонента используется скрипт)
  • Pug-файл компонента импортируется в файл главной страницы src/views/index.pug (или в необходимый файл страницы, откуда будет вызываться компонент)
  • SCSS-файл компонента импортируется в файл src/blocks/components/_components.scss
  • JS-файл компонента импортируется в файл src/js/import/components.js

Страницы проекта

• страницы проекта находятся в папке src/views/pages
  • каждая страница (в том числе главная) наследует шаблон src/views/layouts/default.pug
  • главная страница: src/views/index.pug

Шрифты

• шрифты находятся в папке src/fonts
  • используйте форматы .woff и .woff2
  • шрифты подключаются в файл src/styles/base/_fonts.scss
  • сконвертировать локальные шрифты можно с помощью данного сервиса

Изображения

• изображения находятся в папке src/img
  • изображения автоматически конвертируются в формат .webp. Подробная информация по использованию тут
  • изображение для генерации фавиконок должно находиться в папке src/img/favicon и иметь размер не менее 1024px x 1024px

SVG-спрайты

Для создания спрайтов изображения .svg должны находиться в папке src/img/sprites. Например, у нас есть файлы icon-1.svg, icon-2.svg и icon-3.svg, и мы должны обратиться к icon-2.svg. Для этого в HTML нужно воспользоваться тегом use:

svg
    use(xlink:href="img/sprites/sprite.svg#logo")

Изменить стили svg-иконки из спрайта в CSS:

svg use {
    fill: red;
}

Бывает такая ситуация, когда стили иконки поменять не получается. Это связано с тем, что при экспорте из Figma в svg добавляется лишний код. Например:

<svg width="18" height="19" viewBox="0 0 18 19" fill="none" xmlns="http://www.w3.org/2000/svg">
  <path d="M4.90918 4.04542L13.091 9.54088L4.90918 14.9545L4.90918 4.04542Z" fill="#1B1B1D"/>
</svg>

Нужно удалить fill="none" и fill="#1B1B1D". Должно получиться так:

<svg width="18" height="19" viewBox="0 0 18 19" xmlns="http://www.w3.org/2000/svg">
  <path d="M4.90918 4.04542L13.091 9.54088L4.90918 14.9545L4.90918 4.04542Z"/>
</svg> 

Сторонние библиотеки

• все сторонние библиотеки устанавливаются в папку node_modules
  • для их загрузки воспользуйтеcь командой yarn add package_name
  • для подключения JS-файлов библиотек импортируйте их в самом начале JS-файла БЭМ-блока (то есть тот БЭМ-блок, который использует скрипт), например:

  import $ from "jquery";

  • для подключения стилевых файлов библиотек импортируйте их в файл src/styles/vendor/_libs.scss
  • JS-файлы и стилевые файлы библиотек самостоятельно изменять нельзя

👉 Нужен SCSS без Pug?

Используйте эту сборку.

💛 Нравится проект?

Сообщайте мне о багах, ставьте звёздочку в правом верхнем углу, задонатьте мне на пиво 🍺

✉️ Контакты

По всем вопросам пишите в Telegram