I'm pretty new to Gulp, but I thought I had a handle on it, until I inherited a WordPress theme that needed some development work on.
I've been compiling my styles with no issues until it came to compiling the editor-styles.scss
This is the basic file structure for my styles:
theme-name
_static
styles
_admin
editor-styles.scss
editor-styles.min.css
admin-styles.scss
admin-styoles.min.css
login-styles.scss
login-styles.min.css
_layout
_block.scss
_header.scss
_utils
_mixins.scss
_variables.scss
styles.scss
styles.css
All changes to any scss file in the _layout and _utils folders are compiled correctly to the styles.css in the main index.
When I edit an scss file in the _admin folder, I need it to compile to the .min.css version in that same folder.
Instead, it's compiling and creating a new _admin folder in the main theme index with .css files.
I know why this is, because that is what I have told my compiling to do in my gulpfile.js
However, I can't get my head around how to split these two sources?
This is my gulpfile.js:
// MODULES
var gulp = require('gulp');
var sass = require('gulp-sass');
var js = require('gulp-uglify');
var imagemin = require('gulp-imagemin');
var browserSync = require('browser-sync').create();
var reload = browserSync.reload;
var plumber = require('gulp-plumber');
var gutil = require('gulp-util');
var autoprefixer = require('gulp-autoprefixer');
var sourcemaps = require('gulp-sourcemaps');
var rename = require('gulp-rename');
var concat = require('gulp-concat');
// COMPILE AND MINIFY SASS
gulp.task('sass', function () {
return gulp.src('./wp-content/themes/theme-name/_static/styles/**/*.scss')
.pipe(plumber())
.pipe(sass.sync().on('error', sass.logError))
.pipe(sourcemaps.write())
.pipe(gulp.dest('./wp-content/themes/theme-name'))
.pipe(browserSync.stream())
done();
});
// MINIFY JS
gulp.task('js', function () {
return gulp.src('./wp-content/themes/theme-name/_static/js/*.js')
.pipe(js())
.on('error', onError)
.pipe(rename({
suffix: '.min'
}))
.pipe(concat('all.min.js'))
.pipe(gulp.dest('./wp-content/themes/theme-name/_static/js/min/'))
.pipe(browserSync.stream())
done();
});
// IMAGES
gulp.task('imagemin', function () {
return gulp.src('./wp-content/themes/theme-name/*')
.pipe(imagemin())
.pipe(gulp.dest('./wp-content/themes/theme-name/images'))
done();
});
// BROWSERSYNC
gulp.task('browser-sync', function(done) {
browserSync.init({
proxy: 'http://localhost/project-name'
})
done();
});
// RELOAD
gulp.task('reload', function (done) {
browserSync.reload();
done();
});
// ERROR LOG
var onError = function (err) {
console.log('An error occurred:', gutil.colors.magenta(err.message));
gutil.beep();
this.emit('end');
};
// WATCH
gulp.task('watch', function() {
gulp.watch('./wp-content/themes/theme-name/_static/styles/**/*.scss', gulp.series('sass'));
gulp.watch('./wp-content/themes/theme-name/_static/js/*.js', gulp.series('js'));
gulp.watch('./wp-content/themes/theme-name/images/*', gulp.series('imagemin'));
gulp.watch('./wp-content/themes/theme-name/**/*.php').on('change', browserSync.reload);
gulp.watch('*/theme-name/**/*.php').on('change', browserSync.reload);
});
gulp.task('default', gulp.series('sass', 'js', 'imagemin', 'browser-sync', 'watch'));
Thanks in advance for any help/advice - I'm banging my head against a wall and I'm sure it's something super simple I've overlooked.
There is more than one way to accomplish what you want. You could have separate watch statements triggering separate sass statements for your different directories. The advantage to that is you are not running all your .scss files everytime.
But consider this. Using the gulp-if plugin which allows you to make if/else decisions mid-stream.
const gulpif = require('gulp-if');
const path = require('path'); // needed to get the last directory name in a path
const condition = function (file) {
const match = path.basename(path.dirname(file.path));
return match === "_admin";
}
// COMPILE AND MINIFY SASS
gulp.task('sass', function () {
return gulp.src('./_static/styles/**/*.scss')
.pipe(plumber())
.pipe(sass.sync().on('error', sass.logError))
.pipe(sourcemaps.write())
// if condition is true use first gulp.dest, else use second
// condition is true if current file parent directory is _admin
.pipe(gulpif(condition, gulp.dest('./_static/styles/'), gulp.dest('./')))
.pipe(browserSync.stream());
// done(); // not needed with the return
});
The disadvantage of this method is that all .scss files are re-compiled each time.
If anyone needs to know how to run tasks for separate src and destinations, this is what works for me :) Thanks for your help Mark.
// This is my main sass files.
// It compiles all my sass files, EXCEPT any files in the _admin folder
// and compiles them to styles.css in my main theme index/root
gulp.task('sass', function () {
return gulp.src([
'./wp-content/themes/theme-name/_static/styles/**/*.scss',
'!./wp-content/themes/theme-name/_static/styles/_admin/*.scss'
])
.pipe(plumber())
.pipe(sass.sync().on('error', sass.logError))
.pipe(sourcemaps.write())
.pipe(gulp.dest('./wp-content/themes/andra-birkerts-design'))
.pipe(browserSync.stream())
done();
});
// This is my main admin sass file.
// It compiles just the sass files in the _admin folder
// and compiles them to filename.min.css in the same _admin folder
gulp.task('admin_sass', function () {
return gulp.src('./wp-content/themes/theme-name/_static/styles/_admin/*.scss')
.pipe(plumber())
.pipe(sass.sync().on('error', sass.logError))
.pipe(sourcemaps.write())
.pipe(rename({
suffix: '.min'
}))
.pipe(gulp.dest('./wp-content/themes/theme-name/_static/styles/_admin'))
.pipe(browserSync.stream())
done();
});
gulp.task('default', gulp.series('sass', 'admin_sass', 'browser-sync', 'watch'));
Related
When I use gulp styles it just pipes the initial code to the destination without autoprefixing and when I'm trying to use gulp watch on styles function it starts but never ends.
I'm using Gulp 4
gulpfile
var gulp = require('gulp');
var autoprefixer = require('gulp-autoprefixer');
gulp.task('styles', function() {
return new Promise(function(resolve, reject){
gulp.src('style.css')
.pipe(autoprefixer())
.pipe(gulp.dest('build'))
resolve();
});
});
gulp.task('watch', function() {
gulp.watch('style.css', gulp.series('styles'));
});
Terminal output
PS C:\Users\OneDrive\testGulp> gulp watch
[19:00:23] Using gulpfile ~\OneDrive\testGulp\gulpfile.js
[19:00:23] Starting 'watch'...
File tree structure
So I've been working on this project for a little while and I wanted to add my own css into the project. I'm trying to add a new scss file to the project and have it get built into the main css file, however Gulp doesn't want to import my scss file.
Here is the gulp code
var gulp = require('gulp');
var uglify = require('gulp-uglify');
var watch = require('gulp-watch');
var batch = require('gulp-batch');
var sass = require('gulp-sass');
var minifyCss = require('gulp-minify-css');
var concat = require('gulp-concat');
var rename = require('gulp-rename');
var webserver = require('gulp-webserver');
var paths = {
sass: ['src/scss/**'],
js: ['src/ng/_declare.js', 'src/ng/**'], //_declare.js needs to be first, so it gets added to bundle first.
static: ['src/js/**'],
core: ['./td_frontend_shared/**']
};
gulp.task('default', ['watch-dev']);
gulp.task('publish-dev', function(done){
});
gulp.task('sass', function(done) {
gulp.src('src/scss/import.scss')
.pipe(sass())
.on('error', function(err){
console.log('error building sass', err);
done();
})
.pipe(gulp.dest('public/dist/'))
.pipe(minifyCss({
keepSpecialComments: 0
}))
.pipe(rename({ extname: '.min.css' }))
.pipe(gulp.dest('public/dist/'))
.on('end', done);
});
Any help would be greatly appreciated!
You need to add the task in default if you want it run right away on using gulp in command line. You can do it like this...
gulp.task( 'default', function () {
gulp.start(
'sass'
);
} );
Try my repository for using SASS in HTML projects, it supports babel(optional) and auto reloads page when you change scss files ;)
https://github.com/shramee/gulp-sass-babel
I write most of my CSS in Chrome dev tools, so that the browser will watch for changes to the files and will refresh appropriately. I have recently switched from Compass to Gulp-Sass for compiling my SCSS, but Chrome no longer refreshes upon changes. If I swap out Gulp-Sass for Gulp-Ruby-Sass in my Gulpfile, Chrome will refresh.
I really want to stick with Gulp-Sass/libsass since it compiles so much faster and I don't want a Ruby dependency, but I can't figure out what I need to do to make Gulp-Sass fit in with my workflow.
Any suggestions would be appreciated. Thanks in advance.
Here's my gulpfile:
var gulp = require('gulp');
var sass = require('gulp-sass');
var sourcemaps = require('gulp-sourcemaps');
var minify = require('gulp-minify-css');
var rename = require('gulp-rename');
var sassdoc = require('sassdoc');
var sass_options = {
errLogToConsole: true,
outputStyle: 'compressed'
};
gulp.task('sass-app', function(){
return gulp.src('./static/sass/styles.scss')
.pipe(sourcemaps.init())
.pipe(sass(sass_options).on('error', sass.logError))
.pipe(sourcemaps.write('.'))
// .pipe(rename('styles.css'))
.pipe(gulp.dest('./static/css'));
});
gulp.task('sass-all', function() {
return gulp.src('./static/sass/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass(sass_options).on('error', sass.logError))
.pipe(sourcemaps.write('.'))
.pipe(gulp.dest('./static/css'));
});
gulp.task('watch', ['sass-app'], function(){
gulp.watch('./static/sass/**/*.scss', ['sass-app']);
});
gulp.task('watch-all', ['sass-all'], function (){
gulp.watch('./static/sass/**/*.scss', ['sass-all']);
});
I suggest Browsersync
Here's a sample code that may help with your problem with the proxy
gulp.task('watch-all', ['sass-all'], function (){
browserSync.init({
proxy: "http://localhost/project_name"
});
gulp.watch('./static/sass/**/*.scss', ['sass-all']);
});
I have a gulp 'default' task where I want to clean a folder before gulp continues to build my minified CSS and JS. This 'clean' task needs to run only once per default task. But I am having issues trying to get default task to reference the real build tasks.
So here is my gulpfile:
var gulp = require('gulp');
// including our plugins
var clean = require('gulp-clean');
var less = require('gulp-less');
var util = require('gulp-util');
var lsourcemaps = require('gulp-sourcemaps');
var rename = require('gulp-rename');
var filesize = require('gulp-filesize');
var ugly = require('gulp-uglify');
var path = require('path');
var plumber = require('gulp-plumber');
var minifyCSS = require('gulp-minify-css');
var concat = require('gulp-concat');
// DEFAULT TASK
gulp.task('default', ['clean'], function() {
.pipe(gulp.task('vendor'))
.pipe(gulp.task('css'))
});
// strips public folder for a build operation nice and clean ** obliterates! **
gulp.task('clean', function() {
return gulp.src('public/**', {read: false})
.pipe(clean());
});
// javascript vendor builds
gulp.task('vendor', function() {
return gulp.src(['bower_comps/angular/angular.js', 'bower_comps/angular-bootstrap/ui-bootstrap.js', 'bower_comps/angular-bootstrap/ui-bootstrap-tpls.js'])
//.pipe(filesize())
.pipe(ugly())
.pipe(concat('vendor.min.js'))
.pipe(gulp.dest('public/js'))
});
// builds CSS
gulp.task('css', function() {
return gulp.src('bower_comps/bootstrap-less/less/bootstrap.less')
.pipe(lsourcemaps.init())
.pipe(plumber({
errorHandler: function(err) {
console.log(err);
this.emit('end')
}
}))
.pipe(less({
paths: [path.join(__dirname, 'less', 'includes')]
}))
.pipe(minifyCSS())
.pipe(rename('site.min.css'))
.pipe(lsourcemaps.write('./maps'))
.pipe(gulp.dest('public/css/'))
.pipe(filesize())
});
So how am I going about this wrong?? Each of the individual tasks will run on their own just fine "gulp css", "gulp vendor". Its just when I put them into a default task (master task) with a 'pre-requisite' task of my clean that I run into problems.
Tony
Try these for your tasks:
gulp.task('clean', function() {
// Insert cleaning code here
});
gulp.task('vendor', ['clean'], function() {
// Insert your 'vendor' code here
});
gulp.task(‘css’, ['clean'], function() {
// insert your 'css' code here
});
gulp.task('build', [‘vendor’, ‘css’]);
gulp.task('default', ['build']);
'vendor' and 'css' will run concurrently only after 'clean' has finished. 'clean' will only run once despite being a prerequisite for both 'vendor' and 'css'.
The Problem ist when you call the default task, gulp randomly chooses the order of the task:
gulp.task('default', ['clean', 'move', 'scripts', 'css']);
To solve this problem each task should have dependencies. For example the move task should be performed after the clean task. So the move taks should look like this:
gulp.task('move', ['clean'], function () { //your code }
for more explanation: https://github.com/gulpjs/gulp/blob/master/docs/API.md#gulptaskname-deps-fn
sorry for my bad english :-)
Having trouble understanding where I'm going wrong with this (if it's me at all), I've got my (first) gulp file, and it's working fine:
var gulp = require('gulp');
var uglify = require('gulp-uglify');
var del = require('del');
var sourcemaps = require('gulp-sourcemaps');
var concat = require('gulp-concat');
var handlebars = require('gulp-handlebars');
var wrap = require('gulp-wrap');
var declare = require('gulp-declare');
gulp.task('default', ['clean', 'minify-external', 'minify-internal']);
gulp.task('clean', function() {
del(['build/js/'], function(err){ });
});
gulp.task('minify-external', function() {
return gulp.src([
'bower_components/jquery/dist/jquery.js',
'bower_components/handlebars/handlebars.js',
'bower_components/ember/ember.js',
'bower_components/ember-data/ember-data.js',
])
.pipe(sourcemaps.init())
.pipe(uglify())
.pipe(concat('scripts.min.js'))
.pipe(sourcemaps.write('.'))
.pipe(gulp.dest('build/js/'));
});
gulp.task('minify-internal', function() {
return gulp.src('src/js/**/*.js')
.pipe(sourcemaps.init())
.pipe(uglify())
.pipe(concat('lib.min.js'))
.pipe(sourcemaps.write('.'))
.pipe(gulp.dest('build/js//'));
});
gulp.watch('src/js/**/*.js', ['minify-internal']);
Next I'm trying to add the handlebars pre-compilation into it:
//above omitted for brevity
gulp.task('default', ['clean', 'minify-external', 'minify-internal']);
//...
gulp.task('templates', function() {
return gulp.src('src/templates/**/*.hbs')
.pipe(handlebars())
.pipe(wrap('Handlebars.template(<%= contents %>)'))
.pipe(declare({
namespace: 'Todos.templates',
noRedeclare: true, // Avoid duplicate declarations
}))
.pipe(concat('templates.min.js'))
.pipe(gulp.dest('build/js/'));
});
And the script now fails:
Error: EEXIST, mkdir '[BUILD PATH]/build/js'
Seems to be specific to the templates task, as the other two minify-x tasks run fine. I've attempted async and sync running (that is removing the return statements from tasks). Am I missing something on how streams interact here? Is it normal to output from multiple tasks to the same folder?