git-merged-branches/README.md

CLI tool to list all Git branches merged into a base branch with issue link formatting

# git-merged-branches

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![build][build-src]][build-href]
[![ask DeepWiki][deep-wiki-src]][deep-wiki-href]

**git-merged-branches is a command-line utility to view branches merged into a selected base branch (e.g., master or main).**

- CLI usage
- customizable via `package.json`

## Installation

Install globally to use `git-merged-branches` or the shorter version `gmb`:

```bash
npm install --global git-merged-branches
```

Or use it without installation via [npx](https://docs.npmjs.com/cli/v7/commands/npx):

```bash
npx git-merged-branches
```

## Usage

By default, the command shows merged branches into the base branch (**master** or **main**).
If neither exists, it will notify you.

Example output:

```bash
$ git-merged-branches
2 branches merged into 'master':
fix/crash-on-start
feat/add-new-feature
```

You can also delete these merged branches with the `--delete` option:

```bash
$ git-merged-branches --delete
2 branches merged into 'master':
fix/crash-on-start
feature/add-new-feature

Deleting branches locally…
Deleting branches remotely…
Branches deleted successfully.
```

## Configuration

You can configure the utility in your `package.json` under `git-merged-branches`. This allows you to set:

- **issueUrlFormat**: Base URL for your issue tracker (must be a valid URL).
- **issueUrlPrefix**: Array of prefixes for issue identifiers in branch names.

Example configuration:

```json
"git-merged-branches": {
  "issueUrlFormat": "https://your-jira-instance.net/browse/{{prefix}}{{id}}",
  "issueUrlPrefix": ["TOKEN-", "PROJECT-"]
}
```

With this setup, `git-merged-branches` will generate links for branches with such tokens in their name:

```bash
$ git-merged-branches
4 branches merged into 'master':
fix/EXTERNAL-391
fix/TOKEN-123_some-fix <https://your-jira-instance.net/browse/TOKEN-123>
hotfix
TOKEN-800_new-feature <https://your-jira-instance.net/browse/TOKEN-800>
```

If the configuration is invalid, warnings will be shown and the utility will skip formatting URLs.

## Documentation

- [DeepWiki](https://deepwiki.com/VChet/git-merged-branches)

## Development

To contribute or test locally:

1. Clone the repository:

    ```bash
    git clone https://github.com/VChet/git-merged-branches.git
    cd git-merged-branches
    ```

1. Install dependencies:

    ```bash
    npm install
    ```

1. Build the project:

    ```bash
    npm run build
    ```

1. Link it locally for testing:

    ```bash
    npm link
    ```

Now you can run `git-merged-branches` on your local machine.

## Contributing

If you have any ideas, bug reports, or feature requests,
feel free to [contribute](https://github.com/VChet/git-merged-branches/pulls)
or report [issues](https://github.com/VChet/git-merged-branches/issues).

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/git-merged-branches?style=flat-square
[npm-version-href]: https://npmjs.com/package/git-merged-branches
[npm-downloads-src]: https://img.shields.io/npm/dm/git-merged-branches?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/git-merged-branches
[build-src]: https://img.shields.io/github/actions/workflow/status/VChet/git-merged-branches/build.yml?style=flat-square
[build-href]: https://github.com/VChet/git-merged-branches/actions/workflows/build.yml
[deep-wiki-src]: https://img.shields.io/badge/ask-DeepWiki-blue?style=flat-square
[deep-wiki-href]: https://deepwiki.com/VChet/git-merged-branches