@oaklean/profiler-core/dist/src/helper/ProfilerConfigCommentHelper.js

Part of the @oaklean suite. It provides all basic functions to work with the `.oak` file format. It allows parsing the `.oak` file format as well as tools for analyzing the measurement values. It also provides all necessary capabilities required for prec

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ProfilerConfigCommentHelper = void 0;
const JsoncHelper_1 = require("./JsoncHelper");
const constants_1 = require("../constants");
class ProfilerConfigCommentHelper {
    static addDefaultCommentsToConfigFileContent(configFileContent) {
        const jsonc = new JsoncHelper_1.JsoncHelper(configFileContent);
        jsonc.setCommentIfPossible(['extends'], 'Inherits configuration settings from another config file');
        jsonc.setCommentIfPossible(['exportOptions', 'outDir'], 'Output directory for profiles and reports');
        jsonc.setCommentIfPossible(['exportOptions', 'outHistoryDir'], 'Timestamped historical reports');
        jsonc.setCommentIfPossible(['exportOptions', 'rootDir'], 'Project source root');
        jsonc.setCommentIfPossible(['exportOptions', 'exportV8Profile'], `Export ${constants_1.CPU_PROFILE_FILE_EXTENSION} for external tools`);
        jsonc.setCommentIfPossible(['exportOptions', 'exportReport'], `Export ${constants_1.REPORT_FILE_EXTENSION} file for the ${constants_1.APP_NAME}VSCode Extension`);
        jsonc.setCommentIfPossible(['exportOptions', 'exportSensorInterfaceData'], `Export raw power sensor data (${constants_1.METRICS_DATA_COLLECTION_FILE_EXTENSION} files)`);
        jsonc.setCommentIfPossible(['projectOptions', 'identifier'], `A unique UUID used to identify this project within the (${constants_1.APP_NAME}) ecosystem`);
        jsonc.setCommentIfPossible(['runtimeOptions', 'v8', 'cpu', 'sampleInterval'], 'Sample rate in µs (lower = higher detail/overhead)');
        jsonc.setCommentIfPossible(['runtimeOptions', 'seeds', 'Math.random'], 'Ensures deterministic behavior by seeding the random number generator');
        jsonc.setCommentIfPossible(['runtimeOptions', 'sensorInterface', 'type'], 'Power measurement tool');
        jsonc.setCommentIfPossible(['runtimeOptions', 'sensorInterface', 'options', 'sampleInterval'], 'Sample rate in ms (lower = higher detail/overhead)');
        jsonc.setCommentIfPossible(['runtimeOptions', 'sensorInterface', 'options', 'outputFilePath'], 'Temporary log for raw readings');
        return jsonc.toString();
    }
}
exports.ProfilerConfigCommentHelper = ProfilerConfigCommentHelper;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHJvZmlsZXJDb25maWdDb21tZW50SGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2hlbHBlci9Qcm9maWxlckNvbmZpZ0NvbW1lbnRIZWxwZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsK0NBQTJDO0FBRTNDLDRDQUtxQjtBQUdyQixNQUFhLDJCQUEyQjtJQUN2QyxNQUFNLENBQUMscUNBQXFDLENBQzNDLGlCQUF5QjtRQUV6QixNQUFNLEtBQUssR0FBRyxJQUFJLHlCQUFXLENBQzVCLGlCQUFpQixDQUNqQixDQUFBO1FBRUQsS0FBSyxDQUFDLG9CQUFvQixDQUN6QixDQUFDLFNBQVMsQ0FBQyxFQUNYLDBEQUEwRCxDQUMxRCxDQUFBO1FBQ0QsS0FBSyxDQUFDLG9CQUFvQixDQUN6QixDQUFDLGVBQWUsRUFBRSxRQUFRLENBQUMsRUFDM0IsMkNBQTJDLENBQzNDLENBQUE7UUFDRCxLQUFLLENBQUMsb0JBQW9CLENBQ3pCLENBQUMsZUFBZSxFQUFFLGVBQWUsQ0FBQyxFQUNsQyxnQ0FBZ0MsQ0FDaEMsQ0FBQTtRQUNELEtBQUssQ0FBQyxvQkFBb0IsQ0FDekIsQ0FBQyxlQUFlLEVBQUUsU0FBUyxDQUFDLEVBQzVCLHFCQUFxQixDQUNyQixDQUFBO1FBQ0QsS0FBSyxDQUFDLG9CQUFvQixDQUN6QixDQUFDLGVBQWUsRUFBRSxpQkFBaUIsQ0FBQyxFQUNwQyxVQUFVLHNDQUEwQixxQkFBcUIsQ0FDekQsQ0FBQTtRQUNELEtBQUssQ0FBQyxvQkFBb0IsQ0FDekIsQ0FBQyxlQUFlLEVBQUUsY0FBYyxDQUFDLEVBQ2pDLFVBQVUsaUNBQXFCLGlCQUFpQixvQkFBUSxrQkFBa0IsQ0FDMUUsQ0FBQTtRQUNELEtBQUssQ0FBQyxvQkFBb0IsQ0FDekIsQ0FBQyxlQUFlLEVBQUUsMkJBQTJCLENBQUMsRUFDOUMsaUNBQWlDLGtEQUFzQyxTQUFTLENBQ2hGLENBQUE7UUFDRCxLQUFLLENBQUMsb0JBQW9CLENBQ3pCLENBQUMsZ0JBQWdCLEVBQUUsWUFBWSxDQUFDLEVBQ2hDLDJEQUEyRCxvQkFBUSxhQUFhLENBQ2hGLENBQUE7UUFDRCxLQUFLLENBQUMsb0JBQW9CLENBQ3pCLENBQUMsZ0JBQWdCLEVBQUUsSUFBSSxFQUFFLEtBQUssRUFBRSxnQkFBZ0IsQ0FBQyxFQUNqRCxvREFBb0QsQ0FDcEQsQ0FBQTtRQUNELEtBQUssQ0FBQyxvQkFBb0IsQ0FDekIsQ0FBQyxnQkFBZ0IsRUFBRSxPQUFPLEVBQUUsYUFBYSxDQUFDLEVBQzFDLHVFQUF1RSxDQUN2RSxDQUFBO1FBQ0QsS0FBSyxDQUFDLG9CQUFvQixDQUN6QixDQUFDLGdCQUFnQixFQUFFLGlCQUFpQixFQUFFLE1BQU0sQ0FBQyxFQUM3Qyx3QkFBd0IsQ0FDeEIsQ0FBQTtRQUNELEtBQUssQ0FBQyxvQkFBb0IsQ0FDekIsQ0FBQyxnQkFBZ0IsRUFBRSxpQkFBaUIsRUFBRSxTQUFTLEVBQUUsZ0JBQWdCLENBQUMsRUFDbEUsb0RBQW9ELENBQ3BELENBQUE7UUFDRCxLQUFLLENBQUMsb0JBQW9CLENBQ3pCLENBQUMsZ0JBQWdCLEVBQUUsaUJBQWlCLEVBQUUsU0FBUyxFQUFFLGdCQUFnQixDQUFDLEVBQ2xFLGdDQUFnQyxDQUNoQyxDQUFBO1FBRUQsT0FBTyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUE7SUFDeEIsQ0FBQztDQUNEO0FBL0RELGtFQStEQyJ9