Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmitrytsepelev/rubocop_director
Plan your refactorings properly
https://github.com/dmitrytsepelev/rubocop_director
Last synced: 11 days ago
JSON representation
Plan your refactorings properly
- Host: GitHub
- URL: https://github.com/dmitrytsepelev/rubocop_director
- Owner: DmitryTsepelev
- License: mit
- Created: 2023-05-09T15:43:52.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-26T15:09:13.000Z (3 months ago)
- Last Synced: 2024-10-11T12:56:17.311Z (about 1 month ago)
- Language: Ruby
- Size: 36.1 KB
- Stars: 74
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RubocopDirector
A command–line utility for refactoring planning. It uses `.rubocop_todo.yml` and git history to prioritize a list of refactorings that can bring the most value.
Read more about my approach in the [post](https://dmitrytsepelev.dev/directing-refactoring).
You can support my open–source work [here](https://boosty.to/dmitry_tsepelev).
## Installation
Prerequisites:
- `git` repo;
- generated `.rubocop_todo.yml`.
Install the gem and add to the application's Gemfile by executing:
```bash
$ bundle add rubocop_director
```
## Usage
First of all, create the initial config file based on `.rubocop_todo.yml`:
```bash
bundle exec rubocop-director --generate-config
```
Optionally adjust weights in the config:
1. `update_weight` means how important the fact that file was recently updated;
2. `default_cop_weight` will be used in case when weight for a specific cop is not set;
3. `weights` contains weights for specific cops.
_You can use any numbers you want, but I think it's better to stick with something from 0 to 1._
Build the report:
```bash
bundle exec rubocop-director
```
As a result you'll get something like this:
```bash
💡 Checking git history since 1995-01-01 to find hot files...
💡🎥 Running rubocop to get the list of offences to fix...
💡🎥🎬 Calculating a list of files to refactor...
Path: app/controllers/user_controller.rb
Updated 99 times since 2023-01-01
Offenses:
🚓 Rails/SomeCop - 2
Refactoring value: 1.5431217598108933 (54.79575%)
Path: app/models/user.rb
Updated 136 times since 2023-01-01
Offenses:
🚓 Rails/SomeCop - 1
🚓 Rails/AnotherCop - 1
Refactoring value: 1.2730122208719792 (45.20425%)
```
> Want a different output format (e.g., CSV)? Let me know, open an issue!
Value is calculated using a formula: `sum of value from each cop ( * * ( / ) ** )`.
If you need to count updates from a specific date—use `--since`:
```bash
bundle exec rubocop-director --since=2023-01-01
```
## Development
After checking out the repo, run `bundle install` to install dependencies
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/rubocop_director.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).