gulpfile.js 11.5 KB
Newer Older
C
codecalm 已提交
1
const gulp = require('gulp'),
C
codecalm 已提交
2
	debug = require('gulp-debug'),
C
codecalm 已提交
3
	clean = require('gulp-clean'),
4
	sass = require('gulp-sass')(require('sass')),
C
codecalm 已提交
5
	postcss = require('gulp-postcss'),
C
codecalm 已提交
6
	header = require('gulp-header'),
C
codecalm 已提交
7
	cleanCSS = require('gulp-clean-css'),
C
codecalm 已提交
8
	rtlcss = require('gulp-rtlcss'),
C
codecalm 已提交
9
	minifyJS = require('gulp-minify'),
C
codecalm 已提交
10
	rename = require('gulp-rename'),
C
codecalm 已提交
11
	purgecss = require('gulp-purgecss'),
C
codecalm 已提交
12
	rollupStream = require('@rollup/stream'),
C
codecalm 已提交
13 14
	rollupBabel = require('rollup-plugin-babel'),
	rollupCleanup = require('rollup-plugin-cleanup'),
P
Paweł Kuna 已提交
15
	{ nodeResolve } = require('@rollup/plugin-node-resolve'),
C
codecalm 已提交
16
	rollupCommonjs = require('@rollup/plugin-commonjs'),
C
codecalm 已提交
17
	rollupReplace = require('@rollup/plugin-replace'),
C
codecalm 已提交
18 19
	vinylSource = require('vinyl-source-stream'),
	vinylBuffer = require('vinyl-buffer'),
C
codecalm 已提交
20
	critical = require('critical').stream,
C
codecalm 已提交
21
	browserSync = require('browser-sync'),
C
codecalm 已提交
22
	glob = require('glob'),
C
codecalm 已提交
23
	spawn = require('cross-spawn'),
C
codecalm 已提交
24 25 26
	fs = require('fs'),
	path = require('path'),
	YAML = require('yaml'),
C
codecalm 已提交
27
	yargs = require('yargs/yargs'),
C
codecalm 已提交
28 29
	cp = require('child_process'),
	pkg = require('./package.json'),
C
codecalm 已提交
30
	year = new Date().getFullYear(),
P
Paweł Kuna 已提交
31
	argv = yargs(process.argv).argv
C
codecalm 已提交
32

C
codecalm 已提交
33 34 35
let BUILD = false,
	distDir = './.tmp',
	demoDir = './.tmp',
P
Paweł Kuna 已提交
36
	srcDir = './src'
C
codecalm 已提交
37

C
codecalm 已提交
38 39 40
/**
 * Enable BUILD mode and set directories
 */
C
codecalm 已提交
41
gulp.task('build-on', (cb) => {
P
Paweł Kuna 已提交
42 43 44
	BUILD = true
	distDir = './dist'
	demoDir = './demo'
C
codecalm 已提交
45

P
Paweł Kuna 已提交
46 47
	cb()
})
C
codecalm 已提交
48 49 50 51

/**
 * Return banner added to CSS and JS dist files
 */
C
codecalm 已提交
52 53 54 55 56 57 58 59 60
const getBanner = () => {
	return `/*!
* Tabler v${pkg.version} (${pkg.homepage})
* @version ${pkg.version}
* @link ${pkg.homepage}
* Copyright 2018-${year} The Tabler Authors
* Copyright 2018-${year} codecalm.net Paweł Kuna
* Licensed under MIT (https://github.com/tabler/tabler/blob/master/LICENSE)
*/
P
Paweł Kuna 已提交
61 62
`
}
C
codecalm 已提交
63

C
codecalm 已提交
64 65 66
/**
 * Array.flat polyfill
 */
C
codecalm 已提交
67 68
if (!Array.prototype.flat) {
	Object.defineProperty(Array.prototype, 'flat', {
C
codecalm 已提交
69 70
		value: function (depth = 1) {
			return this.reduce(function (flat, toFlatten) {
P
Paweł Kuna 已提交
71 72
				return flat.concat((Array.isArray(toFlatten) && (depth > 1)) ? toFlatten.flat(depth - 1) : toFlatten)
			}, [])
C
codecalm 已提交
73
		}
P
Paweł Kuna 已提交
74
	})
C
codecalm 已提交
75 76
}

C
codecalm 已提交
77
/**
C
codecalm 已提交
78
 * Import tabler-icons form npm and generate Jekyll `.yml` data files
C
codecalm 已提交
79
 */
C
codecalm 已提交
80 81
gulp.task('svg-icons', (cb) => {
	const prepareSvgFile = (svg) => {
P
Paweł Kuna 已提交
82 83
		return svg.replace(/\n/g, '').replace(/>\s+</g, '><')
	}
C
codecalm 已提交
84

C
codecalm 已提交
85
	const generateIconsYml = (dir, filename) => {
P
Paweł Kuna 已提交
86 87
		const files = glob.sync(dir)
		let svgList = {}
C
codecalm 已提交
88

C
codecalm 已提交
89
		files.forEach((file) => {
P
Paweł Kuna 已提交
90 91 92
			const basename = path.basename(file, '.svg')
			svgList[basename] = prepareSvgFile(fs.readFileSync(file).toString())
		})
C
codecalm 已提交
93

P
Paweł Kuna 已提交
94 95
		fs.writeFileSync(filename, YAML.stringify(svgList))
	}
C
codecalm 已提交
96

P
Paweł Kuna 已提交
97
	generateIconsYml("./node_modules/@tabler/icons/icons/*.svg", `${srcDir}/pages/_data/icons.yml`)
C
codecalm 已提交
98

P
Paweł Kuna 已提交
99 100
	cb()
})
C
codecalm 已提交
101

C
codecalm 已提交
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
/**
 * Generate CHANGELOG.md
 */
gulp.task('changelog', (cb) => {
	const content = YAML.parse(fs.readFileSync('./src/pages/_data/changelog.yml', 'utf8'))
	let readme = `# Changelog

All notable changes to this project will be documented in this file.\n`

	content.forEach((change) => {
		readme += `\n\n## \`${change.version}\` - ${change.date}\n\n`

		if(change.description) {
			readme += `**${change.description}**\n\n`
		}

		change.changes.forEach((line) => {
			readme += `- ${line}\n`
		})

		console.log(change.version);
	})

	fs.writeFileSync('CHANGELOG.md', readme)

	cb()
})

C
codecalm 已提交
130 131 132
/**
 * Check unused Jekyll partials
 */
C
codecalm 已提交
133
gulp.task('unused-files', (cb) => {
P
Paweł Kuna 已提交
134
	let foundFiles = []
C
codecalm 已提交
135

C
codecalm 已提交
136
	glob.sync(`${srcDir}/pages/**/*.{html,md}`).forEach((file) => {
P
Paweł Kuna 已提交
137
		let fileContent = fs.readFileSync(file)
C
codecalm 已提交
138

C
codecalm 已提交
139
		fileContent.toString().replace(/\{% include(_cached)? ([a-z0-9\/_-]+\.html)/g, (f, c, filename) => {
P
Paweł Kuna 已提交
140
			filename = `${srcDir}/pages/_includes/${filename}`
C
codecalm 已提交
141 142

			if (!foundFiles.includes(filename)) {
P
Paweł Kuna 已提交
143
				foundFiles.push(filename)
C
codecalm 已提交
144
			}
P
Paweł Kuna 已提交
145 146
		})
	})
C
codecalm 已提交
147

P
Paweł Kuna 已提交
148
	let includeFiles = glob.sync(`${srcDir}/pages/_includes/**/*.html`)
C
codecalm 已提交
149

C
codecalm 已提交
150
	includeFiles.forEach((file) => {
C
codecalm 已提交
151
		if (!foundFiles.includes(file)) {
P
Paweł Kuna 已提交
152
			console.log('file', file)
C
codecalm 已提交
153
		}
P
Paweł Kuna 已提交
154
	})
C
codecalm 已提交
155

P
Paweł Kuna 已提交
156 157
	cb()
})
C
codecalm 已提交
158

C
codecalm 已提交
159
/**
C
codecalm 已提交
160
 * Clean `dist` folder before build
C
codecalm 已提交
161
 */
C
codecalm 已提交
162
gulp.task('clean-dirs', () => {
C
codecalm 已提交
163
	return gulp
C
codecalm 已提交
164
		.src(`{${distDir}/*,${demoDir}/*}`, { read: false })
P
Paweł Kuna 已提交
165 166
		.pipe(clean())
})
C
codecalm 已提交
167

C
codecalm 已提交
168
gulp.task('clean-jekyll', (cb) => {
C
codecalm 已提交
169
	return spawn('bundle', ['exec', 'jekyll', 'clean'], { stdio: 'inherit' })
P
Paweł Kuna 已提交
170 171
		.on('close', cb)
})
C
codecalm 已提交
172

C
codecalm 已提交
173
/**
C
codecalm 已提交
174
 * Compile SASS to CSS and move it to dist directory
C
codecalm 已提交
175
 */
C
codecalm 已提交
176
gulp.task('sass', () => {
P
Paweł Kuna 已提交
177
	const g = gulp
178
		.src(argv.withPlugins || BUILD ? `${srcDir}/scss/!(_)*.scss` : `${srcDir}/scss/+(tabler|demo).scss`)
C
codecalm 已提交
179
		.pipe(debug())
C
codecalm 已提交
180 181
		.pipe(sass({
			style: 'expanded',
C
codecalm 已提交
182
			precision: 7,
C
codecalm 已提交
183 184
			importer: (url, prev, done) => {
				if (url[0] === '~') {
P
Paweł Kuna 已提交
185
					url = path.resolve('node_modules', url.substr(1))
C
codecalm 已提交
186 187
				}

P
Paweł Kuna 已提交
188
				return { file: url }
C
codecalm 已提交
189 190 191 192 193 194 195 196
			},
		}).on('error', sass.logError))
		.pipe(postcss([
			require('autoprefixer'),
		]))
		.pipe(gulp.dest(`${distDir}/css/`))
		.pipe(browserSync.reload({
			stream: true,
C
codecalm 已提交
197
		}))
P
Paweł Kuna 已提交
198 199 200 201 202 203 204 205 206 207 208

	if (BUILD) {
		g
			.pipe(rtlcss())
			.pipe(rename((path) => {
				path.basename += '.rtl'
			}))
			.pipe(gulp.dest(`${distDir}/css/`))
	}

	return g
P
Paweł Kuna 已提交
209
})
C
codecalm 已提交
210

C
codecalm 已提交
211 212 213
/**
 * CSS minify
 */
P
Paweł Kuna 已提交
214
gulp.task('css-minify', function () {
C
codecalm 已提交
215 216 217 218
	return gulp.src(`${distDir}/css/!(*.min).css`)
		.pipe(debug())
		.pipe(cleanCSS())
		.pipe(rename((path) => {
P
Paweł Kuna 已提交
219
			path.basename += '.min'
C
codecalm 已提交
220
		}))
P
Paweł Kuna 已提交
221 222
		.pipe(gulp.dest(`${distDir}/css/`))
})
C
codecalm 已提交
223

C
codecalm 已提交
224 225 226
/**
 * Compile JS files to dist directory
 */
P
Paweł Kuna 已提交
227 228 229 230 231 232 233
let cache = {}

const compileJs = function (name, mjs = false) {
	if (!cache[name]) {
		cache[name] = null
	}

C
codecalm 已提交
234
	const g = rollupStream({
P
Paweł Kuna 已提交
235 236
		input: `${srcDir}/js/${name}.js`,
		cache: cache[name],
C
codecalm 已提交
237
		output: {
P
Paweł Kuna 已提交
238 239 240
			name: `${name}.js`,
			format: mjs ? 'es' : 'umd',
			...(mjs ? { exports: 'named' } : {})
C
codecalm 已提交
241 242
		},
		plugins: [
C
codecalm 已提交
243 244
			rollupReplace({
				'process.env.NODE_ENV': JSON.stringify(BUILD ? 'production' : 'development'),
245
				preventAssignment: false
C
codecalm 已提交
246
			}),
C
codecalm 已提交
247 248 249 250 251 252 253 254 255
			rollupBabel({
				exclude: 'node_modules/**'
			}),
			nodeResolve(),
			rollupCommonjs(),
			rollupCleanup()
		]
	})
		.on('bundle', (bundle) => {
P
Paweł Kuna 已提交
256
			cache[name] = bundle
C
codecalm 已提交
257
		})
P
Paweł Kuna 已提交
258
		.pipe(vinylSource(`${name}.js`))
C
codecalm 已提交
259
		.pipe(vinylBuffer())
C
codecalm 已提交
260
		.pipe(rename((path) => {
P
Paweł Kuna 已提交
261
			path.dirname = ''
C
codecalm 已提交
262 263 264 265
		}))
		.pipe(gulp.dest(`${distDir}/js/`))
		.pipe(browserSync.reload({
			stream: true,
P
Paweł Kuna 已提交
266
		}))
C
codecalm 已提交
267 268 269 270 271 272 273 274

	if (BUILD) {
		g.pipe(minifyJS({
			ext: {
				src: '.js',
				min: '.min.js'
			},
		}))
P
Paweł Kuna 已提交
275
			.pipe(gulp.dest(`${distDir}/js/`))
C
codecalm 已提交
276 277
	}

P
Paweł Kuna 已提交
278 279 280 281 282 283 284 285 286 287 288 289 290
	return g
}

/**
 * Compile JS files to dist directory
 */
gulp.task('js', () => {
	return compileJs('tabler')
})

gulp.task('js-demo', () => {
	return compileJs('demo')
})
C
codecalm 已提交
291

292 293 294
/**
 * Compile JS module files to dist directory
 */
P
Paweł Kuna 已提交
295 296 297 298 299
gulp.task('mjs', () => {
	return compileJs('tabler.esm', true)
})

let cacheEsm
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
gulp.task('mjs', () => {
	const g = rollupStream({
		input: `${srcDir}/js/tabler.esm.js`,
		cache: cacheEsm,
		output: {
			name: 'tabler.esm.js',
			format: 'es',
			exports: 'named'
		},
		plugins: [
			rollupReplace({
				'process.env.NODE_ENV': JSON.stringify(BUILD ? 'production' : 'development'),
				preventAssignment: false
			}),
			rollupBabel({
				exclude: 'node_modules/**'
			}),
			nodeResolve(),
			rollupCommonjs(),
			rollupCleanup()
		]
	})
		.on('bundle', (bundle) => {
P
Paweł Kuna 已提交
323
			cacheEsm = bundle
324 325 326 327
		})
		.pipe(vinylSource('tabler.esm.js'))
		.pipe(vinylBuffer())
		.pipe(rename((path) => {
P
Paweł Kuna 已提交
328
			path.dirname = ''
329 330 331 332
		}))
		.pipe(gulp.dest(`${distDir}/js/`))
		.pipe(browserSync.reload({
			stream: true,
P
Paweł Kuna 已提交
333
		}))
334 335 336 337 338 339 340 341

	if (BUILD) {
		g.pipe(minifyJS({
			ext: {
				src: '.js',
				min: '.min.js'
			},
		}))
P
Paweł Kuna 已提交
342
			.pipe(gulp.dest(`${distDir}/js/`))
343 344
	}

P
Paweł Kuna 已提交
345 346
	return g
})
347

C
codecalm 已提交
348 349 350
/**
 * Watch Jekyll files and build it to demo directory
 */
C
codecalm 已提交
351
gulp.task('watch-jekyll', (cb) => {
P
Paweł Kuna 已提交
352
	browserSync.notify('Building Jekyll')
C
codecalm 已提交
353
	return spawn('bundle', ['exec', 'jekyll', 'build', '--watch', '--destination', demoDir, '--trace'], { stdio: 'inherit' })
P
Paweł Kuna 已提交
354 355
		.on('close', cb)
})
C
codecalm 已提交
356

C
codecalm 已提交
357 358 359
/**
 * Build Jekyll files do demo directory
 */
C
codecalm 已提交
360
gulp.task('build-jekyll', (cb) => {
P
Paweł Kuna 已提交
361
	var env = Object.create(process.env)
C
codecalm 已提交
362

P
Paweł Kuna 已提交
363 364 365 366
	if (argv.preview) {
		env.JEKYLL_ENV = 'preview'
	} else {
		env.JEKYLL_ENV = 'production'
C
codecalm 已提交
367
	}
C
codecalm 已提交
368

P
Paweł Kuna 已提交
369 370 371 372 373 374
	return spawn('bundle', ['exec', 'jekyll', 'build', '--destination', demoDir, '--trace'], {
		env: env,
		stdio: 'inherit'
	})
		.on('close', cb)
})
C
codecalm 已提交
375

C
sitemap  
codecalm 已提交
376 377 378
gulp.task('build-cleanup', () => {
	return gulp
		.src(`${demoDir}/redirects.json`, { read: false, allowEmpty: true })
P
Paweł Kuna 已提交
379 380
		.pipe(clean())
})
C
sitemap  
codecalm 已提交
381

C
codecalm 已提交
382
gulp.task('build-purgecss', (cb) => {
P
Paweł Kuna 已提交
383
	if (argv.preview) {
C
codecalm 已提交
384 385 386 387 388 389 390
		return gulp.src('demo/dist/{libs,css}/**/*.css')
			.pipe(purgecss({
				content: ['demo/**/*.html']
			}))
			.pipe(gulp.dest('demo/dist/css'))
	}

P
Paweł Kuna 已提交
391 392
	cb()
})
C
codecalm 已提交
393 394

gulp.task('build-critical', (cb) => {
P
Paweł Kuna 已提交
395
	if (argv.preview) {
C
codecalm 已提交
396 397 398 399 400 401
		return gulp
			.src('demo/**/*.html')
			.pipe(
				critical({
					base: 'demo/',
					inline: true,
C
codecalm 已提交
402 403 404 405 406 407 408
					css: ['demo/dist/css/tabler.css'],
					ignore: {
						atrule: ['@font-face', '@import'],
						decl: (node, value) => {
							/url\(/.test(value)
						},
					},
C
codecalm 已提交
409 410 411
				})
			)
			.on('error', err => {
P
Paweł Kuna 已提交
412
				console.log(err.message)
C
codecalm 已提交
413
			})
P
Paweł Kuna 已提交
414
			.pipe(gulp.dest('demo'))
C
codecalm 已提交
415 416
	}

P
Paweł Kuna 已提交
417 418
	cb()
})
C
codecalm 已提交
419

C
codecalm 已提交
420 421 422
/**
 * Watch JS and SCSS files
 */
C
codecalm 已提交
423
gulp.task('watch', (cb) => {
P
Paweł Kuna 已提交
424 425 426 427
	gulp.watch('./src/scss/**/*.scss', gulp.series('sass'))
	gulp.watch('./src/js/**/*.js', gulp.parallel('js', 'mjs', 'js-demo'))
	cb()
})
C
codecalm 已提交
428

C
codecalm 已提交
429 430 431
/**
 * Create BrowserSync server
 */
C
codecalm 已提交
432
gulp.task('browser-sync', () => {
C
codecalm 已提交
433 434 435 436 437 438 439 440 441
	browserSync({
		watch: true,
		server: {
			baseDir: demoDir,
			routes: {
				'/node_modules': 'node_modules',
				'/dist/css': `${distDir}/css`,
				'/dist/js': `${distDir}/js`,
				'/dist/img': `${srcDir}/img`,
C
codecalm 已提交
442
				'/dist/fonts': `${srcDir}/fonts`,
C
codecalm 已提交
443 444 445 446 447 448 449 450
				'/static': `${srcDir}/static`,
			},
		},
		port: 3000,
		open: false,
		host: 'localhost',
		notify: false,
		reloadOnRestart: true
P
Paweł Kuna 已提交
451 452
	})
})
C
codecalm 已提交
453

C
codecalm 已提交
454 455 456
/**
 * Copy libs used in tabler from npm to dist directory
 */
C
codecalm 已提交
457
gulp.task('copy-libs', (cb) => {
P
Paweł Kuna 已提交
458
	const allLibs = require(`${srcDir}/pages/_data/libs`)
C
codecalm 已提交
459

P
Paweł Kuna 已提交
460
	let files = []
C
codecalm 已提交
461

C
codecalm 已提交
462
	Object.keys(allLibs.js).forEach((lib) => {
P
Paweł Kuna 已提交
463 464
		files.push(Array.isArray(allLibs.js[lib]) ? allLibs.js[lib] : [allLibs.js[lib]])
	})
C
codecalm 已提交
465

C
codecalm 已提交
466
	Object.keys(allLibs.css).forEach((lib) => {
P
Paweł Kuna 已提交
467 468
		files.push(Array.isArray(allLibs.css[lib]) ? allLibs.css[lib] : [allLibs.css[lib]])
	})
C
codecalm 已提交
469

P
Paweł Kuna 已提交
470
	files = files.flat()
C
codecalm 已提交
471

C
codecalm 已提交
472 473
	files.forEach((file) => {
		if (!file.match(/^https?/)) {
P
Paweł Kuna 已提交
474 475
			let dirname = path.dirname(file).replace('@', '')
			let cmd = `mkdir -p "dist/libs/${dirname}" && cp -r node_modules/${file} ${distDir}/libs/${file.replace('@', '')}`
C
codecalm 已提交
476 477 478

			cp.exec(cmd)
		}
P
Paweł Kuna 已提交
479
	})
C
codecalm 已提交
480

P
Paweł Kuna 已提交
481 482
	cb()
})
C
codecalm 已提交
483

C
codecalm 已提交
484 485 486
/**
 * Copy static files (flags, payments images, etc) to dist directory
 */
C
codecalm 已提交
487
gulp.task('copy-images', () => {
C
codecalm 已提交
488 489
	return gulp
		.src(`${srcDir}/img/**/*`)
P
Paweł Kuna 已提交
490 491
		.pipe(gulp.dest(`${distDir}/img`))
})
C
codecalm 已提交
492

C
codecalm 已提交
493 494 495
/**
 * Copy static files (demo images, etc) to demo directory
 */
C
codecalm 已提交
496
gulp.task('copy-static', () => {
C
codecalm 已提交
497 498
	return gulp
		.src(`${srcDir}/static/**/*`)
P
Paweł Kuna 已提交
499 500
		.pipe(gulp.dest(`${demoDir}/static`))
})
C
codecalm 已提交
501

C
codecalm 已提交
502 503 504 505 506 507 508 509 510
/**
 * Copy fonts
 */
gulp.task('copy-fonts', () => {
	return gulp
		.src(`${srcDir}/fonts/**/*`)
		.pipe(gulp.dest(`${distDir}/fonts`))
})

C
codecalm 已提交
511 512 513
/**
 * Copy Tabler dist files to demo directory
 */
C
codecalm 已提交
514
gulp.task('copy-dist', () => {
C
codecalm 已提交
515 516
	return gulp
		.src(`${distDir}/**/*`)
P
Paweł Kuna 已提交
517 518
		.pipe(gulp.dest(`${demoDir}/dist/`))
})
C
codecalm 已提交
519

C
codecalm 已提交
520 521 522
/**
 * Add banner to build JS and CSS files
 */
C
codecalm 已提交
523 524 525 526
gulp.task('add-banner', () => {
	return gulp.src(`${distDir}/{css,js}/**/*.{js,css}`)
		.pipe(header(getBanner()))
		.pipe(gulp.dest(`${distDir}`))
P
Paweł Kuna 已提交
527
})
C
codecalm 已提交
528

P
Paweł Kuna 已提交
529
gulp.task('clean', gulp.series('clean-dirs', 'clean-jekyll'))
C
codecalm 已提交
530

P
Paweł Kuna 已提交
531
gulp.task('start', gulp.series('clean', 'sass', 'js', 'js-demo', 'mjs', 'build-jekyll', gulp.parallel('watch-jekyll', 'watch', 'browser-sync')))
C
codecalm 已提交
532

C
codecalm 已提交
533
gulp.task('build-core', gulp.series('build-on', 'clean', 'sass', 'css-minify', 'js', 'js-demo', 'mjs', 'copy-images', 'copy-fonts', 'copy-libs', 'add-banner'))
P
Paweł Kuna 已提交
534 535
gulp.task('build-demo', gulp.series('build-on', 'build-jekyll', 'copy-static', 'copy-dist', 'build-cleanup', 'build-purgecss'/*, 'build-critical'*/))
gulp.task('build', gulp.series('build-core', 'build-demo'))