Explain use with RuboCop

xinminlabs · Dec 12, 2020 · f050286 · f050286
1 parent a1dd3e4
commit f050286
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -149,6 +149,19 @@ Or, they can be passed to `prettier` as arguments:
 prettier --ruby-single-quote false --write '**/*.rb'
 ```
 
+## Use with RuboCop
+
+RuboCop and prettier for Ruby serve different purposes, but there is overlap
+with some of RuboCop's functionality.
+
+Prettier provides a RuboCop configuration fle to disable the rules which clash.
+To enable, add the following config at the top of your project's `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  prettier: rubocop.yml
+```
+
 ## Contributing
 
 Check out our [contributing guide](CONTRIBUTING.md). Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-ruby.

diff --git a/prettier.gemspec b/prettier.gemspec
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
         node_modules/prettier/index.js
         node_modules/prettier/third-party.js
         package.json
+        rubocop.yml
       ]
     end
 

diff --git a/rubocop.yml b/rubocop.yml
@@ -0,0 +1,15 @@
+Layout:
+  Enabled: false
+
+Style/MultilineIfModifier: # clashes with rubyModifier
+  Enabled: false
+Style/SymbolArray: # clashes with rubyArrayLiteral
+  Enabled: false
+Style/WordArray: # clashes with rubyArrayLiteral
+  Enabled: false
+Style/TrailingCommaInArguments: # clashes with trailingComma
+  Enabled: false
+Style/TrailingCommaInArrayLiteral: # clashes with trailingComma
+  Enabled: false
+Style/TrailingCommaInHashLiteral: # clashes with trailingComma
+  Enabled: false