Команда | Результат |
---|---|
npm i |
Установить зависимости |
npm start |
Запустить сборку, сервер и слежение за файлами |
port=3004 npm start |
Запустить сборку, сервер (на указанном порту) и слежение за файлами |
npm start ЗАДАЧА |
Запустить задачу с названием ЗАДАЧА (список задач в gulpfile.js ) |
npm run build |
Сборка проекта без карт кода (минифицированый вид, как результат работы) |
npm run deploy |
Сборка проекта без карт кода и отправка содержимого папки сборки на GH-pages (для корректного сообщения адреса просмотра введите его в package.json ) |
npm test |
и отправка содержимого папки сборки на GH-pages (для корректного сообщения адреса просмотра введите его в package.json ) |
- Используется именование классов, файлов и переменных по БЭМ.
- Каждый БЭМ-блок в своей папке внутри
/src/blocks/
(less, js, картинки, разметка; обязателен только less-файл). - Есть глобальные файлы: css, js, шрифты, картинки, less-файлы (переменные, глобальная стилизация).
- Есть диспетчер подключений
/src/less/style.less
, если в нем импортирован less-файл какого-либо блока, этот блок считается используемым (обрабатывается его js и доп. файлы). - Для разметки можно использовать микрошаблонизацию. А можно и не использовать.
- Перед коммитом происходит проверка
.less
-файлов на соответствие правилам Stylelint (см..stylelintrc
в корне проекта). Если выявлены ошибки, коммит не будет создан.
Каждый блок лежит в /src/blocks/
в своей папке. Каждый блок — как минимум, папка и одноимённый less-файл.
Возможное содержимое блока:
demo-block/ # Папка блока
img/ # Изображения, используемые блоком и обрабатываемые автоматикой сборки
some-folder/ # Какая-то сторонняя папка, не обрабатываемые автоматикой
demo-block.less # Главный стилевой файл блока
demo-block--mod.less # Отдельный файл БЭМ-модификатора блока
demo-block.js # Главный js-файл блока
demo-block--mod.js # js-файл для отдельного БЭМ-модификатора блока
demo-block.html # Варианты разметки (как документация блока или как вставляемый микрошаблонизатором фрагмент)
demo-block.css # Добавочный css (копируется как отдельный файл в `build/css`)
readme.md # Какое-то пояснение
# формат: node createBlock.js [имя блока] [доп. расширения через пробел]
node createBlock.js block # создаст только папку блока, block.html и block.less
node createBlock.js new-block js jade # создаст папку блока, new-block.html, new-block.less, new-block.js, new-block.jade
node createBlock.js new-block js img # создаст папку блока, new-block.html, new-block.less, new-block.js, подпапку img/
По умолчанию будут созданы .html
и .less
файлы, в них будет записан стартовый контент.
Если блок уже существует, файлы не будут затёрты, но создадутся те файлы, которые ещё не существуют.
После создания блока, в диспетчер подключений будет дописана (в самый низ) строка импорта стилевого файла.
Если в диспетчере подключений (файле ./src/less/style.less
):
@import './src/blocks/demo-block/demo-block.less';
То указанный файл будет взят в компиляцию стилей, а так же:
- в обработку будет взят js-файл блока:
./src/blocks/demo-block/demo-block.js
(если существует и не пустой, будет конкатенирован с прочими js-файлами и углифицирован) - в обработку будет взят css-файл блока:
./src/blocks/demo-block/demo-block.css
(если существует и не пустой, будет скопирован в папку сборки и минифицирован) - в обработку будут добавлены все картинки блока:
./src/blocks/demo-block/img/*.{jpg,jpeg,gif,png,svg}
(если в папке блока существует подпапкаimg/
)
Если в диспетчере подключений:
@import './src/blocks/demo-block/demo-block.less';
@import './src/blocks/demo-block/demo-block--mod.less';
То указанные файлы будет взяты в компиляцию стилей, а так же:
- в обработку будет взят js-файл блока:
./src/blocks/demo-block/demo-block.js
(если существует и не пустой, будет конкатенирован с прочими js-файлами и углифицирован) - в обработку будет взят js-файл блока:
./src/blocks/demo-block/demo-block--mod.js
(если существует и не пустой, будет конкатенирован с прочими js-файлами и углифицирован) - в обработку будет взят css-файл блока:
./src/blocks/demo-block/demo-block.css
(если существует и не пустой, будет скопирован в папку сборки и минифицирован) - в обработку будет взят css-файл блока:
./src/blocks/demo-block/demo-block--mod.css
(если существует и не пустой, будет скопирован в папку сборки и минифицирован) - в обработку будут добавлены все картинки блока:
./src/blocks/demo-block/img/*.{jpg,jpeg,gif,png,svg}
(если в папке блока существует подпапкаimg/
)
build/ # Сюда собирается проект, здесь работает сервер автообновлений.
src/ # Исходные файлы
_include/ # - фрагменты html для самого верха (секция head) и самого низа (перед закрывающим body) страницы
blocks/ # - блоки (компоненты) проекта
css/ # - глобальные css-файлы (будут скопированы только если существует и не пустые)
fonts/ # - шрифты проекта (будут скопированы в папку сборки, подпапку fonts/)
img/ # - глобальные картинки (будут обработаны только из корня этой папки, подпапки игнорируются)
js/ # - глобальный js-файл (обработается только если существует и не пустой), фреймворки (только копируются, могут быть подключены вручную)
less/ # - диспетчер подключений и глобальные стили
index.html # - главная страница проекта
Для разметочных файлов можно использовать комментарии вида <!--DEV Комментарий -->
— такие комментарии не попадут в собранный html.