automate-electron-ipc/dist/logger.js

Node library for automating the generation of IPC components for Electron apps.

/*
 *   Apache License 2.0
 *
 *   Copyright (c) 2024, Mattias Aabmets
 *
 *   The contents of this file are subject to the terms and conditions defined in the License.
 *   You may not use, modify, or distribute this file except in compliance with the License.
 *
 *   SPDX-License-Identifier: Apache-2.0
 */
import chalk from "chalk";
function formatOutput(messages, icon) {
    const leadingIcon = `${icon.length === 1 ? " " : ""}${icon} – `;
    const leadingSpace = " ".repeat(leadingIcon.length);
    return messages
        .map((row, index) => {
        const prefix = index === 0 ? leadingIcon : leadingSpace;
        return `${prefix}${row}`;
    })
        .join("\n");
}
function warn(messages) {
    console.warn(chalk.yellow(formatOutput(messages, "⚠️")));
}
function success(messages) {
    console.warn(chalk.green(formatOutput(messages, "✔")));
}
export function nonExistentSchemaPath(path) {
    warn(["Skipping IPC automation, because schema path does not exist:", path]);
}
export function noChannelExpressions(path) {
    warn(["Skipping IPC automation, because no channels were found in path:", path]);
}
export function cannotExecuteChannels() {
    if (!global?.warnedIncorrectUsageOnce) {
        warn(["IPC automation channel expressions have no effect when executed by JavaScript."]);
        global.warnedIncorrectUsageOnce = true;
    }
}
export function reportSuccess(pfsArray) {
    success([
        "Successfully generated IPC bindings:",
        ...pfsArray.map((pfs) => {
            const sanitizedRelPath = pfs.relativePath.replace(/^\.+\//, "");
            const resultPath = pfs.fullPath.includes(sanitizedRelPath)
                ? pfs.fullPath.substring(pfs.fullPath.indexOf(sanitizedRelPath))
                : pfs.fullPath;
            const count = pfs.specs.channelSpecArray.length;
            return `${count} channels from path '${resultPath}'`;
        }),
    ]);
}
export default {
    nonExistentSchemaPath,
    noChannelExpressions,
    cannotExecuteChannels,
    reportSuccess,
};