[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/rubocop 969f60e 53/64: Add some configuration documentatio
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/rubocop 969f60e 53/64: Add some configuration documentation |
Date: |
Wed, 11 Aug 2021 10:08:04 -0400 (EDT) |
branch: elpa/rubocop
commit 969f60e5810cec6d962f558a6665f5ab625d4896
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@batsov.com>
Add some configuration documentation
---
README.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/README.md b/README.md
index bc617da..5471aa9 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,24 @@ If you use them often you might want to enable
`rubocop-mode` which will added s
(add-hook 'ruby-mode-hook #'rubocop-mode)
```
+## Configuration
+
+There are a couple of configuration variables that you can use to adjust
RuboCop.el's behavior.
+
+You can change the shell command used by `rubocop-check-*` commands via
`rubocop-check-command`:
+
+``` emacs-lisp
+;; let's run only lint cops
+(setq rubocop-check-command "rubocop --lint --format emacs")
+```
+
+You can change the shell command used by `rubocop-autocorrect-*` commands via
`rubocop-autocorrect-command`
+
+``` emacs-lisp
+;; let's run all auto-corrections possible (by default it's only the safe ones)
+(setq rubocop-autocorrect-command "rubocop -A --format emacs")
+```
+
## Known issues
Check out the project's
- [nongnu] elpa/rubocop 80be17c 13/64: Fix table, (continued)
- [nongnu] elpa/rubocop 80be17c 13/64: Fix table, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 1ffa08b 05/64: Add a few autoloads, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop ac82199 12/64: Release 0.3, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 329329c 45/64: Bump the development version, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop c6dc521 47/64: Remove a mention of dash.el, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 577df29 16/64: Fix minor-mode description, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop e9a74ce 20/64: Use lexical binding as default, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 88bf695 27/64: Merge pull request #16 from rranelli/fix-autocorrect-project-binding, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop c2959fb 38/64: Fix a docstring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 3afa591 41/64: Make some defvars defcustoms, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 969f60e 53/64: Add some configuration documentation,
ELPA Syncer <=
- [nongnu] elpa/rubocop 0bf3fcd 59/64: Mention rubocopfmt, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 07ad97a 63/64: Update some metadata, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop c2a4c79 32/64: Update copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 4219890 34/64: Use #' where applicable, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 9097535 46/64: Update the copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop b921bec 08/64: Merge pull request #2 from nodo/master, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop 6f4928d 15/64: Merge pull request #4 from arthurnn/patch-1, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop c549052 31/64: Merge pull request #19 from syohex/byte-compile-warning, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop fb20a88 33/64: Tweak some docstrings, ELPA Syncer, 2021/08/11
- [nongnu] elpa/rubocop c0cb592 37/64: Kill the dash.el dependency, ELPA Syncer, 2021/08/11