@atomist/sdm/src/lib/pack/node/transform/updateReadmeTitle.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2020 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 { SeedDrivenGeneratorParameters } from "@atomist/automation-client/lib/operations/generate/SeedDrivenGeneratorParameters";
import { logger } from "@atomist/automation-client/lib/util/logger";
import { CodeTransform } from "../../../api/registration/CodeTransform";
import { NodeProjectCreationParameters } from "../generator/NodeProjectCreationParameters";

export const UpdateReadmeTitle: CodeTransform<NodeProjectCreationParameters & SeedDrivenGeneratorParameters> = async (
    project,
    ctx,
    params,
) => {
    logger.info("UpdateReadmeTitle: params=%j", params);
    try {
        const readmeFile = await project.getFile("README.md");
        const content = await readmeFile.getContent();
        const newContent = content.replace(/^\s*#.*/, `# ${params.appName}\n\n${params.target.description}`);
        await readmeFile.setContent(newContent);
    } catch (e) {
        logger.warn(`Did not update README for ${params.appName}: ${e.message}`);
    }
    return project;
};