gulpfile.mjs

// Load plugins
import gulp from 'gulp';
const { series, parallel, src, dest, task } = gulp;
import gulpPug from 'gulp-pug';
import gulpData from 'gulp-data';
import gulpMergeJson from 'gulp-merge-json';
// sass 1.63.0 breaking change
// https://github.com/sass/dart-sass/issues/2011
// import dartSass from 'sass';
import * as dartSass from 'sass';
import gulpSass from 'gulp-sass';
const sass = gulpSass(dartSass);
import gulpConnect from 'gulp-connect';
import gulpReplace from 'gulp-replace';

// Doesn't work until https://github.com/Nerajno/gulp-jest/issues/77 is fixed
// import { jest as gulpJest } from 'gulp-jest';

import { exec } from 'node:child_process';
import fs from 'node:fs';
import path from 'node:path';

import { deleteAsync } from 'del';

task(clean);
clean.description = 'Clean the build directory';
task('server', webserver);
task('server').description = 'Local dev web server';
task('build',
    series(
        series(pug_data, count_items, pug_src),
        series(api_clean, api_build, api_copy),
        parallel(
            bulma, bulmajs, tablefilter, sweetalert2, jquery, minisearch, js,
            fontawesome_css, fontawesome_font, font_mfizz, images, css
)));
task('build').description = 'Build the static website';
task('default', series('clean', 'build'));
task('default').description = 'clean + build';
task('pug', series(pug_data, pug_src));
task('pug').description = 'Only build content and templates without assets, the API and JS dependencies';
/* https://github.com/Nerajno/gulp-jest/issues/77
task('test', series(test_data));
task('test').description = 'Run test validating the JSON data';
*/
task('count', series(clean, pug_data, count_items));
task('count').description = 'Count the number of items (tools, resources, etc.)';

function clean() {
    // You can use multiple globbing patterns as you would with `gulp.src`
    return deleteAsync(['build']);
};

// aggregate different JSON files into one database
function pug_data() {
    return src('data/**/*.json')
        .pipe(gulpMergeJson({
            fileName: 'data.json',
            edit: (json, file) => {
                // Extract the filename and strip the extension
                var filename = path.basename(file.path),
                    parentFolder = path.basename(path.dirname(file.path)),
                    filenameStrip = filename.replace(path.extname(filename), '');
                var primaryKey = parentFolder + '_' + filenameStrip;

                // Keep the tree structure
                var data = {};
                if(typeof data[parentFolder] === 'undefined') {
                    data[parentFolder] = {};
                }
                data[parentFolder][filenameStrip] = json;

                return data;
            },
            jsonSpace: '  '
        }))
        .pipe(dest('temp/'));
};

// compile pug templates into HTML and pass data in argument
function pug_src() {
    return src('pug/*.pug')
        .pipe(gulpData(function() {
            return JSON.parse(fs.readFileSync('temp/data.json'));
        }))
        .pipe(gulpData(function() {
            return JSON.parse(fs.readFileSync('pug/mapping.json'));
        }))
        .pipe(gulpData(function() {
            return JSON.parse(fs.readFileSync('pug/count.json'));
        }))
        .pipe(gulpData(function() {
            return JSON.parse(fs.readFileSync('CONTRIBUTORS.json'));
        }))
        .pipe(gulpPug({
            pretty: true,
        }))
        .pipe(dest('build/'));
};

function api_clean() {
    return deleteAsync('temp/api');
};

// build the static JSON API via an external script, I didn't find a cleaner way to do it with gulp
// also require 'pug:data' to be run before
function api_build() {
    return exec('node make-scripts/static-json-api.js');
};

function api_copy() {
    return src('temp/api/**/*.json', { buffer: false })
        .pipe(dest('build/api/'))
};

// build the customized bulma CSS
function bulma() {
    return src('sass/bulma.sass')
        .pipe(sass())
        .pipe(dest('build/css/vendor/bulma/'));
};

function bulmajs() {
    return src('node_modules/@vizuaalog/bulmajs/dist/navbar.js', { buffer: false })
        .pipe(dest('build/js/vendor/bulmajs/'));
  };

function tablefilter() {
    return src('node_modules/tablefilter/dist/tablefilter/**/*',
        {
            base: 'node_modules/tablefilter/dist/',
            // buffer: false, // https://github.com/gulpjs/gulp/issues/2768#issuecomment-2030071554
            encoding: false
        }
    )
        .pipe(dest('build/js/vendor/'));
};

function sweetalert2() {
    return src('node_modules/sweetalert2/dist/sweetalert2.all.min.js')
        .pipe(gulpReplace('Math.random()<.1', 'Math.random()<0'))
        .pipe(dest('build/js/vendor/sweetalert2/'));
};

function jquery() {
    return src('node_modules/jquery/dist/jquery.min.js', { buffer: false })
        .pipe(dest('build/js/vendor/jquery/'));
};

function minisearch() {
    return src('node_modules/minisearch/dist/umd/index.js*', { buffer: false })
        .pipe(dest('build/js/vendor/minisearch/'));
};

// copy personal (non-vendor) scripts
function js() {
    return src('js/**/*.js', { buffer: false })
        .pipe(dest('build/js/'));
};

// build personal (non-vendor) css
function css() {
    return src('sass/site.sass')
        .pipe(sass())
        .pipe(dest('build/css/'));
};

function fontawesome_css() {
    return src('node_modules/@fortawesome/fontawesome-free/css/all.min.css', { buffer: false })
        .pipe(dest('build/css/vendor/fontawesome/css/'));
  };

function fontawesome_font() {
    return src('node_modules/@fortawesome/fontawesome-free/webfonts/*',
        {
            base: 'node_modules/@fortawesome/fontawesome-free/',
            // buffer: false, // https://github.com/gulpjs/gulp/issues/2768#issuecomment-2030071554
            encoding: false // https://github.com/gulpjs/gulp/issues/2766
        })
        .pipe(dest('build/css/vendor/fontawesome/'));
};

function font_mfizz() {
    return src(['node_modules/font-mfizz/dist/*',
        '!node_modules/font-mfizz/dist/preview.html',
        ],
        {
            // buffer: false, // https://github.com/gulpjs/gulp/issues/2768#issuecomment-2030071554
            encoding: false
        })
        .pipe(dest('build/css/vendor/font-mfizz/'));
};

function images() {
    return src('img/**/*.*',
        {
            // buffer: false, // https://github.com/gulpjs/gulp/issues/2768#issuecomment-2030071554
            encoding: false
        }
        )
        .pipe(dest('build/img/'));
};

function webserver() {
    gulpConnect.server({
        root: 'build',
        port: 3000
  });
};

// validate JSON data files
/* https://github.com/Nerajno/gulp-jest/issues/77
function test_data() {
    return src('make-scripts/json-validations')
        .pipe(gulpJest({
            "preprocessorIgnorePatterns": [
                "<rootDir>/dist/", "<rootDir>/node_modules/"
            ],
        "automock": false
        }));
};
*/

// count the number of data items (tools, resources, etc.)
async function count_items() {
    fs.readFile('temp/data.json', {encoding:'utf8', flag:'r'}, (err1, data1) => {
        if (err1) throw err1;
        var count = (data1.match(/"name"/g) || []).length;
        console.log(`Number of items: ${count}`);
        fs.writeFile('pug/count.json', JSON.stringify({ count: { total: count } }, null, 2), (err2) => {
            if (err2) throw err2;
        });
    });
};