@eagleoutice/flowr-dev/documentation/doc-util/doc-auto-gen.js

Static Dataflow Analyzer and Program Slicer for the R Programming Language

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.autoGenHeader = autoGenHeader;
exports.fileNameForGenHeader = fileNameForGenHeader;
const version_1 = require("../../util/version");
const doc_files_1 = require("./doc-files");
/**
 *
 */
function autoGenHeader({ rVersion, filename, purpose, currentDateAndTime = new Date().toISOString().replace('T', ', ').replace(/\.\d+Z$/, ' UTC') }) {
    /* what the page is about only shows on hover: the line above every page should be short */
    return `_<span title="an overview of flowR's ${purpose}">Generated</span> from`
        + ` '${fileNameForGenHeader(filename)}' on ${currentDateAndTime} (v${(0, version_1.flowrVersion)().format()}${rVersion ? ', R v' + rVersion : ''}),`
        + ' please do not edit directly._';
}
/**
 *
 */
function fileNameForGenHeader(filename) {
    const shortenFilename = filename.replace(/^.*src\//, 'src/');
    /* the line above every page stays short: only the file name shows, the path waits in the tooltip */
    return `[${shortenFilename.split('/').pop() ?? shortenFilename}](${(0, doc_files_1.flowrSourceFileUrl)(shortenFilename)} "${shortenFilename}")`;
}
//# sourceMappingURL=doc-auto-gen.js.map