@freephoenix888/find-and-replace-in-github-file/dist/find-and-replace-in-github-file.js

Find and replace text in github file

import debug from 'debug';
const log = debug('find-and-replace-in-github-file');
/**
 * Finds and replaces text in a file hosted on a GitHub repository.
 *
 * @example
 * #### Find and replace text in a file hosted on a GitHub repository
 * ```typescript
 * const octokit = new Octokit({ auth: "your-github-token" });
 * await findAndReplaceInGithubFile({
 *   octokit,
 *   owner: "username",
 *   repo: "repository",
 *   path: "path/to/file.txt",
 *   regex: /findMe/g,
 *   replacement: "replaceWithMe",
 *   commitMessage: "Replaced 'findMe' with 'replaceWithMe'"
 * });
 * ```
 *
 * @throws Will throw an error if any GitHub API request fails (except for 404 errors, which only log a warning).
 */
export async function findAndReplaceInGithubFile(options) {
    const { octokit, owner, repo, path, regex, replacement, commitMessage } = options;
    const fileResponse = await octokit.repos.getContent({ owner, repo, path });
    log({ fileResponse });
    if (fileResponse && Array.isArray(fileResponse.data)) {
        throw new Error(`File ${path} appears to be a directory`);
    }
    if (!fileResponse || !('content' in fileResponse.data)) {
        throw new Error(`File ${path} not found`);
    }
    let content = Buffer.from(fileResponse.data.content, 'base64').toString('utf-8');
    log({ content });
    const changedContent = content.replace(regex, replacement);
    log({ changedContent });
    const result = await octokit.repos.createOrUpdateFileContents({
        owner,
        repo,
        path,
        message: commitMessage,
        content: Buffer.from(changedContent).toString('base64'),
        sha: fileResponse.data.sha,
    });
    log({ result });
    log(`Updated file in repo ${repo}: ${fileResponse.data.path}`);
}
;