@atomist/sdm/src/lib/api-helper/log/LoggingProgressLog.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2019 Atomist, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { logger } from "@atomist/automation-client/lib/util/logger";
import { ProgressLog } from "../../spi/log/ProgressLog";
import { format } from "./format";

/**
 * Progress log to logger, at a desired logging level
 */
export class LoggingProgressLog implements ProgressLog {

    public log: string = "";

    constructor(public name: string, private readonly level: "debug" | "info" = "debug") {
    }

    public write(msg: string, ...args: string[]): void {
        let what = format(msg || "", ...args);
        this.log += what;
        if (what.endsWith("\n\r") || what.endsWith("\r\n")) {
            what = what.slice(0, -2);
        }
        if (what.endsWith("\n")) {
            what = what.slice(0, -1);
        }
        switch (this.level) {
            case "info" :
                logger.info(what);
                break;
            default:
                logger.debug(what);
                break;
        }
    }

    public async isAvailable(): Promise<boolean> {
        return true;
    }

    public flush(): Promise<void> {
        return Promise.resolve();
    }

    public close(): Promise<void> {
        return Promise.resolve();
    }

}