Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewmcodes/pruner
CLI tool to delete Git branches
https://github.com/andrewmcodes/pruner
gem git pruner ruby
Last synced: 17 days ago
JSON representation
CLI tool to delete Git branches
- Host: GitHub
- URL: https://github.com/andrewmcodes/pruner
- Owner: andrewmcodes
- License: mit
- Created: 2020-01-24T01:43:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-18T23:12:35.000Z (over 4 years ago)
- Last Synced: 2024-10-10T02:58:48.865Z (28 days ago)
- Topics: gem, git, pruner, ruby
- Language: Ruby
- Homepage:
- Size: 21.5 KB
- Stars: 20
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Pruner
A small Ruby Gem to help you delete Git branches.
- [Notice](#notice)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
- [Step 1](#step-1)
- [Step 2](#step-2)
- [Step 3](#step-3)
- [Step 4](#step-4)
- [Development](#development)
- [Contributing](#contributing)
- [Coding Standards](#coding-standards)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Notice
This implementation is a bit naive so **be careful**. If you select the current branch you have checked out, the gem will **not** delete it.
## Demo
[](https://asciinema.org/a/x94EQbQe3GauDzErwJf3Rq1Kl)
## Installation
```sh
gem install pruner
```
## Usage
Inside of a repository working directory:
```sh
pruner
```
A multiselect prompt will appear. Use the arrow keys to move between branch names, and hit the spacebar on branches you want to delete. When you have finished making your selections, hit Enter.
The gem will then delete your branches! It's as easy as that.
### Example
#### Step 1
Run the `pruner` command.
```sh
➜ pruner
```
#### Step 2
Use the spacebar to select the branches you want to delete and hit Enter.
```sh
➜ pruner
==== Select branches to delete ====
test_1, test_2, test_3
⬡ master
⬢ test_1
⬢ test_2
‣ ⬢ test_3
```
#### Step 3
Type Y and then hit Enter.
```sh
➜ pruner
==== Select branches to delete ====
test_1, test_2, test_3
==== Are you sure you want to delete these branches? ====
→ (Y/n) Y
```
#### Step 4
The branches will be deleted and the output will look like the output below.
```sh
➜ pruner
==== Select branches to delete ====
test_1, test_2, test_3
==== Are you sure you want to delete these branches? ====
→ Yes
==== Deleting Branches ====
- test_1
- test_2
- test_3
==== Branches Deleted ====
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/andrewmcodes/pruner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrewmcodes/pruner/blob/master/CODE_OF_CONDUCT.md).
### Coding Standards
This project uses [Standard](https://github.com/testdouble/standard) to minimize bike shedding related to code formatting.
## Code of Conduct
Everyone interacting in the Pruner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrewmcodes/pruner/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).