mirror of
https://github.com/jimeh/rubocopfmt.el.git
synced 2026-02-19 09:06:41 +00:00
Jim Myhrberg
0eb95d9db9
Large portions of rubocopfmt.el is based on code from go-mode.el. As such rubocopfmt.el should really carry the same license and copyright as go-mode.el does.
41 lines
894 B
Markdown
41 lines
894 B
Markdown
# rubocopfmt-mode
|
|
|
|
Emacs minor-mode to format Ruby code with [rubocopfmt][] on save.
|
|
|
|
Core parts of `rubocopfmt-mode` are borrowed from [`go-mode`][go-mode] and it's
|
|
invocation of `gofmt`.
|
|
|
|
## Installing
|
|
|
|
Install [rubocopfmt][]:
|
|
|
|
```
|
|
gem install rubocopfmt --pre
|
|
```
|
|
|
|
Drop `rubocopfmt.el` somewhere into you `load-path`. I favour the folder
|
|
`~/.emacs.d/vendor`:
|
|
|
|
```lisp
|
|
(add-to-list 'load-path "~/.emacs.d/vendor")
|
|
(require 'rubocopfmt)
|
|
```
|
|
|
|
## Usage
|
|
|
|
To enable formatting `ruby-mode` buffers with rubocopfmt on save, simply enable
|
|
`rubocop-mode` within `ruby-mode` with something like this in your config:
|
|
|
|
```lisp
|
|
(add-hook 'ruby-mode-hook #'rubocopfmt-mode)
|
|
```
|
|
|
|
## Commands
|
|
|
|
- `rubocopfmt` - Format current buffer with rubocopfmt.
|
|
- `rubocopfmt-mode` - Toggle formatting on save on/off.
|
|
|
|
|
|
[rubocopfmt]: https://github.com/jimeh/rubocopfmt
|
|
[go-mode]: https://github.com/dominikh/go-mode.el
|