Find and replace text in github file

Library

Documentation

Quick Start

• Find and replace text in a file hosted on a GitHub repository

Demo

• Clone this repository

git clone https://github.com/FreePhoenix888/find-and-replace-in-github-file.git

• Install dependencies

npm install

• Set environment variables by creating .env.demo.local by copying env.demo which contains "template" of environment variables
• Change values in demo/demo.ts
• Run demo

npx ts-node demo/demo.ts

CLI

Usage

find-and-replace-in-github-file

find-and-replace-in-github-file [Options]

Find and replace text in github file

Options:
  --help           Show help                                           [boolean]
  --version        Show version number                                 [boolean]
  --token          GitHub Personal Access Token              [string] [required]
  --owner          Repository owner                          [string] [required]
  --repo           Repository name                           [string] [required]
  --path           File path in the repository               [string] [required]
  --regex          Regular expression pattern                [string] [required]
  --regex-flags    Regular expression flags (like g, i, m)
                                                         [string] [default: "g"]
  --replacement    Replacement text                          [string] [required]
  --commitMessage  Commit message                            [string] [required]

Usage ways

If you are going to use this package in a project - it is recommended to install it is Locally
If you are going to use this package for yourself - it is recommended to install it Globally or run it directly using npx

Directly running using npx

npx --yes @freephoenix888/find-and-replace-in-github-file

Global Installation

Global installation and running using binary name

npm install --global @freephoenix888/find-and-replace-in-github-file
/home/runner/work/find-and-replace-in-github-file/find-and-replace-in-github-file/dist/cli/find-and-replace-in-github-file

Global installation and running using npx

npm install --global @freephoenix888/find-and-replace-in-github-file
npx /home/runner/work/find-and-replace-in-github-file/find-and-replace-in-github-file/dist/cli/find-and-replace-in-github-file

Local installation

Local installation and running using npx

npm install @freephoenix888/find-and-replace-in-github-file
npx /home/runner/work/find-and-replace-in-github-file/find-and-replace-in-github-file/dist/cli/find-and-replace-in-github-file

Local installation and running using npm script

npm install @freephoenix888/find-and-replace-in-github-file

Add npm script to package.json. Note that you can name your script as you want but it must call binary file provided by the package

{
  "scripts": {
    "/home/runner/work/find-and-replace-in-github-file/find-and-replace-in-github-file/dist/cli/find-and-replace-in-github-file": "/home/runner/work/find-and-replace-in-github-file/find-and-replace-in-github-file/dist/cli/find-and-replace-in-github-file"
  }
}

and run

npm run /home/runner/work/find-and-replace-in-github-file/find-and-replace-in-github-file/dist/cli/find-and-replace-in-github-file