Skip to content

Instantly share code, notes, and snippets.

@mharis mharis/gulpfile.js
Last active Oct 29, 2018

Embed
What would you like to do?
// Require our dependencies
const autoprefixer = require( 'autoprefixer' );
const babel = require( 'gulp-babel' );
const bourbon = require( 'bourbon' ).includePaths;
const browserSync = require( 'browser-sync' );
const cheerio = require( 'gulp-cheerio' );
const concat = require( 'gulp-concat' );
const cssnano = require( 'gulp-cssnano' );
const del = require( 'del' );
const eslint = require( 'gulp-eslint' );
const gulp = require( 'gulp' );
const gutil = require( 'gulp-util' );
const imagemin = require( 'gulp-imagemin' );
const mqpacker = require( 'css-mqpacker' );
const notify = require( 'gulp-notify' );
const plumber = require( 'gulp-plumber' );
const postcss = require( 'gulp-postcss' );
const rename = require( 'gulp-rename' );
const sass = require( 'gulp-sass' );
const sassdoc = require( 'sassdoc' );
const sassLint = require( 'gulp-sass-lint' );
const sort = require( 'gulp-sort' );
const sourcemaps = require( 'gulp-sourcemaps' );
const spritesmith = require( 'gulp.spritesmith' );
const svgmin = require( 'gulp-svgmin' );
const svgstore = require( 'gulp-svgstore' );
const uglify = require( 'gulp-uglify' );
const wpPot = require( 'gulp-wp-pot' );
// Set assets paths.
const paths = {
'css': [ './*.css', '!*.min.css' ],
'icons': 'assets/images/svg-icons/*.svg',
'images': [ 'assets/images/*', '!assets/images/*.svg' ],
'php': [ './*.php', './**/*.php' ],
'sass': 'assets/sass/**/*.scss',
'concat_scripts': 'assets/scripts/concat/*.js',
'scripts': [ 'assets/scripts/*.js', '!assets/scripts/*.min.js' ],
'sprites': 'assets/images/sprites/*.png'
};
/**
* Handle errors and alert the user.
*/
function handleErrors() {
const args = Array.prototype.slice.call( arguments );
notify.onError( {
'title': 'Task Failed [<%= error.message %>',
'message': 'See console.',
'sound': 'Sosumi' // See: https://github.com/mikaelbr/node-notifier#all-notification-options-with-their-defaults
} ).apply( this, args );
gutil.beep(); // Beep 'sosumi' again.
// Prevent the 'watch' task from stopping.
this.emit( 'end' );
}
/**
* Delete style.css and style.min.css before we minify and optimize
*/
gulp.task( 'clean:styles', () =>
del( [ 'style.css', 'style.min.css' ] )
);
/**
* Compile Sass and run stylesheet through PostCSS.
*
* https://www.npmjs.com/package/gulp-sass
* https://www.npmjs.com/package/gulp-postcss
* https://www.npmjs.com/package/gulp-autoprefixer
* https://www.npmjs.com/package/css-mqpacker
*/
gulp.task( 'postcss', [ 'clean:styles' ], () =>
gulp.src( 'assets/sass/*.scss', paths.css )
// Deal with errors.
.pipe( plumber( {'errorHandler': handleErrors} ) )
// Wrap tasks in a sourcemap.
.pipe( sourcemaps.init() )
// Compile Sass using LibSass.
.pipe( sass( {
'includePaths': [].concat( bourbon ),
'errLogToConsole': true,
'outputStyle': 'expanded' // Options: nested, expanded, compact, compressed
} ) )
// Parse with PostCSS plugins.
.pipe( postcss( [
autoprefixer( {
'browsers': [ 'last 2 version' ]
} ),
mqpacker( {
'sort': true
} )
] ) )
// Create sourcemap.
.pipe( sourcemaps.write() )
// Create style.css.
.pipe( gulp.dest( './' ) )
.pipe( browserSync.stream() )
);
/**
* Minify and optimize style.css.
*
* https://www.npmjs.com/package/gulp-cssnano
*/
gulp.task( 'cssnano', [ 'postcss' ], () =>
gulp.src( 'style.css' )
.pipe( plumber( {'errorHandler': handleErrors} ) )
.pipe( cssnano( {
'safe': true // Use safe optimizations.
} ) )
.pipe( rename( 'style.min.css' ) )
.pipe( gulp.dest( './' ) )
.pipe( browserSync.stream() )
);
/**
* Delete the svg-icons.svg before we minify, concat.
*/
gulp.task( 'clean:icons', () =>
del( [ 'assets/images/svg-icons.svg' ] )
);
/**
* Minify, concatenate, and clean SVG icons.
*
* https://www.npmjs.com/package/gulp-svgmin
* https://www.npmjs.com/package/gulp-svgstore
* https://www.npmjs.com/package/gulp-cheerio
*/
gulp.task( 'svg', [ 'clean:icons' ], () =>
gulp.src( paths.icons )
// Deal with errors.
.pipe( plumber( {'errorHandler': handleErrors} ) )
// Minify SVGs.
.pipe( svgmin() )
// Add a prefix to SVG IDs.
.pipe( rename( {'prefix': 'icon-'} ) )
// Combine all SVGs into a single <symbol>
.pipe( svgstore( {'inlineSvg': true} ) )
// Clean up the <symbol> by removing the following cruft...
.pipe( cheerio( {
'run': function( $, file ) {
$( 'svg' ).attr( 'style', 'display:none' );
$( '[fill]' ).removeAttr( 'fill' );
$( 'path' ).removeAttr( 'class' );
$( 'title' ).remove();
},
'parserOptions': {'xmlMode': true}
} ) )
// Save svg-icons.svg.
.pipe( gulp.dest( 'assets/images/' ) )
.pipe( browserSync.stream() )
);
/**
* Optimize images.
*
* https://www.npmjs.com/package/gulp-imagemin
*/
gulp.task( 'imagemin', () =>
gulp.src( paths.images )
.pipe( plumber( {'errorHandler': handleErrors} ) )
.pipe( imagemin( {
'optimizationLevel': 5,
'progressive': true,
'interlaced': true
} ) )
.pipe( gulp.dest( 'assets/images' ) )
);
/**
* Delete the sprites.png before rebuilding sprite.
*/
gulp.task( 'clean:sprites', () => {
del( [ 'assets/images/sprites.png' ] );
} );
/**
* Concatenate images into a single PNG sprite.
*
* https://www.npmjs.com/package/gulp.spritesmith
*/
gulp.task( 'spritesmith', () =>
gulp.src( paths.sprites )
.pipe( plumber( {'errorHandler': handleErrors} ) )
.pipe( spritesmith( {
'imgName': 'sprites.png',
'cssName': '../../assets/sass/base/_sprites.scss',
'imgPath': 'assets/images/sprites.png',
'algorithm': 'binary-tree'
} ) )
.pipe( gulp.dest( 'assets/images/' ) )
.pipe( browserSync.stream() )
);
/**
* Concatenate and transform JavaScript.
*
* https://www.npmjs.com/package/gulp-concat
* https://github.com/babel/gulp-babel
* https://www.npmjs.com/package/gulp-sourcemaps
*/
gulp.task( 'concat', () =>
gulp.src( paths.concat_scripts )
// Deal with errors.
.pipe( plumber(
{'errorHandler': handleErrors}
) )
// Start a sourcemap.
.pipe( sourcemaps.init() )
// Convert ES6+ to ES2015.
.pipe( babel( {
'presets': [
[ 'env', {
'targets': {
'browsers': [ 'last 2 versions' ]
}
} ]
]
} ) )
// Concatenate partials into a single script.
.pipe( concat( 'project.js' ) )
// Append the sourcemap to project.js.
.pipe( sourcemaps.write() )
// Save project.js
.pipe( gulp.dest( 'assets/scripts' ) )
.pipe( browserSync.stream() )
);
/**
* Minify compiled JavaScript.
*
* https://www.npmjs.com/package/gulp-uglify
*/
gulp.task( 'uglify', [ 'concat' ], () =>
gulp.src( paths.scripts )
.pipe( plumber( {'errorHandler': handleErrors} ) )
.pipe( rename( {'suffix': '.min'} ) )
.pipe( babel( {
'presets': [
[ 'env', {
'targets': {
'browsers': [ 'last 2 versions' ]
}
} ]
]
} ) )
.pipe( uglify( {
'mangle': false
} ) )
.pipe( gulp.dest( 'assets/scripts' ) )
);
/**
* Delete the theme's .pot before we create a new one.
*/
gulp.task( 'clean:pot', () =>
del( [ 'languages/_s.pot' ] )
);
/**
* Scan the theme and create a POT file.
*
* https://www.npmjs.com/package/gulp-wp-pot
*/
gulp.task( 'wp-pot', [ 'clean:pot' ], () =>
gulp.src( paths.php )
.pipe( plumber( {'errorHandler': handleErrors} ) )
.pipe( sort() )
.pipe( wpPot( {
'domain': '_s',
'package': '_s'
} ) )
.pipe( gulp.dest( 'languages/_s.pot' ) )
);
/**
* Sass linting.
*
* https://www.npmjs.com/package/sass-lint
*/
gulp.task( 'sass:lint', () =>
gulp.src( [
'assets/sass/**/*.scss',
'!assets/sass/base/_normalize.scss',
'!assets/sass/base/_sprites.scss',
'!node_modules/**'
] )
.pipe( sassLint() )
.pipe( sassLint.format() )
.pipe( sassLint.failOnError() )
);
/**
* JavaScript linting.
*
* https://www.npmjs.com/package/gulp-eslint
*/
gulp.task( 'js:lint', () =>
gulp.src( [
'assets/scripts/concat/*.js',
'assets/scripts/*.js',
'!assets/scripts/project.js',
'!assets/scripts/*.min.js',
'!Gruntfile.js',
'!Gulpfile.js',
'!node_modules/**'
] )
.pipe( eslint() )
.pipe( eslint.format() )
.pipe( eslint.failAfterError() )
);
/**
* Sass docs.
*
* http://sassdoc.com/getting-started/
*/
gulp.task( 'sassdoc', function() {
let options = {
dest: 'docs',
verbose: true
};
return gulp.src( 'assets/sass/**/*.scss' )
.pipe( sassdoc( options ) );
} );
/**
* Process tasks and reload browsers on file changes.
*
* https://www.npmjs.com/package/browser-sync
*/
gulp.task( 'watch', function() {
// Kick off BrowserSync.
browserSync( {
'open': false, // Open project in a new tab?
'injectChanges': true, // Auto inject changes instead of full reload.
'proxy': 'https://_s.test', // Use https://_s.test:3000 to use BrowserSync.
'watchOptions': {
'debounceDelay': 500 // Wait 500ms second before injecting.
}
} );
// Run tasks when files change.
gulp.watch( paths.icons, [ 'icons' ] );
gulp.watch( paths.sass, [ 'styles' ] );
gulp.watch( paths.scripts, [ 'scripts' ] );
gulp.watch( paths.concat_scripts, [ 'scripts' ] );
gulp.watch( paths.sprites, [ 'sprites' ] );
gulp.watch( paths.php, [ 'markup' ] );
} );
/**
* Create individual tasks.
*/
gulp.task( 'markup', browserSync.reload );
gulp.task( 'i18n', [ 'wp-pot' ] );
gulp.task( 'icons', [ 'svg' ] );
gulp.task( 'scripts', [ 'uglify' ] );
gulp.task( 'styles', [ 'cssnano' ] );
gulp.task( 'sprites', [ 'spritesmith' ] );
gulp.task( 'lint', [ 'sass:lint', 'js:lint' ] );
gulp.task( 'docs', [ 'sassdoc' ] );
gulp.task( 'default', [ 'sprites', 'i18n', 'icons', 'styles', 'scripts', 'imagemin' ] );
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.