https://github.com/oleander/rfix-rb
:bug: RuboCop CLI that only lints and auto-fixes code you committed by utilizing git-log and git-diff.
https://github.com/oleander/rfix-rb
cli git linter rubocop rubocop-cli
Last synced: 12 months ago
JSON representation
:bug: RuboCop CLI that only lints and auto-fixes code you committed by utilizing git-log and git-diff.
- Host: GitHub
- URL: https://github.com/oleander/rfix-rb
- Owner: oleander
- License: mit
- Created: 2020-06-16T12:36:36.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T05:28:33.000Z (over 3 years ago)
- Last Synced: 2025-07-01T01:18:20.384Z (12 months ago)
- Topics: cli, git, linter, rubocop, rubocop-cli
- Language: Ruby
- Homepage: https://rubygems.org/gems/rfix
- Size: 727 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# :bug: rfix [](https://github.com/oleander/rfix-rb/actions/workflows/main.yml) [](https://rubygems.org/gems/rfix)
RuboCop CLI that only lints and auto-fixes code you committed by utilizing `git-log` and `git-diff`. Rfix CLI makes it possible to lint (`rfix lint`) and auto-fix (`rfix local|origin|branch`) code changes since a certain point in history. You can auto-fix code committed since creating the current branch (`rfix origin`) or since pushing to upstream (`rfix local`).
Includes a RuboCop formatter with syntax highlighting and build in hyperlinks for offense documentation.
Holds the same CLI arguments as RuboCop. Run `rfix --help` for a complete list or `rfix` for supported commands. Here are a few examples to get you started:
- `rfix local` Auto-fixes commits not yet pushed to upstream
- `rfix origin` Auto-fixes commits between `HEAD` and origin branch
- `rfix lint` Lints commits and untracked files not yet pushed to upstream
## Installation
``` shell
$ gem install rfix [--pre]
```
## Help
``` shell
$ rfix branch "branch" # Fix changes made between HEAD and
$ rfix origin # Fix changes made between HEAD and origin branch
$ rfix local # Fix changes not yet pushed to upstream branch
$ rfix info # Display runtime dependencies and their versions
$ rfix all # Fix all files in this repository (not recommended)
$ rfix lint # Shortcut for 'rfix local --dry --untracked'
$ rfix # Displays this list of supported commands
```
### Arguments
- `--dry` Turns off RuboCops autofix feature (read-only mode)
- `--help` Displays RubyCops and Rfix supported arguments
- `--list-files` List all files being passed to RubyCop
- `--untracked` Include files not tracked by git
- `--config` Configuration file, defaults to `.rubocop.yml`
## Development
### Setup
``` shell
git clone https://github.com/oleander/rfix-rb
cd rfix-rb
bundle install
git submodule update --init --recursive
```
### Run tests
``` shell
$ bundle exec rake spec
```
## Overcommit
Add the following to your `.overcommit.yml`, then run `overcommit --install` and `overcommit --sign pre-commit`. Lints commits not yet pushed to your upstream branch whenever `git commit` is ran.
``` yaml
PreCommit:
RFix:
enabled: true
command: ["rfix", "lint"]
description: "Lint unchanged commits using RuboCop"
parallelize: true
```
### From scratch
1. `gem install overcommit rfix`
2. `curl https://raw.githubusercontent.com/oleander/rfix-rb/master/resouces/overcommit.yml > .overcommit.yml`
3. `overcommit --install`
4. `overcommit --sign pre-commit`
Run `overcommit --run` to test the new hook.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/oleander/rfix.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).