-
Notifications
You must be signed in to change notification settings - Fork 1
/
gulpfile.js
352 lines (322 loc) · 10.8 KB
/
gulpfile.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
const { src, dest, watch, series, parallel } = require('gulp'),
mode = require('gulp-mode')(),
server = require('browser-sync').create(),
sass = require('gulp-sass'),
sassLint = require('gulp-sass-lint'),
autoPrefixer = require('gulp-autoprefixer'),
sourcemaps = require('gulp-sourcemaps'),
plumber = require('gulp-plumber'),
uglify = require('gulp-uglify'),
kit = require('gulp-kit'),
notify = require('gulp-notify'),
babel = require('gulp-babel'),
concat = require('gulp-concat'),
rename = require('gulp-rename'),
jsHint = require('gulp-jshint'),
jsHintStylish = require('jshint-stylish'),
prettyHTML = require('gulp-pretty-html'),
htmlMin = require('gulp-htmlmin'),
rtlCSS = require('gulp-rtlcss'),
gulpIf = require('gulp-if'),
imageMin = require('gulp-imagemin'),
gUtil = require('gulp-util'),
// SASS options
sassOptions = {
errLogToConsole: true,
outputStyle: 'compressed'
},
// JS options
jsOptions = {
mangle: false
},
// KIT options
kitOptions = {
compilePartials: false
},
// HTML Options
prettyHTMLOptions = {
indent_size: 4,
indent_char: ' ',
indent_inner_html: false,
wrap_attributes: "auto"
},
// HTML Min Options
HTMLMinOptions = {
collapseWhitespace: true
},
// rtlCSS Options
rtlCSSOptions = {
suffix: "-rtl"
};
// Check if current mode is production as boolean
const isProduction = mode.production();
// Check if the outputted CSS file will have a RTL version or no
const isRTL = gUtil.env.dir === "rtl";
// Set the production and development folders
const folder = isProduction ? 'public' : 'publicDev';
// Define paths of source files and build directories
const paths = {
js: ['src/js/**/!(app)*.js', 'src/js/app.js'], // JS files source - placing the last file as app.js which contains custom JS code
jsBuild: folder + '/assets/js/', // JS build directory
styles: 'src/scss/**/*.scss', // SASS files source
stylesBuild: folder + '/assets/css/', // SASS build directory
kit: 'src/kit/**/*.kit', // KIT files source
kitBuild: folder + '/', // KIT build directory
fonts: ['src/fonts/**/*', '!src/fonts/**/.gitkeep'], // Fonts files source
fontsPublic: folder + '/assets/fonts/', // Fonts destination directory
images: ['src/images/**/*', '!src/images/**/.gitkeep'], // Images files source
imagesPublic: folder + '/assets/images/', // Images destination directory
};
// Init browserSync server
function browserSyncFn(done) {
server.init({
injectChanges: true,
server: {
baseDir: folder === undefined ? "src" : folder + "/",
directory: true,
notify: false
}
});
done();
}
// Compile KIT files to html
function buildKitFiles() {
return src(paths.kit)
.pipe(plumbError())
.pipe(kit(kitOptions))
.pipe(mode.development(prettyHTML(prettyHTMLOptions)))
.pipe(isProduction ? htmlMin(HTMLMinOptions) : gUtil.noop())
.pipe(dest(paths.kitBuild))
.on("end", server.reload)
.pipe(notify({
"message": "KIT Files Compiled!",
"onLast": true
}));
}
// Compile SASS files to CSS with auto prefixed styles and with sourcemap files
function buildStyles() {
return src(paths.styles)
.pipe(plumbError())
.pipe(mode.development(sourcemaps.init()))
.pipe(sass(sassOptions))
.pipe(autoPrefixer())
.pipe(dest(paths.stylesBuild)) // Output LTR stylesheets.
.pipe(isRTL ? gulpIf('*.css', rtlCSS()) : gUtil.noop()) // Convert to RTL.
.pipe(isRTL ? gulpIf('*.css', rename({ suffix: rtlCSSOptions.suffix })) : gUtil.noop()) // Append suffix to the filename.
.pipe(isRTL ? mode.development(gulpIf('*.css', sourcemaps.write('/'))) : gUtil.noop()) // Output source maps.
.pipe(isRTL ? dest(paths.stylesBuild) : gUtil.noop()) // Output RTL stylesheets.
.pipe(server.reload({
stream: true
}))
.pipe(notify({
"message": "SCSS Compiling Completed!",
"onLast": true
}));
}
/*
Concat, rename, uglify and export all files into one file.
If you want to compile js files in custom order, add a number suffix to each file name inside the "/src/js/libs" folder with the order you want,
e.g. (01.jquery.min.js, 02.bootstrap.min.js, ....)
*/
function buildJS() {
return src(paths.js)
.pipe(plumbError())
.pipe(babel({
presets: ['@babel/env']
}))
.pipe(concat('app.js'))
.pipe(mode.development(dest(paths.jsBuild)))
.pipe(rename('app.min.js'))
.pipe(uglify(jsOptions))
.pipe(dest(paths.jsBuild))
.pipe(server.stream())
.pipe(notify({
"message": "JS Uglify Completed!",
"onLast": true
}));
}
// Copy fronts from the src folder to the assets public folder
function copyFonts() {
return src(paths.fonts)
.pipe(dest(paths.fontsPublic))
.pipe(notify({
"message": "Fonts copied to the assets public folder!",
"onLast": true
}));
}
// Copy images from the src folder to the assets public folder
function copyImages() {
return src(paths.images)
.pipe(dest(paths.imagesPublic))
.pipe(notify({
"message": "Images copied to the assets public folder!",
"onLast": true
}));
}
// Minify images in the src folder and copy the minified images to the assets public folder
function minifyImages() {
return src(paths.images)
.pipe(imageMin([
imageMin.gifsicle({ interlaced: true }),
imageMin.jpegtran({ progressive: true }),
imageMin.optipng({ optimizationLevel: 5 }),
imageMin.svgo({
plugins: [
{ removeViewBox: true },
{ cleanupIDs: false }
]
})
], { verbose: true }))
.pipe(dest(paths.imagesPublic))
.pipe(notify({
"message": "Images minified and copied to the assets public folder!",
"onLast": true
}));
}
// Check SASS errors and enhancements before compiling
function checkSassErrors() {
return src(paths.styles)
.pipe(plumbError())
.pipe(sassLint({
options: {
formatter: 'stylish',
'merge-default-rules': false
}
}))
.pipe(sassLint.format())
.pipe(sassLint.failOnError())
}
// Check JS error and enhancements before compiling
function checkJsErrors() {
return src('src/js/app.js')
.pipe(plumbError())
.pipe(jsHint({
esversion: 6 // Define the JavaScript version to use in the project
}))
.pipe(jsHint.reporter(jsHintStylish))
}
// Watch SASS files changes then check SASS errors and finally compile files to CSS with auto prefixed styles and with sourcemaps files
function watchStyleFiles() {
watch(
paths.styles,
{
events: 'all',
ignoreInitial: false
},
series(checkSassErrors, buildStyles)
);
}
// Watch JS files changes then check JS errors, concat files, rename files and finally uglify the output JS file
function watchJsFiles() {
watch(
paths.js,
{
events: 'all',
ignoreInitial: false
},
series(checkJsErrors, buildJS)
);
}
// Watch Kit files changes and build them to HTML
function watchKitFiles() {
watch(
paths.kit,
{
events: 'all',
ignoreInitial: false
},
series(buildKitFiles)
);
}
// Watch font files changes and copy them to the assets public folder
function watchFontsFiles() {
watch(
paths.fonts,
{
events: 'all',
ignoreInitial: false
},
series(copyFonts)
);
}
// Watch images files changes, minify them and finally copy them to the assets public folder
function watchImagesFiles() {
watch(
paths.images,
{
events: 'all',
ignoreInitial: false
},
series(minifyImages)
);
}
// Watch images files changes, copy them to the assets public folder
function watchCopyImagesFiles() {
watch(
paths.images,
{
events: 'all',
ignoreInitial: false
},
series(copyImages)
);
}
// Global Error Handler
function plumbError() {
return plumber({
errorHandler: function (error) {
notify.onError({
templateOptions: {
date: new Date()
},
title: 'Compiling error with "' + error.plugin + '"',
message: error.formatted
})(error);
// Keep gulp from hanging on this task
this.emit('end');
}
})
}
/*
Default functions to run with running gulp
1. Run the browserSync server to serve files from the "public/" folder
2. Run SASS files watch command to check for SASS errors and finally create source map files with CSS files
3. Run JS files watch command to check JS errors and finally concat, rename, uglify and export all files into one file
4. Run KIT files watch command to compile KIT files into HTML
5. Run Images files minify command to minify images files and copy them to the assets public folder
6. Run Fonts files copy command to copy fonts files to the assets public folder
*/
const parallelCommands = isProduction ?
parallel(buildStyles, buildJS, buildKitFiles, minifyImages, copyFonts) :
parallel(browserSyncFn, watchStyleFiles, watchJsFiles, watchKitFiles, watchCopyImagesFiles, watchFontsFiles);
exports.default = parallelCommands;
/*
Build commands with gulp
1. Build SASS files: gulp buildStyles
2. Build JS files: gulp buildJS
3. Build Kit files: gulp buildKitFiles
4. Minify Images: gulp minifyImages
5. Copy Fonts files: gulp copyFonts
6. Copy Images files: gulp copyImages
*/
exports.buildStyles = buildStyles;
exports.buildJS = buildJS;
exports.buildKitFiles = buildKitFiles;
exports.minifyImages = minifyImages;
exports.copyFonts = copyFonts;
exports.copyImages = copyImages;
/*
Watch commands with gulp
1. Watch SASS files: gulp watchStyleFiles
2. Watch JS files: gulp watchJsFiles
3. Watch Kit files: gulp watchKitFiles
4. Watch Minify Images files: gulp watchImagesFiles
5. Watch Fonts files: gulp watchFontsFiles
6. Watch Copy Images files: gulp watchCopyImagesFiles
*/
exports.watchStyleFiles = watchStyleFiles;
exports.watchJsFiles = watchJsFiles;
exports.watchKitFiles = watchKitFiles;
exports.watchImagesFiles = watchImagesFiles;
exports.watchFontsFiles = watchFontsFiles;
exports.watchCopyImagesFiles = watchCopyImagesFiles;