-
-
Save claudia-romano/98fbfcbd498c7c57d121559d5c90984d to your computer and use it in GitHub Desktop.
var gulp = require('gulp'); | |
var sass = require('gulp-sass')(require('sass-embedded')); | |
var sassGlob = require('gulp-sass-glob'); | |
var browserSync = require('browser-sync'); | |
var postcss = require('gulp-postcss'); | |
var autoprefixer = require('autoprefixer'); | |
var concat = require('gulp-concat'); | |
var rename = require('gulp-rename'); | |
var uglify = require('gulp-uglify'); | |
var connect = require('gulp-connect-php'); | |
var projectPath = 'localhost:8888/projectName'; // 👈 make sure to replace 'projectName' with the name of your project folder | |
var purgecss = require('gulp-purgecss'); | |
// js file paths | |
var utilJsPath = 'main/assets/js'; | |
var componentsJsPath = 'main/assets/js/components/*.js'; // component js files | |
var scriptsJsPath = 'main/assets/js'; //folder for final scripts.js/scripts.min.js files | |
// css file paths | |
var cssFolder = 'main/assets/css'; // folder for final style.css/style-fallback.css files | |
var scssFilesPath = 'main/assets/css/**/*.scss'; // scss files to watch | |
function reload(done) { | |
browserSync.reload({notify: false}); | |
done(); | |
} | |
gulp.task('sass', function() { | |
return gulp.src(scssFilesPath) | |
.pipe(sassGlob()) | |
.pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError)) | |
.pipe(postcss([autoprefixer()])) | |
.pipe(gulp.dest(cssFolder)) | |
.pipe(browserSync.reload({ | |
stream: true, | |
notify: false | |
})); | |
}); | |
gulp.task('scripts', function() { | |
return gulp.src([utilJsPath+'/util.js', componentsJsPath]) | |
.pipe(concat('scripts.js')) | |
.pipe(gulp.dest(scriptsJsPath)) | |
.pipe(rename('scripts.min.js')) | |
.pipe(uglify()) | |
.pipe(gulp.dest(scriptsJsPath)) | |
.pipe(browserSync.reload({ | |
stream: true, | |
notify: false | |
})); | |
}); | |
gulp.task('watch', gulp.series(['sass', 'scripts'], function () { | |
connect.server({}, function (){ | |
browserSync({ | |
proxy: projectPath, // 👈 this contains the name of your project folder | |
notify: false | |
}); | |
}); | |
gulp.watch('**/*.php', gulp.series(reload)); | |
gulp.watch('main/assets/css/**/*.scss', gulp.series(['sass'])); | |
gulp.watch(componentsJsPath, gulp.series(['scripts'])); | |
})); | |
/* Gulp dist task */ | |
// create a distribution folder for production | |
var distFolder = 'dist/'; | |
var assetsFolder = 'dist/assets/'; | |
gulp.task('dist', async function(){ | |
// remove unused classes from the style.css file with PurgeCSS and copy it to the dist folder | |
await purgeCSS(); | |
// minify the scripts.js file and copy it to the dist folder | |
await minifyJs(); | |
// copy any additional js files to the dist folder | |
await moveJS(); | |
// copy all the assets inside main/assets/img folder to the dist folder | |
await moveAssets(); | |
// copy all html files inside main folder to the dist folder | |
await moveContent(); | |
console.log('Distribution task completed!') | |
}); | |
function purgeCSS() { | |
return new Promise(function(resolve, reject) { | |
var stream = gulp.src(cssFolder+'/style.css') | |
.pipe(purgecss({ | |
content: ['main/*.php', scriptsJsPath+'/scripts.js'], | |
safelist: { | |
standard: ['.is-hidden', '.is-visible'], | |
deep: [/class$/], | |
greedy: [] | |
}, | |
defaultExtractor: content => content.match(/[\w-/:%@]+(?<!:)/g) || [] | |
})) | |
.pipe(gulp.dest(distFolder+'/assets/css')); | |
stream.on('finish', function() { | |
resolve(); | |
}); | |
}); | |
}; | |
function minifyJs() { | |
return new Promise(function(resolve, reject) { | |
var stream = gulp.src(scriptsJsPath+'/scripts.js') | |
.pipe(uglify()) | |
.pipe(gulp.dest(distFolder+'/assets/js')); | |
stream.on('finish', function() { | |
resolve(); | |
}); | |
}); | |
}; | |
function moveJS() { | |
return new Promise(function(resolve, reject) { | |
var stream = gulp.src([scriptsJsPath+'/*.js', '!'+scriptsJsPath+'/scripts.js', '!'+scriptsJsPath+'/scripts.min.js'], { allowEmpty: true }) | |
.pipe(gulp.dest(assetsFolder+'js')); | |
stream.on('finish', function() { | |
resolve(); | |
}); | |
}); | |
}; | |
function moveAssets() { | |
return new Promise(function(resolve, reject) { | |
var stream = gulp.src(['main/assets/img/**'], { allowEmpty: true }) | |
.pipe(gulp.dest(assetsFolder+'img')); | |
stream.on('finish', function() { | |
resolve(); | |
}); | |
}); | |
}; | |
function moveContent() { | |
return new Promise(function(resolve, reject) { | |
var stream = gulp.src('main/*.php') | |
.pipe(gulp.dest(distFolder)); | |
stream.on('finish', function() { | |
resolve(); | |
}); | |
}); | |
}; |
Hello Claudia. Thanks for the feedback!
Now it works for me with Codyhouse and the implementation in PHP. I would have one wish for the future. Can you give a hint in advance in your documentation in the tutorial, which pre-condition is necessary to proceed with the step-by-step description you gave. The hint in the documentation at (https://codyhouse.co/ds/docs/framework) would have been a good improvement and would have saved the need to ask about the projectPath
. There are certainly other points where these infomrations are useful.
Hi there, great to hear it works.
Could you clarify which info you think are missing in the PHP section? Thank you!
Hi Claudia. Maybe something like this?
If you want to extend your PHP project with our Codyhouse Framework, then use the following instructions. Required is a webserver (e.g. MAMP or XAMPP) to be able to use all necessary PHP functions local. The projectPath
you use in the browser (e.g. localhost/myproject), you need to add to the gulp config.
We'll look into it! Thanks.
Hi there, if you are using PHP for your project, then I assume you are using some kind of local server (e.g., you are using MAMP or similar). If you do, then those tools give you a default localhost url you can use to view your project. That's what you should use as
projectPath
. Does that make sense?