apc-build v0.4.5

APC Build Tools

Gulp build scripts for front end APC projects

• APC Build Tools
  • Task register helpers
  • Gulp tasks
  • Utilities

Task register helpers

register(gulp, config) ⇒ Object

Register gulp tasks based on a passed config object

Returns: Object - registerWatchers function and array of registered task names

Example

const gulp = require('gulp')

const register = require('apc-build').register(gulp, {
  scssSrc: 'src/**\/*.scss',
  scssIncludePaths: [],
  cssDest: 'output/css',
  showFileSizes: true
})

console.log(register)
// Returns
// {
//   tasks: [ 'lint-sass', 'build-sass' ],
//   registerWatchers: [Function: registerWatchers]
// }

register.registerWatchers(gulp)

Register watchers corresponding to the tasks already set up

Kind: method of register return(#register)

Example

const gulp = require('gulp')

const register = require('apc-build').register(gulp, config)

// Watchers corresponding to config values
// will be registered within watch task
gulp.task('watch', () => {
  register.registerWatchers(gulp)
})

Gulp tasks

build-img(gulp, path, dest) ⇒ function

Copy and compress images with imagemin

Returns: function - Gulp task

Example

const gulp = require('gulp')
const tasks = require('apc-build')

gulp.task('build-img', tasks['build-img'](gulp, ['src/img/*'], 'dist/img'))

build-js(gulp, entries, dest, destFilename, showFileSizes, browserifyIgnore) ⇒ function

Bundle and browserify front end JS files

Returns: function - Gulp task

Example

const gulp = require('gulp')
const tasks = require('apc-build')

gulp.task('build-js', tasks['build-js'](gulp, ['src/js/entry.js'], 'dist/js', 'bundle.js'))

build-sass(gulp, path, dest, scssIncludePaths, showFileSizes) ⇒ function

Compile sass files

Returns: function - Gulp task

Example

const gulp = require('gulp')
const tasks = require('apc-build')

gulp.task('build-sass', tasks['build-sass'](gulp, ['src/scss/*.scss'], 'dist/css', ['node_modules/foundation-sites/scss']))

lint-js(gulp, path) ⇒ function

Lint js files using eslint

Returns: function - Gulp task

Example

const gulp = require('gulp')
const tasks = require('apc-build')

gulp.task('lint-js', tasks['lint-js'](gulp, ['src/js/*']))

lint-pug(gulp, path) ⇒ function

Lint pug files using pug linter

Returns: function - Gulp task

Example

const gulp = require('gulp')
const tasks = require('apc-build')

gulp.task('lint-pug', tasks['lint-pug'](gulp, ['app/views/*.pug']))

lint-sass(gulp, path) ⇒ function

Lint sass files using sass-lint

Returns: function - Gulp task

Example

const gulp = require('gulp')
const tasks = require('apc-build')

gulp.task('lint-sass', tasks['lint-sass'](gulp, 'src/scss/*'))

Utilities

is-gulp(gulp)

Test if object is an instance of gulp

Throws:

• Error Gulp instance not passed