1.0.3 • Published 4 years ago
zemez-build v1.0.3
Zemez Build
Надстройка над Gulp для быстрой и простой сборки проекта.
Использование
Простая пошаговая инструкция:
- Создайте в корневой папке проекта файл gulpfile.js.
- Импортируйте модуль zemez-build.
- Экспортируйте результат вызова функции
task
с нужными параметрами. - Запустите файл из консоли (
gulp
)
Например:
const { action, task } = require( 'zemez-build' );
module.exports.build = task([
action.clean({ src: 'dist' }),
action.copy({ src: [ 'dev/**/*.scss', 'dev/**/*.pug' ], dest: 'tmp' }),
action.delMarker({ src: 'tmp/**/*', dest: 'tmp', marker: 'DIST' }),
action.sass({ src: 'tmp/**/!(_)*.scss', dest: 'dist' }),
action.pug({ src: 'tmp/components/page/!(_)*.pug', dest: 'dist' }),
action.copy({ src: [ 'dev/**/*.js', 'dev/**/*.ico' ], dest: 'dist' }),
action.minifyimg({ src: [ 'dev/**/*.jpg', 'dev/**/*.png' ], dest: 'dist' }),
action.clean({ src: 'tmp' })
]);
API
set()
Создает из последовательности действий массив выполняемых функций для дальнейшей передачи в gulp.series или gulp.parallel.
executableSet = set( actions );
параметр | тип | описание |
---|---|---|
actions | Array | Массив набора действий |
executableSet | Array | Испольняемый набор функций |
task()
Создает из последовательности действий gulp-таск. В дальнейшем может быть вставлен в другой таск или экспортирован.
series = task( actions );
параметр | тип | описание |
---|---|---|
actions | Array | Массив набора действий |
series | function | Серия тасков |
action.custom()
Обертка для быстрого создания своего простого действия
actionObject = action.custom( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.cb | function | Выполняемый колбек (длжен быть синхронным), не принимает параметров |
action.copy()
Копирование файлов
actionObject = action.copy( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.cb | function | Выполняемый колбек (длжен быть синхронным), не принимает параметров |
options.opts | object | gulp.src параметры |
options.src | string|Array | glob выборка файлов для копирования |
options.dest | string | путь назначения |
action.clean()
Удаление файлов
actionObject = action.clean( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.cb | function | Выполняемый колбек (длжен быть синхронным), не принимает параметров |
options.src | string|Array | glob выборка файлов для удаления |
action.minifyimg()
Минификация картинок
actionObject = action.minifyimg( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.cb | function | Выполняемый колбек (длжен быть синхронным), не принимает параметров |
options.opts | object | gulp.src параметры |
options.src | string|Array | glob выборка файлов для минификации |
options.dest | string | путь назначения |
action.delMarker()
Удаление части содержимого фалойв по маркерам
actionObject = action.delMarker( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.opts | object | gulp.src параметры |
options.src | string|Array | glob выборка файлов |
options.dest | string | путь назначения |
options.marker | string | Имя маркера (допустимы цифры, буквы верхнего регистра и символ подчеркивания) |
action.pug()
Компиляция pug файлов
actionObject = action.pug( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.cb | function | Выполняемый колбек (длжен быть синхронным), не принимает параметров |
options.opts | object | gulp.src параметры |
options.pug | object | параметры pug компилятора |
options.src | string|Array | glob выборка файлов для компиляции |
options.dest | string | путь назначения |
action.sass()
Компиляция sass файлов
actionObject = action.sass( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.cb | function | Выполняемый колбек (длжен быть синхронным), не принимает параметров |
options.opts | object | gulp.src параметры |
options.sass | object | параметры sass компилятора |
options.src | string|Array | glob выборка файлов для компиляции |
options.dest | string | путь назначения |
action.transform()
Транформация содержимого файлов из выборки
actionObject = action.transform( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.opts | object | gulp.src параметры |
options.src | string|Array | glob выборка файлов для обработки |
options.dest | string | путь назначения |
options.cb | function | колбек для транформации, получает содержимое файла contents и file, должен возвращать строку |
action.json()
Изменение содержимого json-файла как обьекта
actionObject = action.json( options );
параметр | тип | описание |
---|---|---|
actionObject | object | Созданный обьект действия для дальнейшего исполнения |
options | object | Параметры действия |
options.name | string | Отображаемое в консоли имя действия при выполнении |
options.opts | object | gulp.src параметры |
options.src | string|Array | glob выборка файлов для обработки |
options.dest | string | путь назначения |
options.cb | function | колбек для транформации, получает обьект, должен возвращать обьект |