Documented gulp tasks, and added scripts to package.json

This commit is contained in:
Alicia Sykes
2017-04-24 20:39:54 +01:00
parent e2f7800ed8
commit c39f728f00
2 changed files with 86 additions and 85 deletions

View File

@@ -1,84 +1,84 @@
var gulp = require('gulp');
var gutil = require ('gulp-util');
var del = require('del');
var jade = require('gulp-jade');
var coffee = require('gulp-coffee');
var concat = require('gulp-concat');
var uglify = require('gulp-uglify');
var sass = require('gulp-sass');
var cleanCSS= require('gulp-clean-css');
var bower = require('gulp-bower');
// Compile Jade views into HTML
gulp.task('views', function() {
locals = require('./src/locals.json');
gulp.src('./src/views/*.jade')
.pipe(jade({locals: locals}))
.pipe(gulp.dest('./production/'))
});
// Compile CoffeeScript into JS, concat and minify
gulp.task('coffee', function() {
gulp.src('./src/scripts/**/*.coffee')
.pipe(coffee({bare: true}).on('error', gutil.log))
.pipe(concat('scripts.js'))
.pipe(uglify())
.pipe(gulp.dest('./production/js'));
});
// Compile SASS into CSS, concat and minify
gulp.task('sass', function () {
return gulp.src('./src/styles/basic.sass')
.pipe(sass().on('error', gutil.log))
.pipe(concat('styles.css'))
.pipe(cleanCSS({compatibility: 'ie8'}))
.pipe(gulp.dest('./production/css'));
});
// Copy all static assets to production
gulp.task('assets', function () {
return gulp.src('./src/assets/**/*')
.pipe(gulp.dest('./production/assets'));
});
// Watch source for changes, and run appropriate task
gulp.task('watch', function() {
gulp.watch('src/views/**/*.jade', ['views'] );
gulp.watch('src/scripts/**/*.coffee', ['coffee'] );
gulp.watch('src/styles/**/*.sass', ['sass'] );
gulp.watch('src/assets/**/*', ['assets'] );
gulp.watch('src/locals.json', ['build']);
});
// Run tests
gulp.task('test', function(){
gutil.log(gutil.colors.yellow(
'No tests have been configured in the gulpfile yet.'
));
});
// Delete production files
gulp.task('clean', function () {
return del([ 'production' ]);
});
// Build complete project
gulp.task('build', ['clean'], function(){
bower('./production/bower_components');
gulp.start('views', 'coffee', 'sass', 'assets');
gutil.beep(); // Delete this line if you don't like the sound effects!
});
// Default task - build the project then run tests
gulp.task('default', ['build'], function(){
gulp.start('test');
});
var gulp = require('gulp');
var gutil = require ('gulp-util');
var del = require('del');
var jade = require('gulp-jade');
var coffee = require('gulp-coffee');
var concat = require('gulp-concat');
var uglify = require('gulp-uglify');
var sass = require('gulp-sass');
var cleanCSS= require('gulp-clean-css');
var bower = require('gulp-bower');
// Compile Jade views into HTML
gulp.task('views', function() {
locals = require('./src/locals.json');
gulp.src('./src/views/*.jade')
.pipe(jade({locals: locals}))
.pipe(gulp.dest('./production/'))
});
// Compile CoffeeScript into JS, concat and minify
gulp.task('coffee', function() {
gulp.src('./src/scripts/**/*.coffee')
.pipe(coffee({bare: true}).on('error', gutil.log))
.pipe(concat('scripts.js'))
.pipe(uglify())
.pipe(gulp.dest('./production/js'));
});
// Compile SASS into CSS, concat and minify
gulp.task('sass', function () {
return gulp.src('./src/styles/basic.sass')
.pipe(sass().on('error', gutil.log))
.pipe(concat('styles.css'))
.pipe(cleanCSS({compatibility: 'ie8'}))
.pipe(gulp.dest('./production/css'));
});
// Copy all static assets to production
gulp.task('assets', function () {
return gulp.src('./src/assets/**/*')
.pipe(gulp.dest('./production/assets'));
});
// Watch source for changes, and run appropriate task
gulp.task('watch', function() {
gulp.watch('src/views/**/*.jade', ['views'] );
gulp.watch('src/scripts/**/*.coffee', ['coffee'] );
gulp.watch('src/styles/**/*.sass', ['sass'] );
gulp.watch('src/assets/**/*', ['assets'] );
gulp.watch('src/locals.json', ['build']);
});
// Run tests
gulp.task('test', function(){
gutil.log(gutil.colors.yellow(
'No tests have been configured in the gulpfile yet.'
));
});
// Delete production files
gulp.task('clean', function () {
return del([ 'production' ]);
});
// Build complete project
gulp.task('build', ['clean'], function(){
bower('./production/bower_components');
gulp.start('views', 'coffee', 'sass', 'assets');
gutil.beep(); // Delete this line if you don't like the sound effects!
});
// Default task - build the project then run tests
gulp.task('default', ['build'], function(){
gulp.start('test');
});

View File

@@ -7,7 +7,8 @@
"scripts": {
"test": "gulp test",
"build": "gulp build",
"watch": "gulp watch"
"watch": "gulp watch",
"postinstall": "bower install"
},
"author": "Alicia Sykes",
"license": "MIT",