/* ESP8266 file system builder Copyright (C) 2016-2019 by Xose PĂ©rez This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ /*eslint quotes: ['error', 'single']*/ /*eslint-env es6*/ // ----------------------------------------------------------------------------- // Dependencies // ----------------------------------------------------------------------------- const gulp = require('gulp'); const through = require('through2'); const htmlmin = require('gulp-htmlmin'); const inline = require('gulp-inline'); const inlineImages = require('gulp-css-base64'); const favicon = require('gulp-base64-favicon'); const crass = require('gulp-crass'); const htmllint = require('gulp-htmllint'); const csslint = require('gulp-csslint'); const rename = require('gulp-rename'); const replace = require('gulp-replace'); const remover = require('gulp-remove-code'); const gzip = require('gulp-gzip'); const path = require('path'); const terser = require('terser') // ----------------------------------------------------------------------------- // Configuration // ----------------------------------------------------------------------------- const htmlFolder = 'html/'; const configFolder = 'espurna/config/'; const dataFolder = 'espurna/data/'; const staticFolder = 'espurna/static/'; // ----------------------------------------------------------------------------- // Methods // ----------------------------------------------------------------------------- var toHeader = function(name, debug) { return through.obj(function (source, encoding, callback) { var parts = source.path.split(path.sep); var filename = parts[parts.length - 1]; var safename = name || filename.split('.').join('_'); // Generate output var output = ''; output += '#define ' + safename + '_len ' + source.contents.length + '\n'; output += 'const uint8_t ' + safename + '[] PROGMEM = {'; for (var i=0; i 0) { output += ','; } if (0 === (i % 20)) { output += '\n'; } output += '0x' + ('00' + source.contents[i].toString(16)).slice(-2); } output += '\n};'; // clone the contents var destination = source.clone(); destination.path = source.path + '.h'; destination.contents = Buffer.from(output); if (debug) { console.info('Image ' + filename + ' \tsize: ' + source.contents.length + ' bytes'); } callback(null, destination); }); }; var htmllintReporter = function(filepath, issues) { if (issues.length > 0) { issues.forEach(function (issue) { console.info( '[gulp-htmllint] ' + filepath + ' [' + issue.line + ',' + issue.column + ']: ' + '(' + issue.code + ') ' + issue.msg ); }); process.exitCode = 1; } }; var compressJs = function() { return through.obj(function (source, encoding, callback) { if (source.isNull()) { callback(null, source); return; } if (source.path.endsWith("custom.js")) { var contents = source.contents.toString(); var result = terser.minify(contents); if (result.error) { var { message, filename, line, col, pos } = result.error; throw new Error("terser error `" + message + "` in file " + filename + ", at line " + line); } source.contents = Buffer.from(result.code); this.push(source); callback(); return; } callback(null, source); return; }); }; var buildWebUI = function(module) { // Declare some modules as optional to remove with // removeIf(!name) ...code... endRemoveIf(!name) sections // (via gulp-remove-code) var modules = { 'light': false, 'sensor': false, 'rfbridge': false, 'rfm69': false, 'garland': false, 'thermostat': false, 'lightfox': false, 'curtain': false }; // Note: only build these when specified as module arg var excludeAll = [ 'rfm69', 'lightfox' ]; // 'all' to include all *but* excludeAll // '' to include a single module // 'small' is the default state (all disabled) if ('all' === module) { Object.keys(modules). filter(function(key) { return excludeAll.indexOf(key) < 0; }). forEach(function(key) { modules[key] = true; }); } else if ('small' !== module) { modules[module] = true; } return gulp.src(htmlFolder + '*.html'). pipe(remover(modules)). pipe(htmllint({ 'failOnError': true, 'rules': { 'id-class-style': false, 'label-req-for': false, 'line-end-style': false, } }, htmllintReporter)). pipe(favicon()). pipe(inline({ base: htmlFolder, js: [function() { return remover(modules); }, compressJs], css: [crass, inlineImages], disabledTypes: ['svg', 'img'] })). pipe(remover(modules)). pipe(htmlmin({ collapseWhitespace: true, removeComments: true, minifyCSS: true, minifyJS: false })). pipe(replace('pure-', 'p-')). pipe(gzip({ gzipOptions: { level: 9 } })). pipe(rename('index.' + module + '.html.gz')). pipe(gulp.dest(dataFolder)). pipe(toHeader('webui_image', true)). pipe(gulp.dest(staticFolder)); }; // ----------------------------------------------------------------------------- // Tasks // ----------------------------------------------------------------------------- gulp.task('certs', function() { gulp.src(dataFolder + 'server.*'). pipe(toHeader(debug=false)). pipe(gulp.dest(staticFolder)); }); gulp.task('csslint', function() { gulp.src(htmlFolder + '*.css'). pipe(csslint({ids: false})). pipe(csslint.formatter()); }); gulp.task('webui_small', function() { return buildWebUI('small'); }); gulp.task('webui_sensor', function() { return buildWebUI('sensor'); }); gulp.task('webui_light', function() { return buildWebUI('light'); }); gulp.task('webui_rfbridge', function() { return buildWebUI('rfbridge'); }); gulp.task('webui_rfm69', function() { return buildWebUI('rfm69'); }); gulp.task('webui_lightfox', function() { return buildWebUI('lightfox'); }); gulp.task('webui_garland', function() { return buildWebUI('garland'); }); gulp.task('webui_thermostat', function() { return buildWebUI('thermostat'); }); gulp.task('webui_curtain', function() { return buildWebUI('curtain'); }); gulp.task('webui_all', function() { return buildWebUI('all'); }); gulp.task('webui', gulp.parallel( 'webui_small', 'webui_sensor', 'webui_light', 'webui_rfbridge', 'webui_rfm69', 'webui_lightfox', 'webui_garland', 'webui_thermostat', 'webui_curtain', 'webui_all' ) ); gulp.task('default', gulp.series('webui'));