@naturalcycles/nodejs-lib/dist/fs/json2env.js

Standard library for Node.js

import fs from 'node:fs';
import { dimGrey } from '../colors/colors.js';
import { fs2 } from './fs2.js';
const JSON2ENV_OPT_DEF = {
    saveEnvFile: true,
    bashEnv: true,
    githubEnv: true,
    fail: true,
};
export function json2env(opt) {
    const { jsonPath, prefix, saveEnvFile, bashEnv, githubEnv, fail, debug, silent } = {
        ...JSON2ENV_OPT_DEF,
        ...opt,
    };
    if (!fs2.pathExists(jsonPath)) {
        if (fail) {
            throw new Error(`Path doesn't exist: ${jsonPath}`);
        }
        if (!silent) {
            console.log(`json2env input file doesn't exist, skipping without error (${jsonPath})`);
        }
        if (bashEnv) {
            appendToBashEnv({});
        }
        return;
    }
    // read file
    const json = fs2.readJson(jsonPath);
    if (debug) {
        console.log(json);
    }
    if (saveEnvFile) {
        const shPath = `${jsonPath}.sh`;
        const exportStr = objectToShellExport(json, prefix);
        fs2.writeFile(shPath, exportStr);
        if (!silent) {
            console.log(`json2env created ${dimGrey(shPath)}:`);
            console.log(exportStr);
        }
    }
    if (bashEnv) {
        appendToBashEnv(json, prefix);
    }
    if (githubEnv) {
        appendToGithubEnv(json, prefix);
        appendToGithubOutput(json, prefix);
    }
}
export function appendToBashEnv(obj, prefix = '') {
    const { BASH_ENV } = process.env;
    if (BASH_ENV) {
        const data = objectToShellExport(obj, prefix);
        fs.appendFileSync(BASH_ENV, data);
        console.log(`BASH_ENV appended:\n${data}`);
    }
}
export function appendToGithubEnv(obj, prefix = '') {
    const { GITHUB_ENV } = process.env;
    if (GITHUB_ENV) {
        const data = objectToGithubActionsEnv(obj, prefix);
        fs.appendFileSync(GITHUB_ENV, data);
        console.log(`GITHUB_ENV appended:\n${data}`);
    }
}
export function appendToGithubOutput(obj, prefix = '') {
    const { GITHUB_OUTPUT } = process.env;
    if (GITHUB_OUTPUT) {
        const data = objectToGithubActionsEnv(obj, prefix);
        fs.appendFileSync(GITHUB_OUTPUT, data);
        console.log(`GITHUB_OUTPUT appended:\n${data}`);
    }
}
/**
 * https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
 */
export function appendToGithubSummary(...lines) {
    const { GITHUB_STEP_SUMMARY } = process.env;
    if (GITHUB_STEP_SUMMARY) {
        const str = lines.join('\n') + '\n';
        fs.appendFileSync(GITHUB_STEP_SUMMARY, str);
        console.log(`GITHUB_STEP_SUMMARY appended:\n${str}`);
    }
}
/**
 * Turns Object with keys/values into a *.sh script that exports all keys as values.
 *
 * @example
 * { a: 'b', b: 'c'}
 *
 * will turn into:
 *
 * export a="b"
 * export b="c"
 *
 * Quotes are important, otherwise it'll break on e.g space character in the value.
 * Includes trailing newline for composability.
 */
export function objectToShellExport(obj, prefix = '') {
    if (!Object.keys(obj).length)
        return '';
    return (Object.entries(obj)
        .map(([k, v]) => {
        if (v !== undefined && v !== null) {
            return `export ${prefix}${k}="${v}"`;
        }
    })
        .filter(Boolean)
        .join('\n') + '\n'); // trailing \n is important
}
/**
 * Turns Object with keys/values into a file of key-value pairs
 *
 * @example
 * { a: 'b', b: 'c'}
 *
 * will turn into:
 *
 * a="b"
 * b="c"
 *
 * Quotes are important, otherwise it'll break on e.g space character in the value.
 * Includes trailing newline for composability.
 *
 * UPD: Quoted values behave inconsistently, so we're trying to NOT quote now, and-see-what-happens.
 */
export function objectToGithubActionsEnv(obj, prefix = '') {
    if (!Object.keys(obj).length)
        return '';
    return (Object.entries(obj)
        .map(([k, v]) => {
        if (v !== undefined && v !== null) {
            return `${prefix}${k}=${v}`;
        }
    })
        .filter(Boolean)
        .join('\n') + '\n'); // trailing \n is important
}