gulp-samples.js

/* eslint-disable no-undef */
/* eslint-disable @typescript-eslint/no-var-requires */
/* eslint-disable @typescript-eslint/no-unused-vars */

let gulp = require('gulp');
var gulpChangeMod = require('gulp-chmod');
let gulpIgnore = require('gulp-ignore');
let uglify = require('gulp-uglify');

// let gSort = require('gulp-sort');
let rename = require('gulp-rename');
let fs = require('fs.extra');
let path = require('path');
let flatten = require('gulp-flatten');
let del = require('del');
let es = require('event-stream');

var igConfig = require('./gulp-config.js')

eval(require('typescript')
.transpile(require('fs')
.readFileSync("./tasks/Transformer.ts").toString()));

function log(msg) {
    console.log('GULP ' + msg);
}
log('loaded gulp scripts');

// NOTE you can comment out strings in this array to run subset of samples
var sampleSource = [
    // including specific samples:
    // igConfig.SamplesCopyPath + '/charts/category-chart/axis-gap/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/multi-row-dragging/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/action-strip/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/column*/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/editing-events/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/**/App.razor',

    // including samples for all components:
    igConfig.SamplesCopyPath + '/**/App.razor',

    // including samples for specific components:
    // igConfig.SamplesCopyPath + '/charts/category-chart/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/data-chart/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/doughnut-chart/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/financial-chart/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/pie-chart/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/sparkline/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/tree-map/**/App.razor',
    // igConfig.SamplesCopyPath + '/charts/zoomslider/**/App.razor',
    // igConfig.SamplesCopyPath + '/maps/geo-map/**/App.razor',
    // igConfig.SamplesCopyPath + '/gauges/bullet-graph/**/App.razor',
    // igConfig.SamplesCopyPath + '/gauges/linear-gauge/**/App.razor',
    // igConfig.SamplesCopyPath + '/gauges/radial-gauge/**/App.razor',
    // igConfig.SamplesCopyPath + '/grids/data-grid/**/App.razor',
    // igConfig.SamplesCopyPath + '/grids/list/**/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/**/App.razor',
    // igConfig.SamplesCopyPath + '/grids/tree-grid/**/App.razor',
    // igConfig.SamplesCopyPath + '/grids/tree/**/App.razor',
    // igConfig.SamplesCopyPath + '/grids/pivot-grid/**/App.razor',
    // igConfig.SamplesCopyPath + '/editors/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/badge/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/button/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/checkbox/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/chip/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/circular-progress-indicator/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/combo/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/date-time-input/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/dropdown/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/form/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/icon-button/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/input/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/linear-progress-indicator/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/radio/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/ripple/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/select/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/slider/**/App.razor',
    // igConfig.SamplesCopyPath + '/inputs/switches/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/accordion/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/avatar/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/card/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/expansion-panel/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/dock-manager/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/icon/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/stepper/**/App.razor',
    // igConfig.SamplesCopyPath + '/layouts/tabs/**/App.razor',
    // igConfig.SamplesCopyPath + '/menus/**/App.razor',
    // igConfig.SamplesCopyPath + '/scheduling/**/App.razor',
    // igConfig.SamplesCopyPath + '/notifications/**/App.razor',
    // igConfig.SamplesCopyPath + '/excel/excel-library/**/App.razor',

    // igConfig.SamplesCopyPath + '/excel/spreadsheet/**/App.razor',
    // igConfig.SamplesCopyPath + '/gauges/bullet-graph/animation/App.razor',
    // igConfig.SamplesCopyPath + '/grids/**/binding-live-data/App.razor',
    // igConfig.SamplesCopyPath + '/grids/**/overview/App.razor',
    // igConfig.SamplesCopyPath + '/grids/**/column-types/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/advanced-filtering-options/App.razor',
    // igConfig.SamplesCopyPath + '/grids/grid/styling-custom-css/App.razor',
    // "!" + igConfig.SamplesCopyPath + '/**/Program.cs',
    "!" + igConfig.SamplesCopyPath + '/**/obj/**',
    "!" + igConfig.SamplesCopyPath + '/**/bin/**',
    // "!" + igConfig.SamplesCopyPath + '/**/_Imports.razor',
    // "!" + igConfig.SamplesCopyPath + '/**/wwwroot/index.html',
    // "!" + igConfig.SamplesCopyPath + '/**/wwwroot/index.css',
];

// this variable stores detailed information about all samples in ./samples/ folder
var samples = [];

var sampleOutputFolder = '';

function cleanSamples() {
    // cleaning up obsolete files in individual samples
    // del.sync("../../samples/**/src/sandbox.config.json", {force:true});
    // del.sync("../../samples/**/manifest.json", {force:true});

    del.sync("../../samples/**/css/open-iconic/README.md", {force:true});
}
// lints all source files in ./samples folder and remove any routing paths (@page)
// since they are auto-generated when samples are copied to browsers
function lintSamples(cb) {
    for (const info of samples) {
        Transformer.lintSample(info, false)
    }
    cb();
} exports.lintSamples = lintSamples;

// lints only .razor files in ./samples folder and remove any routing paths (@page)
// since they are auto-generated when samples are copied to browsers
function lintRazorFiles(cb) {
    for (const info of samples) {
        Transformer.lintRazor(info, false)
    }
    cb();
} exports.lintRazorFiles = lintRazorFiles;

function saveSamples(cb) {
    for (const info of samples) {
        if (info.SourceRazorFile &&
            info.SourceRazorFile.Path &&
            info.SourceRazorFile.Content) {
            // log('saving ' + info.SourceRazorFile.Path)
        fs.writeFileSync(info.SourceRazorFile.Path, info.SourceRazorFile.Content);
        }
    }
    cb();
} exports.saveSamples = saveSamples;

function getSamples(cb) {

    var deferredSamples = [
        igConfig.SamplesCopyPath + '/charts/data-chart/itemized-bar-chart/App.razor',
        igConfig.SamplesCopyPath + '/charts/data-chart/itemized-column-chart/App.razor',
        igConfig.SamplesCopyPath + '/charts/data-chart/itemized-stacked-bar-chart/App.razor',
        igConfig.SamplesCopyPath + '/charts/data-chart/itemized-stacked-column-chart/App.razor',
        // excluding bugged samples:
        igConfig.SamplesCopyPath + '/grids/tree-grid/editing-columns/App.razor', // BUG https://github.com/IgniteUI/igniteui-blazor-examples/issues/423
        igConfig.SamplesCopyPath + '/grids/grid/custom-context-menu/App.razor', // BUG https://github.com/IgniteUI/igniteui-blazor-examples/issues/420
        // excluding deferred gird samples
      igConfig.SamplesCopyPath + '/grids/grid/toolbar-style/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/advanced-filtering-style/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/binding-nested-data-2/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/column-hiding-styles/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/column-moving-styles/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/column-pinning-styles/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/column-resize-styling/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/column-selection-styles/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/conditional-cell-style-2/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/data-exporting-indicator/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/data-performance-infinite-scroll/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/data-performance-operations/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/data-performance-summary/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/data-persistence-state/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/data-summary-custom-selection/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/editing-styles/App.razor',
    //   igConfig.SamplesCopyPath + '/grids/grid/excel-style-filtering-sample-1/App.razor',
    //   igConfig.SamplesCopyPath + '/grids/grid/excel-style-filtering-sample-2/App.razor',
    //   igConfig.SamplesCopyPath + '/grids/grid/excel-style-filtering-sample-3/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/excel-style-filtering-style/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/external-excel-style-filtering/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/filtering-style/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/filtering-template/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/keyboard-custom-navigation/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/multi-column-headers-styling/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/remote-filtering-data/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/remote-paging-batch-editing/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/remote-paging-custom/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/remote-paging-template/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/row-classes/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/row-drop-indicator/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/row-editing-style/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/row-paging-style/App.razor',
      igConfig.SamplesCopyPath + '/grids/grid/row-pinning-style/App.razor/App.razor',
    ];

    samples = [];
    console.log(deferredSamples[0]);

    gulp.src(sampleSource)
    // .pipe(gSort( { asc: false } ))
    .pipe(es.map(function(sample, sampleCallback) {
        // console.log('Sample: ' + sample.dirname);
        let sampleFolder = Transformer.getRelative(sample.dirname);
        // console.log('SampleFolder: ' + sampleFolder);
        let samplePath = sampleFolder + '/' + sample.basename;
        // console.log('SamplePath: ' + samplePath);

        // skip samples that were deferred
        if (deferredSamples.includes(samplePath)) {
            sampleCallback(null, sample);
        } else {
            // console.log("get " + samplePath);
            let sampleFiles = [];
            gulp.src([
                    // sampleFolder + "/Pages/*",
                    sampleFolder + "/App.razor",
                    sampleFolder + "/Components/*",
                    sampleFolder + "/**/*.cs",
                    sampleFolder + "/*.csproj",
                    sampleFolder + "/wwwroot/*.js",
                    sampleFolder + "/wwwroot/*.css",
                    sampleFolder + "/wwwroot/index.html",
                 // sampleFolder + "/wwwroot/*",
            // '!' + sampleFolder + "/wwwroot/index.html",
            //   '!' + sampleFolder + "/wwwroot/index.css",
            //   '!' + sampleFolder + "/Pages/_*.razor",
            //   '!' + sampleFolder + "/Pages/DataGridBindingLiveData.razor",
              '!' + sampleFolder + "/Pages/*.g.cs",
              '!' + sampleFolder + "/_Imports.razor",
            //   '!' + sampleFolder + "/Program.cs", // not excluded b/c we need to get names of IG modules
              '!' + sampleFolder + "/obj/**",
              '!' + sampleFolder + "/obj/*.*",
              '!' + sampleFolder + "/bin/**",
              '!' + sampleFolder + "/bin/*.*",])
            .pipe(flatten({ "includeParents": -1 }))
            .pipe(es.map(function(file, fileCallback) {
                let fileDir = Transformer.getRelative(file.dirname);
                console.log('PipeFildir: ' + fileDir);
                sampleFiles.push(fileDir + "/" + file.basename);
                // console.log("get file " + fileDir + "/" + file.basename);
                fileCallback(null, file);
            }))
            .on("end", function() {
                // log(sampleFolder);
                let sampleInfo = Transformer.getSampleInfo(sample, sampleFiles);
                if (sampleInfo !== null) {
                    samples.push(sampleInfo);
                }
                sampleCallback(null, sample);
            });
        }

    }))
    .on("end", function() {
        Transformer.sort(samples);
        Transformer.process(samples);
        Transformer.verify(samples);

        // Transformer.print(samples);

        log('getSamples() found ' + samples.length + " samples");
        // for (const sample of samples) {
        //     log(' ' + sample.SampleFolderPath);
        // }
        // let last = samples[samples.length - 1];
        // log('package name ' + last.PackageFileContent.name);
        // last.PackageDependencies = Transformer.getDependencies(last);
        // log('packages \n' + last.PackageFileContent.dependencies);
        // log('dependencies: \n' + last.PackageDependencies);
        cb();
    });
} exports.getSamples = getSamples;

function makeDirectoryFor(filePath) {
    var dirname = path.dirname(filePath);
    if (fs.existsSync(dirname)) {
        return true;
    }
    makeDirectoryFor(dirname);
    fs.mkdirSync(dirname);
    // fs.mkdir(sampleOutputFolder + 'src', { recursive: true }, (err) => { if (err) throw err; });
}

function makeSamplesWritable(cb) {
    gulp.src(sampleSource)
        .pipe(gulpChangeMod(666))
        .pipe(gulp.dest(sampleSource))
        .on("end", function() {
            cb();
        });
} exports.makeSamplesWritable = makeSamplesWritable;

function exclude(fileWithString) {
    return es.map(function(file, cb) {
        if (file.basename.indexOf(fileWithString) >= 0 ||
            file.dirname.indexOf(fileWithString) >= 0) {
            // log('- share data ' + file.basename);
            cb(null);
        } else {
            // log('+ share data ' + file.basename);
            cb(null, file);
        }
    });
}

function cleanupSampleBrowser(outputPath) {
    log('cleaning up files in ' + outputPath);
    del.sync([
        outputPath + "/wwwroot/code-viewer/**/*.json", // auto-generated code-viewer .json files
        outputPath + "/wwwroot/sb/*.js", // auto-copied sample's .js files
        outputPath + "/Services/*.*", // auto-copied data files
        outputPath + "/Components/**", // auto-copied sample's .razor components
        outputPath + "/Pages/**/*.*", // auto-copied samples
        outputPath + "/Pages/**", // auto-copied folders
        "!" + outputPath + "/Pages/_*.razor", // e.g. _Home.razor
        "!" + outputPath + "/Pages/_*.cshtml" // e.g. _Host.cshtml
    ], { force: true });
}

function cleanupSampleBrowsers(cb) {
    cleanupSampleBrowser( "../../browser/IgBlazorSamples.Client");
    cleanupSampleBrowser( "../../browser/IgBlazorSamples.Server");
    cb();
} exports.cleanupSampleBrowsers = cleanupSampleBrowsers;

function saveFile(filePath, fileContent) {
    makeDirectoryFor(filePath);
    // if (!fs.existsSync(outputClientRazor)) {
    fs.writeFileSync(filePath, fileContent);
    //   console.log("copied " + filePath);
}

function copySamplePages(cb, outputPath) {

    log('copying sample to ' + outputPath + '/Pages/*.* from /samples/**/app.razor files:');
    for (const sample of samples) {

        let sampleFolder = sample.ComponentGroup + '/' + sample.ComponentFolder + '/' + sample.SampleFolderName;
        log("copying sample to " + outputPath + '/Pages/' + sampleFolder + '/App.razor');

        // lint and force auto-generation of routing paths (@page) in razor files
        Transformer.lintSample(sample, true);

        // outputFolder = Strings.toTitleCase(outputClient);
        // let dataFiles = [];
        for (const file of sample.SourceFiles) {
            // console.log(" file.Name=" +  file.Path);
            if (file.isRazorFile()) {
                var copyTarget = outputPath + '/Pages/' + sampleFolder + '/' + file.Parent + '/' + file.Name;
                // log("copying sample to " + copyTarget);
                saveFile(copyTarget, file.Content);
            } else if (file.Name.indexOf("Program.cs") >= 0)  {
                continue;
            } else if (file.isCS()) {
                saveFile(outputPath + '/Services/' + file.Name, file.Content);
                sample.DataFilesCount++;
                if (file.Name.indexOf("DataGenerator") >= 0) {
                    // dataFiles.push('../samples/' + sampleFolder + '/' + file.Parent + '/' + file.Name);
                }
            } else {
                // log("WARNING unknown source file: " + file.Path);
                throw new Error("ERROR unknown source file: " + file.Path);
            }
        }

        // if (dataFiles.length > 1) {
        //     console.log(dataFiles);
        // }
    }

    log('TOC generating with routing paths for samples');
    let routingGroups = Transformer.getRoutingGroups(samples);
    let routingFile = Transformer.getRoutingFile(routingGroups);

    log('TOC generating ' + outputPath + '/wwwroot/toc.json');
    saveFile(outputPath + '/wwwroot/toc.json', routingFile);

    cb();
}

function copySampleScripts(cb, outputPath, indexName) {
    var insertScriptFiles = [];

    log('deleting scripts in: ' + outputPath + '/wwwroot/sb/*.js');
    del.sync('../IgBlazorSamples.Client/wwwroot/sb/' + "*.js", {force:true});

    log('copying scripts to:  ' + outputPath + '/wwwroot/sb/*.js');

    var copiedScriptFiles = [];
    for (const sample of samples) {

        //console.log(sample);
        var fileIndex = 0;
        var fileSuffix = "";
        for (const file of sample.PublicFiles_JS) {

            var fileName = sample.ComponentFolder + "-" + sample.SampleFolderName + fileSuffix + ".js";
            fileIndex = fileIndex + 1;
            fileSuffix = fileIndex;

            var scriptPath = outputPath + '/wwwroot/sb/' + fileName
            // log("-copying scripts to:  " + scriptPath);

            if (copiedScriptFiles.indexOf(fileName) === -1) {
                copiedScriptFiles.push(fileName);

                log("copying scripts to:  " + scriptPath);

                // console.log("copySampleScripts " + scriptName);
                saveFile(scriptPath, file.Content);

                if (file.Name.indexOf("DockManager") >= 0) {
                    var fileRequiresLoading = true;
                    if (file.Name.indexOf("bundle") >= 0) {
                        // skipping non-entry point bundle files for DockManager
                        if (file.Name.indexOf("1") >= 0) fileRequiresLoading = false;
                        if (file.Name.indexOf("2") >= 0) fileRequiresLoading = false;
                        if (file.Name.indexOf("3") >= 0) fileRequiresLoading = false;
                    }
                    if (fileRequiresLoading) {
                        insertScriptFiles.push('<script src="sb/' + fileName + '"></script>');
                    }
                } else {
                    insertScriptFiles.push('<script src="sb/' + fileName + '"></script>');
                }
            }
        }
    }
    // sorting inserts
    //insertScriptFiles.sort((a, b) => a > b ? 1 : -1)

    // updating index.html with JavaScripts for samples
    let indexPath = outputPath + indexName;
    log('updating ' + indexPath);
    let indexFile = fs.readFileSync(indexPath).toString();
    let indexLines = indexFile.split('\n');
    let insertStart = -1;
    let insertEnd = -1;
    for (let i = 0; i < indexLines.length; i++) {
        let line = indexLines[i];
        if (line.indexOf("<!--AutoInsertJavaScriptsForSamples Start-->") > 0) {
            insertStart = i;
        }
        else if (line.indexOf("<!--AutoInsertJavaScriptsForSamples End-->") > 0) {
            insertEnd = i;
        }
    }

    if (insertStart < 0 ) {
        throw new Error("File '" + indexPath + "' is missing: '<!--AutoInsertJavaScriptsForSamples Start-->'");
    }
    else if (insertEnd < 0 ) {
        throw new Error("File '" + indexPath + "' is missing: '<!--AutoInsertJavaScriptsForSamples End-->'");
    }
    else if (insertStart > 0 && insertEnd > 0) {

        for (let i = insertStart+1; i < insertEnd; i++) {
            if (indexLines[i].indexOf("AutoInsertJavaScriptsForSamples") < 0)
                indexLines[i] = ""; // clearing previously auto-generated inserts for JS files
        }

        // for (let i = insertEnd - 1; i > insertStart+1; i--) {
        //     indexLines.splice(i, 1);
        // }

        // adding latest auto-generated inserts for JS files
        indexLines[insertStart] += '\n' + insertScriptFiles.join('\n');
    }

    // indexLines = indexLines.filter((v, i, a) => a.indexOf(v) === i);

    var isLocalBuild = __dirname.indexOf('Agent') < 0;
    for (let i = 0; i < indexLines.length; i++) {
        if (indexLines[i].indexOf('<base href') > 0) {
            if (isLocalBuild) {
                log('updating <base href="/" /> ');
                indexLines[i] = '    <base href="/" />';
            } else {
                log('updating <base href="/blazor-client/" /> ');
                indexLines[i] = '    <base href="/blazor-client/" />';
            }
            break;
        }
    }
    log('is local build = ' + isLocalBuild + ' ' + __dirname);

    index = indexLines.join('\n');
    while (index.indexOf('\n\n') >= 0) {
        index = index.split('\n\n').join('\n');
    }
    fs.writeFileSync(indexPath, index);
    // cb();
}

// '../../browser/IgBlazorSamples.Server/Pages'
// '../../browser/IgBlazorSamples.Server/Services'
// '../../browser/IgBlazorSamples.Server/wwwroot'
function copySamplesToServer(cb) {
    cleanupSampleBrowser( "../../browser/IgBlazorSamples.Server");
    copySampleScripts(cb, "../../browser/IgBlazorSamples.Server", "/Pages/_Host.cshtml");
    copySamplePages(cb,   "../../browser/IgBlazorSamples.Server");
} exports.copySamplesToServer = copySamplesToServer;

// '../../browser/IgBlazorSamples.Client/Pages'
// '../../browser/IgBlazorSamples.Client/Services'
// '../../browser/IgBlazorSamples.Client/wwwroot'
function copySamplesToClient(cb) {
    cleanupSampleBrowser( "../../browser/IgBlazorSamples.Client");
    copySampleScripts(cb, "../../browser/IgBlazorSamples.Client", "/wwwroot/index.html");
    copySamplePages(cb,   "../../browser/IgBlazorSamples.Client");
} exports.copySamplesToClient = copySamplesToClient;

function updateReadme(cb) {

    // log('updating readme files... ');
    var template = fs.readFileSync("../../templates/sample/ReadMe.md", "utf8");
    for (const sample of samples) {

        if (sample.SourceFiles !== undefined &&
            sample.SourceFiles.length > 0) {
            // let outputPath = sampleOutputFolder + '/' + sample.SampleFolderPath;
            let outputPath = sampleOutputFolder + sample.SampleFolderPath + "/ReadMe.md";
            makeDirectoryFor(outputPath);
            log("updating " + outputPath);
            let readmeFile = Transformer.updateReadme(sample, template);
            fs.writeFileSync(outputPath, readmeFile);
            // break;
        }
    }
    cb();
} exports.updateReadme = updateReadme;

// updating .csproj files for all samples using a template project
function updateProjects(cb) {

    // del.sync("../../samples/**/css/open-iconic/README.md", {force:true});
    // del.sync("../../samples/**/css/open-iconic/BlazorClientApp.sln", {force:true});
    // del.sync("../../samples/**/css/open-iconic/BlazorClientApp.csproj", {force:true});
    // del.sync("../../samples/**/css/open-iconic/_Imports.razor", {force:true});
    // del.sync("../../samples/**/css/open-iconic/Program.cs", {force:true});
    // del.sync("../../samples/**/css/open-iconic/wwwroot", {force:true});
    // del.sync("../../samples/**/css/open-iconic/Properties", {force:true});

    // getting content of Project file from templates
    let templateProject = fs.readFileSync("../../templates/sample/BlazorClientApp.csproj");

    gulp.src(["../../samples/**/*.csproj"])
    // .pipe(flatten({ "includeParents": -1 }))
    .pipe(es.map(function(file, fileCallback) {
        let fileDir = Transformer.getRelative(file.dirname);

        if (file.dirname.indexOf("wwwroot") > 0 ||
            file.dirname.indexOf("Pages") > 0 ||
            file.dirname.indexOf("Services") > 0) {
            log("ERROR invalid project location: " + file.dirname)
        } else {
            let filePath = fileDir + "/" + file.basename;
            // let filePath = file.dirname + "/" + file.basename;
            let oldContent = file.contents.toString();
            var newContent = templateProject + '';
            if (newContent !== oldContent) {
                fs.writeFileSync(filePath, newContent);
                log('updated project: ' + filePath);
                // file.contents = new Buffer(newContent);
            }
        }
        // send the updated file down the pipe
        fileCallback(null, file);
    }))
    .on("end", function() {
        cb();
    });
} exports.updateProjects = updateProjects;


// updating IG blazor versions in .csproj files for all samples
function updateIG(cb) {

    // NOTE: change this array with new version of packages
    let packageUpgrades = [
        // these IG packages are often updated:
        { name: "IgniteUI.Blazor.Trial"                , version: "23.1.33" },
        { name: "IgniteUI.Blazor.Documents.Core.Trial",  version: "23.1.33" },
        { name: "IgniteUI.Blazor.Documents.Excel.Trial", version: "23.1.33" },
        // these IG packages are sometimes updated:
        { name: "Microsoft.AspNetCore.Components",                       version: "6.0.0" },
        { name: "Microsoft.AspNetCore.Components.Web",                   version: "6.0.0" },
        { name: "Microsoft.AspNetCore.Components.WebAssembly",           version: "6.0.0" },
        { name: "Microsoft.AspNetCore.Components.WebAssembly.DevServer", version: "6.0.0" }, // suffix: 'PrivateAssets="all" ' },
        { name: "Microsoft.AspNetCore.Cors",                             version: "2.2.0" },
        { name: "Microsoft.AspNetCore.Http.Abstractions",                version: "2.2.0" },
        { name: "System.Net.Http.Json", version:"6.0.0" },
    ];

    // creating package mapping for quick lookup
    let packageMappings = {};
    for (const item of packageUpgrades) {
        item.id = item.name;
        let name = item.name;
        packageMappings[name] = item;
    }

    let updatedPackages = 0; // NOTE you can comment out strings in this array to run these function only on a subset of samples
    var packagePaths = [
        '../../browser/**/*.csproj', // browser
        '../../samples/**/*.csproj',
        // '../../samples/charts/**/*.csproj',
        // '../../samples/editors/**/*.csproj',
        // '../../samples/excel/**/*.csproj',
        // '../../samples/gauges/**/*.csproj',
        // '../../samples/grids/**/*.csproj',
        // '../../samples/inputs/**/*.csproj',
        // '../../samples/layouts/**/*.csproj',
        // '../../samples/maps/**/*.csproj',
        // '../../samples/menus/**/*.csproj',
        // '../../samples/notifications/**/*.csproj',
        // '../../samples/scheduling/**/*.csproj',

        // '../samples/charts/category-chart/**/*.csproj',
        // '../samples/maps/geo-map/type-scatter-bubble-series/*.csproj',
        '!../../samples/**/node_modules/**/*.csproj',
    ];
    gulp.src(packagePaths)
    // .pipe(flatten({ "includeParents": -1 }))
    .pipe(es.map(function(file, fileCallback) {
        let filePath = file.dirname + "/" + file.basename;
        var fileContent = file.contents.toString();
        var fileLines = fileContent.split('\n');
        // log("updating: " + filePath);

        var fileChanged = false;
        for (let i = 0; i < fileLines.length; i++) {
            const line = fileLines[i];
            //   <PackageReference Include="IgniteUI.Blazor.Documents.Excel.Trial" Version="22.1.46" />
            let words = line.split("Version=");
            if (words.length === 2 && words[0].indexOf('PackageReference') > 0) {
                // matching packages
                let packageName = words[0].replace("<PackageReference", "").replace("Include=", "").split('"').join('').trim();
                let packageInfo = packageMappings[packageName];
                if (packageInfo !== undefined) {
                    let tabString = line.indexOf('      ') >= 0 ? '      ': '    ';
                    let newLine = tabString + '<PackageReference Include="' + packageInfo.name + '" Version="' + packageInfo.version + '" ';
                    if (packageInfo.suffix) {
                        newLine += packageInfo.suffix;
                    }
                    newLine += '/>';

                    if (fileLines[i].trim() !== newLine.trim()) {
                        fileLines[i] = newLine;
                        fileChanged = true;
                    }
                }
            }
        }
        if (fileChanged) {
            let newContent = fileLines.join('\n'); // newContent !== fileContent
            updatedPackages++;
            fs.writeFileSync(filePath, newContent);
            log("updated: " + filePath);
        }
            // let filePath = fileDir + "/" + file.basename;
            // // let filePath = file.dirname + "/" + file.basename;
            // let oldContent = file.contents.toString();
            // var newContent = templateProject + '';
            // if (newContent !== oldContent) {
            //     fs.writeFileSync(filePath, newContent);
            //     log('updated project: ' + filePath);
            //     // file.contents = new Buffer(newContent);
            // }
        // cb();
        // send the updated file down the pipe
        fileCallback(null, file);
    }))
    .on("end", function() {
        log("updateIG... done = " + updatedPackages + " files");
        cb();
    });
} exports.updateIG = updateIG;

// updates ./public/meta.json with version in ./package.json file
function updateVersion(cb) {

    const appPackage = require('../package.json');
    const appVersion = appPackage.version;
    const jsonData = { version: appVersion, note: "this file is auto-generated" };
    const jsonContent = JSON.stringify(jsonData);
    const jsonPublicFile = './public/meta.json';

    fs.writeFile(jsonPublicFile, jsonContent, 'utf8', function(err) {
        if (err) {
            console.log('gulp cannot update ' + jsonPublicFile + ' file: \n' + err);
            return console.log(err);
        }
        console.log('gulp updated ' + jsonPublicFile + ' file with latest version number');
    });

    const jsonSourceFile = './src/CacheApp.json';
    fs.writeFile(jsonSourceFile, jsonContent, 'utf8', function(err) {
        if (err) {
            console.log('gulp cannot update ' + jsonSourceFile + ' file: \n' + err);
            return console.log(err);
        }
        console.log('gulp updated ' + jsonSourceFile + ' file with latest version number');
    });
    cb();

} exports.updateVersion = updateVersion;

function updateIndex(cb) {

    var template = fs.readFileSync("../../templates/sample/src/index.tsx", "utf8");
    for (const sample of samples) {

        let outputPath = sampleOutputFolder + sample.SampleFolderPath + "/src/index.tsx";
        let oldIndexFile = fs.readFileSync(outputPath).toString();

        makeDirectoryFor(outputPath);
        let newIndexFile = Transformer.updateIndex(sample, template);
        if (newIndexFile !== oldIndexFile) {
            // log('updated: ' + outputPath);
            fs.writeFileSync(outputPath, newIndexFile);
        }
        // fs.mkdir(sampleOutputFolder + 'src', { recursive: true }, (err) => { if (err) throw err; });
        // fs.writeFileSync(outputPath, indexFile);
        // break;
    }
    cb();
} exports.updateIndex = updateIndex;

function updateSharedFiles(cb) {

    // always override these shared files
    gulp.src([
        '../../templates/sample/wwwroot/index.css',
        // '../../templates/sample/src/react-app-env.d.ts',
        // '../../templates/sample/sandbox.config.json',
        // '../../templates/sample/tsconfig.json',
        // '../../templates/sample/.gitignore',
        // '../../templates/sample/.eslintrc.js',
    ])
    .pipe(flatten({ "includeParents": -1 }))
    .pipe(es.map(function(file, fileCallback) {
        let sourceContent = file.contents.toString();
        let sourcePath = Transformer.getRelative(file.dirname);
        sourcePath = sourcePath.replace('../../templates/sample', '');

        for (const sample of samples) {
            // if (sample.isUsingFileName(file.basename)) {
                let samplePath = sampleOutputFolder + sample.SampleFolderPath;
                let targetPath = samplePath + sourcePath + '/' + file.basename;

                if (fs.existsSync(targetPath)) {
                    let targetContent = fs.readFileSync(targetPath, "utf8");
                    if (sourceContent !== targetContent) {
                        fs.writeFileSync(targetPath , sourceContent);
                        log('updated ' + targetPath);
                    }
                } else {
                    fs.writeFileSync(targetPath, sourceContent);
                    log('added ' + targetPath);
                }
        }
        fileCallback(null, file);
        // SourceFiles.push(fileDir + "/" + file.basename);
    }))
    .on("end", function() {
        cb();
    });

} exports.updateSharedFiles = updateSharedFiles;

function updateDataFiles(cb) {

    // update these shared files if a sample is using them
    gulp.src(['../../templates/sample/Services/*.*'])
    // gulp.src([
    //     '../../templates/sample/Services/EnergyRenewableData.cs',
    //     '../../templates/sample/Services/SharedExcelData.cs',
    // ])
    .pipe(flatten({ "includeParents": -1 }))
    .pipe(es.map(function(file, fileCallback) {
        let sourceContent = file.contents.toString();
        let sourcePath = Transformer.getRelative(file.dirname);
        sourcePath = sourcePath.replace('../../templates/sample', '');

        for (const sample of samples) {
            if (sample.isUsingFileName(file.basename)) {

                let samplePath = sampleOutputFolder + sample.SampleFolderPath;
                let targetPath = samplePath + sourcePath + '/' + file.basename;

                if (fs.existsSync(targetPath)) {
                    let targetContent = fs.readFileSync(targetPath, "utf8");
                    if (sourceContent !== targetContent) {
                        fs.writeFileSync(targetPath , sourceContent);
                        log('updated ' + targetPath);
                    }
                } else {
                    // fs.writeFileSync(targetPath, sourceContent);
                    // log('added ' + targetPath);
                }

                // let targetPath = sampleOutputFolder + sample.SampleFolderPath + '/src/' + file.basename;
                // let targetContent = fs.readFileSync(targetPath, "utf8");
                // if (sourceContent !== targetContent) {
                //     fs.writeFileSync(targetPath, sourceContent);
                //     // log('updated ' + file.basename + ' in ' + sample.SampleFilePath)
                //     log('updated ' + targetPath);
                // }
            }
        }
        fileCallback(null, file);
    }))
    .on("end", function() {
        cb();
    });


} exports.updateDataFiles = updateDataFiles;

// testing functions
function logRoutes(cb) {
    let routes = [];
    for (const sample of samples) {
        // routes.push("/" + sample.SampleGroup + "/" + sample.SampleRoutePath)
        routes.push(sample.SampleRoute)
    }
    routes.sort();
    for (const route of routes) {
        console.log(route);
    }
    cb();
} exports.logRoutes = logRoutes;

function logFile() {
    return es.map(function(file, cb) {
        let relative = Transformer.getRelative(file.dirname);
        log(relative + '/' + file.basename);
        // log(path.relative(path.join(file.cwd, file.base), file.path))
        cb(null, file);
    });
}

function logPublicFiles(cb) {
    gulp.src([
        './samples/**/public/*.*',
    ])
    .pipe(logFile())
    .on("end", function() { cb(); });
} exports.logPublicFiles = logPublicFiles;

function logSourceFiles(cb) {
    gulp.src([
        './samples/**/src/*.ts',
       '!./samples/**/src/index.*',
    ])
    .pipe(logFile())
    .on("end", function() { cb(); });
} exports.logSourceFiles = logSourceFiles;

function logRootFiles(cb) {
    gulp.src([
        './samples/**/*.*',
       '!./samples/**/src/*.*',
       '!./samples/**/*.tsx',
       '!./samples/**/*.ts',
       '!./samples/**/*.css',
       '!./samples/**/index.*',
       '!./samples/**/manifest.json',
       '!./samples/**/package.json',
       '!./samples/**/tsconfig.json',
    ])
    .pipe(es.map(function(file, cbFile) {
        let relative = Transformer.getRelative(file.dirname);
        log(file.basename + ' ' + relative + '/' + file.basename);
        cbFile(null, file);
    }))
    .on("end", function() { cb(); });
} exports.logRootFiles = logRootFiles;

function logUniqueFiles(cb) {

    let fileNames = [];
    gulp.src([
        './samples/**/src/*.ts',
       '!./samples/**/src/index.*',
    ])
    .pipe(es.map(function(file, cbFile) {
        if (fileNames.indexOf(file.basename) === -1) {
            fileNames.push(file.basename);
        }
        cbFile(null, file);
    }))
    .on("end", function() {
        fileNames.sort();
        for (const name of fileNames) {
            log(name);
        }
        cb();
    });

} exports.logUniqueFiles = logUniqueFiles;

function logSandboxUrls(cb) {

    for (const sample of samples) {
        console.log("" + sample.SandboxUrlShort);
    }
    cb();
} exports.logSandboxUrls = logSandboxUrls;

function copyTemplates(cb) {

    // del.sync("../../samples/**/.gitignore", {force:true});

    var sampleSource = [
        // '../../samples/charts/category-chart/**/*.md',
        // '../../samples/charts/data-chart/**/*.md',
        // '../../samples/charts/doughnut-chart/**/*.md',
        // '../../samples/charts/financial-chart/**/*.md',
        // '../../samples/charts/pie-chart/**/*.md',
        // '../../samples/charts/sparkline/**/*.md',
        // '../../samples/charts/tree-map/**/*.md',
        // '../../samples/charts/zoomslider/**/*.md',
        // '../../samples/maps/**/*.md',
        '../../samples/gauges/bullet-graph/**/*.md',
        '../../samples/gauges/linear-gauge/**/*.md',
        '../../samples/gauges/radial-gauge/**/*.md',
        // '../../samples/grids/**/*.md',
        '../../samples/layouts/**/*.md',
        // excluding *.md in node_modules sub folders
        // '../../samples/excel/excel-library/**/*.md',
        // '../../samples/excel/spreadsheet/**/*.md',
        "!" + '/**/node_modules/**/*.md',
    ];

    var sampleLocations = [];
    // del.sync("./sample-test-files/**/*.*", {force:true});

    gulp.src(sampleSource)
    // .pipe(gSort( { asc: false } ))
    .pipe(es.map(function(sampleFile, sampleCallback) {

        // let sampleFolder = '../.' + Transformer.getRelative(sampleFile.dirname);
        let sampleFolder = Transformer.getRelative(sampleFile.dirname);
        // console.log('copyTemplates ' + sampleFile.dirname + '   ' + sampleFile.basename);
        // log('copyTemplates ' + sampleFile.dirname + '   ' + sampleFolder);
        // // log(sampleFolder);
        sampleLocations.push(sampleFolder);

        // let sampleFiles = [];
        // gulp.src([sampleFolder + "/**"])
        // .pipe(flatten({ "includeParents": -1 }))
        // // .pipe(gSort( { asc: false } ))
        // .pipe(es.map(function(file, fileCallback) {
        //     console.log('getSamples ' + file.basename);
        //     // let fileDir = Transformer.getRelative(file.dirname);
        //     // sampleFiles.push(fileDir + "/" + file.basename);
        //     fileCallback(null, file);
        // }))
        // .on("end", function() {
        //     // log(sampleFolder);

        //     // let sampleInfo = Transformer.getSampleInfo(samplePackage, sampleFiles);
        //     // samples.push(sampleInfo);

        //     sampleCallback(null, sampleFile);
        // });

        sampleCallback(null, sampleFile);
    }))
    .on("end", function() {
        // Transformer.sort(samples);
        // Transformer.process(samples);

        // console.log('copyTemplates found ' + sampleLocations.length + " samples");

        // .pipe(gulp.dest('../samples/charts/category-chart/annotations'))

        for (const location of sampleLocations) {
            console.log('copyTemplates to ' + location);
            gulp.src([
                // '../../templates/sample/**',
                '../../templates/sample/**/*',
                // '../../templates/sample/.gitignore',
                // '../../templates/sample/.gitignore',
                // '../../templates/sample/wwwroot/*.*',
                // '../../templates/sample/Properties/*.*'
            ]) // , { base: 'sample' }
            // .pipe(es.map(function(templateFile, templateCallback) {
            //     let templateFolder = '.' + Transformer.getRelative(templateFile.dirname);
            //     console.log('updateSamples found ' + templateFolder + "  " + templateFile.basename);
            //     templateCallback(null, templateFile);
            // }))
            .pipe(gulp.dest(location))
        }

        console.log('copyTemplates to ' + sampleLocations.length + " samples");

        // let last = samples[samples.length - 1];
        // log('package name ' + last.PackageFileContent.name);
        // last.PackageDependencies = Transformer.getDependencies(last);
        // log('packages \n' + last.PackageFileContent.dependencies);
        // log('dependencies: \n' + last.PackageDependencies);

        cb();
    });
} exports.copyTemplates = copyTemplates;

function logSampleNames(cb) {
    let sampleNames = [];
    gulp.src([
       '../../samples/**/App.razor',
      '!../../samples/**/bin/**/App.razor',
      '!../../samples/**/obj/**/App.razor',
    ])
    .pipe(es.map(function(file, cbFile) {
        sampleNames.push(file.dirname.split('samples')[1]);
        cbFile(null, file);
    })
    .on("end", function() {
        sampleNames.sort();
        for (const name of sampleNames) {
            console.log(name);
        }
        cb();
    }));

} exports.logSampleNames = logSampleNames;

function convertSamples(cb) {
    for (const sample of samples) {

        for (const file of sample.SourceFiles) {

            if (file.isRazorFile()) {
                // log("converting " + file.Path)
                var appRazor = file.Path.split("/Pages")[0];
                appRazor += "/App.razor";
                log("converting " + appRazor)
                // fs.writeFileSync(appRazor, file.Content, {encoding:'utf8',flag:'w'});
            }
        }
    }
    cb();

} exports.convertSamples = convertSamples;

function removeSamplePages(cb) {
    del.sync(igConfig.SamplesCopyPath + '/**/Pages', {force:true});

    cb();
} exports.removeSamplePages = removeSamplePages;

function renameProjects(cb) {

    var sourceFiles = [
        igConfig.SamplesCopyPath + '/**/BlazorClientApp.csproj',
        igConfig.SamplesCopyPath + '/**/BlazorClientApp.sln'
        // igConfig.SamplesCopyPath + '/charts/category-chart/annotations/BlazorClientApp.csproj',
        // igConfig.SamplesCopyPath + '/charts/category-chart/annotations/BlazorClientApp.sln'
    ];

    gulp.src(sourceFiles, {allowEmpty: true})
    .pipe(rename({
        basename: 'BlazorClient'
    }))
    // .pipe(rename(function (file) {
    //   file.dirname += "/folder";
    //   file.basename = "BlazorClient";
    //   file.extname = ".md";
    // }))
    .pipe(gulp.dest(function (file) { return file.base; }))
    .on("end", function() {
        log("renaming done" )

        del.sync(sourceFiles, {force:true});
        cb();
    });

} exports.renameProjects = renameProjects;

function updateCodeViewer(cb) {

    log("code-viewer cleanup in /wwwroot/code-viewer/**/.json");
    del.sync("../IgBlazorSamples.Client/wwwroot/code-viewer/**/.json", { force: true });

    log("code-viewer generating in /wwwroot/code-viewer/**/.json");

    // note the 'samples' is a global variable with info about all samples
    // note the 'sample' is a local variable with info about ome sample, see SampleInfo class in Transformer.ts
    for (const sample of samples) {

        // using actual sample route so store json files in sub-folders
        // this way we re-use route when creating a link to code-viewer file in topics
        var path = sample.SampleRouteNew;
        // path = path.substring(1, path.length);
        // path = path.replace("/", "-");

        var codeViewPath = "../IgBlazorSamples.Client/wwwroot/code-viewer" + path + ".json";
        // log("generating " + codeViewPath);

        var content = "{\r\n \"sampleFiles\":\r\n";
        var contentItems = [];

        for (const file of sample.SourceFiles) {
            // console.log("SourceFiles " + file.Name);

            if (file.isRazorFile()) {
                //var code = file.Content.replace(new RegExp('.*\@page.*\r?\n', 'g'), "");
                var codeLines = file.Content.split('\n');
                var codeParsed = [];
                for (const line of codeLines) {
                    if (line.indexOf(".Register(IgniteUIBlazor)") < 0 &&
                        line.indexOf("@page") < 0 &&
                        line.indexOf("@inject IIgniteUIBlazor IgniteUIBlazor") < 0) {
                        codeParsed.push(line.trimEnd());
                    }
                }
                var code = codeParsed.join('\n');
                var exp = /(protected override void OnInitialized\(\)\n\s*{\n\s*\n\s*})/gm;
                code = code.replace(exp, '');
                code = code.replace(/\n\n\n/gm, '\n\n');
                //code = code.replace(/\n\n/gm, '\n');
                var item = new CodeViewer(file.Path, code, "razor", "razor", true);
                contentItems.push(item);
            }
            else if (file.isProgramCS()) {
                var item = new CodeViewer(file.Path, file.Content, "cs", "MODULES", true);
                contentItems.push(item);
            }
            else if (file.isCS()) {
                var name = file.Name.toLowerCase();
                var header = "DATA";
                if (sample.DataFilesCount > 1) {
                    var isGenerator = name.indexOf("generator") >= 0;
                    header = isGenerator ? "DATA GENERATOR" : "DATA SOURCE";
                }
                var item = new CodeViewer(file.Path, file.Content, "cs", header, true);
                contentItems.push(item);
            }
        }

        if (sample.PublicFiles_JS.length > 0) {
            for(const file of sample.PublicFiles_JS) {
                var item = new CodeViewer(file.Path, file.Content, "js", "js", true);
                contentItems.push(item);
            }
        }

        if (sample.PublicFiles_CSS.length > 0) {
            for(const file of sample.PublicFiles_CSS) {
                // if (!file.Content.includes("loaded from the shared CSS file")) {
                //     console.log("CSS " + file.Path);
                    var item = new CodeViewer(file.Path, file.Content, "css", "css", true);
                    contentItems.push(item);
                // }
            }
        }

        if (sample.PublicIndexFile !== undefined) {
            var file = sample.PublicIndexFile;
            var item = new CodeViewer(file.Path, file.Content, "html", "html", true);
            // contentItems.push(item);
        }

        content += JSON.stringify(contentItems, null, '  ');
        content += "\r\n}";

        makeDirectoryFor(codeViewPath);
        fs.writeFileSync(codeViewPath, content);

        // - generate .json file with info about source files, e.g.
        //     \browser\IgBlazorSamples.Client\wwwroot\code-viewer\charts-category-chart-annotations.json
        // - note that "content" field should contain source code for sample files: .razor/.tsx, .cs/.ts, and .css
        // - save all .json files in this folder: \browser\IgBlazorSamples.Client\wwwroot\code-viewer\
        // - save each .json file with sample's component name and sample's folder name: charts-category-chart-annotations.json
    }

    cb();

} exports.updateCodeViewer = updateCodeViewer;