Skip to content

Instantly share code, notes, and snippets.

@soin08
Last active December 4, 2023 22:33
Show Gist options
  • Save soin08/4793992d8cc537f62df3 to your computer and use it in GitHub Desktop.
Save soin08/4793992d8cc537f62df3 to your computer and use it in GitHub Desktop.
Gulpfile.js to use with Django projects. Based on gulpfile.js from Google Web Starter Kit.
//Based on gulpfile.js from Google Web Starter Kit.
//https://github.com/google/web-starter-kit
'use strict';
// Include Gulp & Tools We'll Use
var gulp = require('gulp');
var $ = require('gulp-load-plugins')();
var del = require('del');
var runSequence = require('run-sequence');
var browserSync = require('browser-sync');
var pagespeed = require('psi');
var reload = browserSync.reload;
var exec = require('child_process').exec;
var notifier = require('node-notifier');
var AUTOPREFIXER_BROWSERS = [
'ie >= 10',
'ie_mob >= 10',
'ff >= 30',
'chrome >= 34',
'safari >= 7',
'opera >= 23',
'ios >= 7',
'android >= 4.4',
'bb >= 10'
];
function getRelativePath(absPath) {
absPath = absPath.replace(/\\/g, '/');
var curDir = __dirname.replace(/\\/g, '/');
return absPath.replace(curDir, '');
}
function logUglifyError(error) {
this.emit('end');
var file = getRelativePath(error.fileName);
$.util.log($.util.colors.bgRed('Uglify Error:'))
$.util.log($.util.colors.bgMagenta('file: ') + $.util.colors.inverse(file));
$.util.log($.util.colors.bgMagenta('line: '+error.lineNumber));
//remove path from error message
var message = error.message.substr(error.message.indexOf(' ')+1);
$.util.log($.util.colors.bgRed(message));
notifier.notify({ title: 'Gulp message', message: 'Uglify error!' });
}
function logCoffeeError(error) {
this.emit('end');
var file = getRelativePath(error.filename);
$.util.log($.util.colors.bgRed('Coffee Error:'))
$.util.log($.util.colors.bgMagenta('file: ') + $.util.colors.inverse(file));
$.util.log($.util.colors.bgMagenta('line: '+error.location.first_line+', column: '+error.location.first_column));
$.util.log($.util.colors.bgRed(error.name+': '+error.message));
$.util.log($.util.colors.bgMagenta('near: ') + $.util.colors.inverse(error.code));
notifier.notify({ title: 'Gulp message', message: 'Coffee error!' });
};
function logSASSError(error) {
var file = getRelativePath(error.file);
$.util.log($.util.colors.bgRed('Sass Error:'))
$.util.log($.util.colors.bgMagenta('file: ') + $.util.colors.inverse(file));
$.util.log($.util.colors.bgMagenta('line: '+error.line+', column: '+error.column));
$.util.log($.util.colors.bgRed(error.message));
notifier.notify({ title: 'Gulp message', message: 'SASS Error!' });
}
// Lint JavaScript
gulp.task('jshint', function () {
return gulp.src('app/static/scripts/**/*.js')
.pipe(reload({stream: true, once: true}))
.pipe($.jshint())
.pipe($.jshint.reporter('jshint-stylish'));
});
//Lint CoffeeScript
gulp.task('coffeelint', function() {
return gulp.src('app/static/scripts/**/*.coffee')
.pipe(reload({stream: true, once: true}))
.pipe($.coffeelint())
.pipe($.coffeelint.reporter())
})
// Optimize Images
gulp.task('images', function () {
return gulp.src('app/static/images/**/*')
.pipe($.cache($.imagemin({
progressive: true,
interlaced: true
})))
.pipe(gulp.dest('dist/static/images'))
.pipe($.size({title: 'images'}));
});
// Copy All Files At The Root Level (app)
gulp.task('copy', function () {
return gulp.src([
'app/**',
'!app/**/__pycache__{,/**}',
'!app/templates{,/**/*.html}',
'!app/static{/fonts/**,/images/**,/scripts/**,/styles/**}'
], {
dot: true
}).pipe(gulp.dest('dist'))
.pipe($.size({title: 'copy'}));
});
// Copy Web Fonts To Dist
gulp.task('fonts', function () {
return gulp.src(['app/static/fonts/**'])
.pipe(gulp.dest('dist/static/fonts'))
.pipe($.size({title: 'fonts'}));
});
// Compile and Automatically Prefix Stylesheets
gulp.task('styles', function () {
// For best performance, don't add Sass partials to `gulp.src`
return gulp.src([
'app/static/styles/*.scss',
'app/static/styles/**/*.css',
'app/static/styles/components/components.scss'
])
.pipe($.sourcemaps.init())
//.pipe($.changed('.tmp/styles', {extension: '.css'}))
.pipe($.sass({
precision: 10,
onError: logSASSError
}))
.pipe($.autoprefixer({browsers: AUTOPREFIXER_BROWSERS}))
.pipe($.sourcemaps.write())
.pipe(gulp.dest('.tmp/styles'))
// Concatenate And Minify Styles
.pipe($.if('*.css', $.csso()))
.pipe($.rename({suffix: '.min'}))
.pipe(gulp.dest('dist/static/styles'))
.pipe($.size({title: 'styles'}));
});
//Concat and minify scripts
gulp.task('scripts', function() {
return gulp.src([
'app/static/scripts/**/*.coffee',
'app/static/scripts/**/*.js'
])
.pipe($.sourcemaps.init())
.pipe($.changed('.tmp/scripts', {extension: '.js'}))
.pipe($.if('*.coffee', $.coffee({ bare: true })))
.on('error', logCoffeeError)
.pipe($.concat('app.js'))
.pipe($.sourcemaps.write())
.pipe(gulp.dest('.tmp/scripts'))
.pipe($.uglify())
.on('error', logUglifyError)
.pipe($.rename({suffix: '.min'}))
.pipe(gulp.dest('dist/static/scripts'))
.pipe($.size({title: 'scripts'}));
})
// Scan Your HTML For Assets & Optimize Them
gulp.task('html', function () {
var assets = $.useref.assets({searchPath: '{.tmp,app}'});
return gulp.src('app/templates/**/*.html')
.pipe(assets)
// Concatenate And Minify JavaScript
.pipe($.if('*.js', $.uglify({preserveComments: 'some'})))
// Remove Any Unused CSS
// Note: If not using the Style Guide, you can delete it from
// the next line to only include styles your project uses.
.pipe($.if('*.css', $.uncss({
html: [
'app/templates/**/*.html'
],
// CSS Selectors for UnCSS to ignore
ignore: [
/.navdrawer-container.open/,
/.app-bar.open/
]
})))
// Concatenate And Minify Styles
// In case you are still using useref build blocks
.pipe($.if('*.css', $.csso()))
.pipe(assets.restore())
.pipe($.useref())
// Update Production Style Guide Paths
.pipe($.replace('components/components.css', 'components/main.min.css'))
// Minify Any HTML
.pipe($.if('*.html', $.minifyHtml()))
// Output Files
.pipe(gulp.dest('dist/templates'))
.pipe($.size({title: 'html'}));
});
// Clean Output Directory
gulp.task('clean', del.bind(null, ['.tmp', 'dist/*', '!dist/.git'], {dot: true}));
//Activate virtualenv and run Django server
gulp.task('runserver', function() {
var isWin = /^win/.test(process.platform);
var cmd = '. ../bin/activate';
if (isWin) { //for Windows
cmd = '..\\Scripts\\activate';
}
var proc = exec(cmd+' && python app/manage.py runserver');
});
gulp.task('runserver:dist', function() {
var isWin = /^win/.test(process.platform);
var cmd = '. ../bin/activate';
if (isWin) { //for Windows
cmd = '..\\Scripts\\activate';
}
var proc = exec(cmd+' && python dist/manage.py runserver');
});
// Build and serve the output from the dist build
gulp.task('serve:dist', ['build', 'runserver:dist'], function () {
browserSync({
notify: false,
proxy: "127.0.0.1:8000"
});
});
// Build Production Files
gulp.task('build', ['clean'], function (cb) {
runSequence('styles', ['jshint', 'coffeelint', 'scripts', 'html', 'images', 'fonts', 'copy'], cb);
});
// Watch Files For Changes & Reload, the default task
gulp.task('default', ['styles', 'jshint', 'coffeelint', 'scripts', 'runserver'], function () {
browserSync({
notify: false,
proxy: "127.0.0.1:8000"
});
gulp.watch(['app/**/*.html'], reload);
gulp.watch(['app/static/styles/**/*.{scss,css}'], ['styles', reload]);
gulp.watch(['app/static/scripts/**/*.js'], ['jshint']);
gulp.watch(['app/static/scripts/**/*.coffee'], ['coffeelint']);
gulp.watch(['app/static/scripts/**/*.{js,coffee}'], ['scripts', reload]);
gulp.watch(['app/static/images/**/*'], reload);
});
// Run PageSpeed Insights
gulp.task('pagespeed', function (cb) {
// Update the below URL to the public URL of your site
pagespeed.output('example.com', {
strategy: 'mobile',
// By default we use the PageSpeed Insights free (no API key) tier.
// Use a Google Developer API key if you have one: http://goo.gl/RkN0vE
// key: 'YOUR_API_KEY'
}, cb);
});
// Load custom tasks from the `tasks` directory
// try { require('require-dir')('tasks'); } catch (err) { console.error(err); }
{
"devDependencies": {
"browser-sync": "^2.2.1",
"del": "^1.1.1",
"gulp": "^3.8.11",
"gulp-autoprefixer": "^2.1.0",
"gulp-cache": "^0.2.8",
"gulp-changed": "^1.1.1",
"gulp-coffee": "^2.3.1",
"gulp-coffeelint": "^0.4.0",
"gulp-concat": "^2.5.2",
"gulp-csso": "^1.0.0",
"gulp-flatten": "0.0.4",
"gulp-if": "^1.2.5",
"gulp-imagemin": "^2.2.1",
"gulp-jshint": "^1.9.2",
"gulp-load-plugins": "^0.8.1",
"gulp-minify-html": "^1.0.0",
"gulp-rename": "^1.2.0",
"gulp-replace": "^0.5.3",
"gulp-sass": "^1.3.3",
"gulp-size": "^1.2.1",
"gulp-sourcemaps": "^1.5.0",
"gulp-uglify": "^1.1.0",
"gulp-uncss": "^1.0.0",
"gulp-useref": "^1.1.1",
"gulp-util": "^3.0.4",
"jshint-stylish": "^1.0.1",
"node-notifier": "^4.1.2",
"opn": "^1.0.1",
"psi": "^1.0.6",
"require-dir": "^0.1.0",
"run-sequence": "^1.0.2"
},
"engines": {
"node": ">=0.10.0"
},
"private": true,
"scripts": {
"test": "gulp && git status | grep 'working directory clean' >/dev/null || (echo 'Please commit all changes generated by building'; exit 1)"
}
}
@jyek
Copy link

jyek commented Oct 21, 2015

This is excellent. For the 'runserver' task, you could do something like this so that you get your usual console and request logs:

    var proc = exec(cmd+' && PYTHONUNBUFFERED=1 python manage.py runserver');

    proc.stderr.on('data', function(data) {
      process.stdout.write(data);
    });

    proc.stdout.on('data', function(data) {
      process.stdout.write(data);
    });

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment