gulpfile.js

"use strict";

const gulp = require("gulp");
const packagedef = require("./package.json");
const replace = require('gulp-replace');
const path = require("path");
const fs = require("fs");

async function CleanDistFolder() {
    console.log("Cleaning dist folder...");
    const del = await import('del');
    return del.deleteAsync(['./dist/*']);
}

/**
 * Build distribution files using webpack config
 */
function BuildWithWebpack(done) {
    const { exec } = require('child_process');

    console.log("Building distribution files with webpack...");
    exec('npx webpack --config ./configs/webpack.config.js', (err, stdout, stderr) => {
        if (err) {
            console.error(stderr);
            return done(err);
        }
        console.log(stdout);
        done();
    });
}

//////////////////////////////////////
//// Build documentation site from js content using jsdoc

//// remove previous output
async function CleanDocsFolder() {
    console.log("Cleaning docs folder...");
    const del = await import('del');
    return del.deleteAsync(['./docs/*']);
}

// extract docs and compile to html, adds in readme.md from docs-src
function CompileDocs(done) {
    const { exec } = require('child_process');

    console.log("Building documentation.");
    exec('npx jsdoc -c ./configs/jsdoc.json', (err, stdout, stderr) => {
        if (err) {
            console.error(stderr);
            return done(err);
        }
        console.log(stdout);
        done();
    });
}

// static docs files that jsdocs won't put where we want
function CopyDocStatics() {
    return gulp.src('./docs-src/configs/**').pipe(gulp.dest('./docs/configs/'));
}

/**
 * Helper function to get all files with a specific extension from a directory
 */
function getAllFiles(dir, ext) {
    let files = [];
    const items = fs.readdirSync(dir, { withFileTypes: true });

    for (const item of items) {
        const fullPath = path.join(dir, item.name);
        if (item.isDirectory()) {
            files = files.concat(getAllFiles(fullPath, ext));
        } else if (item.isFile() && path.extname(item.name) === ext) {
            files.push(fullPath);
        }
    }

    return files;
}

/**
 * Process namespace strings in documentation files (to put dot delimeters back into names)
 */
function ProcessNamespacesAndVersion(cb) {
    const namespaces = [
        "MeadCo.ScriptX.Print.Licensing",
        "MeadCo.ScriptX.Print.HTML",
        "MeadCo.ScriptX.Print.PDF",
        "MeadCo.ScriptX.Print"
    ];

    console.log("Processing namespace strings in documentation files...");

    try {
        // Get all HTML files in docs directory
        const docFiles = getAllFiles('./docs', '.html');

        // Process each namespace in each file
        for (const file of docFiles) {
            let content = fs.readFileSync(file, 'utf8');

            for (const namespace of namespaces) {
                const badName = namespace.replace(/\./g, "");
                const regex = new RegExp(badName + "(?![a-zA-Z]*\.html|[a-zA-Z]*\")", "gi");
                content = content.replace(regex, namespace);
            }

            content = content.replace(/{@packageversion}/g, packagedef.version);

            // Remove the footer element and its content (the generated date etc.)
            content = content.replace(/<footer[\s\S]*?<\/footer>/gi, '');

            fs.writeFileSync(file, content, 'utf8');
        }

        console.log('Namespace processing completed');
        cb();
    } catch (err) {
        cb(err);
    }
}

exports.Clean = gulp.parallel(CleanDistFolder, CleanDocsFolder);
exports.BuildDocs = gulp.series(CleanDocsFolder, gulp.series(CompileDocs, ProcessNamespacesAndVersion, CopyDocStatics));
exports.BuildDist = gulp.series(CleanDistFolder, BuildWithWebpack);
exports.Dist = gulp.series(exports.Clean, gulp.parallel(gulp.series(CompileDocs, ProcessNamespacesAndVersion, CopyDocStatics), BuildWithWebpack));