-
Notifications
You must be signed in to change notification settings - Fork 25
/
gulpfile.js
329 lines (296 loc) · 9.31 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
// The require statement tells Node to look into the node_modules folder for a package
// Importing specific gulp API functions lets us write them below as series() instead of gulp.series()
'use strict';
const {
src,
dest,
watch,
series,
parallel
} = require('gulp');
const colors = require('ansi-colors');
const browserSync = require('browser-sync').create();
const sass = require('gulp-sass');
const bourbon = require('node-bourbon').includePaths;
const cssmin = require('gulp-cssmin');
const rename = require('gulp-rename');
const concat = require('gulp-concat');
const del = require('del');
const panini = require('panini');
const uglify = require('gulp-uglify-es').default;
const sourcemaps = require('gulp-sourcemaps');
const imagemin = require('gulp-imagemin');
const removeCode = require('gulp-remove-code');
const removeLog = require('gulp-remove-logging');
const prettyHtml = require('gulp-pretty-html');
const sassLint = require('gulp-sass-lint');
const htmllint = require('gulp-htmllint');
const jshint = require('gulp-jshint');
const htmlreplace = require('gulp-html-replace');
const newer = require('gulp-newer');
const autoprefixer = require('gulp-autoprefixer');
const accessibility = require('gulp-accessibility');
const babel = require('gulp-babel');
const ghPages = require('gulp-gh-pages');
const purgecss = require('gulp-purgecss')
const chalk = require('chalk');
const log = console.log;
// File paths
const files = {
scssPath: 'app/scss/**/*.scss',
jsPath: 'app/js/**/*.js'
}
// ------------ DEVELOPMENT TASKS -------------
// RESET PANINI'S CACHE OF LAYOUTS AND PARTIALS
function resetPages(done) {
log(chalk.red.bold('---------------CLEARING PANINI CACHE---------------'));
panini.refresh();
done();
}
// USING PANINI, TEMPLATE, PAGE AND PARTIAL FILES ARE COMBINED TO FORM HTML MARKUP
function compileHTML() {
log(chalk.red.bold('---------------COMPILING HTML WITH PANINI---------------'));
panini.refresh();
return src('src/pages/**/*.html')
.pipe(panini({
root: 'src/pages/',
layouts: 'src/layouts/',
// pageLayouts: {
// All pages inside src/pages/blog will use the blog.html layout
// 'blog': 'blog'
// }
partials: 'src/partials/',
helpers: 'src/helpers/',
data: 'src/data/'
}))
.pipe(dest('dist'))
.pipe(browserSync.stream());
}
// COPY AND TRANSPILE CUSTOM JS
function compileJS() {
log(chalk.red.bold('---------------COMPILE CUSTOM.JS---------------'));
return src(['src/assets/js/**/*.js'])
.pipe(babel())
.pipe(dest('dist/assets/js/'))
.pipe(browserSync.stream());
}
// COMPILE SCSS INTO CSS
function compileSCSS() {
log(chalk.red.bold('---------------COMPILING SCSS---------------'));
return src(['src/assets/scss/main.scss', 'src/assets/scss/rtl.scss'])
.pipe(sass({
outputStyle: 'expanded',
sourceComments: 'map',
sourceMap: 'scss',
includePaths: bourbon
}).on('error', sass.logError))
.pipe(autoprefixer('last 2 versions'))
.pipe(dest('dist/assets/css'))
.pipe(browserSync.stream());
}
// COPY JS VENDOR FILES
function jsVendor() {
log(chalk.red.bold('---------------COPY JAVASCRIPT VENDOR FILES INTO DIST---------------'));
return src([
'node_modules/jquery/dist/jquery.js',
'node_modules/popper.js/dist/umd/popper.js',
'node_modules/bootstrap/dist/js/bootstrap.js',
])
.pipe(dest('dist/assets/vendor/js'))
.pipe(browserSync.stream());
}
// COPY CSS VENDOR FILES
function cssVendor() {
log(chalk.red.bold('---------------COPY CSS VENDOR FILES INTO DIST---------------'));
return src(['node_modules/animate.css/animate.css'])
.pipe(dest('dist/assets/vendor/css'))
.pipe(browserSync.stream());
}
// SCSS LINT
function scssLint() {
log(chalk.red.bold('---------------SCSS LINTING---------------'));
return src('src/assets/scss/**/*.scss')
.pipe(sassLint({
configFile: '.scss-lint.yml'
}))
.pipe(sassLint.format())
.pipe(sassLint.failOnError());
}
// HTML LINTER
function htmlLint() {
log(chalk.red.bold('---------------HTML LINTING---------------'));
return src('dist/**/*.html')
.pipe(htmllint({}, htmllintReporter));
}
function htmllintReporter(filepath, issues) {
if (issues.length > 0) {
issues.forEach(function (issue) {
log(colors.cyan('[gulp-htmllint] ') + colors.white(filepath + ' [' + issue.line + ']: ') + colors.red('(' + issue.code + ') ' + issue.msg));
});
process.exitCode = 1;
} else {
log(chalk.green.bold('---------------NO HTML LINT ERROR---------------'));
}
}
// JS LINTER
function jsLint() {
return src('src/assets/js/*.js')
.pipe(jshint())
.pipe(jshint.reporter('default'));
}
// WATCH FILES
function watchFiles() {
watch('src/**/*.html', compileHTML);
watch(['src/assets/scss/**/*.scss', 'src/assets/scss/*.scss'], compileSCSS);
watch('src/assets/js/*.js', compileJS);
watch('src/assets/img/**/*', copyImages);
}
// BROWSER SYNC
function browserSyncInit(done) {
log(chalk.red.bold('---------------BROWSER SYNC INIT---------------'));
browserSync.init({
server: './dist'
});
return done();
}
// DEPLOY TO GIT
function deploy() {
return src('/*')
.pipe(ghPages({
remoteUrl: 'https://github.com/johndavemanuel/bootstrap4-gulp-starter-template.git',
branch: 'master',
message: 'Automated push of contents via gulp'
}));
}
// ------------ OPTIMIZATION TASKS -------------
// COPIES AND MINIFY IMAGE TO DIST
function copyImages() {
log(chalk.red.bold('---------------OPTIMIZING IMAGES---------------'));
return src('src/assets/img/**/*.+(png|jpg|jpeg|gif|svg)')
.pipe(newer('dist/assets/img/'))
.pipe(imagemin())
.pipe(dest('dist/assets/img/'))
.pipe(browserSync.stream());
}
// PLACES FONT FILES IN THE DIST FOLDER
function copyFont() {
log(chalk.red.bold('---------------COPYING FONTS INTO DIST FOLDER---------------'));
return src([
'src/assets/font/*',
])
.pipe(dest('dist/assets/fonts'))
.pipe(browserSync.stream());
}
// PRETTIFY HTML FILES
function prettyHTML() {
log(chalk.red.bold('---------------HTML PRETTIFY---------------'));
return src('dist/**/*.html')
.pipe(prettyHtml({
indent_size: 4,
indent_char: ' ',
unformatted: ['code', 'pre', 'em', 'strong', 'span', 'i', 'b', 'br']
}))
.pipe(dest('dist'));
}
// DELETE DIST FOLDER
function cleanDist(done) {
log(chalk.red.bold('---------------REMOVING OLD FILES FROM DIST---------------'));
del.sync('dist');
return done();
}
// CREATE DOCS FOLDER FOR DEMO
function generateDocs() {
log(chalk.red.bold('---------------CREATING DOCS---------------'));
return src([
'dist/**/*',
])
.pipe(dest('docs'))
.pipe(browserSync.stream());
}
// ACCESSIBILITY CHECK
function HTMLAccessibility() {
return src('dist/**/*.html')
.pipe(accessibility({
force: true
}))
.on('error', console.log)
.pipe(accessibility.report({
reportType: 'txt'
}))
.pipe(rename({
extname: '.txt'
}))
.pipe(dest('accessibility-reports'));
}
// ------------ PRODUCTION TASKS -------------
// CHANGE TO MINIFIED VERSIONS OF JS AND CSS
function renameSources() {
log(chalk.red.bold('---------------RENAMING SOURCES---------------'));
return src('dist/**/*.html')
.pipe(htmlreplace({
'js': 'assets/js/main.min.js',
'css': 'assets/css/main.min.css'
}))
.pipe(dest('dist/'));
}
// CONCATINATE JS SCRIPTS
function concatScripts() {
log(chalk.red.bold('---------------CONCATINATE SCRIPTS---------------'));
return src([
'dist/assets/vendor/js/jquery.js',
'dist/assets/vendor/js/popper.js',
'dist/assets/vendor/js/bootstrap.js',
'src/assets/js/util/*',
'src/assets/js/*'
])
.pipe(sourcemaps.init())
.pipe(concat('main.js'))
.pipe(sourcemaps.write('./'))
.pipe(dest('dist/assets/js'))
.pipe(browserSync.stream());
}
// MINIFY SCRIPTS
function minifyScripts() {
log(chalk.red.bold('---------------MINIFY SCRIPTS---------------'));
return src('dist/assets/js/main.js')
.pipe(removeLog())
.pipe(removeCode({
production: true
}))
.pipe(uglify().on('error', console.error))
.pipe(rename('main.min.js'))
.pipe(dest('dist/assets/js'));
}
// PURGE CSS
function purgeCSS() {
log(chalk.red.bold('---------------PURGE CSS---------------'));
return src([
'dist/assets/css/main.css',
])
.pipe(purgecss({
content: ['dist/*.html']
}))
.pipe(dest('dist/assets/css'))
}
// MINIFY AND CONCAT CSS
function minifyCSS() {
log(chalk.red.bold('---------------MINIFY CSS---------------'));
return src([
'dist/assets/vendor/css/**/*',
'dist/assets/css/main.css'
])
.pipe(sourcemaps.init())
.pipe(concat('main.css'))
.pipe(sourcemaps.write('./'))
.pipe(cssmin())
.pipe(rename('main.min.css'))
.pipe(dest('dist/assets/css'));
}
// DEVELOPMENT
exports.development = series(cleanDist, copyFont, copyImages, compileHTML, compileSCSS, cssVendor, jsVendor, compileJS, resetPages, prettyHTML, browserSyncInit, watchFiles);
// PRODUCTION
exports.production = series(cleanDist, copyFont, copyImages, compileHTML, compileSCSS, cssVendor, purgeCSS, minifyCSS, jsVendor, concatScripts, minifyScripts, renameSources, prettyHTML, generateDocs, browserSyncInit);
// RUN ALL LINTERS
exports.lint = series(htmlLint, scssLint, jsLint);
// RUN ACCESSIBILITY CHECK
exports.a11y = HTMLAccessibility;