{"id":372,"date":"2016-07-27T17:45:38","date_gmt":"2016-07-27T17:45:38","guid":{"rendered":"https:\/\/www.tech.shinynewthings.com\/?p=372"},"modified":"2016-07-28T15:30:01","modified_gmt":"2016-07-28T15:30:01","slug":"372","status":"publish","type":"post","link":"https:\/\/www.tech.shinynewthings.com\/?p=372","title":{"rendered":"RuboCop – commands"},"content":{"rendered":"

Installing Rubocop and Overcommit<\/h1>\n

Install gems<\/h2>\n

$ gem install rubocop $ gem install overcommit<\/p>\n

sets up githooks<\/h2>\n

$ overcommit –install<\/p>\n

Sign changes to overcommit.yml<\/h2>\n

$ overcommit –sign<\/p>\n

Run Rubocop against project<\/h2>\n

Displays Filename, line and description of error<\/h4>\n

$ rubocop<\/p>\n

Rubocop Output<\/h2>\n

Symbol Description<\/h3>\n

. No issues<\/h3>\n

C Convention<\/h3>\n

E Error<\/h3>\n

F Fatal error<\/h3>\n

W Warning<\/h3>\n

Output offense name and count<\/h2>\n

$ rubocop –format offenses<\/p>\n

Show cop definition<\/h2>\n

$ rubocop –show-cop Style\/ZeroLengthPredicate<\/p>\n

List all cops with description, key\/values and link to style guide<\/h2>\n

$ rubocop –show-cops<\/p>\n

Output offense name and count<\/h2>\n

$ rubocop –format offenses<\/p>\n

Run a specific cop against project<\/h2>\n

$ rubocop –only Style\/StringLiterals<\/p>\n

Check a specific file with all cops<\/h2>\n

$ rubocop .\/app\/models\/app_namespace\/api\/v1\/saved_calendar.rb<\/p>\n

Check a specific file with all cops<\/h2>\n

$ rubocop .\/app\/models\/app_namespace\/api\/v1\/saved_calendar.rb –only Style\/StringLiterals<\/p>\n

Check a specific file output errors as json<\/h2>\n

$ rubocop –format json app\/models\/app_namespace\/api\/v1\/project.rb<\/p>\n

Auto-correct with a specific cop<\/h2>\n

$ rubocop –auto-correct –only RedundantParentheses<\/p>\n

Output offenses w formatted suggestion,<\/h2>\n

url to additional comments \/ example<\/h4>\n

$ rubocop –display-style-guide<\/p>\n

Displays Filename, line and description of error<\/h2>\n

With url to documentation for this cop<\/h3>\n

$ rubocop –display-style-guide –display-cop-names<\/p>\n

Show code correctness<\/h2>\n

$ rubocop –lint<\/p>\n

List Files<\/h2>\n

$ rubocop –list-target-files<\/p>\n

In the instance of a Merge, it may be required to Skip RuboCop<\/h2>\n

$ SKIP=RuboCop git commit -am “Merge”<\/p>\n

Generate todo list \/ Turn off all cops<\/h2>\n

$ rubocop –auto-gen-config<\/p>\n","protected":false},"excerpt":{"rendered":"

Installing Rubocop and Overcommit Install gems $ gem install rubocop $ gem install overcommit sets up githooks $ overcommit –install Sign changes to overcommit.yml $ overcommit –sign Run Rubocop against project Displays Filename, line and description of error $ rubocop Rubocop Output Symbol Description . No issues C Convention E Error F Fatal error W […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-372","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=\/wp\/v2\/posts\/372","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=372"}],"version-history":[{"count":10,"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=\/wp\/v2\/posts\/372\/revisions"}],"predecessor-version":[{"id":374,"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=\/wp\/v2\/posts\/372\/revisions\/374"}],"wp:attachment":[{"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=372"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=372"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tech.shinynewthings.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=372"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}