Global

Members

---

<constant> config :Object

Config options

Type:

• Object

Properties:

Name	Type	Description
distDir	String	Base path to distributive (must be fully)
outDir	String	Base path to output dir (must be fully)
server	Object	Server config Properties Name Type Description path String Path to server port Number Server port openInBrowser Boolean Open default Browser after start7
liveReloadOptions	Object	Live reload options. Options list see on gulp-livereload API
css	Object | Array	CSS Options. If you want usage several processor, define as array object, options are (for everyone): Properties Name Type Description path Object | Array | String Config path. See For detail ignores Array Ignores pattern which will be adding to all gulp.src functions for css build processor String Package name for build sourceExt String Source filename extension outputExt String Output filename extension processor String Package name for build liveReloadOptions Object Livereload options for css building additionalMinifyWatchCallback function | undefined Additional minify watch callback. Called on Css class additionalBuildCallback function | undefined Additional build callback. Called on Css class additionalWatchCallback function | undefined Additional watch callback. Called on Css class additionalMinifyWatchCallback function | undefined Additional minify watch callback. Called on Css class minifyOptions function | undefined Options for gulp-clean-css package minifySuffix String | undefined Minify suffix for min file versions. By default is .min watchTasks String | Array Task which will be run on build files watcher. Be default is build-css watchMinifyTasks String | Array Task which will be run on minify files watcher. Be default is minify-css additionalMinifyPath Array | Object Additional minify files pattern which will be adding to all gulp.src functions for minify css. See Path config options for detail enableMin Boolean Enable or disable run minify task & watcher. By default is true processorOptions Object Options for gulp package which will be build css. Testing on gulp-stylus, gulp-sass and gulp-less
images	Object	Images optimize config Properties Name Type Description processorName String NPM package name for image optimizer (by default is gulp-imagemin liveReloadOptions Object Options for Livereload paths Object Config path. See For detail
templates	Object | Array	CSS Options. If you want usage several processor, define as array object, options are (for everyone): Properties Name Type Description path Object | Array | String Config path. See For detail ignores Array Ignores pattern which will be adding to all gulp.src functions for templates build processor String Package name for build sourceExt String Source filename extension outputExt String Output filename extension liveReloadOptions Object Livereload options for templates building additionalMinifyWatchCallback function | undefined Additional minify watch callback. Called on Templates class additionalBuildCallback function | undefined Additional build callback. Called on Templates class additionalWatchCallback function | undefined Additional watch callback. Called on Templates class additionalMinifyWatchCallback function | undefined Additional minify watch callback. Called on Templates class minifyOptions function | undefined Options for gulp-minhtml package minifySuffix String | undefined Minify suffix for min file versions. By default is .min watchTasks String | Array Task which will be run on build files watcher. Be default is minify-html watchMinifyTasks String | Array Task which will be run on minify files watcher. Be default is minify-html additionalMinifyPath Array | Object Additional minify files pattern which will be adding to all gulp.src functions for minify templates. See Path config options for detail enableMin Boolean Enable or disable run minify task & watcher. By default is true processorOptions Object Options for gulp package which will be build templates. Testing on gulp-pug
js	Object | Array	JS build Options. If you want usage several processor, or several distributive dir define as array object, options are (for everyone): Properties Name Type Description paths Object | Array | String Config path. See For detail ignores Array Ignores pattern which will be adding to all gulp.src functions for js build processor String Package name for build sourceExt String Source filename extension outputExt String Output filename extension liveReloadOptions Object Livereload options for js building additionalMinifyWatchCallback function | undefined Additional minify watch callback. Called on JS class additionalBuildCallback function | undefined Additional build callback. Called on JS class additionalWatchCallback function | undefined Additional watch callback. Called on JS class additionalMinifyWatchCallback function | undefined Additional minify watch callback. Called on JS class minifyOptions function | undefined Options for gulp-uglify/a> package minifySuffix String | undefined Minify suffix for min file versions. By default is .min watchTasks String | Array Task which will be run on build files watcher. Be default is build-js watchMinifyTasks String | Array Task which will be run on minify files watcher. Be default is minify-js additionalMinifyPath Array | Object Additional minify files pattern which will be adding to all gulp.src functions for minify js. See Path config options for detail enableMin Boolean Enable or disable run minify task & watcher. By default is true processorOptions Object Options for gulp package which will be build js. Testing on gulp-stylus, gulp-sass and gulp-less originalConfig Object Config which giving in constructor paths Object | Array Paths processorOptions Object | Array Processor options additionalMinifyPath Array | Object | undefined Additional minify paths additionalMinifyWatchCallback Array | Object | undefined Additional minify watch paths additionalBuildCallback Array | Object | undefined Additional build paths config additionalBuildCallback Array | Object | undefined Additional build paths config minifyOptions Array | Object | undefined Options for gulp-uglify package additionalMinifyWatchCallback function | undefined Additional minify watch callback additionalMinifyCallback function | undefined Additional minify callback minifySuffix String Suffix for minified files defaultProcessor String Default processor defTasks String | Array Default run tasks watchTasks String | Array Watch tasks for build paths watchMinifyTasks String | Array Watch tasks for minify paths configPaths Object Default path from config ignores Object | Array Ignore files pattern babelOptions Object Options for gulp-babel package
copyFiles	Object | Array	Copy files config Properties Name Type Description paths Object | Array Copy files config path. See For detail tasks Object | Array Tasks list for watch. Default is copy rsyncOptions function Additional rsync callback for adding wrapper options
moveFiles	Object | Array	Move files config Properties Name Type Description paths Object | Array Copy files config path. See For detail tasks Object | Array Tasks list for watch. Default is move rsyncOptions function Additional rsync callback for adding wrapper options
additionalTasks	Object	Additional tasks list in format "taskName": () => {... task body ...}
additionalSeries	Object	Additional tasks series list in format "seriesName": [... tasks list ...]
requireJSConcat	Object	AMD build app config Properties Name Type Description configFile String Path to require.js config file minOptions Object Options for gulp-uglify building amd file sourcePath Object Path to output build file minPath String Path to minified builded file requireJSConfig Object Additional options for gulp-requirejs Properties Name Type Description baseUrl String Base path to source dir outFile String Output filename configFile String Relative path to bootstrap require.js file
concat	Object	Concatenate files config Properties Name Type Description paths Object Paths in format 'outfileName': [... files list ...] concatOptions Object Options for gulp-concat minifyOptions Object Minify options for gulp-uglify

Author:

• Donii Sergii<doniysa@gmail.com>

Source:

• config.dist.js, line 26

---

<constant> pathConfig :Object

Config paths definitions. It's a virtual constants (for documentation) and tell you about path generate. You can definition as strings array path, destination folder will be put from config.outDir and src will be everyone string

You can use relative path or full. If you used relative path, you must define config.outDir and config.distDir in your config file

In the obligatory case, that was not transferred after processing, this config will consist of an array of objects with two properties:

Type:

• Object

Properties:

Name	Type	Description
src	String	Source folder
dest	String	Destination folder

Source:

• config.dist.js, line 9

See:

• PathBuild

---

<constant> WATCH_ALL :number

Watch all source

Type:

• number

Source:

• gulpfile.js, line 45

---

<constant> WATCH_BUILD :number

Build watcher flag

Type:

• number

Source:

• gulpfile.js, line 31

---

<constant> WATCH_MINIFY :number

Watch only for minify

Type:

• number

Source:

• gulpfile.js, line 38

Methods

---

buildConfigPath(config)

Build destination and output dir from config

Parameters:

Name	Type	Description
config	Object	Config

Source:

• gulpfile.js, line 58

Returns:

Type

Object

---

copyTask(confName, move, onlyWatch)

Runner for move/copy task or watch

Parameters:

Name	Type	Description
confName	String	Config name
move	Boolean	If true, run move copy task and copy otherwise
onlyWatch	Boolean	If true run watcher

Source:

• gulpfile.js, line 78

---

nextBuildTask(configName, construct, minify, watchType)

Parameters:

Name	Type	Description
configName	String	Option config name
construct	function	Function runner
minify	Boolean	If minify flag, run minify task
watchType	String | Boolean | undefined	Watch type. One of false/undefined (disable watch),

Source:

• gulpfile.js, line 112