rayelliott
/
understrap
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #533 from lilolbear/master 

DRYed config and added a non-conflicting vendor option with cleanup. Thx @lilolbear !!
This commit is contained in:
Holger 2018-02-02 11:35:52 +01:00 committed by GitHub
parent 35023d761f 1a446d5f42
commit 257ed23ec4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 91 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.jscsrc
View File

@ -2,6 +2,11 @@
"preset": "wordpress", "preset": "wordpress",
"fileExtensions": [ ".js" ], "fileExtensions": [ ".js" ],
"excludeFiles": [ "excludeFiles": [
"js/**.min.js" "js/**.min.js",
"js/**.min.js",
"src/**/*.js",
"js/core.js",
"js/popper.js",
"js/theme.js"
] ]
} }

6
.jshintignore
View File

@ -1 +1,5 @@
js/**.min.js js/**.min.js
src/**/*.js
js/core.js
js/popper.js
js/theme.js

2
.travis.yml
View File

@ -93,4 +93,4 @@ script:
# -n flag: Do not print warnings (shortcut for --warning-severity=0) # -n flag: Do not print warnings (shortcut for --warning-severity=0)
# --standard: Use WordPress as the standard. # --standard: Use WordPress as the standard.
# --extensions: Only sniff PHP files. # --extensions: Only sniff PHP files.
- $WP_DEVELOP_DIR/php-codesniffer/scripts/phpcs -p -s -v -n . --standard=./codesniffer.ruleset.xml --extensions=php - $WP_DEVELOP_DIR/php-codesniffer/scripts/phpcs -p -s -v -n . --standard=./codesniffer.ruleset.xml --extensions=php --ignore=*/woocommerce/*,*/src/*

22
gulpconfig.json Normal file
View File

@ -0,0 +1,22 @@
{
"browserSyncOptions" : {
"proxy": "localhost/wordpress/",
"notify": false
},
"browserSyncWatchFiles" : [
"./css/*.min.css",
"./js/*.min.js",
"./**/*.php"
],
"paths" : {
"js": "./js",
"css": "./css",
"sass": "./sass",
"node": "./node_modules/",
"bower": "./bower_components/",
"dev": "./src",
"dist": "./dist",
"distprod": "./dist-product",
"vendor": ""
}
}

123
gulpfile.js
View File

@ -1,28 +1,3 @@
// Defining base paths
var basePaths = {
js: './js/',
node: './node_modules/',
dev: './src/'
};
// browser-sync watched files
// automatically reloads the page when files changed
var browserSyncWatchFiles = [
'./css/*.min.css',
'./js/*.min.js',
'./**/*.php'
];
// browser-sync options
// see: https://www.browsersync.io/docs/options/
var browserSyncOptions = {
proxy: "localhost/wordpress/",
notify: false
};
// Defining requirements // Defining requirements
var gulp = require('gulp'); var gulp = require('gulp');
var plumber = require('gulp-plumber'); var plumber = require('gulp-plumber');
@ -43,13 +18,17 @@ var browserSync = require('browser-sync').create();
var del = require('del'); var del = require('del');
var cleanCSS = require('gulp-clean-css'); var cleanCSS = require('gulp-clean-css');
var gulpSequence = require('gulp-sequence'); var gulpSequence = require('gulp-sequence');
var replace = require('gulp-replace');
// Configuration file to keep your code DRY
var cfg = require('./gulpconfig.json');
var paths = cfg.paths;
// Run: // Run:
// gulp sass + cssnano + rename // gulp sass + cssnano + rename
// Prepare the min.css for production (with 2 pipes to be sure that "theme.css" == "theme.min.css") // Prepare the min.css for production (with 2 pipes to be sure that "theme.css" == "theme.min.css")
gulp.task('scss-for-prod', function() { gulp.task('scss-for-prod', function() {
var source = gulp.src('./sass/*.scss') var source = gulp.src(paths.sass + '/*.scss')
.pipe(plumber({ .pipe(plumber({
errorHandler: function (err) { errorHandler: function (err) {
console.log(err); console.log(err);
@ -61,14 +40,14 @@ gulp.task('scss-for-prod', function() {
var pipe1 = source.pipe(clone()) var pipe1 = source.pipe(clone())
.pipe(sourcemaps.write(undefined, { sourceRoot: null })) .pipe(sourcemaps.write(undefined, { sourceRoot: null }))
.pipe(gulp.dest('./css')) .pipe(gulp.dest(paths.css))
.pipe(rename('custom-editor-style.css')) .pipe(rename('custom-editor-style.css'))
var pipe2 = source.pipe(clone()) var pipe2 = source.pipe(clone())
.pipe(minify-css()) .pipe(minify-css())
.pipe(rename({suffix: '.min'})) .pipe(rename({suffix: '.min'}))
.pipe(gulp.dest('./css')); .pipe(gulp.dest(paths.css));
return merge(pipe1, pipe2); return merge(pipe1, pipe2);
}); });
@ -78,7 +57,7 @@ gulp.task('scss-for-prod', function() {
// gulp sourcemaps + sass + reload(browserSync) // gulp sourcemaps + sass + reload(browserSync)
// Prepare the child-theme.css for the development environment // Prepare the child-theme.css for the development environment
gulp.task('scss-for-dev', function() { gulp.task('scss-for-dev', function() {
gulp.src('./sass/*.scss') gulp.src(paths.sass + '/*.scss')
.pipe(plumber({ .pipe(plumber({
errorHandler: function (err) { errorHandler: function (err) {
console.log(err); console.log(err);
@ -88,11 +67,11 @@ gulp.task('scss-for-dev', function() {
.pipe(sourcemaps.init({loadMaps: true})) .pipe(sourcemaps.init({loadMaps: true}))
.pipe(sass()) .pipe(sass())
.pipe(sourcemaps.write(undefined, { sourceRoot: null })) .pipe(sourcemaps.write(undefined, { sourceRoot: null }))
.pipe(gulp.dest('./css')) .pipe(gulp.dest(paths.css))
}); });
gulp.task('watch-scss', ['browser-sync'], function () { gulp.task('watch-scss', ['browser-sync'], function () {
gulp.watch('./sass/**/*.scss', ['scss-for-dev']); gulp.watch(paths.sass + '/**/*.scss', ['scss-for-dev']);
}); });
@ -100,7 +79,7 @@ gulp.task('watch-scss', ['browser-sync'], function () {
// gulp sass // gulp sass
// Compiles SCSS files in CSS // Compiles SCSS files in CSS
gulp.task('sass', function () { gulp.task('sass', function () {
var stream = gulp.src('./sass/*.scss') var stream = gulp.src(paths.sass + '/*.scss')
.pipe(plumber({ .pipe(plumber({
errorHandler: function (err) { errorHandler: function (err) {
console.log(err); console.log(err);
@ -108,7 +87,7 @@ gulp.task('sass', function () {
} }
})) }))
.pipe(sass()) .pipe(sass())
.pipe(gulp.dest('./css')) .pipe(gulp.dest(paths.css))
.pipe(rename('custom-editor-style.css')) .pipe(rename('custom-editor-style.css'))
return stream; return stream;
}); });
@ -118,8 +97,8 @@ gulp.task('sass', function () {
// gulp watch // gulp watch
// Starts watcher. Watcher runs gulp sass task on changes // Starts watcher. Watcher runs gulp sass task on changes
gulp.task('watch', function () { gulp.task('watch', function () {
gulp.watch('./sass/**/*.scss', ['styles']); gulp.watch(paths.sass + '/**/*.scss', ['styles']);
gulp.watch([basePaths.dev + 'js/**/*.js','js/**/*.js','!js/theme.js','!js/theme.min.js'], ['scripts']); gulp.watch([paths.dev + '/js/**/*.js','js/**/*.js','!js/theme.js','!js/theme.min.js'], ['scripts']);
//Inside the watch task. //Inside the watch task.
gulp.watch('./img/**', ['imagemin']) gulp.watch('./img/**', ['imagemin'])
@ -139,7 +118,7 @@ gulp.task('imagemin', function(){
// gulp cssnano // gulp cssnano
// Minifies CSS files // Minifies CSS files
gulp.task('cssnano', function(){ gulp.task('cssnano', function(){
return gulp.src('./css/theme.css') return gulp.src(paths.css + '/theme.css')
.pipe(sourcemaps.init({loadMaps: true})) .pipe(sourcemaps.init({loadMaps: true}))
.pipe(plumber({ .pipe(plumber({
errorHandler: function (err) { errorHandler: function (err) {
@ -150,11 +129,11 @@ gulp.task('cssnano', function(){
.pipe(rename({suffix: '.min'})) .pipe(rename({suffix: '.min'}))
.pipe(cssnano({discardComments: {removeAll: true}})) .pipe(cssnano({discardComments: {removeAll: true}}))
.pipe(sourcemaps.write('./')) .pipe(sourcemaps.write('./'))
.pipe(gulp.dest('./css/')) .pipe(gulp.dest(paths.css))
}); });
gulp.task('minify-css', function() { gulp.task('minify-css', function() {
return gulp.src('./css/theme.css') return gulp.src(paths.css + '/theme.css')
.pipe(sourcemaps.init({loadMaps: true})) .pipe(sourcemaps.init({loadMaps: true}))
.pipe(cleanCSS({compatibility: '*'})) .pipe(cleanCSS({compatibility: '*'}))
.pipe(plumber({ .pipe(plumber({
@ -165,11 +144,11 @@ gulp.task('minify-css', function() {
})) }))
.pipe(rename({suffix: '.min'})) .pipe(rename({suffix: '.min'}))
.pipe(sourcemaps.write('./')) .pipe(sourcemaps.write('./'))
.pipe(gulp.dest('./css/')); .pipe(gulp.dest(paths.css));
}); });
gulp.task('cleancss', function() { gulp.task('cleancss', function() {
return gulp.src('./css/*.min.css', { read: false }) // much faster return gulp.src(paths.css + '/*.min.css', { read: false }) // much faster
.pipe(ignore('theme.css')) .pipe(ignore('theme.css'))
.pipe(rimraf()); .pipe(rimraf());
}); });
@ -181,7 +160,7 @@ gulp.task('styles', function(callback){ gulpSequence('sass', 'minify-css')(callb
// gulp browser-sync // gulp browser-sync
// Starts browser-sync task for starting the server. // Starts browser-sync task for starting the server.
gulp.task('browser-sync', function() { gulp.task('browser-sync', function() {
browserSync.init(browserSyncWatchFiles, browserSyncOptions); browserSync.init(cfg.browserSyncWatchFiles, cfg.browserSyncOptions);
}); });
@ -198,20 +177,20 @@ gulp.task('scripts', function() {
var scripts = [ var scripts = [
// Start - All BS4 stuff // Start - All BS4 stuff
basePaths.dev + 'js/bootstrap4/bootstrap.js', paths.dev + '/js/bootstrap4/bootstrap.js',
// End - All BS4 stuff // End - All BS4 stuff
basePaths.dev + 'js/skip-link-focus-fix.js' paths.dev + '/js/skip-link-focus-fix.js'
]; ];
gulp.src(scripts) gulp.src(scripts)
.pipe(concat('theme.min.js')) .pipe(concat('theme.min.js'))
.pipe(uglify()) .pipe(uglify())
.pipe(gulp.dest('./js/')); .pipe(gulp.dest(paths.js));
gulp.src(scripts) gulp.src(scripts)
.pipe(concat('theme.js')) .pipe(concat('theme.js'))
.pipe(gulp.dest('./js/')); .pipe(gulp.dest(paths.js));
}); });
// Deleting any file inside the /src folder // Deleting any file inside the /src folder
@ -229,67 +208,75 @@ gulp.task('copy-assets', function() {
////////////////// All Bootstrap 4 Assets ///////////////////////// ////////////////// All Bootstrap 4 Assets /////////////////////////
// Copy all JS files // Copy all JS files
var stream = gulp.src(basePaths.node + 'bootstrap/dist/js/**/*.js')
.pipe(gulp.dest(basePaths.dev + '/js/bootstrap4'));
var stream = gulp.src(paths.node + 'bootstrap/dist/js/**/*.js')
.pipe(gulp.dest(paths.dev + '/js/bootstrap4'));
// Copy all Bootstrap SCSS files // Copy all Bootstrap SCSS files
gulp.src(basePaths.node + 'bootstrap/scss/**/*.scss') gulp.src(paths.node + 'bootstrap/scss/**/*.scss')
.pipe(gulp.dest(basePaths.dev + '/sass/bootstrap4')); .pipe(gulp.dest(paths.dev + '/sass/bootstrap4'));
return stream; return stream;
////////////////// End Bootstrap 4 Assets ///////////////////////// ////////////////// End Bootstrap 4 Assets /////////////////////////
// Copy all Font Awesome Fonts // Copy all Font Awesome Fonts
var stream = gulp.src(basePaths.node + 'font-awesome/fonts/**/*.{ttf,woff,woff2,eof,svg}') var stream = gulp.src(paths.node + 'font-awesome/fonts/**/*.{ttf,woff,woff2,eof,svg}')
.pipe(gulp.dest('./fonts')); .pipe(gulp.dest('./fonts'));
// Copy all Font Awesome SCSS files // Copy all Font Awesome SCSS files
gulp.src(basePaths.node + 'font-awesome/scss/*.scss') gulp.src(paths.node + 'font-awesome/scss/*.scss')
.pipe(gulp.dest(basePaths.dev + '/sass/fontawesome')); .pipe(gulp.dest(paths.dev + '/sass/fontawesome'));
// _s SCSS files // _s SCSS files
gulp.src(basePaths.node + 'undescores-for-npm/sass/media/*.scss') gulp.src(paths.node + 'undescores-for-npm/sass/media/*.scss')
.pipe(gulp.dest(basePaths.dev + '/sass/underscores')); .pipe(gulp.dest(paths.dev + '/sass/underscores'));
// _s JS files into /src/js // _s JS files into /src/js
gulp.src(basePaths.node + 'undescores-for-npm/js/skip-link-focus-fix.js') gulp.src(paths.node + 'undescores-for-npm/js/skip-link-focus-fix.js')
.pipe(gulp.dest(basePaths.dev + '/js')); .pipe(gulp.dest(paths.dev + '/js'));
// _s JS files into /js // _s JS files into /js
gulp.src(basePaths.node + 'undescores-for-npm/js/skip-link-focus-fix.js') gulp.src(paths.node + 'undescores-for-npm/js/skip-link-focus-fix.js')
.pipe(gulp.dest(basePaths.js)); .pipe(gulp.dest(paths.js + paths.vendor));
// Copy Popper JS files // Copy Popper JS files
gulp.src(basePaths.node + 'popper.js/dist/umd/popper.min.js')
.pipe(gulp.dest(basePaths.js));
gulp.src(basePaths.node + 'popper.js/dist/umd/popper.js') gulp.src(paths.node + 'popper.js/dist/umd/popper.min.js')
.pipe(gulp.dest(basePaths.js)); .pipe(gulp.dest(paths.js + paths.vendor));
gulp.src(paths.node + 'popper.js/dist/umd/popper.js')
.pipe(gulp.dest(paths.js + paths.vendor));
return stream; return stream;
}); });
// Deleting the files distributed by the copy-assets task
gulp.task('clean-vendor-assets', function () {
return del([paths.dev+'/js/bootstrap4/**', paths.dev+'/sass/bootstrap4/**', './fonts/*wesome*.{ttf,woff,woff2,eof,svg}', paths.dev+'/sass/fontawesome/**', paths.dev+'/sass/underscores/**', paths.dev+'/js/skip-link-focus-fix.js', paths.js+'/**/skip-link-focus-fix.js', paths.js+'/**/popper.min.js', paths.js+'/**/popper.js', (paths.vendor!=''?(paths.js+paths.vendor+'/**'):'')]);
});
// Run // Run
// gulp dist // gulp dist
// Copies the files to the /dist folder for distribution as simple theme // Copies the files to the /dist folder for distribution as simple theme
gulp.task('dist', ['clean-dist'], function() { gulp.task('dist', ['clean-dist'], function() {
gulp.src(['**/*','!bower_components','!bower_components/**','!node_modules','!node_modules/**','!src','!src/**','!dist','!dist/**','!dist-product','!dist-product/**','!sass','!sass/**','!readme.txt','!readme.md','!package.json','!gulpfile.js','!CHANGELOG.md','!.travis.yml','!jshintignore', '!codesniffer.ruleset.xml', '*']) return gulp.src(['**/*', '!'+paths.bower, '!'+paths.bower+'**', '!'+paths.node, '!'+paths.node+'**', '!'+paths.dev, '!'+paths.dev+'/**', '!'+paths.dist, '!'+paths.dist+'/**', '!'+paths.distprod, '!'+paths.distprod+'/**', '!'+paths.sass, '!'+paths.sass+'/**', '!readme.txt', '!readme.md', '!package.json', '!gulpfile.js', '!CHANGELOG.md', '!.travis.yml', '!jshintignore', '!codesniffer.ruleset.xml', '*'])
.pipe(gulp.dest('dist/')) .pipe(replace('/js/jquery.slim.min.js', '/js'+paths.vendor+'/jquery.slim.min.js'))
.pipe(replace('/js/popper.min.js', '/js'+paths.vendor+'/popper.min.js'))
.pipe(replace('/js/skip-link-focus-fix.js', '/js'+paths.vendor+'/skip-link-focus-fix.js'))
.pipe(gulp.dest(paths.dist));
}); });
// Deleting any file inside the /dist folder // Deleting any file inside the /dist folder
gulp.task('clean-dist', function () { gulp.task('clean-dist', function () {
return del(['dist/**/*',]); return del([paths.dist + '/**',]);
}); });
// Run // Run
// gulp dist-product // gulp dist-product
// Copies the files to the /dist-prod folder for distribution as theme with all assets // Copies the files to the /dist-prod folder for distribution as theme with all assets
gulp.task('dist-product', ['clean-dist-product'], function() { gulp.task('dist-product', ['clean-dist-product'], function() {
gulp.src(['**/*','!bower_components','!bower_components/**','!node_modules','!node_modules/**','!dist','!dist/**','!dist-product','!dist-product/**', '*']) return gulp.src(['**/*', '!'+paths.bower, '!'+paths.bower+'/**', '!'+paths.node, '!'+paths.node+'/**', '!'+paths.dist, '!'+paths.dist+'/**', '!'+paths.distprod, '!'+paths.distprod+'/**', '*'])
.pipe(gulp.dest('dist-product/')) .pipe(gulp.dest(paths.distprod))
}); });
// Deleting any file inside the /dist-product folder // Deleting any file inside the /dist-product folder
gulp.task('clean-dist-product', function () { gulp.task('clean-dist-product', function () {
return del(['dist-product/**/*',]); return del([paths.distprod + '/**',]);
}); });

1
package.json
View File

@ -41,6 +41,7 @@
"gulp-merge": "^0.1.1", "gulp-merge": "^0.1.1",
"gulp-plumber": "^1.2.0", "gulp-plumber": "^1.2.0",
"gulp-rename": "^1.2.2", "gulp-rename": "^1.2.2",
"gulp-replace": "^0.6.1",
"gulp-rimraf": "^0.2.2", "gulp-rimraf": "^0.2.2",
"gulp-sass": "^3.1.0", "gulp-sass": "^3.1.0",
"gulp-sequence": "^0.4.6", "gulp-sequence": "^0.4.6",