1.0.3 • Published 4 years ago

zemez-build v1.0.3

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

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 );
параметртипописание
actionsArrayМассив набора действий
executableSetArrayИспольняемый набор функций

task()

Создает из последовательности действий gulp-таск. В дальнейшем может быть вставлен в другой таск или экспортирован.

series = task( actions );
параметртипописание
actionsArrayМассив набора действий
seriesfunctionСерия тасков

action.custom()

Обертка для быстрого создания своего простого действия

actionObject = action.custom( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.cbfunctionВыполняемый колбек (длжен быть синхронным), не принимает параметров

action.copy()

Копирование файлов

actionObject = action.copy( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.cbfunctionВыполняемый колбек (длжен быть синхронным), не принимает параметров
options.optsobjectgulp.src параметры
options.srcstring|Arrayglob выборка файлов для копирования
options.deststringпуть назначения

action.clean()

Удаление файлов

actionObject = action.clean( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.cbfunctionВыполняемый колбек (длжен быть синхронным), не принимает параметров
options.srcstring|Arrayglob выборка файлов для удаления

action.minifyimg()

Минификация картинок

actionObject = action.minifyimg( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.cbfunctionВыполняемый колбек (длжен быть синхронным), не принимает параметров
options.optsobjectgulp.src параметры
options.srcstring|Arrayglob выборка файлов для минификации
options.deststringпуть назначения

action.delMarker()

Удаление части содержимого фалойв по маркерам

actionObject = action.delMarker( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.optsobjectgulp.src параметры
options.srcstring|Arrayglob выборка файлов
options.deststringпуть назначения
options.markerstringИмя маркера (допустимы цифры, буквы верхнего регистра и символ подчеркивания)

action.pug()

Компиляция pug файлов

actionObject = action.pug( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.cbfunctionВыполняемый колбек (длжен быть синхронным), не принимает параметров
options.optsobjectgulp.src параметры
options.pugobjectпараметры pug компилятора
options.srcstring|Arrayglob выборка файлов для компиляции
options.deststringпуть назначения

action.sass()

Компиляция sass файлов

actionObject = action.sass( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.cbfunctionВыполняемый колбек (длжен быть синхронным), не принимает параметров
options.optsobjectgulp.src параметры
options.sassobjectпараметры sass компилятора
options.srcstring|Arrayglob выборка файлов для компиляции
options.deststringпуть назначения

action.transform()

Транформация содержимого файлов из выборки

actionObject = action.transform( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.optsobjectgulp.src параметры
options.srcstring|Arrayglob выборка файлов для обработки
options.deststringпуть назначения
options.cbfunctionколбек для транформации, получает содержимое файла contents и file, должен возвращать строку

action.json()

Изменение содержимого json-файла как обьекта

actionObject = action.json( options );
параметртипописание
actionObjectobjectСозданный обьект действия для дальнейшего исполнения
optionsobjectПараметры действия
options.namestringОтображаемое в консоли имя действия при выполнении
options.optsobjectgulp.src параметры
options.srcstring|Arrayglob выборка файлов для обработки
options.deststringпуть назначения
options.cbfunctionколбек для транформации, получает обьект, должен возвращать обьект
1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago